me
/
guix
Archived
1
0
Fork 0
Code

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 <maxim.cournoyer@gmail.com>
master
Tomas Volf 2024-06-20 23:40:56 +02:00 committed by Maxim Cournoyer
parent 77d949c812
commit 603d523fc3
No known key found for this signature in database
GPG Key ID: 1260E46482E63562
1 changed files with 5 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
doc/contributing.texi
View File

@ -2946,7 +2946,7 @@ account the submitter's motivation for doing things in a certain way.
@cindex Reviewed-by, git trailer @cindex Reviewed-by, git trailer
When you deem the proposed change adequate and ready for inclusion When you deem the proposed change adequate and ready for inclusion
within Guix, the following well understood/codified 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 @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 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 @samp{b4 am} sub-command, which is able to retrieve the complete
@ -2958,7 +2958,8 @@ looks good to you:
@itemize @itemize
@item @item
If the @emph{whole} series (containing multiple commits) looks good to 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 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 otherwise, adding another @samp{(for the whole series)} comment on the
line below to explicit this fact. line below to explicit this fact.
@ -2966,8 +2967,8 @@ line below to explicit this fact.
@item @item
If you instead want to mark a @emph{single commit} as reviewed (but not If you instead want to mark a @emph{single commit} as reviewed (but not
the whole series), simply reply with the whole series), simply reply with
@samp{Reviewed-by:@tie{}Your@tie{}Name<your-email@@example.com>} to that @samp{Reviewed-by:@tie{}Your@tie{}Name@tie{}<your-email@@example.com>}
commit message. to that commit message.
@end itemize @end itemize
If you are not a committer, you can help others find a @emph{series} you If you are not a committer, you can help others find a @emph{series} you