Skip to content

Commit b9f2e2b

Browse files
author
Mariusz Glebocki
authored
Update README.rst (chipsalliance#1772)
Add instructions how to change a submodule. Request users to put some info in the PR description when they are creating one.
2 parents 7b3ed32 + e05c5f9 commit b9f2e2b

File tree

1 file changed

+12
-1
lines changed

1 file changed

+12
-1
lines changed

README.rst

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -167,10 +167,21 @@ Using dedicated branch
167167

168168
Create a new branch and point submodules to revisions with your changes. Then pick one of the following methods.
169169

170+
To change a submodule:
171+
172+
- Change submodule's remote to point to your fork: ``git submodule set-url -- SUBMODULE_PATH URL``. Use https URL, which is available on github when you click green "❬❭ Code ▾" button.
173+
Example: ``git submodule set-url ./yosys-f4pga-plugins https://github.com/antmicro/yosys-f4pga-plugins.git``
174+
- Change current directory to the submodule directory and switch revision to one you want to use. The URL you've added above has been assigned to remote "origin".
175+
Example: ``git fetch origin my-branch-name; git checkout FETCH_HEAD``
176+
- If you want to change more than one submodule, repeat two previous steps for all other submodules you want to change.
177+
- Change current directory to the top-level ``yosys-systemverilog`` working directory. Stage all performed changes, i.e. ``.gitmodules`` file and directories of every changed submodule. Commit changes.
178+
Example: ``git add .gitmodules ./yosys-f4pga-plugins``.
179+
- Commit and push your changes to your ``yosys-systemverilog`` fork.
180+
170181
Create a Pull Request
171182
"""""""""""""""""""""
172183

173-
Just that. Create a (WIP) Pull Request using your new branch.
184+
Just that. Create a (Draft/WIP) Pull Request using your new branch. Mention in the description what are you testing, just to let everyone know what this PR is for. E.g. paste a link to the main PR that you are testing.
174185

175186
Start a workflow manually (using Github Web UI)
176187
"""""""""""""""""""""""""""""""""""""""""""""""

0 commit comments

Comments
 (0)