diff options
| author | Eric Engestrom <eric@engestrom.ch> | 2020-06-07 19:14:51 +0200 |
|---|---|---|
| committer | Marge Bot <eric+marge@anholt.net> | 2020-06-19 19:51:53 +0000 |
| commit | a096d4109419c7c9015d8652549c5066d7fd1205 (patch) | |
| tree | 71372bf2317c6f6ee5aa9b3d74576cf99aa7e712 | |
| parent | 7488d491072cbd98e3bfc6d39b2ca10504572e72 (diff) | |
docs: move `Fixes:` tag explanation to its own section
This also adds the ability to link directly to it:
https://mesa3d.org/submittingpatches.html#fixes
Signed-off-by: Eric Engestrom <eric@engestrom.ch>
Reviewed-by: Eric Anholt <eric@anholt.net>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/5378>
| -rw-r--r-- | docs/submittingpatches.rst | 40 |
1 files changed, 19 insertions, 21 deletions
diff --git a/docs/submittingpatches.rst b/docs/submittingpatches.rst index 984c0aa3186..5cd5025fd88 100644 --- a/docs/submittingpatches.rst +++ b/docs/submittingpatches.rst @@ -60,27 +60,9 @@ Patch formatting Prefer the full url to just ``Closes: #1``, since the url makes it easier to get to the bug page from ``git log`` - **Do not use the Fixes: tag for this!** Mesa already uses Fixes for - something else. - -- If a patch addresses a issue introduced with earlier commit, that - should be noted in the commit message. For example: - - :: - - Fixes: d7b3707c612 "util/disk_cache: use stat() to check if entry is a directory" - -- You can produce those fixes lines by running - - :: - - git config --global alias.fixes "show -s --pretty='format:Fixes: %h (\"%s\")'" - - once and then using - - :: - - git fixes <sha1> + **Do not use the ``Fixes:`` tag for this!** Mesa already uses + ``Fixes:`` for something else. + See `below <#fixes>`__. - If there have been several revisions to a patch during the review process, they should be noted such as in this example: @@ -120,6 +102,22 @@ Patch formatting This provides reviewers with quick feedback if the patch has already been reviewed. +.. _fixes: + +The ``Fixes:`` tag +------------------ + +If a patch addresses a issue introduced with earlier commit, that +should be noted in the commit message. For example:: + + Fixes: d7b3707c612 "util/disk_cache: use stat() to check if entry is a directory" + +You can produce those fixes lines by running this command once:: + + git config --global alias.fixes "show -s --pretty='format:Fixes: %h (\"%s\")'" + +After that, using ``git fixes <sha1>`` will print the full line for you. + .. _testing: Testing Patches |