Skip to content

Commit

Permalink
modify notes on commit squashing
Browse files Browse the repository at this point in the history
  • Loading branch information
Hwurzburg committed Sep 26, 2024
1 parent 9c3ed13 commit 112e1e6
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion dev/source/docs/submitting-patches-back-to-master.rst
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ Preparing commits
to `online resources <http://gitready.com/advanced/2009/02/10/squashing-commits-with-rebase.html>`__
to understand how to use this tool.

- The commits of the change should be squashed (see :ref:`git-interactive-rebase`) into one commit and then the "Tools/gittools/git-subsystems-split" script run to create a single commit for each library module affected.
- Each commit should involve only a single library. The commits of the changes in each library should be squashed (see :ref:`git-interactive-rebase`) into the minimal number of commits per library that allows readability and clarity when reviewing (usually only one commit). The "Tools/gittools/git-subsystems-split" script can be run on any commit spanning multiple libraries to create a single commit for each library module affected before submitting. if needed.

- Do not submit patches with commented-out code or code that is never reachable within ``#define`` s.

Expand Down

0 comments on commit 112e1e6

Please sign in to comment.