apteryx pushed a commit to branch master
in repository guix.
commit 603d523fc321514fa01d56fe4a96fbc2f9268343
Author: Tomas Volf <[email protected]>
AuthorDate: Thu Jun 20 23:40:56 2024 +0200
doc: Fix Reviewed-by format.
The documentation does not have a space between `e' and `<', which is not
how
people use it, as can be seen from git log. So adjust the format to match
the
reality.
* doc/contributing.texi (Reviewing the Work of Others): Fix format for
Reviewed-by.
Change-Id: Ib863536db72b885cf34927323cb4ebc52a8db2ed
Signed-off-by: Maxim Cournoyer <[email protected]>
---
doc/contributing.texi | 9 +++++----
1 file changed, 5 insertions(+), 4 deletions(-)
diff --git a/doc/contributing.texi b/doc/contributing.texi
index 938c8bfdb1..92bab5b694 100644
--- a/doc/contributing.texi
+++ b/doc/contributing.texi
@@ -2946,7 +2946,7 @@ account the submitter's motivation for doing things in a
certain way.
@cindex Reviewed-by, git trailer
When you deem the proposed change adequate and ready for inclusion
within Guix, the following well understood/codified
-@samp{Reviewed-by:@tie{}Your@tie{}Name<your-email@@example.com>}
+@samp{Reviewed-by:@tie{}Your@tie{}Name@tie{}<your-email@@example.com>}
@footnote{The @samp{Reviewed-by} Git trailer is used by other projects
such as Linux, and is understood by third-party tools such as the
@samp{b4 am} sub-command, which is able to retrieve the complete
@@ -2958,7 +2958,8 @@ looks good to you:
@itemize
@item
If the @emph{whole} series (containing multiple commits) looks good to
-you, reply with
@samp{Reviewed-by:@tie{}Your@tie{}Name<your-email@@example.com>}
+you, reply with
+@samp{Reviewed-by:@tie{}Your@tie{}Name@tie{}<your-email@@example.com>}
to the cover page if it has one, or to the last patch of the series
otherwise, adding another @samp{(for the whole series)} comment on the
line below to explicit this fact.
@@ -2966,8 +2967,8 @@ line below to explicit this fact.
@item
If you instead want to mark a @emph{single commit} as reviewed (but not
the whole series), simply reply with
-@samp{Reviewed-by:@tie{}Your@tie{}Name<your-email@@example.com>} to that
-commit message.
+@samp{Reviewed-by:@tie{}Your@tie{}Name@tie{}<your-email@@example.com>}
+to that commit message.
@end itemize
If you are not a committer, you can help others find a @emph{series} you
