Date: Fri, 9 Apr 2021 20:17:57 GMT From: "George V. Neville-Neil" <gnn@FreeBSD.org> To: doc-committers@FreeBSD.org, dev-commits-doc-all@FreeBSD.org Subject: git: 6982d9119d - main - Add langauge and other simple updates from uqs Message-ID: <202104092017.139KHvhB031642@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=6982d9119d292a8202d4fdf61cb4709b91d167ec commit 6982d9119d292a8202d4fdf61cb4709b91d167ec Author: George V. Neville-Neil <gnn@FreeBSD.org> AuthorDate: 2021-04-09 20:16:43 +0000 Commit: George V. Neville-Neil <gnn@FreeBSD.org> CommitDate: 2021-04-09 20:17:49 +0000 Add langauge and other simple updates from uqs --- .../en/articles/committers-guide/_index.adoc | 42 +++++++++++----------- 1 file changed, 20 insertions(+), 22 deletions(-) diff --git a/documentation/content/en/articles/committers-guide/_index.adoc b/documentation/content/en/articles/committers-guide/_index.adoc index 6142719316..5d3cd89afa 100644 --- a/documentation/content/en/articles/committers-guide/_index.adoc +++ b/documentation/content/en/articles/committers-guide/_index.adoc @@ -2021,9 +2021,9 @@ 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 generate 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. +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. @@ -2034,43 +2034,42 @@ 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 destination of the fork should be your own, personal, github account (gvnn3 in my case). +The first step is to create a fork of https://github.com/freebsd/freebsd-src[FreeBSD] on GitHub. +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: .... -% git remote add collab git@github.com:gvnn3/freebsd-src.git +% git remote add github git@github.com:gvnn3/freebsd-src.git % git remote -v -collab git@github.com:gvnn3/freebsd-src.git (fetch) -collab git@github.com:gvnn3/freebsd-src.git (push) +github git@github.com:gvnn3/freebsd-src.git (fetch) +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. .... -% git checkout -b gnn-collab +% 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 +collab+ remote: +try to push to your +github+ remote: .... -% git push collab -fatal: The current branch gnn-collab has no upstream branch. +% git push github +fatal: The current branch gnn-github has no upstream branch. To push the current branch and set the remote as upstream, use - git push --set-upstream collab gnn-collab + git push --set-upstream github gnn-github .... -Setting the push as +git+ advises allows it so succeed: +Setting the push as +git+ advises allows it to succeed: .... -% git push --set-upstream collab gnn-collab -X11 forwarding request failed on channel 0 +% git push --set-upstream github gnn-feature Enumerating objects: 20486, done. Counting objects: 100% (20486/20486), done. Delta compression using up to 8 threads @@ -2079,19 +2078,18 @@ Writing objects: 100% (20180/20180), 56.25 MiB | 13.15 MiB/s, done. Total 20180 (delta 11316), reused 12972 (delta 7770), pack-reused 0 remote: Resolving deltas: 100% (11316/11316), completed with 247 local objects. remote: -remote: Create a pull request for 'gnn-collab' on GitHub by visiting: -remote: https://github.com/gvnn3/freebsd-src/pull/new/gnn-collab +remote: Create a pull request for 'gnn-feature' on GitHub by visiting: +remote: https://github.com/gvnn3/freebsd-src/pull/new/gnn-feature remote: To github.com:gvnn3/freebsd-src.git - * [new branch] gnn-collab -> gnn-collab -Branch 'gnn-collab' set up to track remote branch 'gnn-collab' from 'collab'. + * [new branch] gnn-feature -> gnn-feature +Branch 'gnn-feature' set up to track remote branch 'gnn-feature' from 'github'. .... Subsequent changes to the same branch will push correctly by default: .... % git push -X11 forwarding request failed on channel 0 Enumerating objects: 4, done. Counting objects: 100% (4/4), done. Delta compression using up to 8 threads @@ -2100,10 +2098,10 @@ Writing objects: 100% (3/3), 314 bytes | 1024 bytes/s, done. Total 3 (delta 1), reused 1 (delta 0), pack-reused 0 remote: Resolving deltas: 100% (1/1), completed with 1 local object. To github.com:gvnn3/freebsd-src.git - 9e5243d7b659..cf6aeb8d7dda gnn-collab -> gnn-collab + 9e5243d7b659..cf6aeb8d7dda gnn-feature -> gnn-feature .... -At this point your work is now in your branch on +github+ and you can +At this point your work is now in your branch on +GitHub+ and you can share the link with other collaborators.
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?202104092017.139KHvhB031642>