random-mirrors/smaeul-u-boot
1
0
Fork 0
mirror of https://github.com/smaeul/u-boot.git synced 2025-10-14 04:46:01 +01:00
Code Issues Packages Projects Releases Wiki Activity

patman: Tidy up unnecessary blank lines and numbers

Browse Source 
Quite a few blank lines are not needed here. Drop these and use the #
mechanism to number paragraphs.

Signed-off-by: Simon Glass <sjg@chromium.org>
This commit is contained in:
Simon Glass 2022-08-17 12:47:07 -06:00
parent 74eaa5c661
commit 65af8f2c60
1 changed files with 15 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

45
tools/patman/patman.rst
View File

@ -11,21 +11,15 @@ Patman patch manager
This tool is a Python script which: This tool is a Python script which:
- Creates patch directly from your branch - Creates patch directly from your branch
- Cleans them up by removing unwanted tags - Cleans them up by removing unwanted tags
- Inserts a cover letter with change lists - Inserts a cover letter with change lists
- Runs the patches through checkpatch.pl and its own checks - Runs the patches through checkpatch.pl and its own checks
- Optionally emails them out to selected people - Optionally emails them out to selected people
It also has some Patchwork features: It also has some Patchwork features:
- shows review tags from Patchwork so you can update your local patches - shows review tags from Patchwork so you can update your local patches
- pulls these down into a new branch on request - pulls these down into a new branch on request
- lists comments received on a series - lists comments received on a series
It is intended to automate patch creation and make it a less It is intended to automate patch creation and make it a less
@ -53,15 +47,12 @@ This tool requires a certain way of working:
- Maintain a number of branches, one for each patch series you are - Maintain a number of branches, one for each patch series you are
working on working on
- Add tags into the commits within each branch to indicate where the - Add tags into the commits within each branch to indicate where the
series should be sent, cover letter, version, etc. Most of these are series should be sent, cover letter, version, etc. Most of these are
normally in the top commit so it is easy to change them with 'git normally in the top commit so it is easy to change them with 'git
commit --amend' commit --amend'
- Each branch tracks the upstream branch, so that this script can - Each branch tracks the upstream branch, so that this script can
automatically determine the number of commits in it (optional) automatically determine the number of commits in it (optional)
- Check out a branch, and run this script to create and send out your - Check out a branch, and run this script to create and send out your
patches. Weeks later, change the patches and repeat, knowing that you patches. Weeks later, change the patches and repeat, knowing that you
will get a consistent result each time. will get a consistent result each time.
@ -623,41 +614,35 @@ and it will create and send the version 2 series.
General points General points
-------------- --------------
1. When you change back to the us-cmd branch days or weeks later all your #. When you change back to the us-cmd branch days or weeks later all your
information is still there, safely stored in the commits. You don't need information is still there, safely stored in the commits. You don't need
to remember what version you are up to, who you sent the last lot of patches to remember what version you are up to, who you sent the last lot of patches
to, or anything about the change logs. to, or anything about the change logs.
#. If you put tags in the subject, patman will Cc the maintainers
2. If you put tags in the subject, patman will Cc the maintainers
automatically in many cases. automatically in many cases.
#. If you want to keep the commits from each series you sent so that you can
3. If you want to keep the commits from each series you sent so that you can
compare change and see what you did, you can either create a new branch for compare change and see what you did, you can either create a new branch for
each version, or just tag the branch before you start changing it: each version, or just tag the branch before you start changing it:
.. code-block:: bash .. code-block:: bash
git tag sent/us-cmd-rfc git tag sent/us-cmd-rfc
# ...later... # ...later...
git tag sent/us-cmd-v2 git tag sent/us-cmd-v2
4. If you want to modify the patches a little before sending, you can do #. If you want to modify the patches a little before sending, you can do
this in your editor, but be careful! this in your editor, but be careful!
#. If you want to run git send-email yourself, use the -n flag which will
5. If you want to run git send-email yourself, use the -n flag which will
print out the command line patman would have used. print out the command line patman would have used.
#. It is a good idea to add the change log info as you change the commit,
6. It is a good idea to add the change log info as you change the commit,
not later when you can't remember which patch you changed. You can always not later when you can't remember which patch you changed. You can always
go back and change or remove logs from commits. go back and change or remove logs from commits.
#. Some mailing lists have size limits and when we add binary contents to
7. Some mailing lists have size limits and when we add binary contents to
our patches it's easy to exceed the size limits. Use "--no-binary" to our patches it's easy to exceed the size limits. Use "--no-binary" to
generate patches without any binary contents. You are supposed to include generate patches without any binary contents. You are supposed to include
a link to a git repository in your "Commit-notes", "Series-notes" or a link to a git repository in your "Commit-notes", "Series-notes" or
"Cover-letter" for maintainers to fetch the original commit. "Cover-letter" for maintainers to fetch the original commit.
#. Patches will have no changelog entries for revisions where they did not
8. Patches will have no changelog entries for revisions where they did not
change. For clarity, if there are no changes for this patch in the most change. For clarity, if there are no changes for this patch in the most
recent revision of the series, a note will be added. For example, a patch recent revision of the series, a note will be added. For example, a patch
with the following tags in the commit:: with the following tags in the commit::
@ -669,15 +654,15 @@ General points
Series-changes: 4 Series-changes: 4
- Another change - Another change
would have a changelog of::: would have a changelog of:::
(no changes since v4) (no changes since v4)
Changes in v4: Changes in v4:
- Another change - Another change
Changes in v2: Changes in v2:
- Some change - Some change
Other thoughts Other thoughts