Mirrors_Framework/ODrive
1
0
Fork 0
mirror of https://github.com/odriverobotics/ODrive.git synced 2026-09-20 22:55:00 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

clarify readme

Browse Source
This commit is contained in:
Samuel Sadok
2018-03-13 00:49:41 -07:00
parent ee9bd77774
commit 1d4d02fd62
1 changed files with 2 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Firmware/README.md
+2 -1
View File
@@ -317,12 +317,13 @@ You will likely want the pinout for this process. It is available [here](https:/
### Generating patchfiles
If you made changes to CubeMX generated files outside of the `USER CODE BEGIN`...`USER CODE END` sections and contribute them back, please add a patch file so that the next person who runs CubeMX doesn't run into problems. The way described here will use git to revert your changes and then revert the revert on top of that, thus giving you a commit that represents the exact patch that you want to export.
* Make sure your current desired state is committed.
* Make a new temporary branch: `git checkout -b cubemx_temp`
* Run the CubeMX code generation as described in the previous section.
* The diff will now _not_ be empty since CubeMX reversed your changes.
* Stage the falsely reversed file and make a commit with the message "bogus commit".
* Run `git revert HEAD` to revert the bogus commit. This gives you the "double negative" commit which you will export, so write a meaningful commit message.
* Run `git format-patch HEAD~1` to export the commit as patch file.
* Run `git rebase --interactive HEAD~2` and write "drop" for both commits that you just did.
* Check out your previous branch and then force-delete the temporary branch: `git branch -D cubemx_temp`
* Move the patch file to `Board/v3/` and add it in a new commit.
<br><br>