git: bcd1bb7a20 - main - committers-guide: Remove "Submitted by" from examples

Mateusz Piotrowski 0mp at FreeBSD.org
Tue Apr 20 15:46:09 UTC 2021


The branch main has been updated by 0mp:

URL: https://cgit.FreeBSD.org/doc/commit/?id=bcd1bb7a20c7204bd9e2eaf5f3148a9157a47447

commit bcd1bb7a20c7204bd9e2eaf5f3148a9157a47447
Author:     Mateusz Piotrowski <0mp at FreeBSD.org>
AuthorDate: 2021-04-20 15:30:23 +0000
Commit:     Mateusz Piotrowski <0mp at FreeBSD.org>
CommitDate: 2021-04-20 15:45:19 +0000

    committers-guide: Remove "Submitted by" from examples
    
    Reviewed by:    imp
    Differential Revision:  https://reviews.freebsd.org/D29868
---
 documentation/content/en/articles/committers-guide/_index.adoc | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)

diff --git a/documentation/content/en/articles/committers-guide/_index.adoc b/documentation/content/en/articles/committers-guide/_index.adoc
index cf26d2ce87..0944750736 100644
--- a/documentation/content/en/articles/committers-guide/_index.adoc
+++ b/documentation/content/en/articles/committers-guide/_index.adoc
@@ -2611,16 +2611,18 @@ Approved by: re (username)
 [example]
 ====
 
-The commit is based on a patch from a PR submitted by John Smith. The commit message "PR" and "Submitted by" fields are filled..
+The commit is based on a patch from a PR submitted by John Smith.
+The commit message "PR" field is filled.
 
 [.programlisting]
 ....
 ...
 
 	    PR:                    12345
-	    Submitted by:	   John Smith <John.Smith at example.com>
 ....
 
+The committer sets the author of the patch with `git commit --author "John Smith <John.Smith at example.com>"`.
+
 ====
 
 .Commit Log for a Commit Needing Review
@@ -2701,7 +2703,6 @@ The extra information to include in the commit would look something like
 [.programlisting]
 ....
 PR:                 54321
-Submitted by:       John Smith <John.Smith at example.com>
 Reviewed by:        -arch
 Obtained from:      NetBSD
 MFC after:          1 month


More information about the dev-commits-doc-all mailing list