From: Tracey Emery <tracey@traceyemery.net>
Subject: Re: got.1 examples: master -> main branch?
To: Christian Weisgerber <naddy@mips.inka.de>
Cc: gameoftrees@openbsd.org
Date: Mon, 28 Sep 2020 16:52:06 -0600

On Tue, Sep 29, 2020 at 12:34:19AM +0200, Christian Weisgerber wrote:
> Currently the example section in got.1 uses a "master" branch
> throughout.  Should we replace this with "main" for consistency?
> Or keep it for some time while most repositories out there use
> "master"?
> 

It would be super handy to also have Stefan's instructions on switching
master to main, which was not totally intuitive.

> diff 9814e6a376df853a88deb889d68f178c803ad8ca /home/naddy/got
> blob - 2af328db5bc16371a9ab63961a5e8cdffad041e8
> file + got/got.1
> --- got/got.1
> +++ got/got.1
> @@ -2041,10 +2041,10 @@ In a work tree or a git repository directory, list all
>  In a work tree or a git repository directory, create a new branch called
>  .Dq unified-buffer-cache
>  which is forked off the
> -.Dq master
> +.Dq main
>  branch:
>  .Pp
> -.Dl $ got branch unified-buffer-cache master
> +.Dl $ got branch unified-buffer-cache main
>  .Pp
>  Switch an existing work tree to the branch
>  .Dq unified-buffer-cache .
> @@ -2127,7 +2127,7 @@ to be amended and perhaps committed again:
>  .Dl $ got backout unified-buffer-cache
>  .Pp
>  Fetch new upstream commits into the local repository's
> -.Dq origin/master
> +.Dq origin/main
>  branch:
>  .Pp
>  .Dl $ cd /usr/src
> @@ -2140,25 +2140,25 @@ the
>  command must be used instead:
>  .Pp
>  .Dl $ cd /var/git/src.git
> -.Dl $ git fetch origin master:refs/remotes/origin/master
> +.Dl $ git fetch origin main:refs/remotes/origin/main
>  .Pp
>  Rebase the local
> -.Dq master
> +.Dq main
>  branch to merge the new changes that are now visible on the
> -.Dq origin/master
> +.Dq origin/main
>  branch:
>  .Pp
>  .Dl $ cd /usr/src
> -.Dl $ got update -b origin/master
> -.Dl $ got rebase master
> +.Dl $ got update -b origin/main
> +.Dl $ got rebase main
>  .Pp
>  Rebase the
>  .Dq unified-buffer-cache
>  branch on top of the new head commit of the
> -.Dq master
> +.Dq main
>  branch.
>  .Pp
> -.Dl $ got update -b master
> +.Dl $ got update -b main
>  .Dl $ got rebase unified-buffer-cache
>  .Pp
>  Create a patch from all changes on the unified-buffer-cache branch.
> @@ -2166,45 +2166,45 @@ The patch can be mailed out for review and applied to
>  .Ox Ns 's
>  CVS tree:
>  .Pp
> -.Dl $ got diff master unified-buffer-cache > /tmp/ubc.diff
> +.Dl $ got diff main unified-buffer-cache > /tmp/ubc.diff
>  .Pp
>  Edit the entire commit history of the
>  .Dq unified-buffer-cache
>  branch:
>  .Pp
>  .Dl $ got update -b unified-buffer-cache
> -.Dl $ got update -c master
> +.Dl $ got update -c main
>  .Dl $ got histedit
>  .Pp
>  In order to merge changes committed to the
>  .Dq unified-buffer-cache
>  branch back into the
> -.Dq master
> +.Dq main
>  branch, the
>  .Dq unified-buffer-cache
>  branch must first be rebased onto the
> -.Dq master
> +.Dq main
>  branch:
>  .Pp
> -.Dl $ got update -b master
> +.Dl $ got update -b main
>  .Dl $ got rebase unified-buffer-cache
>  .Pp
>  Changes on the
>  .Dq unified-buffer-cache
>  branch can now be made visible on the
> -.Dq master
> +.Dq main
>  branch with
>  .Cm got integrate .
>  Because the rebase operation switched the work tree to the
>  .Dq unified-buffer-cache
>  branch, the work tree must be switched back to the
> -.Dq master
> +.Dq main
>  branch before the
>  .Dq unified-buffer-cache
>  branch can be integrated into
> -.Dq master :
> +.Dq main :
>  .Pp
> -.Dl $ got update -b master
> +.Dl $ got update -b main
>  .Dl $ got integrate unified-buffer-cache
>  .Pp
>  Additional steps may be necessary if local changes need to be pushed back
> @@ -2269,34 +2269,34 @@ without extra command line arguments:
>  .Dl $ git fetch
>  .Pp
>  To make changes fetched from the remote repository appear on the
> -.Dq master
> +.Dq main
>  branch, the
> -.Dq master
> +.Dq main
>  branch must be rebased onto the
> -.Dq origin/master
> +.Dq origin/main
>  branch.
>  This will also merge local changes, if any, with the incoming changes:
>  .Pp
> -.Dl $ got update -b origin/master
> -.Dl $ got rebase master
> +.Dl $ got update -b origin/main
> +.Dl $ got rebase main
>  .Pp
>  On the
> -.Dq master
> +.Dq main
>  branch, log messages for local changes can now be amended with
>  .Dq OK
>  by other developers and any other important new information:
>  .Pp
> -.Dl $ got update -c origin/master
> +.Dl $ got update -c origin/main
>  .Dl $ got histedit -m
>  .Pp
>  Local changes on the
> -.Dq master
> +.Dq main
>  branch can then be pushed to the remote
>  repository with
>  .Cm git push :
>  .Pp
>  .Dl $ cd /var/git/repo
> -.Dl $ git push origin master
> +.Dl $ git push origin main
>  .Sh SEE ALSO
>  .Xr tog 1 ,
>  .Xr git-repository 5 ,
> -- 
> Christian "naddy" Weisgerber                          naddy@mips.inka.de

-- 

Tracey Emery