--- Begin Message ---
|
Subject: |
[PATCH] doc: Fix Reviewed-by format |
|
Date: |
Thu, 20 Jun 2024 23:40:56 +0200 |
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(-)
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
--- End Message ---
--- Begin Message ---
|
Subject: |
Re: [bug#71687] [PATCH] doc: Fix Reviewed-by format |
|
Date: |
Sun, 23 Jun 2024 21:45:38 -0400 |
|
User-agent: |
Gnus/5.13 (Gnus v5.13) |
Hello!
Tomas Volf <~@wolfsden.cz> writes:
> 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
--- End Message ---