Date: Fri, 9 Apr 2021 20:17:58 GMT From: "George V. Neville-Neil" <gnn@FreeBSD.org> To: doc-committers@FreeBSD.org, dev-commits-doc-all@FreeBSD.org Subject: git: 63584c7bba - main - Address points brought up by bsdimp Message-ID: <202104092017.139KHwxq031669@gitrepo.freebsd.org>
next in thread | raw e-mail | index | archive | help
The branch main has been updated by gnn (src committer): URL: https://cgit.FreeBSD.org/doc/commit/?id=63584c7bba7b5971b475a90e47cf083c0d538dd3 commit 63584c7bba7b5971b475a90e47cf083c0d538dd3 Author: George V. Neville-Neil <gnn@FreeBSD.org> AuthorDate: 2021-04-09 20:16:49 +0000 Commit: George V. Neville-Neil <gnn@FreeBSD.org> CommitDate: 2021-04-09 20:17:49 +0000 Address points brought up by bsdimp --- .../content/en/articles/committers-guide/_index.adoc | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/documentation/content/en/articles/committers-guide/_index.adoc b/documentation/content/en/articles/committers-guide/_index.adoc index 5d3cd89afa..5effac883f 100644 --- a/documentation/content/en/articles/committers-guide/_index.adoc +++ b/documentation/content/en/articles/committers-guide/_index.adoc @@ -288,6 +288,7 @@ They assume a basic understanding of git. There are many primers for git on the web, but the https://git-scm.com/book/en/v2[Git Book] provides one of the better treatments. ==== Keeping Current With The FreeBSD src Tree +[[keeping_current]] First step: cloning a tree. This downloads the entire tree. There are two ways to download. @@ -496,6 +497,7 @@ When you have anything non trivial, you'll likely be better off keeping a local Stashing is also integrated with the 'git pull' command: just add '--autostash' to the command line. ===== Keeping a local branch +[[keeping_a_local_branch]] It is much easier to keep a local branch with git than subversion. In subversion you need to merge the commit, and resolve the conflicts. This is manageable, but can lead to a convoluted history that's hard to upstream should that ever be necessary, or hard to replicate if you need to do so. @@ -2021,11 +2023,12 @@ git log refs/freebsd/vendor/zlib/1.2.10 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. +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 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 as shown above. +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.>> [source,shell] ```` @@ -2034,10 +2037,10 @@ freebsd https://git.freebsd.org/src.git (fetch) freebsd ssh://git@gitrepo.freebsd.org/src.git (push) ```` -The first step is to create a fork of https://github.com/freebsd/freebsd-src[FreeBSD] on GitHub. +The first step is to create a fork of https://github.com/freebsd/freebsd-src[FreeBSD] on GitHub following these https://docs.github.com/en/github/getting-started-with-github/fork-a-repo[guidelines]. The destination of the fork should be your own, personal, GitHub account (gvnn3 in my case). -Now add a remote that points to your fork: +Now add a remote on your local system that points to your fork: .... % git remote add github git@github.com:gvnn3/freebsd-src.git % git remote -v @@ -2046,17 +2049,14 @@ github git@github.com:gvnn3/freebsd-src.git (push) freebsd https://git.freebsd.org/src.git (fetch) freebsd ssh://git@gitrepo.freebsd.org/src.git (push) .... -With this in place you can create a local branch as shown above. +With this in place you can create a <<keeping_a_local_branch,as shown above.>> .... % git checkout -b gnn-github .... -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. Before you can push you'll have to -set the appropriate upstream, as git will tell you the first time you -try to push to your +github+ remote: +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. +Before you can push you'll have to set the appropriate upstream, as git will tell you the first time you try to push to your +github+ remote: .... % git push github
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?202104092017.139KHwxq031669>