From owner-dev-commits-doc-all@freebsd.org Wed Mar 17 23:36:32 2021 Return-Path: Delivered-To: dev-commits-doc-all@mailman.nyi.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mailman.nyi.freebsd.org (Postfix) with ESMTP id C99A957CBB8 for ; Wed, 17 Mar 2021 23:36:32 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from mxrelay.nyi.freebsd.org (mxrelay.nyi.freebsd.org [IPv6:2610:1c1:1:606c::19:3]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256 client-signature RSA-PSS (4096 bits) client-digest SHA256) (Client CN "mxrelay.nyi.freebsd.org", Issuer "R3" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 4F164J5QhPz3n4q; Wed, 17 Mar 2021 23:36:32 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org (gitrepo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:5]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (Client did not present a certificate) by mxrelay.nyi.freebsd.org (Postfix) with ESMTPS id AD394177D7; Wed, 17 Mar 2021 23:36:32 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org ([127.0.1.44]) by gitrepo.freebsd.org (8.16.1/8.16.1) with ESMTP id 12HNaWul038919; Wed, 17 Mar 2021 23:36:32 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.16.1/8.16.1/Submit) id 12HNaWY3038918; Wed, 17 Mar 2021 23:36:32 GMT (envelope-from git) Date: Wed, 17 Mar 2021 23:36:32 GMT Message-Id: <202103172336.12HNaWY3038918@gitrepo.freebsd.org> To: doc-committers@FreeBSD.org, dev-commits-doc-all@FreeBSD.org From: Warner Losh Subject: git: a7ec32b97b - main - Wording improvements MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: imp X-Git-Repository: doc X-Git-Refname: refs/heads/main X-Git-Reftype: branch X-Git-Commit: a7ec32b97beee65b3a05778232110a93ed323a72 Auto-Submitted: auto-generated X-BeenThere: dev-commits-doc-all@freebsd.org X-Mailman-Version: 2.1.34 Precedence: list List-Id: Commit messages for all branches of the doc repository List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Wed, 17 Mar 2021 23:36:32 -0000 The branch main has been updated by imp: URL: https://cgit.FreeBSD.org/doc/commit/?id=a7ec32b97beee65b3a05778232110a93ed323a72 commit a7ec32b97beee65b3a05778232110a93ed323a72 Author: Warner Losh AuthorDate: 2021-03-17 23:35:37 +0000 Commit: Warner Losh 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 <> section instead of emulate the brief style here. +But for your actual commit, you should follow the <> 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