[PATCH] doc: Fix Reviewed-by format

  • Done
  • quality assurance status badge
Details
2 participants
  • Maxim Cournoyer
  • Tomas Volf
Owner
unassigned
Submitted by
Tomas Volf
Severity
normal

Debbugs page

Tomas Volf wrote 9 months ago
(address . guix-patches@gnu.org)(name . Tomas Volf)(address . ~@wolfsden.cz)
14564e767017f18c0dc8d6326419f1c8d4daab16.1718919656.git.~@wolfsden.cz
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
---
doc/contributing.texi | 9 +++++----
1 file changed, 5 insertions(+), 4 deletions(-)

Toggle diff (36 lines)
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 @@ Reviewing the Work of Others
@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 @@ Reviewing the Work of Others
@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 @@ Reviewing the Work of Others
@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
--
2.45.1
Maxim Cournoyer wrote 9 months ago
(name . Tomas Volf)(address . ~@wolfsden.cz)
87tthj9kql.fsf@gmail.com
Hello!

Tomas Volf <~@wolfsden.cz> writes:

Toggle quote (9 lines)
> 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

Note that unlike in the Linux project, we punctuate our commit summaries
(with a trailing dot and capitalized first letter).

Applied, closing.

--
Thanks,
Maxim
Closed
?
Your comment

This issue is archived.

To comment on this conversation send an email to 71687@debbugs.gnu.org

To respond to this issue using the mumi CLI, first switch to it
mumi current 71687
Then, you may apply the latest patchset in this issue (with sign off)
mumi am -- -s
Or, compose a reply to this issue
mumi compose
Or, send patches to this issue
mumi send-email *.patch
You may also tag this issue. See list of standard tags. For example, to set the confirmed and easy tags
mumi command -t +confirmed -t +easy
Or, remove the moreinfo tag and set the help tag
mumi command -t -moreinfo -t +help