Date: Fri, 7 May 2021 05:42:28 GMT From: Guangyuan Yang <ygy@FreeBSD.org> To: doc-committers@FreeBSD.org, dev-commits-doc-all@FreeBSD.org Subject: git: ef3b1ba824 - main - committers-guide: Improve hyphenations and branch names Message-ID: <202105070542.1475gSOV049702@gitrepo.freebsd.org>
next in thread | raw e-mail | index | archive | help
The branch main has been updated by ygy: URL: https://cgit.FreeBSD.org/doc/commit/?id=ef3b1ba824cac8af81150b9ce1824172f04afa3a commit ef3b1ba824cac8af81150b9ce1824172f04afa3a Author: Guangyuan Yang <ygy@FreeBSD.org> AuthorDate: 2021-05-07 05:40:44 +0000 Commit: Guangyuan Yang <ygy@FreeBSD.org> CommitDate: 2021-05-07 05:40:44 +0000 committers-guide: Improve hyphenations and branch names Submitted by: gnn --- documentation/content/en/articles/committers-guide/_index.adoc | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/documentation/content/en/articles/committers-guide/_index.adoc b/documentation/content/en/articles/committers-guide/_index.adoc index 67110e1343..02c927bf64 100644 --- a/documentation/content/en/articles/committers-guide/_index.adoc +++ b/documentation/content/en/articles/committers-guide/_index.adoc @@ -2104,9 +2104,9 @@ would look at the log for the vendor branch for zlib starting at 1.2.10. === Collaborating with others One of the keys to good software development on a project as large as FreeBSD is the ability to collaborate with others before you push your changes to the tree. -The FreeBSD project's Git repositories do not, yet, allow user created branches to be pushed to the repository, and therefore if you wish to share your changes with others you must use another mechanism, such as a hosted GitLab or GitHub, in order to share changes in a user generated branch. +The FreeBSD project's Git repositories do not, yet, allow user-created branches to be pushed to the repository, and therefore if you wish to share your changes with others you must use another mechanism, such as a hosted GitLab or GitHub, in order to share changes in a user-generated branch. -The following instructions show how to set up a user generated branch, based on the FreeBSD main branch, and push it to GitHub. +The following instructions show how to set up a user-generated branch, based on the FreeBSD main branch, and push it to GitHub. Before you begin, make sure that your local Git repo is up to date and has the correct origins set <<keeping_current,as shown above.>> @@ -2134,7 +2134,7 @@ With this in place you can create a branch <<keeping_a_local_branch,as shown abo [source,shell] .... -% git checkout -b gnn-github +% git checkout -b gnn-pr2001-fix .... Make whatever modifications you wish in your branch. Build, test, and once you're ready to collaborate with others it's time to push your changes into your hosted branch. @@ -2143,10 +2143,10 @@ Before you can push you'll have to set the appropriate upstream, as Git will tel [source,shell] .... % git push github -fatal: The current branch gnn-github has no upstream branch. +fatal: The current branch gnn-pr2001-fix has no upstream branch. To push the current branch and set the remote as upstream, use - git push --set-upstream github gnn-github + git push --set-upstream github gnn-pr2001-fix .... Setting the push as +git+ advises allows it to succeed:
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?202105070542.1475gSOV049702>