From: Josh Rickmar Subject: Cleanup hardcoded got naming in got.1 To: gameoftrees@openbsd.org Date: Sat, 8 Jul 2023 07:30:47 -0400 To make cvg diffs less ugly... diff /home/jrick/src/got commit - 23e46bde0119105c3b49111db9f530a27c115a49 path + /home/jrick/src/got blob - ea3b833f1bc15d5ea3e276e75da0a16f1e29702c file + got/got.1 --- got/got.1 +++ got/got.1 @@ -82,7 +82,7 @@ The Show the path of each imported file to indicate progress. .Pp The -.Cm got import +.Nm Cm import command requires the .Ev GOT_AUTHOR environment variable to be set, @@ -99,7 +99,7 @@ The options for configuration file. .Pp The options for -.Cm got import +.Cm Nm import are as follows: .Bl -tag -width Ds .It Fl b Ar branch @@ -125,7 +125,7 @@ option, Without the .Fl m option, -.Cm got import +.Cm Nm import opens a temporary file in an editor where a log message can be written. .It Fl r Ar repository-path Use the repository at the specified path. @@ -150,7 +150,7 @@ cloned repository. .Ar directory is specified, the directory name will be derived from the name of the cloned repository. -.Cm got clone +.Cm Nm clone will refuse to run if the .Ar directory already exists. @@ -192,7 +192,7 @@ More details about the pack file format are documented More details about the pack file format are documented in .Xr git-repository 5 . .Pp -.Cm got clone +.Cm Nm clone creates a remote repository entry in the .Xr got.conf 5 and @@ -204,12 +204,12 @@ arguments for future use by or .Ar reference arguments for future use by -.Cm got fetch +.Cm Nm fetch or .Xr git-fetch 1 . .Pp The options for -.Cm got clone +.Cm Nm clone are as follows: .Bl -tag -width Ds .It Fl a @@ -220,7 +220,7 @@ file for future use by in the cloned repository's .Xr got.conf 5 file for future use by -.Cm got fetch . +.Cm Nm fetch . If this option is not specified, a branch resolved via the remote repository's HEAD reference will be fetched. Cannot be used together with the @@ -261,7 +261,7 @@ option enabled, such that files will be set up with the .Dq mirror option enabled, such that -.Cm got fetch +.Cm Nm fetch or .Xr git-fetch 1 will write incoming changes directly to branches in the @@ -270,11 +270,11 @@ This avoids the usual requirement of having to run .Dq refs/remotes/ namespace. This avoids the usual requirement of having to run -.Cm got rebase +.Cm Nm rebase or -.Cm got merge +.Cm Nm merge after -.Cm got fetch +.Cm Nm fetch in order to make incoming changes appear on branches in the .Dq refs/heads/ namespace. @@ -307,7 +307,7 @@ namespace. .Dq refs/ namespace. .Pp -.Cm got clone +.Cm Nm clone will refuse to fetch references from the remote repository's .Dq refs/remotes/ or @@ -316,7 +316,7 @@ Causes .It Fl v Verbose mode. Causes -.Cm got clone +.Cm Nm clone to print debugging messages to standard error output. This option will be passed to .Xr ssh 1 @@ -345,7 +345,7 @@ file of the local repository, as created by or Git's .Pa config file of the local repository, as created by -.Cm got clone . +.Cm Nm clone . .Pp By default, any branches configured in .Xr got.conf 5 @@ -353,7 +353,7 @@ If .Ar remote-repository will be fetched. If -.Cm got fetch +.Cm Nm fetch is invoked in a work tree then this work tree's current branch will be fetched, too, provided it is present on the server. If no branches to fetch can be found in @@ -378,16 +378,16 @@ The .Dq refs/remotes/ reference namespace will be updated to point at the newly fetched commits. The -.Cm got rebase +.Cm Nm rebase or -.Cm got merge +.Cm Nm merge command can then be used to make new changes visible on branches in the .Dq refs/heads/ namespace, merging incoming changes with the changes on those branches as necessary. .Pp If the repository was created as a mirror with -.Cm got clone -m , +.Cm Nm clone -m , then all branches in the .Dq refs/heads/ namespace will be updated directly to match the corresponding branches in @@ -395,7 +395,7 @@ by Git's garbage collector or If those branches contained local commits, these commits will no longer be reachable via a reference and will therefore be at risk of being discarded by Git's garbage collector or -.Cm gotadmin cleanup . +.Cm Nmadmin cleanup . Maintaining custom changes in a mirror repository is therefore discouraged. .Pp In any case, references in the @@ -404,7 +404,7 @@ The options for in the same namespace. .Pp The options for -.Cm got fetch +.Cm Nm fetch are as follows: .Bl -tag -width Ds .It Fl a @@ -434,7 +434,7 @@ Git's garbage collector or Any commit, tree, tag, and blob objects belonging to deleted branches or tags remain in the repository and may be removed separately with Git's garbage collector or -.Cm gotadmin cleanup . +.Cm Nmadmin cleanup . .It Fl l List branches and tags available for fetching from the remote repository and exit immediately. @@ -464,16 +464,16 @@ namespace, unless the local repository was created as Each reference will be mapped into the local repository's .Dq refs/remotes/ namespace, unless the local repository was created as a mirror with -.Cm got clone -m +.Cm Nm clone -m in which case references will be mapped directly into the local repository's .Dq refs/ namespace. .Pp Once a reference has been fetched, a branch based on it can be created with -.Cm got branch +.Cm Nm branch if needed. .Pp -.Cm got fetch +.Cm Nm fetch will refuse to fetch references from the remote repository's .Dq refs/remotes/ or @@ -494,7 +494,7 @@ Causes .It Fl v Verbose mode. Causes -.Cm got fetch +.Cm Nm fetch to print debugging messages to standard error output. The same option will be passed to .Xr ssh 1 @@ -553,7 +553,7 @@ The options for .Ar path prefix . .Pp The options for -.Cm got checkout +.Cm Nm checkout are as follows: .Bl -tag -width Ds .It Fl b Ar branch @@ -580,9 +580,9 @@ commit with option. If no such branch is known, a new branch must be created for this commit with -.Cm got branch +.Cm Nm branch before -.Cm got checkout +.Cm Nm checkout can be used. Checking out work trees with an unknown branch is intentionally not supported. .It Fl E @@ -617,13 +617,13 @@ Such files will be updated when Files which already contain merge conflicts will not be updated to avoid further complications. Such files will be updated when -.Cm got update +.Cm Nm update is run again after merge conflicts have been resolved. If the conflicting changes are no longer needed, affected files can be reverted with -.Cm got revert +.Cm Nm revert before running -.Cm got update +.Cm Nm update again. .Pp Show the status of each affected file, using the following status codes: @@ -653,7 +653,7 @@ The base commit of such a work tree can be made consis commands may refuse to run while the work tree contains files from multiple base commits. The base commit of such a work tree can be made consistent by running -.Cm got update +.Cm Nm update across the entire work tree. Specifying a .Ar path @@ -661,17 +661,17 @@ option. .Fl b option. .Pp -.Cm got update +.Cm Nm update cannot update paths with staged changes. If changes have been staged with -.Cm got stage , +.Cm Nm stage , these changes must first be committed with -.Cm got commit +.Cm Nm commit or unstaged with -.Cm got unstage . +.Cm Nm unstage . .Pp The options for -.Cm got update +.Cm Nm update are as follows: .Bl -tag -width Ds .It Fl b Ar branch @@ -688,9 +688,9 @@ Such changes could first be committed to a different b work tree with pristine file contents corresponding exactly to the specified .Ar branch . Such changes could first be committed to a different branch with -.Cm got commit , +.Cm Nm commit , or could be discarded with -.Cm got revert . +.Cm Nm revert . .It Fl c Ar commit Update the work tree to the specified .Ar commit . @@ -735,7 +735,7 @@ If changes have been staged with Otherwise, show modifications at or within the specified paths. .Pp If changes have been staged with -.Cm got stage , +.Cm Nm stage , staged changes are shown in the second output column, using the following status codes: .Bl -column YXZ description @@ -751,7 +751,7 @@ The options for .El .Pp The options for -.Cm got status +.Cm Nm status are as follows: .Bl -tag -width Ds .It Fl I @@ -784,7 +784,7 @@ and .Xr cvs 1 and .Xr git 1 , -.Cm got status +.Cm Nm status reads .Xr glob 7 patterns from @@ -799,17 +799,17 @@ matching rules, As an extension to .Xr glob 7 matching rules, -.Cm got status +.Cm Nm status supports consecutive asterisks, .Dq ** , which will match an arbitrary amount of directories. Unlike .Xr cvs 1 , -.Cm got status +.Cm Nm status only supports a single ignore pattern per line. Unlike .Xr git 1 , -.Cm got status +.Cm Nm status does not support negated ignore patterns prefixed with .Dq \&! , and gives no special significance to the location of path component separators, @@ -837,14 +837,14 @@ The options for Otherwise, the path is interpreted relative to the repository root. .Pp The options for -.Cm got log +.Cm Nm log are as follows: .Bl -tag -width Ds .It Fl b Display individual commits which were merged into the current branch from other branches. By default, -.Cm got log +.Cm Nm log shows the linear history of the current branch only. .It Fl C Ar number Set the number of context lines shown in diffs with @@ -957,11 +957,11 @@ and if .Fl P option is used, and if -.Cm got diff +.Cm Nm diff is running in a work tree, attempt to interpret the two arguments as paths. .Pp The options for -.Cm got diff +.Cm Nm diff are as follows: .Bl -tag -width Ds .It Fl a @@ -1001,7 +1001,7 @@ This option is only valid when This option can be used to resolve ambiguity in cases where paths look like tag names, reference names, or object IDs. This option is only valid when -.Cm got diff +.Cm Nm diff is invoked in a work tree. .It Fl r Ar repository-path Use the repository at the specified path. @@ -1012,10 +1012,10 @@ Show changes staged with work tree, use the repository path associated with this work tree. .It Fl s Show changes staged with -.Cm got stage +.Cm Nm stage instead of showing local changes in the work tree. This option is only valid when -.Cm got diff +.Cm Nm diff is invoked in a work tree. .It Fl w Ignore whitespace-only changes. @@ -1031,7 +1031,7 @@ The options for Display line-by-line history of a file at the specified path. .Pp The options for -.Cm got blame +.Cm Nm blame are as follows: .Bl -tag -width Ds .It Fl c Ar commit @@ -1078,7 +1078,7 @@ The options for if there is no work tree. .Pp The options for -.Cm got tree +.Cm Nm tree are as follows: .Bl -tag -width Ds .It Fl c Ar commit @@ -1117,7 +1117,7 @@ The options for .Dq refs/ . .Pp The options for -.Cm got ref +.Cm Nm ref are as follows: .Bl -tag -width Ds .It Fl c Ar object @@ -1139,7 +1139,7 @@ Git's garbage collector or Any commit, tree, tag, and blob objects belonging to deleted references remain in the repository and may be removed separately with Git's garbage collector or -.Cm gotadmin cleanup . +.Cm Nmadmin cleanup . Cannot be used together with any other options except .Fl r . .It Fl l @@ -1197,7 +1197,7 @@ The .Dq refs/heads/ reference namespace. The -.Cm got branch +.Cm Nm branch command creates references in this namespace only. .Pp When deleting branches, the specified @@ -1222,7 +1222,7 @@ update files across the entire work tree, just like If invoked in a work tree, once the branch was created successfully switch the work tree's head reference to the newly created branch and update files across the entire work tree, just like -.Cm got update -b Ar name +.Cm Nm update -b Ar name would do. Show the status of each affected file, using the following status codes: .Bl -column YXZ description @@ -1236,7 +1236,7 @@ The options for .El .Pp The options for -.Cm got branch +.Cm Nm branch are as follows: .Bl -tag -width Ds .It Fl c Ar commit @@ -1259,7 +1259,7 @@ Git's garbage collector or Any commit, tree, and blob objects belonging to the branch remain in the repository and may be removed separately with Git's garbage collector or -.Cm gotadmin cleanup . +.Cm Nmadmin cleanup . .It Fl l List all existing branches in the repository, including copies of remote repositories' branches in the @@ -1308,7 +1308,7 @@ The .Dq refs/tags/ reference namespace. The -.Cm got tag +.Cm Nm tag command operates on references in this namespace only. References in this namespace point at tag objects which contain a pointer to another object, a tag message, as well as author and timestamp information. @@ -1322,7 +1322,7 @@ The options for the repository's HEAD reference otherwise. .Pp The options for -.Cm got tag +.Cm Nm tag are as follows: .Bl -tag -width Ds .It Fl c Ar commit @@ -1345,7 +1345,7 @@ option, Without the .Fl m option, -.Cm got tag +.Cm Nm tag opens a temporary file in an editor where a tag message can be written. .It Fl r Ar repository-path Use the repository at the specified path. @@ -1363,7 +1363,7 @@ or a public SSH key with the private half available vi is the path to a file which may refer to either a private SSH key, or a public SSH key with the private half available via .Xr ssh-agent 1 . -.Cm got tag +.Cm Nm tag will sign the tag object by invoking .Xr ssh-keygen 1 with the @@ -1379,7 +1379,7 @@ Otherwise, list all tag objects and verify signatures is specified, show and verify the tag object with the provided name. Otherwise, list all tag objects and verify signatures where present. .Pp -.Cm got tag +.Cm Nm tag verifies SSH-based signatures by invoking .Xr ssh-keygen 1 with the options @@ -1398,10 +1398,10 @@ By design, the .El .Pp By design, the -.Cm got tag +.Cm Nm tag command will not delete tags or change existing tags. If a tag must be deleted, the -.Cm got ref +.Cm Nm ref command may be used to delete a tag's reference. This should only be done if the tag has not already been copied to another repository. @@ -1413,21 +1413,21 @@ By default, files which match a Schedule unversioned files in a work tree for addition to the repository in the next commit. By default, files which match a -.Cm got status +.Cm Nm status ignore pattern will not be added. .Pp If a .Ar path mentioned in the command line is not an unversioned file then -.Cm got add +.Cm Nm add may raise an error. To avoid unnecessary errors from paths picked up by file globbing patterns in the shell, paths in the argument list will be silently ignored if they are not reported by -.Cm got status +.Cm Nm status at all, or if they are reported with one of the following status codes and do not have changes staged via -.Cm got stage : +.Cm Nm stage : .Bl -column YXZ description .It M Ta modified file .It A Ta file scheduled for addition in next commit @@ -1436,17 +1436,17 @@ The options for .El .Pp The options for -.Cm got add +.Cm Nm add are as follows: .Bl -tag -width Ds .It Fl I Add files even if they match a -.Cm got status +.Cm Nm status ignore pattern. .It Fl R Permit recursion into directories. If this option is not specified, -.Cm got add +.Cm Nm add will refuse to run if a specified .Ar path is a directory. @@ -1463,7 +1463,7 @@ The options for from the repository in the next commit. .Pp The options for -.Cm got remove +.Cm Nm remove are as follows: .Bl -tag -width Ds .It Fl f @@ -1476,7 +1476,7 @@ If this option is not specified, .It Fl R Permit recursion into directories. If this option is not specified, -.Cm got remove +.Cm Nm remove will refuse to run if a specified .Ar path is a directory. @@ -1509,7 +1509,7 @@ The patch must be in the unified diff format as produc the work tree. .Pp The patch must be in the unified diff format as produced by -.Cm got diff , +.Cm Nm diff , .Xr git-diff 1 , or by .Xr diff 1 @@ -1555,13 +1555,13 @@ Such changes can be viewed with operation will be aborted. Any changes made to the work tree up to this point will be left behind. Such changes can be viewed with -.Cm got diff +.Cm Nm diff and can be reverted with -.Cm got revert +.Cm Nm revert if needed. .Pp The options for -.Cm got patch +.Cm Nm patch are as follows: .Bl -tag -width Ds .It Fl c Ar commit @@ -1582,11 +1582,11 @@ option is not used then If the .Fl c option is not used then -.Cm got patch +.Cm Nm patch will attempt to locate merge-bases via object IDs found in .Ar patchfile meta-data, such as produced by -.Cm got diff +.Cm Nm diff or .Xr git-diff 1 . Use of the @@ -1632,17 +1632,17 @@ There is no way to bring discarded changes back after File contents will be overwritten with those contained in the work tree's base commit. There is no way to bring discarded changes back after -.Cm got revert ! +.Cm Nm revert ! .Pp If a file was added with -.Cm got add , +.Cm Nm add , it will become an unversioned file again. If a file was deleted with -.Cm got remove , +.Cm Nm remove , it will be restored. .Pp The options for -.Cm got revert +.Cm Nm revert are as follows: .Bl -tag -width Ds .It Fl F Ar response-script @@ -1671,7 +1671,7 @@ If this option is not specified, .It Fl R Permit recursion into directories. If this option is not specified, -.Cm got revert +.Cm Nm revert will refuse to run if a specified .Ar path is a directory. @@ -1694,11 +1694,11 @@ If changes have been explicitly staged for commit with Otherwise, commit changes at or within the specified paths. .Pp If changes have been explicitly staged for commit with -.Cm got stage , +.Cm Nm stage , only commit staged changes and reject any specified paths which have not been staged. .Pp -.Cm got commit +.Cm Nm commit opens a temporary file in an editor where a log message can be written unless the .Fl m @@ -1724,11 +1724,11 @@ The base commit of such a work tree can be made consis commands may refuse to run while the work tree contains files from multiple base commits. The base commit of such a work tree can be made consistent by running -.Cm got update +.Cm Nm update across the entire work tree. .Pp The -.Cm got commit +.Cm Nm commit command requires the .Ev GOT_AUTHOR environment variable to be set, @@ -1746,7 +1746,7 @@ The options for configuration file. .Pp The options for -.Cm got commit +.Cm Nm commit are as follows: .Bl -tag -width Ds .It Fl A Ar author @@ -1779,7 +1779,7 @@ when creating the new commit. Use the prepared log message stored in the file found at .Ar path when creating the new commit. -.Cm got commit +.Cm Nm commit opens a temporary file in an editor where the prepared log message can be reviewed and edited further if needed. Cannot be used together with the @@ -1792,21 +1792,21 @@ This option prevents option. .It Fl N This option prevents -.Cm got commit +.Cm Nm commit from opening the commit message in an editor. It has no effect unless it is used together with the .Fl F option and is intended for non-interactive use such as scripting. .It Fl n This option prevents -.Cm got commit +.Cm Nm commit from generating a diff of the to-be-committed changes in a temporary file which can be viewed while editing a commit message. .It Fl S Allow the addition of symbolic links which point outside of the path space that is under version control. By default, -.Cm got commit +.Cm Nm commit will reject such symbolic links due to safety concerns. As a precaution, .Nm @@ -1819,7 +1819,7 @@ version control. version control. .El .Pp -.Cm got commit +.Cm Nm commit will refuse to run if certain preconditions are not met. If the work tree's current branch is not in the .Dq refs/heads/ @@ -1827,7 +1827,7 @@ If a path is found to be out of date, Local changes may only be committed if they are based on file content found in the most recent commit on the work tree's branch. If a path is found to be out of date, -.Cm got update +.Cm Nm update must be used first in order to merge local changes with changes made in the repository. .Tg se @@ -1852,7 +1852,7 @@ file of the local repository, as created by or Git's .Pa config file of the local repository, as created by -.Cm got clone . +.Cm Nm clone . .Pp All objects corresponding to new changes will be written to a temporary pack file which is then uploaded to the server. @@ -1866,18 +1866,18 @@ be fetched from the server with If any changes to be sent are based on out-of-date copies or would otherwise break linear history of existing branches, new changes must be fetched from the server with -.Cm got fetch +.Cm Nm fetch and local branches must be rebased with -.Cm got rebase +.Cm Nm rebase before -.Cm got send +.Cm Nm send can succeed. The .Fl f option can be used to make exceptions to these requirements. .Pp The options for -.Cm got send +.Cm Nm send are as follows: .Bl -tag -width Ds .It Fl a @@ -1925,11 +1925,11 @@ in the remote repository, even when .It Fl f Attempt to force the server to overwrite existing branches or tags in the remote repository, even when -.Cm got fetch +.Cm Nm fetch followed by -.Cm got rebase +.Cm Nm rebase or -.Cm got merge +.Cm Nm merge would usually be required before changes can be sent. The server may reject forced requests regardless, depending on its configuration. @@ -1956,11 +1956,11 @@ be fetched with .Fl f option, new changes should be fetched with -.Cm got fetch +.Cm Nm fetch and local branches should be rebased with -.Cm got rebase +.Cm Nm rebase or merged with -.Cm got merge , +.Cm Nm merge , followed by another attempt to send the changes. .Pp The @@ -2021,7 +2021,7 @@ Causes .It Fl v Verbose mode. Causes -.Cm got send +.Cm Nm send to print debugging messages to standard error output. The same option will be passed to .Xr ssh 1 @@ -2060,12 +2060,12 @@ may be viewed with .Pp The merged changes will appear as local changes in the work tree, which may be viewed with -.Cm got diff , +.Cm Nm diff , amended manually or with further -.Cm got cherrypick +.Cm Nm cherrypick commands, committed with -.Cm got commit . +.Cm Nm commit . .Pp If invoked in a work tree where no .Cm rebase , @@ -2073,30 +2073,30 @@ operation is taking place, or .Cm merge operation is taking place, -.Cm got cherrypick +.Cm Nm cherrypick creates a record of commits which have been merged into the work tree. When a file changed by -.Cm got cherrypick +.Cm Nm cherrypick is committed with -.Cm got commit , +.Cm Nm commit , the log messages of relevant merged commits will then appear in the editor, where the messages should be further adjusted to convey the reasons for cherrypicking the changes. Upon exiting the editor, if the time stamp of the log message file is unchanged or the log message is empty, -.Cm got commit +.Cm Nm commit will fail with an unmodified or empty log message error. .Pp If all the changes in all files touched by a given commit are discarded, e.g. with -.Cm got revert , +.Cm Nm revert , this commit's log message record will also disappear. .Pp -.Cm got cherrypick +.Cm Nm cherrypick will refuse to run if certain preconditions are not met. If the work tree contains multiple base commits, it must first be updated to a single base commit with -.Cm got update . +.Cm Nm update . If any relevant files already contain merge conflicts, these conflicts must be resolved first. .Pp @@ -2168,12 +2168,12 @@ which may be viewed with .Pp The reverse-merged changes will appear as local changes in the work tree, which may be viewed with -.Cm got diff , +.Cm Nm diff , amended manually or with further -.Cm got backout +.Cm Nm backout commands, committed with -.Cm got commit . +.Cm Nm commit . .Pp If invoked in a work tree where no .Cm rebase , @@ -2181,30 +2181,30 @@ operation is taking place, or .Cm merge operation is taking place, -.Cm got backout +.Cm Nm backout creates a record of commits which have been reverse-merged into the work tree. When a file changed by -.Cm got backout +.Cm Nm backout is committed with -.Cm got commit , +.Cm Nm commit , the log messages of relevant reverse-merged commits will then appear in the editor, where the messages should be further adjusted to convey the reasons for backing out the changes. Upon exiting the editor, if the time stamp of the log message file is unchanged or the log message is empty, -.Cm got commit +.Cm Nm commit will fail with an unmodified or empty log message error. .Pp If all the changes in all files touched by a given commit are discarded, e.g. with -.Cm got revert , +.Cm Nm revert , this commit's log message record will also disappear. .Pp -.Cm got backout +.Cm Nm backout will refuse to run if certain preconditions are not met. If the work tree contains multiple base commits, it must first be updated to a single base commit with -.Cm got update . +.Cm Nm update . If any relevant files already contain merge conflicts, these conflicts must be resolved first. .Pp @@ -2267,13 +2267,13 @@ When has been rebased. .Pp When -.Cm got rebase +.Cm Nm rebase is used as intended, the specified .Ar branch represents a local commit history and may already contain changes that are not yet visible in any other repositories. The work tree's current branch, which must be set with -.Cm got update -b +.Cm Nm update -b before starting the .Cm rebase operation, represents a branch from a remote repository which shares @@ -2310,11 +2310,11 @@ commits will remain in the repository and can be viewe reference namespace. As long as these references are not removed older versions of rebased commits will remain in the repository and can be viewed with the -.Cm got rebase -l +.Cm Nm rebase -l command. Removal of these references makes objects which become unreachable via any reference subject to removal by Git's garbage collector or -.Cm gotadmin cleanup . +.Cm Nmadmin cleanup . .Pp While rebasing commits, show the status of each affected file, using the following status codes: @@ -2345,7 +2345,7 @@ when the rebase operation continues. change into a no-op change, the corresponding commit will be elided when the rebase operation continues. .Pp -.Cm got rebase +.Cm Nm rebase will refuse to run if certain preconditions are not met. If the .Ar branch @@ -2354,30 +2354,30 @@ branch, then the work tree must first be updated with reference namespace, the branch may not be rebased. If the work tree is not yet fully updated to the tip commit of its branch, then the work tree must first be updated with -.Cm got update . +.Cm Nm update . If changes have been staged with -.Cm got stage , +.Cm Nm stage , these changes must first be committed with -.Cm got commit +.Cm Nm commit or unstaged with -.Cm got unstage . +.Cm Nm unstage . If the work tree contains local changes, these changes must first be committed with -.Cm got commit +.Cm Nm commit or reverted with -.Cm got revert . +.Cm Nm revert . If the .Ar branch contains changes to files outside of the work tree's path prefix, the work tree cannot be used to rebase this branch. .Pp The -.Cm got update , -.Cm got integrate , -.Cm got merge , -.Cm got commit , +.Cm Nm update , +.Cm Nm integrate , +.Cm Nm merge , +.Cm Nm commit , and -.Cm got histedit +.Cm Nm histedit commands will refuse to run while a rebase operation is in progress. Other commands which manipulate the work tree may be used for conflict resolution purposes. @@ -2386,13 +2386,13 @@ need to be rebased and .Ar branch is already based on the work tree's current branch, then no commits need to be rebased and -.Cm got rebase +.Cm Nm rebase will simply switch the work tree to the specified .Ar branch and update files in the work tree accordingly. .Pp The options for -.Cm got rebase +.Cm Nm rebase are as follows: .Bl -tag -width Ds .It Fl a @@ -2417,14 +2417,14 @@ the the object ID of their common ancestor commit. Given these object IDs, the -.Cm got log +.Cm Nm log command with the .Fl c and .Fl x options can be used to examine the history of either version of the branch, and the -.Cm got branch +.Cm Nm branch command with the .Fl c option can be used to create a new branch from a pre-rebase state if desired. @@ -2436,7 +2436,7 @@ If this option is used, Otherwise, list all backed up commits for any branches. .Pp If this option is used, -.Cm got rebase +.Cm Nm rebase does not require a work tree. None of the other options can be used together with .Fl l . @@ -2456,10 +2456,10 @@ Git's garbage collector or Any commit, tree, tag, and blob objects belonging to deleted backups remain in the repository and may be removed separately with Git's garbage collector or -.Cm gotadmin cleanup . +.Cm Nmadmin cleanup . .Pp If this option is used, -.Cm got rebase +.Cm Nm rebase does not require a work tree. None of the other options can be used together with .Fl X . @@ -2476,7 +2476,7 @@ The the tip commit of the work tree's current branch. .Pp The -.Cm got histedit +.Cm Nm histedit command requires the .Ev GOT_AUTHOR environment variable to be set, @@ -2495,7 +2495,7 @@ operation, the work tree's current branch must be set Before starting a .Cm histedit operation, the work tree's current branch must be set with -.Cm got update -b +.Cm Nm update -b to the branch which should be edited, unless this branch is already the current branch of the work tree. The tip of this branch represents the upper bound (inclusive) of commits @@ -2505,7 +2505,7 @@ must be set with .Pp Furthermore, the work tree's base commit must be set with -.Cm got update -c +.Cm Nm update -c to a point in this branch's commit history where editing should begin. This commit represents the lower bound (non-inclusive) of commits touched by the @@ -2540,22 +2540,22 @@ The While the histedit operation is interrupted arbitrary files may be edited, and commands which manipulate the work tree can be used freely. The -.Cm got add +.Cm Nm add and -.Cm got remove +.Cm Nm remove commands can be used to add new files or remove existing ones. The -.Cm got revert -p +.Cm Nm revert -p command can be used to eliminate arbitrary changes from files in the work tree. The -.Cm got stage -p +.Cm Nm stage -p command may be used to prepare a subset of changes for inclusion in the next commit. Finally, the -.Cm got commit +.Cm Nm commit command can be used to insert arbitrary commits into the edited history. Regular editing of history must eventually be resumed by running -.Cm got histedit -c . +.Cm Nm histedit -c . .It Cm fold Ar commit Ta Combine the specified commit with the next commit listed further below that will be used. .It Cm drop Ar commit Ta Remove this commit from the edited history. @@ -2588,11 +2588,11 @@ commits will remain in the repository and can be viewe reference namespace. As long as these references are not removed older versions of edited commits will remain in the repository and can be viewed with the -.Cm got histedit -l +.Cm Nm histedit -l command. Removal of these references makes objects which become unreachable via any reference subject to removal by Git's garbage collector or -.Cm gotadmin cleanup . +.Cm Nmadmin cleanup . .Pp While merging commits, show the status of each affected file, using the following status codes: @@ -2622,42 +2622,42 @@ when the histedit operation continues. change into a no-op change, the corresponding commit will be elided when the histedit operation continues. .Pp -.Cm got histedit +.Cm Nm histedit will refuse to run if certain preconditions are not met. If the work tree's current branch is not in the .Dq refs/heads/ reference namespace, the history of the branch may not be edited. If the work tree contains multiple base commits, it must first be updated to a single base commit with -.Cm got update . +.Cm Nm update . If changes have been staged with -.Cm got stage , +.Cm Nm stage , these changes must first be committed with -.Cm got commit +.Cm Nm commit or unstaged with -.Cm got unstage . +.Cm Nm unstage . If the work tree contains local changes, these changes must first be committed with -.Cm got commit +.Cm Nm commit or reverted with -.Cm got revert . +.Cm Nm revert . If the edited history contains changes to files outside of the work tree's path prefix, the work tree cannot be used to edit the history of this branch. .Pp The -.Cm got update , -.Cm got rebase , -.Cm got merge , +.Cm Nm update , +.Cm Nm rebase , +.Cm Nm merge , and -.Cm got integrate +.Cm Nm integrate commands will refuse to run while a histedit operation is in progress. Other commands which manipulate the work tree may be used, and the -.Cm got commit +.Cm Nm commit command may be used to commit arbitrary changes to the temporary branch while the histedit operation is interrupted. .Pp The options for -.Cm got histedit +.Cm Nm histedit are as follows: .Bl -tag -width Ds .It Fl a @@ -2712,14 +2712,14 @@ the the object ID of their common ancestor commit. Given these object IDs, the -.Cm got log +.Cm Nm log command with the .Fl c and .Fl x options can be used to examine the history of either version of the branch, and the -.Cm got branch +.Cm Nm branch command with the .Fl c option can be used to create a new branch from a pre-histedit state if desired. @@ -2731,7 +2731,7 @@ If this option is used, Otherwise, list all backed up commits for any branches. .Pp If this option is used, -.Cm got histedit +.Cm Nm histedit does not require a work tree. None of the other options can be used together with .Fl l . @@ -2759,10 +2759,10 @@ Git's garbage collector or Any commit, tree, tag, and blob objects belonging to deleted backups remain in the repository and may be removed separately with Git's garbage collector or -.Cm gotadmin cleanup . +.Cm Nmadmin cleanup . .Pp If this option is used, -.Cm got histedit +.Cm Nm histedit does not require a work tree. None of the other options can be used together with .Fl X . @@ -2785,7 +2785,7 @@ is no longer needed it may be deleted with In case the integrated .Ar branch is no longer needed it may be deleted with -.Cm got branch -d . +.Cm Nm branch -d . .Pp Show the status of each affected file, using the following status codes: .Bl -column YXZ description @@ -2796,28 +2796,28 @@ Show the status of each affected file, using the follo .It ! Ta a missing versioned file was restored .El .Pp -.Cm got integrate +.Cm Nm integrate will refuse to run if certain preconditions are not met. Most importantly, the .Ar branch must have been rebased onto the work tree's current branch with -.Cm got rebase +.Cm Nm rebase before it can be integrated, in order to linearize commit history and resolve merge conflicts. If the work tree contains multiple base commits, it must first be updated to a single base commit with -.Cm got update . +.Cm Nm update . If changes have been staged with -.Cm got stage , +.Cm Nm stage , these changes must first be committed with -.Cm got commit +.Cm Nm commit or unstaged with -.Cm got unstage . +.Cm Nm unstage . If the work tree contains local changes, these changes must first be committed with -.Cm got commit +.Cm Nm commit or reverted with -.Cm got revert . +.Cm Nm revert . .Tg mg .It Xo .Cm merge @@ -2838,19 +2838,19 @@ If a linear project history is desired, then use of on the branch. .Pp If a linear project history is desired, then use of -.Cm got rebase +.Cm Nm rebase should be preferred over -.Cm got merge . +.Cm Nm merge . However, even strictly linear projects may require merge commits in order to merge in new versions of third-party code stored on vendor branches created with -.Cm got import . +.Cm Nm import . .Pp Merge commits are commits based on multiple parent commits. The tip commit of the work tree's current branch, which must be in the .Dq refs/heads/ reference namespace and must be set with -.Cm got update -b +.Cm Nm update -b before starting the .Cm merge operation, will be used as the first parent. @@ -2892,7 +2892,7 @@ the work tree's current branch unmodified. Alternatively, the merge operation may be aborted which will leave the work tree's current branch unmodified. .Pp -.Cm got merge +.Cm Nm merge will refuse to run if certain preconditions are not met. If the work tree's current branch is not in the .Dq refs/heads/ @@ -2900,43 +2900,43 @@ namespace with branch in the .Dq refs/heads/ namespace with -.Cm got update -b . +.Cm Nm update -b . If the work tree is not yet fully updated to the tip commit of its branch, then the work tree must first be updated with -.Cm got update . +.Cm Nm update . If the work tree contains multiple base commits, it must first be updated to a single base commit with -.Cm got update . +.Cm Nm update . If changes have been staged with -.Cm got stage , +.Cm Nm stage , these changes must first be committed with -.Cm got commit +.Cm Nm commit or unstaged with -.Cm got unstage . +.Cm Nm unstage . If the work tree contains local changes, these changes must first be committed with -.Cm got commit +.Cm Nm commit or reverted with -.Cm got revert . +.Cm Nm revert . If the .Ar branch contains changes to files outside of the work tree's path prefix, the work tree cannot be used to merge this branch. .Pp The -.Cm got update , -.Cm got commit , -.Cm got rebase , -.Cm got histedit , -.Cm got integrate , +.Cm Nm update , +.Cm Nm commit , +.Cm Nm rebase , +.Cm Nm histedit , +.Cm Nm integrate , and -.Cm got stage +.Cm Nm stage commands will refuse to run while a merge operation is in progress. Other commands which manipulate the work tree may be used for conflict resolution purposes. .Pp The options for -.Cm got merge +.Cm Nm merge are as follows: .Bl -tag -width Ds .It Fl a @@ -2958,9 +2958,9 @@ created with commit immediately. The merge result can be adjusted as desired before a merge commit is created with -.Cm got merge -c . +.Cm Nm merge -c . Alternatively, the merge may be aborted with -.Cm got merge -a . +.Cm Nm merge -a . .El .Tg sg .It Xo @@ -2976,7 +2976,7 @@ Paths may be staged if they are added, modified, or de is specified, stage all changes in the work tree. Otherwise, stage changes at or within the specified paths. Paths may be staged if they are added, modified, or deleted according to -.Cm got status . +.Cm Nm status . .Pp Show the status of each affected file, using the following status codes: .Bl -column YXZ description @@ -2990,29 +2990,29 @@ Staged changes affect the behaviour of committed. .Pp Staged changes affect the behaviour of -.Cm got commit , -.Cm got status , +.Cm Nm commit , +.Cm Nm status , and -.Cm got diff . +.Cm Nm diff . While paths with staged changes exist, the -.Cm got commit +.Cm Nm commit command will refuse to commit any paths which do not have staged changes. Local changes created on top of staged changes can only be committed if the path is staged again, or if the staged changes are committed first. The -.Cm got status +.Cm Nm status command will show both local changes and staged changes. The -.Cm got diff +.Cm Nm diff command is able to display local changes relative to staged changes, and to display staged changes relative to the repository. The -.Cm got revert +.Cm Nm revert command cannot revert staged changes but may be used to revert local changes created on top of staged changes. .Pp The options for -.Cm got stage +.Cm Nm stage are as follows: .Bl -tag -width Ds .It Fl F Ar response-script @@ -3049,7 +3049,7 @@ By default, Allow staging of symbolic links which point outside of the path space that is under version control. By default, -.Cm got stage +.Cm Nm stage will reject such symbolic links due to safety concerns. As a precaution, .Nm @@ -3062,27 +3062,27 @@ version control. version control. .El .Pp -.Cm got stage +.Cm Nm stage will refuse to run if certain preconditions are not met. If a file contains merge conflicts, these conflicts must be resolved first. If a file is found to be out of date relative to the head commit on the work tree's current branch, the file must be updated with -.Cm got update +.Cm Nm update before it can be staged (however, this does not prevent the file from becoming out-of-date at some point after having been staged). .Pp The -.Cm got update , -.Cm got rebase , -.Cm got merge , +.Cm Nm update , +.Cm Nm rebase , +.Cm Nm merge , and -.Cm got histedit +.Cm Nm histedit commands will refuse to run while staged changes exist. If staged changes cannot be committed because a staged path is out of date, the path must be unstaged with -.Cm got unstage +.Cm Nm unstage before it can be updated with -.Cm got update , +.Cm Nm update , and may then be staged again if necessary. .Tg ug .It Xo @@ -3110,7 +3110,7 @@ The options for .El .Pp The options for -.Cm got unstage +.Cm Nm unstage are as follows: .Bl -tag -width Ds .It Fl F Ar response-script @@ -3163,7 +3163,7 @@ The options for be resolved to the ID of an object found at this path in the repository. .Pp The options for -.Cm got cat +.Cm Nm cat are as follows: .Bl -tag -width Ds .It Fl c Ar commit @@ -3211,12 +3211,12 @@ Used by the The author's name and email address, such as .Dq An Flan Hacker Aq Mt flan_hacker@openbsd.org . Used by the -.Cm got commit , -.Cm got import , -.Cm got rebase , -.Cm got merge , +.Cm Nm commit , +.Cm Nm import , +.Cm Nm rebase , +.Cm Nm merge , and -.Cm got histedit +.Cm Nm histedit commands. Because .Xr git 1 @@ -3251,16 +3251,16 @@ The default limit on the number of commits traversed b information found in Git configuration files will be ignored. .It Ev GOT_LOG_DEFAULT_LIMIT The default limit on the number of commits traversed by -.Cm got log . +.Cm Nm log . If set to zero, the limit is unbounded. This variable will be silently ignored if it is set to a non-numeric value. .It Ev VISUAL , EDITOR The editor spawned by -.Cm got commit , -.Cm got histedit , -.Cm got import , +.Cm Nm commit , +.Cm Nm histedit , +.Cm Nm import , or -.Cm got tag . +.Cm Nm tag . If not set, the .Xr vi 1 text editor will be spawned. @@ -3292,7 +3292,7 @@ file. file. .El .Sh EXIT STATUS -.Ex -std got +.Ex -std .Sh EXAMPLES Enable tab-completion of .Nm @@ -3487,7 +3487,7 @@ instead of Before working against existing branches in a repository cloned with .Cm git clone --bare instead of -.Cm got clone , +.Cm Nm clone , a Git .Dq refspec must be configured to map all references in the remote repository @@ -3526,24 +3526,24 @@ namespace free for use by local branches checked out w This configuration leaves the local repository's .Dq refs/heads namespace free for use by local branches checked out with -.Cm got checkout +.Cm Nm checkout and, if needed, created with -.Cm got branch . +.Cm Nm branch . Branches in the .Dq refs/remotes/origin namespace can now be updated with incoming changes from the remote repository with -.Cm got fetch +.Cm Nm fetch or .Xr git-fetch 1 without extra command line arguments. Newly fetched changes can be examined with -.Cm got log . +.Cm Nm log . .Pp Display changes on the remote repository's version of the .Dq master branch, as of the last time -.Cm got fetch +.Cm Nm fetch was run: .Pp .Dl $ got log -c origin/master | less @@ -3554,7 +3554,7 @@ The latter is only needed in case of ambiguity. .Dq refs/remotes/origin/master . The latter is only needed in case of ambiguity. .Pp -.Cm got rebase +.Cm Nm rebase can be used to merge changes which are visible on the .Dq origin/master branch into the @@ -3583,7 +3583,7 @@ branch with branch can now be made visible on the .Dq master branch with -.Cm got integrate . +.Cm Nm 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 @@ -3605,9 +3605,9 @@ branch can be sent to the remote repository with If the remote repository offers write access, local changes on the .Dq master branch can be sent to the remote repository with -.Cm got send . +.Cm Nm send . Usually, -.Cm got send +.Cm Nm send can be run without further arguments. The arguments shown here match defaults, provided the work tree's current branch is the @@ -3708,9 +3708,9 @@ As an alternative to .Dl $ got rebase master .Pp As an alternative to -.Cm got rebase , +.Cm Nm rebase , branches can be merged with -.Cm got merge : +.Cm Nm merge : .Pp .Dl $ got update -b master .Dl $ got merge upstream/master @@ -3726,7 +3726,7 @@ must be created for each pull request with .Pp If multiple pull requests need to be managed in parallel, a separate branch must be created for each pull request with -.Cm got branch . +.Cm Nm branch . Each such branch can then be used as above, in place of .Dq refs/heads/master . Changes for any accepted pull requests will still appear under @@ -3810,7 +3810,7 @@ In situations where files or directories were moved ar .Xr git-merge 1 . .It In situations where files or directories were moved around -.Cm got +.Cm Nm will not automatically merge changes to new locations and .Xr git 1 will usually produce better results.