git: a7ec32b97b - main - Wording improvements

Warner Losh imp at FreeBSD.org
Wed Mar 17 23:36:32 UTC 2021


The branch main has been updated by imp:

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

commit a7ec32b97beee65b3a05778232110a93ed323a72
Author:     Warner Losh <imp at FreeBSD.org>
AuthorDate: 2021-03-17 23:35:37 +0000
Commit:     Warner Losh <imp at FreeBSD.org>
CommitDate: 2021-03-17 23:35:37 +0000

    Wording improvements
    
    Describe how to collapse multiple MFCs better. Use consistent punctuation. fix
    some typos.
    
    Submitted by: Pau Amma
---
 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 290210be48..8c4d20fa0d 100644
--- a/documentation/content/en/articles/committers-guide/_index.adoc
+++ b/documentation/content/en/articles/committers-guide/_index.adoc
@@ -720,7 +720,8 @@ use `git pull --rebase` and try to push again.
 % for h in $HASH_LIST; do git cherry-pick -x $h; done
 % git rebase -i stable/X
 # mark each of the commits after the first as 'squash'
-# edit the commit message to be sane, if necessary
+# Update the commit message to reflect all elements of commit, if necessary.
+# Be sure to retain the "cherry picked from" lines.
 % git push freebsd HEAD:stable/X
 ....
 
@@ -1338,7 +1339,7 @@ At this point, you should have a pristine copy of glorbnitz ready to commit.
 ....
 As above, I used `-m` for simplicity, but you should likely create a commit message that explains what a Glorb is and why you'd use a Nitz to get it.
 Not everybody will know.
-But for your actual commmit, you should follow the <<commit-log-message,commit log message>> section instead of emulate the brief style here.
+But for your actual commit, you should follow the <<commit-log-message,commit log message>> section instead of emulating the brief style used here.
 
 ==== Now import it into our repository
 Now you need to import the branch into our repository.
@@ -1369,7 +1370,7 @@ By 'good' we mean:
 . All the right files are present
 . None of the wrong files are present
 . The vendor branch points at something sensible
-. The tag looks good, and is annotated.
+. The tag looks good, and is annotated
 . The commit message for the tag has a quick summary of what's new since the last tag
 
 ==== Time to finally merge it into the base tree


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