2 .\" Copyright (c) 2017 Martin Pieuchot
3 .\" Copyright (c) 2018, 2019, 2020 Stefan Sperling
5 .\" Permission to use, copy, modify, and distribute this software for any
6 .\" purpose with or without fee is hereby granted, provided that the above
7 .\" copyright notice and this permission notice appear in all copies.
9 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
30 is a version control system which stores the history of tracked files
31 in a Git repository, as used by the Git version control system.
32 This repository format is described in
33 .Xr git-repository 5 .
38 version control system because every copy of a repository is writeable.
39 Modifications made to files can be synchronized between repositories
44 must be checked out from the repository for modification.
45 Checked out files are stored in a
47 which can be placed at an arbitrary directory in the filesystem hierarchy.
48 The on-disk format of this work tree is described in
52 provides global and command-specific options.
53 Global options must precede the command name, and are as follows:
54 .Bl -tag -width tenletters
56 Display usage information and exit immediately.
58 Display program version and exit immediately.
64 .Bl -tag -width checkout
71 .Op Fl r Ar repository-path
75 Create an initial commit in a repository from the file hierarchy
78 The created commit will not have any parent commits, i.e. it will be a
80 Also create a new reference which provides a branch name for the newly
82 Show the path of each imported file to indicate progress.
88 environment variable to be set,
89 unless an author has been configured in
95 configuration settings can be obtained from the repository's
97 file or from Git's global
108 If this option is not specified, a branch corresponding to the repository's
109 HEAD reference will be used.
110 Use of this option is required if the branch resolved via the repository's
111 HEAD reference already exists.
113 Ignore files or directories with a name which matches the specified
115 This option may be specified multiple times to build a list of ignore patterns.
118 follows the globbing rules documented in
120 Ignore patterns which end with a slash,
122 will only match directories.
124 Use the specified log message when creating the new commit.
129 opens a temporary file in an editor where a log message can be written.
130 Quitting the editor without saving the file will abort the import operation.
131 .It Fl r Ar repository-path
132 Use the repository at the specified path.
133 If not specified, assume the repository is located at or above the current
141 .Op Fl R Ar reference
146 Clone a Git repository at the specified
152 is specified, the directory name will be derived from the name of the
155 will refuse to run if the
161 specifies a protocol scheme, a server hostname, an optional port number
162 separated from the hostname by a colon, and a path to the repository on
164 .Lk scheme://hostname:port/path/to/repository
166 The following protocol schemes are supported:
167 .Bl -tag -width git+ssh
169 The Git protocol as implemented by the
172 Use of this protocol is discouraged since it supports neither authentication
175 The Git protocol wrapped in an authenticated and encrypted
178 With this protocol the hostname may contain an embedded username for
183 Short alias for git+ssh.
186 Objects in the cloned repository are stored in a pack file which is downloaded
188 This pack file will then be indexed to facilitate access to the objects stored
190 If any objects in the pack file are stored in deltified form, all deltas will
191 be fully resolved in order to compute the ID of such objects.
192 This can take some time.
193 More details about the pack file format are documented in
194 .Xr git-repository 5 .
197 creates a remote repository entry in the
201 files of the cloned repository to store the
207 arguments for future use by
217 Fetch all branches from the remote repository's
219 reference namespace and set
220 .Cm fetch_all_branches
221 in the cloned repository's
223 file for future use by
225 If this option is not specified, a branch resolved via the remote
226 repository's HEAD reference will be fetched.
227 Cannot be used together with the
233 from the remote repository's
236 This option may be specified multiple times to build a list of branches
238 If the branch corresponding to the remote repository's HEAD reference is not
239 in this list, the cloned repository's HEAD reference will be set to the first
240 branch which was fetched.
241 If this option is not specified, a branch resolved via the remote
242 repository's HEAD reference will be fetched.
243 Cannot be used together with the
247 List branches and tags available for fetching from the remote repository
248 and exit immediately.
249 Cannot be used together with any of the other options except
254 Create the cloned repository as a mirror of the original repository.
255 This is useful if the cloned repository will not be used to store
256 locally created commits.
262 files will be set up with the
264 option enabled, such that
268 will write incoming changes directly to branches in the
270 reference namespace, rather than to branches in the
273 This avoids the usual requirement of having to run
279 in order to make incoming changes appear on branches in the
282 But maintaining custom changes in the cloned repository becomes difficult
283 since such changes will be at risk of being discarded whenever incoming
286 Suppress progress reporting output.
287 The same option will be passed to
290 .It Fl R Ar reference
291 In addition to the branches and tags that will be fetched, fetch an arbitrary
293 from the remote repository's
296 This option may be specified multiple times to build a list of additional
300 may either be a path to a specific reference, or a reference namespace
301 which will cause all references in this namespace to be fetched.
303 Each reference will be mapped into the cloned repository's
305 namespace, unless the
307 option is used to mirror references directly into the cloned repository's
312 will refuse to fetch references from the remote repository's
321 to print debugging messages to standard error output.
322 This option will be passed to
325 Multiple -v options increase the verbosity.
333 .Op Fl R Ar reference
334 .Op Fl r Ar repository-path
335 .Op Ar remote-repository
338 Fetch new changes from a remote repository.
340 .Ar remote-repository
344 The remote repository's URL is obtained from the corresponding entry in
348 file of the local repository, as created by
351 By default, any branches configured in
354 .Ar remote-repository
358 is invoked in a work tree then this work tree's current branch will be
359 fetched, too, provided it is present on the server.
360 If no branches to fetch can be found in
362 or via a work tree, or said branches are not found on the server, a branch
363 resolved via the remote repository's HEAD reference will be fetched.
364 Likewise, if a HEAD reference for the
365 .Ar remote-repository
366 exists but its target no longer matches the remote HEAD, then
367 the new target branch will be fetched.
368 This default behaviour can be overridden with the
374 New changes will be stored in a separate pack file downloaded from the server.
375 Optionally, separate pack files stored in the repository can be combined with
378 By default, branch references in the
380 reference namespace will be updated to point at the newly fetched commits.
385 command can then be used to make new changes visible on branches in the
387 namespace, merging incoming changes with the changes on those branches
390 If the repository was created as a mirror with
392 then all branches in the
394 namespace will be updated directly to match the corresponding branches in
395 the remote repository.
396 If those branches contained local commits, these commits will no longer be
397 reachable via a reference and will therefore be at risk of being discarded
398 by Git's garbage collector or
399 .Cm gotadmin cleanup .
400 Maintaining custom changes in a mirror repository is therefore discouraged.
402 In any case, references in the
404 namespace will always be fetched and mapped directly to local references
405 in the same namespace.
412 Fetch all branches from the remote repository's
415 This option can be enabled by default for specific repositories in
417 Cannot be used together with the
423 from the remote repository's
426 This option may be specified multiple times to build a list of branches
428 Cannot be used together with the
432 Delete branches and tags from the local repository which are no longer
433 present in the remote repository.
434 Only references are deleted.
435 Any commit, tree, tag, and blob objects belonging to deleted branches or
436 tags remain in the repository and may be removed separately with
437 Git's garbage collector or
438 .Cm gotadmin cleanup .
440 List branches and tags available for fetching from the remote repository
441 and exit immediately.
442 Cannot be used together with any of the other options except
448 Suppress progress reporting output.
449 The same option will be passed to
452 .It Fl R Ar reference
453 In addition to the branches and tags that will be fetched, fetch an arbitrary
455 from the remote repository's
458 This option may be specified multiple times to build a list of additional
462 may either be a path to a specific reference, or a reference namespace
463 which will cause all references in this namespace to be fetched.
465 Each reference will be mapped into the local repository's
467 namespace, unless the local repository was created as a mirror with
469 in which case references will be mapped directly into the local repository's
473 Once a reference has been fetched, a branch based on it can be created with
478 will refuse to fetch references from the remote repository's
483 .It Fl r Ar repository-path
484 Use the repository at the specified path.
485 If not specified, assume the repository is located at or above the current
487 If this directory is a
489 work tree, use the repository path associated with this work tree.
491 Allow existing references in the
493 namespace to be updated if they have changed on the server.
494 If not specified, only new tag references will be created.
499 to print debugging messages to standard error output.
500 The same option will be passed to
503 Multiple -v options increase the verbosity.
506 Delete all references which correspond to a particular
507 .Ar remote-repository
508 instead of fetching new changes.
509 This can be useful when a remote repository is being removed from
515 .Ar remote-repository
516 argument is mandatory and no other options except
523 Only references are deleted.
524 Any commit, tree, tag, and blob objects fetched from a remote repository
525 will generally be stored in pack files and may be removed separately with
527 and Git's garbage collector.
535 .Op Fl p Ar path-prefix
537 .Op Ar work-tree-path
540 Copy files from a repository into a new work tree.
541 Show the status of each affected file, using the following status codes:
542 .Bl -column YXZ description
543 .It A Ta new file was added
544 .It E Ta file already exists in work tree's meta-data
549 is not specified, either use the last component of
550 .Ar repository path ,
553 was specified use the last component of
561 Check out files from a commit on the specified
563 If this option is not specified, a branch resolved via the repository's HEAD
564 reference will be used.
566 Check out files from the specified
568 on the selected branch.
569 If this option is not specified, the most recent commit on the selected
574 argument is a commit ID SHA1 hash, or a reference name or a keyword
575 which will be resolved to a commit ID.
576 An abbreviated hash argument will be expanded to a full SHA1 hash
577 automatically, provided the abbreviation is unique.
582 resolve to the repository's HEAD reference, or, if the
584 option is used, the head of the checked-out
586 Keywords and reference names may be appended with
590 modifiers and an optional integer N to denote the
591 Nth descendant or antecedent by first parent traversal, respectively;
594 denotes the work tree branch head's 2nd generation ancestor, and
596 will denote the 3rd generation ancestor of the commit resolved by the
599 If an integer does not follow the
605 is implicitly appended
614 is not contained in the selected branch, a different branch which contains
615 this commit must be specified with the
618 If no such branch is known, a new branch must be created for this
624 Checking out work trees with an unknown branch is intentionally not supported.
626 Proceed with the checkout operation even if the directory at
629 Existing files will be left intact.
630 .It Fl p Ar path-prefix
631 Restrict the work tree to a subset of the repository's tree hierarchy.
632 Only files beneath the specified
636 Silence progress output.
647 Update an existing work tree to a different
649 Change existing files in the work tree as necessary to match file contents
651 Preserve any local changes in the work tree and merge them with the
654 Files which already contain merge conflicts will not be updated to avoid
655 further complications.
656 Such files will be updated when
658 is run again after merge conflicts have been resolved.
659 If the conflicting changes are no longer needed, affected files can be
666 Show the status of each affected file, using the following status codes:
667 .Bl -column YXZ description
668 .It U Ta file was updated and contained no local changes
669 .It G Ta file was updated and local changes were merged cleanly
670 .It C Ta file was updated and conflicts occurred during merge
671 .It D Ta file was deleted
672 .It d Ta file's deletion was prevented by local modifications
673 .It A Ta new file was added
674 .It \(a~ Ta versioned file is obstructed by a non-regular file
675 .It ! Ta a missing versioned file was restored
676 .It # Ta file was not updated because it contains merge conflicts
677 .It ? Ta changes destined for an unversioned file were not merged
682 is specified, update the entire work tree.
683 Otherwise, restrict the update operation to files at or within the
685 Each path is required to exist in the update operation's target commit.
686 Files in the work tree outside specified paths will remain unchanged and
687 will retain their previously recorded base commit.
690 commands may refuse to run while the work tree contains files from
691 multiple base commits.
692 The base commit of such a work tree can be made consistent by running
694 across the entire work tree.
697 is incompatible with the
702 cannot update paths with staged changes.
703 If changes have been staged with
705 these changes must first be committed with
715 Switch the work tree's branch reference to the specified
717 before updating the work tree.
718 This option requires that all paths in the work tree are updated.
720 As usual, any local changes in the work tree will be preserved.
721 This can be useful when switching to a newly created branch in order
722 to commit existing local changes to this branch.
724 Any local changes must be dealt with separately in order to obtain a
725 work tree with pristine file contents corresponding exactly to the specified
727 Such changes could first be committed to a different branch with
729 or could be discarded with
732 Update the work tree to the specified
734 If this option is not specified, the most recent commit on the work tree's
739 argument is a commit ID SHA1 hash, or a reference name or a keyword
740 which will be resolved to a commit ID.
741 An abbreviated hash argument will be expanded to a full SHA1 hash
742 automatically, provided the abbreviation is unique.
747 resolve to the work tree's base commit and branch head, respectively.
748 Keywords and reference names may be appended with
752 modifiers and an optional integer N to denote the
753 Nth descendant or antecedent, respectively, by first parent traversal;
756 denotes the work tree branch head's 2nd generation ancestor, and
758 denotes the 4th generation descendant of the work tree's base commit.
761 will denote the 3rd generation ancestor of the commit resolved by the
764 If an integer does not follow the
770 is implicitly appended
777 Silence progress output.
783 .Op Fl S Ar status-codes
784 .Op Fl s Ar status-codes
788 Show the current modification status of files in a work tree,
789 using the following status codes:
790 .Bl -column YXZ description
791 .It M Ta modified file
792 .It A Ta file scheduled for addition in next commit
793 .It D Ta file scheduled for deletion in next commit
794 .It C Ta modified or added file which contains merge conflicts
795 .It ! Ta versioned file was expected on disk but is missing
796 .It \(a~ Ta versioned file is obstructed by a non-regular file
797 .It ? Ta unversioned item not tracked by
799 .It m Ta modified file modes (executable bit only)
800 .It N Ta non-existent
802 specified on the command line
807 is specified, show modifications in the entire work tree.
808 Otherwise, show modifications at or within the specified paths.
810 If changes have been staged with
812 staged changes are shown in the second output column, using the following
814 .Bl -column YXZ description
815 .It M Ta file modification is staged
816 .It A Ta file addition is staged
817 .It D Ta file deletion is staged
820 Changes created on top of staged changes are indicated in the first column:
821 .Bl -column YXZ description
822 .It MM Ta file was modified after earlier changes have been staged
823 .It MA Ta file was modified after having been staged for addition
831 Show unversioned files even if they match an ignore pattern.
832 .It Fl S Ar status-codes
833 Suppress the output of files with a modification status matching any of the
834 single-character status codes contained in the
837 Any combination of codes from the above list of possible status codes
839 For staged files, status codes displayed in either column will be matched.
840 Cannot be used together with the
843 .It Fl s Ar status-codes
844 Only show files with a modification status matching any of the
845 single-character status codes contained in the
848 Any combination of codes from the above list of possible status codes
850 For staged files, status codes displayed in either column will be matched.
851 Cannot be used together with the
856 For compatibility with
867 files in each traversed directory and will not display unversioned files
868 which match these patterns.
869 Ignore patterns which end with a slash,
871 will only match directories.
876 supports consecutive asterisks,
878 which will match an arbitrary amount of directories.
882 only supports a single ignore pattern per line.
886 does not support negated ignore patterns prefixed with
888 and gives no special significance to the location of path component separators,
897 .Op Fl r Ar repository-path
898 .Op Fl S Ar search-pattern
902 Display history of a repository.
905 is specified, show only commits which modified this path.
906 If invoked in a work tree, the
908 is interpreted relative to the current working directory,
909 and the work tree's path prefix is implicitly prepended.
910 Otherwise, the path is interpreted relative to the repository root.
917 Display individual commits which were merged into the current branch
921 shows the linear history of the current branch only.
923 Set the number of context lines shown in diffs with
925 By default, 3 lines of context are shown.
927 Start traversing history at the specified
929 If this option is not specified, default to the work tree's current branch
930 if invoked in a work tree, or to the repository's HEAD reference.
934 argument is a commit ID SHA1 hash, or a reference name or a keyword
935 which will be resolved to a commit ID.
936 An abbreviated hash argument will be expanded to a full SHA1 hash
937 automatically, provided the abbreviation is unique.
942 resolve to the work tree's base commit and branch head, respectively.
943 The former is only valid if invoked in a work tree, while the latter will
944 resolve to the tip of the work tree's current branch if invoked in a
945 work tree, otherwise it will resolve to the repository's HEAD reference.
946 Keywords and references may be appended with
950 modifiers and an optional integer N to denote the
951 Nth descendant or antecedent, respectively, by first parent traversal;
954 denotes the HEAD reference's 2nd generation ancestor, and
956 denotes the 4th generation descendant of the work tree's base commit.
959 will denote the 3rd generation descendant of the commit resolved by the
966 modifier without a trailing integer has an implicit
975 Display diffstat of changes introduced in each commit.
976 Cannot be used with the
980 Limit history traversal to a given number of commits.
981 If this option is not specified, a default limit value of zero is used,
982 which is treated as an unbounded limit.
984 .Ev GOT_LOG_DEFAULT_LIMIT
985 environment variable may be set to change this default value.
987 Display the list of file paths changed in each commit, using the following
989 .Bl -column YXZ description
990 .It M Ta modified file
991 .It D Ta file was deleted
992 .It A Ta new file was added
993 .It m Ta modified file modes (executable bit only)
996 Cannot be used with the
1000 Display the patch of modifications made in each commit.
1003 is specified, only show the patch of modifications at or within this path.
1004 Cannot be used with the
1008 Determine a set of commits to display as usual, but display these commits
1010 .It Fl r Ar repository-path
1011 Use the repository at the specified path.
1012 If not specified, assume the repository is located at or above the current
1014 If this directory is a
1016 work tree, use the repository path associated with this work tree.
1017 .It Fl S Ar search-pattern
1018 If specified, show only commits with a log message, author name,
1019 committer name, or ID SHA1 hash matched by the extended regular
1021 .Ar search-pattern .
1022 Lines in committed patches will be matched if
1025 File paths changed by a commit will be matched if
1028 Regular expression syntax is documented in
1031 Display a short one-line summary of each commit, instead of the default
1033 Cannot be used together with the
1039 Stop traversing commit history immediately after the specified
1042 This option has no effect if the specified
1052 .Op Fl r Ar repository-path
1053 .Op Ar object1 Ar object2 | Ar path ...
1056 When invoked within a work tree without any arguments, display all
1057 local changes in the work tree.
1060 arguments are specified, only show changes within the specified paths.
1062 If two arguments are provided, treat each argument as a reference, a tag
1063 name, or an object ID SHA1 hash, and display differences between the
1064 corresponding objects.
1065 Both objects must be of the same type (blobs, trees, or commits).
1066 An abbreviated hash argument will be expanded to a full SHA1 hash
1067 automatically, provided the abbreviation is unique.
1068 If none of these interpretations produce a valid result or if the
1073 is running in a work tree, attempt to interpret the two arguments as paths.
1080 Treat file contents as ASCII text even if binary data is detected.
1082 Set the number of context lines shown in the diff.
1083 By default, 3 lines of context are shown.
1085 Show differences between commits in the repository.
1086 This option may be used up to two times.
1087 When used only once, show differences between the specified
1089 and its first parent commit.
1090 When used twice, show differences between the two specified commits.
1094 option is used, all non-option arguments will be interpreted as paths.
1097 arguments are provided, only show differences for the specified paths.
1101 argument is a commit ID SHA1 hash, or a reference name or a keyword
1102 which will be resolved to a commit ID.
1103 An abbreviated hash argument will be expanded to a full SHA1 hash
1104 automatically, provided the abbreviation is unique.
1109 resolve to the work tree's base commit and branch head, respectively.
1110 The former is only valid if invoked in a work tree, while the latter will
1111 resolve to the tip of the work tree's current branch if invoked in a
1112 work tree, otherwise it will resolve to the repository's HEAD reference.
1113 Keywords and references may be appended with
1117 modifiers and an optional integer N to denote the
1118 Nth descendant or antecedent, respectively, by first parent traversal;
1121 denotes the HEAD reference's 2nd generation ancestor, and
1123 denotes the 4th generation descendant of the work tree's base commit.
1126 will denote the 8th generation descendant of the commit resolved by the
1129 If an integer does not follow the
1135 is implicitly appended
1142 Cannot be used together with the
1146 Display diffstat of changes before the actual diff by annotating each file path
1147 or blob hash being diffed with the total number of lines added and removed.
1148 A summary line will display the total number of changes across all files.
1150 Interpret all arguments as paths only.
1151 This option can be used to resolve ambiguity in cases where paths
1152 look like tag names, reference names, or object IDs.
1153 This option is only valid when
1155 is invoked in a work tree.
1156 .It Fl r Ar repository-path
1157 Use the repository at the specified path.
1158 If not specified, assume the repository is located at or above the current
1160 If this directory is a
1162 work tree, use the repository path associated with this work tree.
1164 Show changes staged with
1166 instead of showing local changes in the work tree.
1167 This option is only valid when
1169 is invoked in a work tree.
1171 Ignore whitespace-only changes.
1177 .Op Fl r Ar repository-path
1181 Display line-by-line history of a file at the specified path.
1188 Start traversing history at the specified
1190 The expected argument is a commit ID SHA1 hash, or a reference name
1191 or a keyword which will be resolved to a commit ID.
1192 An abbreviated hash argument will be expanded to a full SHA1 hash
1193 automatically, provided the abbreviation is unique.
1198 resolve to the work tree's base commit and branch head, respectively.
1199 The former is only valid if invoked in a work tree, while the latter will
1200 resolve to the tip of the work tree's current branch if invoked in a
1201 work tree, otherwise it will resolve to the repository's HEAD reference.
1202 Keywords and references may be appended with
1206 modifiers and an optional integer N to denote the
1207 Nth descendant or antecedent by first parent traversal, respectively;
1210 denotes the work tree branch head's 2nd generation ancestor, and
1212 denotes the 4th generation descendant of the work tree's base commit.
1215 will denote the 5th generation ancestor of the commit resolved by the
1222 modifier without a trailing integer has an implicit
1230 .It Fl r Ar repository-path
1231 Use the repository at the specified path.
1232 If not specified, assume the repository is located at or above the current
1234 If this directory is a
1236 work tree, use the repository path associated with this work tree.
1243 .Op Fl r Ar repository-path
1247 Display a listing of files and directories at the specified
1248 directory path in the repository.
1249 Entries shown in this listing may carry one of the following trailing
1251 .Bl -column YXZ description
1252 .It @ Ta entry is a symbolic link
1253 .It / Ta entry is a directory
1254 .It * Ta entry is an executable file
1255 .It $ Ta entry is a Git submodule
1258 Symbolic link entries are also annotated with the target path of the link.
1262 is specified, list the repository path corresponding to the current
1263 directory of the work tree, or the root directory of the repository
1264 if there is no work tree.
1271 List files and directories as they appear in the specified
1274 The expected argument is a commit ID SHA1 hash, or a reference name
1275 or a keyword which will be resolved to a commit ID.
1276 An abbreviated hash argument will be expanded to a full SHA1 hash
1277 automatically, provided the abbreviation is unique.
1282 resolve to the work tree's base commit and branch head, respectively.
1283 The former is only valid if invoked in a work tree, while the latter will
1284 resolve to the tip of the work tree's current branch if invoked in a
1285 work tree, otherwise it will resolve to the repository's HEAD reference.
1286 Keywords and references may be appended with
1290 modifiers and an optional integer N to denote the
1291 Nth descendant or antecedent by first parent traversal, respectively;
1294 denotes the work tree branch head's 2nd generation ancestor, and
1296 denotes the 4th generation descendant of the work tree's base commit.
1299 will denote the 3rd generation ancestor of the commit resolved by the
1306 modifier without a trailing integer has an implicit
1315 Show object IDs of files (blob objects) and directories (tree objects).
1317 Recurse into sub-directories in the repository.
1318 .It Fl r Ar repository-path
1319 Use the repository at the specified path.
1320 If not specified, assume the repository is located at or above the current
1322 If this directory is a
1324 work tree, use the repository path associated with this work tree.
1330 .Op Fl r Ar repository-path
1331 .Op Fl s Ar reference
1334 Manage references in a repository.
1336 References may be listed, created, deleted, and changed.
1337 When creating, deleting, or changing a reference the specified
1339 must be an absolute reference name, i.e. it must begin with
1347 Create a reference or change an existing reference.
1348 The reference with the specified
1350 will point at the specified
1355 argument is an ID SHA1 hash or an existing reference or tag name
1356 or a keyword which will be resolved to the ID of a corresponding commit,
1357 tree, tag, or blob object.
1358 An abbreviated hash argument will be expanded to a full SHA1 hash
1359 automatically, provided the abbreviation is unique.
1364 resolve to the work tree's base commit and branch head, respectively.
1365 The former is only valid if invoked in a work tree, while the latter will
1366 resolve to the tip of the work tree's current branch if invoked in a
1367 work tree, otherwise it will resolve to the repository's HEAD reference.
1368 Keywords and reference names may be appended with
1372 modifiers and an optional integer N to denote the
1373 Nth descendant or antecedent by first parent traversal, respectively;
1376 denotes the work tree branch head's 2nd generation ancestor, and
1378 will denote the 3rd generation ancestor of the commit resolved by the
1381 If an integer does not follow the
1387 is implicitly appended
1394 Cannot be used together with any other options except
1397 Delete the reference with the specified
1399 from the repository.
1400 Any commit, tree, tag, and blob objects belonging to deleted references
1401 remain in the repository and may be removed separately with
1402 Git's garbage collector or
1403 .Cm gotadmin cleanup .
1404 Cannot be used together with any other options except
1407 List references in the repository.
1410 is specified, list all existing references in the repository.
1413 is a reference namespace, list all references in this namespace.
1414 Otherwise, show only the reference with the given
1416 Cannot be used together with any other options except
1420 .It Fl r Ar repository-path
1421 Use the repository at the specified path.
1422 If not specified, assume the repository is located at or above the current
1424 If this directory is a
1426 work tree, use the repository path associated with this work tree.
1427 .It Fl s Ar reference
1428 Create a symbolic reference, or change an existing symbolic reference.
1429 The symbolic reference with the specified
1431 will point at the specified
1433 which must already exist in the repository.
1434 Care should be taken not to create loops between references when
1435 this option is used.
1436 Cannot be used together with any other options except
1439 Sort listed references by modification time (most recently modified first)
1440 instead of sorting by lexicographical order.
1441 Use of this option requires the
1443 option to be used as well.
1451 .Op Fl r Ar repository-path
1455 Create, list, or delete branches.
1457 Local branches are managed via references which live in the
1459 reference namespace.
1462 command creates references in this namespace only.
1464 When deleting branches, the specified
1468 reference namespace first.
1469 If no corresponding branch is found, the
1471 namespace will be searched next.
1473 If invoked in a work tree without any arguments, print the name of the
1474 work tree's current branch.
1478 argument is passed, attempt to create a branch reference with the given name.
1479 By default the new branch reference will point at the latest commit on the
1480 work tree's current branch if invoked in a work tree, and otherwise to a commit
1481 resolved via the repository's HEAD reference.
1483 If invoked in a work tree, once the branch was created successfully
1484 switch the work tree's head reference to the newly created branch and
1485 update files across the entire work tree, just like
1486 .Cm got update -b Ar name
1488 Show the status of each affected file, using the following status codes:
1489 .Bl -column YXZ description
1490 .It U Ta file was updated and contained no local changes
1491 .It G Ta file was updated and local changes were merged cleanly
1492 .It C Ta file was updated and conflicts occurred during merge
1493 .It D Ta file was deleted
1494 .It A Ta new file was added
1495 .It \(a~ Ta versioned file is obstructed by a non-regular file
1496 .It ! Ta a missing versioned file was restored
1504 Make a newly created branch reference point at the specified
1506 The expected argument is a commit ID SHA1 hash, or a reference name or keyword
1507 which will be resolved to a commit ID.
1508 An abbreviated hash argument will be expanded to a full SHA1 hash
1509 automatically, provided the abbreviation is unique.
1514 resolve to the work tree's base commit and branch head, respectively.
1515 The former is only valid if invoked in a work tree, while the latter will
1516 resolve to the tip of the work tree's current branch if invoked in a
1517 work tree, otherwise it will resolve to the repository's HEAD reference.
1518 Keywords and references may be appended with
1522 modifiers and an optional integer N to denote the
1523 Nth descendant or antecedent by first parent traversal, respectively;
1526 denotes the work tree branch head's 2nd generation ancestor, and
1528 denotes the 4th generation descendant of the work tree's base commit.
1531 will denote the 3rd generation descendant of the commit resolved by the
1538 modifier without a trailing integer has an implicit
1547 Delete the branch with the specified
1553 reference namespace.
1555 Only the branch reference is deleted.
1556 Any commit, tree, and blob objects belonging to the branch
1557 remain in the repository and may be removed separately with
1558 Git's garbage collector or
1559 .Cm gotadmin cleanup .
1561 List all existing branches in the repository, including copies of remote
1562 repositories' branches in the
1564 reference namespace.
1566 If invoked in a work tree, the work tree's current branch is shown
1567 with one of the following annotations:
1568 .Bl -column YXZ description
1569 .It * Ta work tree's base commit matches the branch tip
1570 .It \(a~ Ta work tree's base commit is out-of-date
1573 Do not switch and update the work tree after creating a new branch.
1574 .It Fl r Ar repository-path
1575 Use the repository at the specified path.
1576 If not specified, assume the repository is located at or above the current
1578 If this directory is a
1580 work tree, use the repository path associated with this work tree.
1582 Sort listed branches by modification time (most recently modified first)
1583 instead of sorting by lexicographical order.
1586 reference namespace are listed before branches in
1589 Use of this option requires the
1591 option to be used as well.
1598 .Op Fl r Ar repository-path
1599 .Op Fl s Ar signer-id
1602 Manage tags in a repository.
1604 Tags are managed via references which live in the
1606 reference namespace.
1609 command operates on references in this namespace only.
1610 References in this namespace point at tag objects which contain a pointer
1611 to another object, a tag message, as well as author and timestamp information.
1613 Attempt to create a tag with the given
1615 and make this tag point at the given
1617 If no commit is specified, default to the latest commit on the work tree's
1618 current branch if invoked in a work tree, and to a commit resolved via
1619 the repository's HEAD reference otherwise.
1626 Make the newly created tag reference point at the specified
1630 argument is a commit ID SHA1 hash, or a reference or keyword
1631 which will be resolved to a commit ID.
1632 An abbreviated hash argument will be expanded to a full SHA1 hash
1633 automatically, provided the abbreviation is unique.
1638 resolve to the work tree's base commit and branch head, respectively.
1639 The former is only valid if invoked in a work tree, while the latter will
1640 resolve to the tip of the work tree's current branch if invoked in a
1641 work tree, otherwise it will resolve to the repository's HEAD reference.
1642 Keywords and references may be appended with
1646 modifiers and an optional integer N to denote the
1647 Nth descendant or antecedent by first parent traversal, respectively;
1650 denotes the work tree branch head's 2nd generation ancestor, and
1652 denotes the 4th generation descendant of the work tree's base commit.
1655 will denote the 3rd generation ancestor of the commit resolved by the
1662 modifier without a trailing integer has an implicit
1671 List all existing tags in the repository instead of creating a new tag.
1674 argument is passed, show only the tag with the given
1677 Use the specified tag message when creating the new tag.
1682 opens a temporary file in an editor where a tag message can be written.
1683 Quitting the editor without saving the file will abort the tag operation.
1684 .It Fl r Ar repository-path
1685 Use the repository at the specified path.
1686 If not specified, assume the repository is located at or above the current
1688 If this directory is a
1690 work tree, use the repository path associated with this work tree.
1691 .It Fl s Ar signer-id
1692 While creating a new tag, sign this tag with the identity given in
1695 For SSH-based signatures,
1697 is the path to a file which may refer to either a private SSH key,
1698 or a public SSH key with the private half available via
1701 will sign the tag object by invoking
1705 command, using the signature namespace
1707 for compatibility with
1710 Verify tag object signatures.
1713 is specified, show and verify the tag object with the provided name.
1714 Otherwise, list all tag objects and verify signatures where present.
1717 verifies SSH-based signatures by invoking
1720 .Fl Y Cm verify Fl f Ar allowed_signers .
1725 otherwise verification is impossible.
1728 During SSH signature creation and verification this option will be passed to
1730 Multiple -v options increase the verbosity.
1736 command will not delete tags or change existing tags.
1737 If a tag must be deleted, the
1739 command may be used to delete a tag's reference.
1740 This should only be done if the tag has not already been copied to
1747 Schedule unversioned files in a work tree for addition to the
1748 repository in the next commit.
1749 By default, files which match a
1751 ignore pattern will not be added.
1755 mentioned in the command line is not an unversioned file then
1758 To avoid unnecessary errors from paths picked up by file globbing patterns
1759 in the shell, paths in the argument list will be silently ignored if they
1762 at all, or if they are reported with one of the following status codes
1763 and do not have changes staged via
1765 .Bl -column YXZ description
1766 .It M Ta modified file
1767 .It A Ta file scheduled for addition in next commit
1768 .It C Ta modified or added file which contains merge conflicts
1769 .It m Ta modified file modes (executable bit only)
1777 Add files even if they match a
1781 Permit recursion into directories.
1782 If this option is not specified,
1784 will refuse to run if a specified
1792 .Op Fl s Ar status-codes
1796 Remove versioned files from a work tree and schedule them for deletion
1797 from the repository in the next commit.
1804 Perform the operation even if a file contains local modifications,
1805 and do not raise an error if a specified
1807 does not exist on disk.
1809 Keep affected files on disk.
1811 Permit recursion into directories.
1812 If this option is not specified,
1814 will refuse to run if a specified
1817 .It Fl s Ar status-codes
1818 Only delete files with a modification status matching one of the
1819 single-character status codes contained in the
1822 The following status codes may be specified:
1823 .Bl -column YXZ description
1824 .It M Ta modified file (this implies the
1827 .It ! Ta versioned file expected on disk but missing
1835 .Op Fl p Ar strip-count
1841 to files in a work tree.
1842 Files added or removed by a patch will be scheduled for addition or removal in
1845 The patch must be in the unified diff format as produced by
1852 diff when invoked with their
1857 argument is provided, read unified diff data from standard input instead.
1861 contains multiple patches, then attempt to apply each of them in sequence.
1863 Show the status of each affected file, using the following status codes:
1864 .Bl -column XYZ description
1865 .It M Ta file was modified
1866 .It G Ta file was merged using a merge-base found in the repository
1867 .It C Ta file was merged and conflicts occurred during merge
1868 .It D Ta file was deleted
1869 .It A Ta file was added
1870 .It # Ta failed to patch the file
1873 If a change does not match at its exact line number, attempt to
1874 apply it somewhere else in the file if a good spot can be found.
1875 Otherwise, the patch will fail to apply.
1879 will refuse to apply a patch if certain preconditions are not met.
1880 Files to be deleted must already be under version control, and must
1881 not have been scheduled for deletion already.
1882 Files to be added must not yet be under version control and must not
1883 already be present on disk.
1884 Files to be modified must already be under version control and may not
1885 contain conflict markers.
1887 If an error occurs, the
1889 operation will be aborted.
1890 Any changes made to the work tree up to this point will be left behind.
1891 Such changes can be viewed with
1893 and can be reverted with
1902 Attempt to locate files within the specified
1904 for use as a merge-base for 3-way merges.
1908 option is not used then
1910 will attempt to locate merge-bases via object IDs found in
1912 meta-data, such as produced by
1918 option is only recommended in the absence of such meta-data.
1920 Ideally, the specified
1922 should contain versions of files which the changes contained in the
1925 Files will be located by path, relative to the repository root.
1928 option is used then leading path components will be stripped
1929 before paths are looked up in the repository.
1931 In case no merge-base is available for a file, changes will be applied
1932 without doing a 3-way merge.
1933 Changes which do not apply cleanly may then be rejected entirely, rather
1934 than producing merge conflicts in the patched target file.
1938 argument is a commit ID SHA1 hash, or a reference name or a keyword
1939 which will be resolved to a commit ID.
1940 An abbreviated hash argument will be expanded to a full SHA1 hash
1941 automatically, provided the abbreviation is unique.
1946 resolve to the work tree's base commit and branch head, respectively.
1947 Keywords and references may be appended with
1951 modifiers and an optional integer N to denote the
1952 Nth descendant or antecedent by first parent traversal, respectively;
1955 denotes the work tree branch head's 2nd generation ancestor, and
1957 denotes the 4th generation descendant of the work tree's base commit.
1960 will denote the 3rd generation descendant of the commit resolved by the
1967 modifier without a trailing integer has an implicit
1976 Do not make any modifications to the work tree.
1977 This can be used to check whether a patch would apply without issues.
1980 contains diffs that affect the same file multiple times, the results
1981 displayed may be incorrect.
1982 .It Fl p Ar strip-count
1983 Specify the number of leading path components to strip from paths
1992 path prefixes generated by
1994 will be recognized and stripped automatically.
1996 Reverse the patch before applying it.
2002 .Op Fl F Ar response-script
2006 Revert any local changes in files at the specified paths in a work tree.
2007 File contents will be overwritten with those contained in the
2008 work tree's base commit.
2009 There is no way to bring discarded changes back after
2012 If a file was added with
2014 it will become an unversioned file again.
2015 If a file was deleted with
2017 it will be restored.
2023 .It Fl F Ar response-script
2031 responses line-by-line from the specified
2033 file instead of prompting interactively.
2035 Instead of reverting all changes in files, interactively select or reject
2036 changes to revert based on
2042 (quit reverting this file) responses.
2043 If a file is in modified status, individual patches derived from the
2044 modified file content can be reverted.
2045 Files in added or deleted status may only be reverted in their entirety.
2047 Permit recursion into directories.
2048 If this option is not specified,
2050 will refuse to run if a specified
2064 Create a new commit in the repository from changes in a work tree
2065 and use this commit as the new base commit for the work tree.
2068 is specified, commit all changes in the work tree.
2069 Otherwise, commit changes at or within the specified paths.
2071 If changes have been explicitly staged for commit with
2073 only commit staged changes and reject any specified paths which
2074 have not been staged.
2077 opens a temporary file in an editor where a log message can be written
2085 options are used together.
2086 Quitting the editor without saving the file will abort the commit operation.
2088 Show the status of each affected file, using the following status codes:
2089 .Bl -column YXZ description
2090 .It M Ta modified file
2091 .It D Ta file was deleted
2092 .It A Ta new file was added
2093 .It m Ta modified file modes (executable bit only)
2096 Files which are not part of the new commit will retain their previously
2097 recorded base commit.
2100 commands may refuse to run while the work tree contains files from
2101 multiple base commits.
2102 The base commit of such a work tree can be made consistent by running
2104 across the entire work tree.
2108 command requires the
2110 environment variable to be set,
2111 unless an author has been configured in
2117 configuration settings can be
2118 obtained from the repository's
2120 file or from Git's global
2129 Set author information in the newly created commit to
2131 This is useful when committing changes on behalf of someone else.
2134 argument must use the same format as the
2136 environment variable.
2138 In addition to storing author information, the newly created commit
2141 information which is obtained, as usual, from the
2143 environment variable, or
2145 or Git configuration settings.
2147 Allow committing files in conflicted status.
2149 Committing files with conflict markers should generally be avoided.
2150 Cases where conflict markers must be stored in the repository for
2151 some legitimate reason should be very rare.
2152 There are usually ways to avoid storing conflict markers verbatim by
2153 applying appropriate programming tricks.
2155 Use the prepared log message stored in the file found at
2157 when creating the new commit.
2159 opens a temporary file in an editor where the prepared log message can be
2160 reviewed and edited further if needed.
2161 Cannot be used together with the
2165 Use the specified log message when creating the new commit.
2166 Cannot be used together with the
2170 This option prevents
2172 from opening the commit message in an editor.
2173 It has no effect unless it is used together with the
2175 option and is intended for non-interactive use such as scripting.
2177 This option prevents
2179 from generating a diff of the to-be-committed changes in a temporary file
2180 which can be viewed while editing a commit message.
2182 Allow the addition of symbolic links which point outside of the path space
2183 that is under version control.
2186 will reject such symbolic links due to safety concerns.
2189 may decide to represent such a symbolic link as a regular file which contains
2190 the link's target path, rather than creating an actual symbolic link which
2191 points outside of the work tree.
2192 Use of this option is discouraged because external mechanisms such as
2194 are better suited for managing symbolic links to paths not under
2199 will refuse to run if certain preconditions are not met.
2200 If the work tree's current branch is not in the
2202 reference namespace, new commits may not be created on this branch.
2203 Local changes may only be committed if they are based on file content
2204 found in the most recent commit on the work tree's branch.
2205 If a path is found to be out of date,
2207 must be used first in order to merge local changes with changes made
2215 .Op Fl r Ar repository-path
2217 .Op Ar remote-repository
2220 Send new changes to a remote repository.
2222 .Ar remote-repository
2226 The remote repository's URL is obtained from the corresponding entry in
2230 file of the local repository, as created by
2233 All objects corresponding to new changes will be written to a temporary
2234 pack file which is then uploaded to the server.
2235 Upon success, references in the
2237 reference namespace of the local repository will be updated to point at
2238 the commits which have been sent.
2240 By default, changes will only be sent if they are based on up-to-date
2241 copies of relevant branches in the remote repository.
2242 If any changes to be sent are based on out-of-date copies or would
2243 otherwise break linear history of existing branches, new changes must
2244 be fetched from the server with
2246 and local branches must be rebased with
2253 option can be used to make exceptions to these requirements.
2260 Send all branches from the local repository's
2262 reference namespace.
2265 option is equivalent to listing all branches with multiple
2268 Cannot be used together with the
2274 from the local repository's
2276 reference namespace.
2277 This option may be specified multiple times to build a list of branches
2279 If this option is not specified, default to the work tree's current branch
2280 if invoked in a work tree, or to the repository's HEAD reference.
2281 Cannot be used together with the
2285 Delete the specified
2287 from the remote repository's
2289 reference namespace.
2290 This option may be specified multiple times to build a list of branches
2293 Only references are deleted.
2294 Any commit, tree, tag, and blob objects belonging to deleted branches
2295 may become subject to deletion by Git's garbage collector running on
2298 Requesting deletion of branches results in an error if the server
2299 does not support this feature or disallows the deletion of branches
2300 based on its configuration.
2302 Attempt to force the server to overwrite existing branches or tags
2303 in the remote repository, even when
2309 would usually be required before changes can be sent.
2310 The server may reject forced requests regardless, depending on its
2313 Any commit, tree, tag, and blob objects belonging to overwritten branches
2314 or tags may become subject to deletion by Git's garbage collector running
2319 reference namespace is globally shared between all repositories.
2322 option to overwrite tags is discouraged because it can lead to
2323 inconsistencies between the tags present in different repositories.
2324 In general, creating a new tag with a different name is recommended
2325 instead of overwriting an existing tag.
2329 option is particularly discouraged if changes being sent are based
2330 on an out-of-date copy of a branch in the remote repository.
2331 Instead of using the
2333 option, new changes should
2336 and local branches should be rebased with
2340 followed by another attempt to send the changes.
2344 option should only be needed in situations where the remote repository's
2345 copy of a branch or tag is known to be out-of-date and is considered
2347 The risks of creating inconsistencies between different repositories
2348 should also be taken into account.
2350 Suppress progress reporting output.
2351 The same option will be passed to
2354 .It Fl r Ar repository-path
2355 Use the repository at the specified path.
2356 If not specified, assume the repository is located at or above the current
2358 If this directory is a
2360 work tree, use the repository path associated with this work tree.
2362 Attempt to send all tags from the local repository's
2364 reference namespace.
2367 option is equivalent to listing all tags with multiple
2370 Cannot be used together with the
2376 from the local repository's
2378 reference namespace, in addition to any branches that are being sent.
2381 option may be specified multiple times to build a list of tags to send.
2382 No tags will be sent if the
2386 Raise an error if the specified
2388 already exists in the remote repository, unless the
2390 option is used to overwrite the server's copy of the tag.
2391 In general, creating a new tag with a different name is recommended
2392 instead of overwriting an existing tag.
2394 Cannot be used together with the
2401 to print debugging messages to standard error output.
2402 The same option will be passed to
2405 Multiple -v options increase the verbosity.
2415 Merge changes from a single
2420 should be on a different branch than the work tree's base commit.
2422 The expected argument is a commit ID SHA1 hash, or a reference name or
2423 keyword which will be resolved to a commit ID.
2424 An abbreviated hash argument will be expanded to a full SHA1 hash
2425 automatically, provided the abbreviation is unique.
2430 resolve to the work tree's base commit and branch head, respectively.
2431 Keywords and references may be appended with
2435 modifiers and an optional integer N to denote the
2436 Nth descendant or antecedent by first parent traversal, respectively;
2439 denotes the work tree branch head's 2nd generation ancestor, and
2441 denotes the 4th generation descendant of the work tree's base commit.
2444 will denote the 3rd generation descendant of the commit resolved by the
2451 modifier without a trailing integer has an implicit
2460 Show the status of each affected file, using the following status codes:
2461 .Bl -column YXZ description
2462 .It G Ta file was merged
2463 .It C Ta file was merged and conflicts occurred during merge
2464 .It ! Ta changes destined for a missing file were not merged
2465 .It D Ta file was deleted
2466 .It d Ta file's deletion was prevented by local modifications
2467 .It A Ta new file was added
2468 .It \(a~ Ta changes destined for a non-regular file were not merged
2469 .It ? Ta changes destined for an unversioned file were not merged
2472 The merged changes will appear as local changes in the work tree, which
2475 amended manually or with further
2481 If invoked in a work tree where no
2486 operation is taking place,
2488 creates a record of commits which have been merged into the work tree.
2489 When a file changed by
2493 the log messages of relevant merged commits will then appear in the editor,
2494 where the messages should be further adjusted to convey the reasons for
2495 cherrypicking the changes.
2496 Upon exiting the editor, if the time stamp of the log message file
2497 is unchanged or the log message is empty,
2499 will fail with an unmodified or empty log message error.
2501 If all the changes in all files touched by a given commit are discarded,
2504 this commit's log message record will also disappear.
2507 will refuse to run if certain preconditions are not met.
2508 If the work tree contains multiple base commits, it must first be updated
2509 to a single base commit with
2511 If any relevant files already contain merge conflicts, these
2512 conflicts must be resolved first.
2520 Display a list of commit log messages recorded by cherrypick operations,
2521 represented by references in the
2522 .Dq refs/got/worktree
2523 reference namespace.
2526 is specified, only show the log message of the specified commit.
2528 If invoked in a work tree, only log messages recorded by cherrypick operations
2529 in the current work tree will be displayed.
2530 Otherwise, all commit log messages will be displayed irrespective of the
2531 work tree in which they were created.
2532 This option cannot be used with
2535 Delete log messages created by previous cherrypick operations, represented by
2537 .Dq refs/got/worktree
2538 reference namespace.
2541 is specified, only delete the log message of the specified commit.
2543 If invoked in a work tree, only log messages recorded by cherrypick operations
2544 in the current work tree will be deleted.
2545 Otherwise, all commit log messages will be deleted irrespective of the
2546 work tree in which they were created.
2547 This option cannot be used with
2558 Reverse-merge changes from a single
2563 should be on the same branch as the work tree's base commit.
2565 The expected argument is a commit ID SHA1 hash, or a reference name
2566 or keyword which will be resolved to a commit ID.
2567 An abbreviated hash argument will be expanded to a full SHA1 hash
2568 automatically, provided the abbreviation is unique.
2573 resolve to the work tree's base commit and branch head, respectively.
2574 Keywords and references may be appended with
2578 modifiers and an optional integer N to denote the
2579 Nth descendant or antecedent by first parent traversal, respectively;
2582 denotes the work tree branch head's 2nd generation ancestor, and
2584 denotes the 4th generation descendant of the work tree's base commit.
2587 will denote the 5th generation descendant of the commit resolved by the
2594 modifier without a trailing integer has an implicit
2603 Show the status of each affected file, using the following status codes:
2604 .Bl -column YXZ description
2605 .It G Ta file was merged
2606 .It C Ta file was merged and conflicts occurred during merge
2607 .It ! Ta changes destined for a missing file were not merged
2608 .It D Ta file was deleted
2609 .It d Ta file's deletion was prevented by local modifications
2610 .It A Ta new file was added
2611 .It \(a~ Ta changes destined for a non-regular file were not merged
2612 .It ? Ta changes destined for an unversioned file were not merged
2615 The reverse-merged changes will appear as local changes in the work tree,
2616 which may be viewed with
2618 amended manually or with further
2624 If invoked in a work tree where no
2629 operation is taking place,
2631 creates a record of commits which have been reverse-merged into the work tree.
2632 When a file changed by
2636 the log messages of relevant reverse-merged commits will then appear in
2637 the editor, where the messages should be further adjusted to convey the
2638 reasons for backing out the changes.
2639 Upon exiting the editor, if the time stamp of the log message file
2640 is unchanged or the log message is empty,
2642 will fail with an unmodified or empty log message error.
2644 If all the changes in all files touched by a given commit are discarded,
2647 this commit's log message record will also disappear.
2650 will refuse to run if certain preconditions are not met.
2651 If the work tree contains multiple base commits, it must first be updated
2652 to a single base commit with
2654 If any relevant files already contain merge conflicts, these
2655 conflicts must be resolved first.
2663 Display a list of commit log messages recorded by backout operations,
2664 represented by references in the
2665 .Dq refs/got/worktree
2666 reference namespace.
2669 is specified, only show the log message of the specified commit.
2671 If invoked in a work tree, only log messages recorded by backout operations
2672 in the current work tree will be displayed.
2673 Otherwise, all commit log messages will be displayed irrespective of the
2674 work tree in which they were created.
2675 This option cannot be used with
2678 Delete log messages created by previous backout operations, represented by
2680 .Dq refs/got/worktree
2681 reference namespace.
2684 is specified, only delete the log message of the specified commit.
2686 If invoked in a work tree, only log messages recorded by backout operations
2687 in the current work tree will be deleted.
2688 Otherwise, all commit log messages will be deleted irrespective of the
2689 work tree in which they were created.
2690 This option cannot be used with
2701 Rebase commits on the specified
2703 onto the tip of the current branch of the work tree.
2706 must share common ancestry with the work tree's current branch.
2707 Rebasing begins with the first descendant commit of the youngest
2708 common ancestor commit shared by the specified
2710 and the work tree's current branch, and stops once the tip commit
2717 is used as intended, the specified
2719 represents a local commit history and may already contain changes
2720 that are not yet visible in any other repositories.
2721 The work tree's current branch, which must be set with
2725 operation, represents a branch from a remote repository which shares
2726 a common history with the specified
2728 but has progressed, and perhaps diverged, due to commits added to the
2731 Rebased commits are accumulated on a temporary branch which the work tree
2732 will remain switched to throughout the entire rebase operation.
2733 Commits on this branch represent the same changes with the same log
2734 messages as their counterparts on the original
2736 but with different commit IDs.
2737 Once rebasing has completed successfully, the temporary branch becomes
2738 the new version of the specified
2740 and the work tree is automatically switched to it.
2741 If author information is available via the
2743 environment variable,
2749 configuration settings, this author information will be used to identify
2754 Old commits in their pre-rebase state are automatically backed up in the
2755 .Dq refs/got/backup/rebase
2756 reference namespace.
2757 As long as these references are not removed older versions of rebased
2758 commits will remain in the repository and can be viewed with the
2761 Removal of these references makes objects which become unreachable via
2762 any reference subject to removal by Git's garbage collector or
2763 .Cm gotadmin cleanup .
2765 While rebasing commits, show the status of each affected file,
2766 using the following status codes:
2767 .Bl -column YXZ description
2768 .It G Ta file was merged
2769 .It C Ta file was merged and conflicts occurred during merge
2770 .It ! Ta changes destined for a missing file were not merged
2771 .It D Ta file was deleted
2772 .It d Ta file's deletion was prevented by local modifications
2773 .It A Ta new file was added
2774 .It \(a~ Ta changes destined for a non-regular file were not merged
2775 .It ? Ta changes destined for an unversioned file were not merged
2778 If merge conflicts occur, the rebase operation is interrupted and may
2779 be continued once conflicts have been resolved.
2780 If any files with destined changes are found to be missing or unversioned,
2781 or if files could not be deleted due to differences in deleted content,
2782 the rebase operation will be interrupted to prevent potentially incomplete
2783 changes from being committed to the repository without user intervention.
2784 The work tree may be modified as desired and the rebase operation can be
2785 continued once the changes present in the work tree are considered complete.
2786 Alternatively, the rebase operation may be aborted which will leave
2788 unmodified and the work tree switched back to its original branch.
2790 If a merge conflict is resolved in a way which renders the merged
2791 change into a no-op change, the corresponding commit will be elided
2792 when the rebase operation continues.
2795 will refuse to run if certain preconditions are not met.
2800 reference namespace, the branch may not be rebased.
2801 If the work tree is not yet fully updated to the tip commit of its
2802 branch, then the work tree must first be updated with
2804 If changes have been staged with
2806 these changes must first be committed with
2810 If the work tree contains local changes, these changes must first be
2817 contains changes to files outside of the work tree's path prefix,
2818 the work tree cannot be used to rebase this branch.
2827 commands will refuse to run while a rebase operation is in progress.
2828 Other commands which manipulate the work tree may be used for
2829 conflict resolution purposes.
2833 is already based on the work tree's current branch, then no commits
2834 need to be rebased and
2836 will simply switch the work tree to the specified
2838 and update files in the work tree accordingly.
2845 Abort an interrupted rebase operation.
2846 If this option is used, no other command-line arguments are allowed.
2848 Allow a rebase operation to continue with files in conflicted status.
2849 This option should generally be avoided, and can only be used with the
2853 Continue an interrupted rebase operation.
2854 If this option is used, no other command-line arguments are allowed except
2857 Show a list of past rebase operations, represented by references in the
2858 .Dq refs/got/backup/rebase
2859 reference namespace.
2861 Display the author, date, and log message of each backed up commit,
2862 the object ID of the corresponding post-rebase commit, and
2863 the object ID of their common ancestor commit.
2864 Given these object IDs,
2871 options can be used to examine the history of either version of the branch,
2876 option can be used to create a new branch from a pre-rebase state if desired.
2880 is specified, only show commits which at some point in time represented this
2882 Otherwise, list all backed up commits for any branches.
2884 If this option is used,
2886 does not require a work tree.
2887 None of the other options can be used together with
2890 Delete backups created by past rebase operations, represented by references
2892 .Dq refs/got/backup/rebase
2893 reference namespace.
2897 is specified, only delete backups which at some point in time represented
2899 Otherwise, delete all references found within
2900 .Dq refs/got/backup/rebase .
2902 Any commit, tree, tag, and blob objects belonging to deleted backups
2903 remain in the repository and may be removed separately with
2904 Git's garbage collector or
2905 .Cm gotadmin cleanup .
2907 If this option is used,
2909 does not require a work tree.
2910 None of the other options can be used together with
2917 .Op Fl F Ar histedit-script
2921 Edit commit history between the work tree's current base commit and
2922 the tip commit of the work tree's current branch.
2926 command requires the
2928 environment variable to be set,
2929 unless an author has been configured in
2935 configuration settings can be obtained from the repository's
2937 file or from Git's global
2943 operation, the work tree's current branch must be set with
2945 to the branch which should be edited, unless this branch is already the
2946 current branch of the work tree.
2947 The tip of this branch represents the upper bound (inclusive) of commits
2952 Furthermore, the work tree's base commit
2955 to a point in this branch's commit history where editing should begin.
2956 This commit represents the lower bound (non-inclusive) of commits touched
2961 Editing of commit history is controlled via a
2963 which can be written in an editor based on a template, passed on the
2964 command line, or generated with the
2971 Quitting the editor without saving the file will abort the histedit operation.
2973 The format of the histedit script is line-based.
2974 Each line in the script begins with a command name, followed by
2975 whitespace and an argument.
2976 For most commands, the expected argument is a commit ID SHA1 hash.
2977 Any remaining text on the line is ignored.
2978 Lines which begin with the
2980 character are ignored entirely.
2982 The available histedit script commands are as follows:
2983 .Bl -column YXZ pick-commit
2984 .It Cm pick Ar commit Ta Use the specified commit as it is.
2985 .It Cm edit Ar commit Ta Apply the changes from the specified commit, but
2986 then interrupt the histedit operation for amending, without creating a commit.
2987 While the histedit operation is interrupted arbitrary files may be edited,
2988 and commands which manipulate the work tree can be used freely.
2993 commands can be used to add new files or remove existing ones.
2996 command can be used to eliminate arbitrary changes from files in the work tree.
2999 command may be used to prepare a subset of changes for inclusion in the
3003 command can be used to insert arbitrary commits into the edited history.
3004 Regular editing of history must eventually be resumed by running
3005 .Cm got histedit -c .
3006 .It Cm fold Ar commit Ta Combine the specified commit with the next commit
3007 listed further below that will be used.
3008 .It Cm drop Ar commit Ta Remove this commit from the edited history.
3009 .It Cm mesg Oo Ar log-message Oc Ta Create a new log message for the commit of
3014 command on the previous line of the histedit script.
3017 argument provides a new single-line log message to use.
3020 argument is omitted, open an editor where a new log message can be written.
3023 Every commit in the history being edited must be mentioned in the script.
3024 Lines may be re-ordered to change the order of commits in the edited history.
3025 No commit may be listed more than once.
3027 Edited commits are accumulated on a temporary branch which the work tree
3028 will remain switched to throughout the entire histedit operation.
3029 Once history editing has completed successfully, the temporary branch becomes
3030 the new version of the work tree's branch and the work tree is automatically
3033 Old commits in their pre-histedit state are automatically backed up in the
3034 .Dq refs/got/backup/histedit
3035 reference namespace.
3036 As long as these references are not removed older versions of edited
3037 commits will remain in the repository and can be viewed with the
3040 Removal of these references makes objects which become unreachable via
3041 any reference subject to removal by Git's garbage collector or
3042 .Cm gotadmin cleanup .
3044 While merging commits, show the status of each affected file,
3045 using the following status codes:
3046 .Bl -column YXZ description
3047 .It G Ta file was merged
3048 .It C Ta file was merged and conflicts occurred during merge
3049 .It ! Ta changes destined for a missing file were not merged
3050 .It D Ta file was deleted
3051 .It d Ta file's deletion was prevented by local modifications
3052 .It A Ta new file was added
3053 .It \(a~ Ta changes destined for a non-regular file were not merged
3054 .It ? Ta changes destined for an unversioned file were not merged
3057 If merge conflicts occur, the histedit operation is interrupted and may
3058 be continued once conflicts have been resolved.
3059 If any files with destined changes are found to be missing or unversioned,
3060 or if files could not be deleted due to differences in deleted content,
3061 the histedit operation will be interrupted to prevent potentially incomplete
3062 changes from being committed to the repository without user intervention.
3063 The work tree may be modified as desired and the histedit operation can be
3064 continued once the changes present in the work tree are considered complete.
3065 Alternatively, the histedit operation may be aborted which will leave
3066 the work tree switched back to its original branch.
3068 If a merge conflict is resolved in a way which renders the merged
3069 change into a no-op change, the corresponding commit will be elided
3070 when the histedit operation continues.
3073 will refuse to run if certain preconditions are not met.
3074 If the work tree's current branch is not in the
3076 reference namespace, the history of the branch may not be edited.
3077 If the work tree contains multiple base commits, it must first be updated
3078 to a single base commit with
3080 If changes have been staged with
3082 these changes must first be committed with
3086 If the work tree contains local changes, these changes must first be
3091 If the edited history contains changes to files outside of the work tree's
3092 path prefix, the work tree cannot be used to edit the history of this branch.
3100 commands will refuse to run while a histedit operation is in progress.
3101 Other commands which manipulate the work tree may be used, and the
3103 command may be used to commit arbitrary changes to the temporary branch
3104 while the histedit operation is interrupted.
3111 Abort an interrupted histedit operation.
3112 If this option is used, no other command-line arguments are allowed.
3114 Allow a histedit operation to continue with files in conflicted status.
3115 This option should generally be avoided, and can only be used with the
3119 Continue an interrupted histedit operation.
3120 If this option is used, no other command-line arguments are allowed except
3124 This option is a quick equivalent to a histedit script which drops all
3128 option can only be used when starting a new histedit operation.
3129 If this option is used, no other command-line arguments are allowed.
3131 Interrupt the histedit operation for editing after merging each commit.
3132 This option is a quick equivalent to a histedit script which uses the
3134 command for all commits.
3137 option can only be used when starting a new histedit operation.
3138 If this option is used, no other command-line arguments are allowed.
3139 .It Fl F Ar histedit-script
3142 instead of opening a temporary file in an editor where a histedit script
3145 Fold all commits into a single commit.
3146 This option is a quick equivalent to a histedit script which folds all
3147 commits, combining them all into one commit.
3150 option can only be used when starting a new histedit operation.
3151 If this option is used, no other command-line arguments are allowed.
3153 Show a list of past histedit operations, represented by references in the
3154 .Dq refs/got/backup/histedit
3155 reference namespace.
3157 Display the author, date, and log message of each backed up commit,
3158 the object ID of the corresponding post-histedit commit, and
3159 the object ID of their common ancestor commit.
3160 Given these object IDs,
3167 options can be used to examine the history of either version of the branch,
3172 option can be used to create a new branch from a pre-histedit state if desired.
3176 is specified, only show commits which at some point in time represented this
3178 Otherwise, list all backed up commits for any branches.
3180 If this option is used,
3182 does not require a work tree.
3183 None of the other options can be used together with
3186 Edit log messages only.
3187 This option is a quick equivalent to a histedit script which edits
3188 only log messages but otherwise leaves every picked commit as-is.
3191 option can only be used when starting a new histedit operation.
3192 If this option is used, no other command-line arguments are allowed.
3194 Delete backups created by past histedit operations, represented by references
3196 .Dq refs/got/backup/histedit
3197 reference namespace.
3201 is specified, only delete backups which at some point in time represented
3203 Otherwise, delete all references found within
3204 .Dq refs/got/backup/histedit .
3206 Any commit, tree, tag, and blob objects belonging to deleted backups
3207 remain in the repository and may be removed separately with
3208 Git's garbage collector or
3209 .Cm gotadmin cleanup .
3211 If this option is used,
3213 does not require a work tree.
3214 None of the other options can be used together with
3218 .It Cm integrate Ar branch
3220 Integrate the specified
3222 into the work tree's current branch.
3223 Files in the work tree are updated to match the contents on the integrated
3225 and the reference of the work tree's branch is changed to point at the
3226 head commit of the integrated
3229 Both branches can be considered equivalent after integration since they
3230 will be pointing at the same commit.
3231 Both branches remain available for future work, if desired.
3232 In case the integrated
3234 is no longer needed it may be deleted with
3237 Show the status of each affected file, using the following status codes:
3238 .Bl -column YXZ description
3239 .It U Ta file was updated
3240 .It D Ta file was deleted
3241 .It A Ta new file was added
3242 .It \(a~ Ta versioned file is obstructed by a non-regular file
3243 .It ! Ta a missing versioned file was restored
3247 will refuse to run if certain preconditions are not met.
3248 Most importantly, the
3250 must have been rebased onto the work tree's current branch with
3252 before it can be integrated, in order to linearize commit history and
3253 resolve merge conflicts.
3254 If the work tree contains multiple base commits, it must first be updated
3255 to a single base commit with
3257 If changes have been staged with
3259 these changes must first be committed with
3263 If the work tree contains local changes, these changes must first be
3277 into the current branch of the work tree.
3278 If the branches have diverged, creates a merge commit.
3281 already includes all commits from the work tree's branch, updates the work
3282 tree's branch to be the same as
3284 without creating a commit, and updates the work tree to the most recent commit
3287 If a linear project history is desired, then use of
3289 should be preferred over
3291 However, even strictly linear projects may require merge commits in order
3292 to merge in new versions of third-party code stored on vendor branches
3296 Merge commits are commits based on multiple parent commits.
3297 The tip commit of the work tree's current branch, which must be in the
3299 reference namespace and must be set with
3303 operation, will be used as the first parent.
3304 The tip commit of the specified
3306 will be used as the second parent.
3308 No ancestral relationship between the two branches is required.
3309 If the two branches have already been merged previously, only new changes
3312 It is not possible to create merge commits with more than two parents.
3313 If more than one branch needs to be merged, then multiple merge commits
3314 with two parents each can be created in sequence.
3316 While merging changes found on the
3318 into the work tree, show the status of each affected file,
3319 using the following status codes:
3320 .Bl -column YXZ description
3321 .It G Ta file was merged
3322 .It C Ta file was merged and conflicts occurred during merge
3323 .It ! Ta changes destined for a missing file were not merged
3324 .It D Ta file was deleted
3325 .It d Ta file's deletion was prevented by local modifications
3326 .It A Ta new file was added
3327 .It \(a~ Ta changes destined for a non-regular file were not merged
3328 .It ? Ta changes destined for an unversioned file were not merged
3331 If merge conflicts occur, the merge operation is interrupted and conflicts
3332 must be resolved before the merge operation can continue.
3333 If any files with destined changes are found to be missing or unversioned,
3334 or if files could not be deleted due to differences in deleted content,
3335 the merge operation will be interrupted to prevent potentially incomplete
3336 changes from being committed to the repository without user intervention.
3337 The work tree may be modified as desired and the merge can be continued
3338 once the changes present in the work tree are considered complete.
3339 Alternatively, the merge operation may be aborted which will leave
3340 the work tree's current branch unmodified.
3343 will refuse to run if certain preconditions are not met.
3344 If the work tree's current branch is not in the
3346 reference namespace then the work tree must first be switched to a
3351 If the work tree is not yet fully updated to the tip commit of its
3352 branch, then the work tree must first be updated with
3354 If the work tree contains multiple base commits, it must first be updated
3355 to a single base commit with
3357 If changes have been staged with
3359 these changes must first be committed with
3363 If the work tree contains local changes, these changes must first be
3370 contains changes to files outside of the work tree's path prefix,
3371 the work tree cannot be used to merge this branch.
3381 commands will refuse to run while a merge operation is in progress.
3382 Other commands which manipulate the work tree may be used for
3383 conflict resolution purposes.
3390 Abort an interrupted merge operation.
3391 If this option is used, no other command-line arguments are allowed.
3393 Allow a merge operation to continue with files in conflicted status.
3394 This option should generally be avoided, and can only be used with the
3398 Continue an interrupted merge operation.
3399 If this option is used, no other command-line arguments are allowed except
3402 Create a merge commit even if the branches have not diverged.
3404 Merge changes into the work tree as usual but do not create a merge
3406 The merge result can be adjusted as desired before a merge commit is
3409 Alternatively, the merge may be aborted with
3416 .Op Fl F Ar response-script
3420 Stage local changes for inclusion in the next commit.
3423 is specified, stage all changes in the work tree.
3424 Otherwise, stage changes at or within the specified paths.
3425 Paths may be staged if they are added, modified, or deleted according to
3428 Show the status of each affected file, using the following status codes:
3429 .Bl -column YXZ description
3430 .It A Ta file addition has been staged
3431 .It M Ta file modification has been staged
3432 .It D Ta file deletion has been staged
3435 Staged file contents are saved in newly created blob objects in the repository.
3436 These blobs will be referred to by tree objects once staged changes have been
3439 Staged changes affect the behaviour of
3444 While paths with staged changes exist, the
3446 command will refuse to commit any paths which do not have staged changes.
3447 Local changes created on top of staged changes can only be committed if
3448 the path is staged again, or if the staged changes are committed first.
3451 command will show both local changes and staged changes.
3454 command is able to display local changes relative to staged changes,
3455 and to display staged changes relative to the repository.
3458 command cannot revert staged changes but may be used to revert
3459 local changes created on top of staged changes.
3465 .It Fl F Ar response-script
3473 responses line-by-line from the specified
3475 file instead of prompting interactively.
3477 Instead of staging new changes, list paths which are already staged,
3478 along with the IDs of staged blob objects and stage status codes.
3479 If paths were provided on the command line, show the staged paths
3480 among the specified paths.
3481 Otherwise, show all staged paths.
3483 Instead of staging the entire content of a changed file, interactively
3484 select or reject changes for staging based on
3488 (reject change), and
3490 (quit staging this file) responses.
3491 If a file is in modified status, individual patches derived from the
3492 modified file content can be staged.
3493 Files in added or deleted status may only be staged or rejected in
3496 Allow staging of symbolic links which point outside of the path space
3497 that is under version control.
3500 will reject such symbolic links due to safety concerns.
3503 may decide to represent such a symbolic link as a regular file which contains
3504 the link's target path, rather than creating an actual symbolic link which
3505 points outside of the work tree.
3506 Use of this option is discouraged because external mechanisms such as
3508 are better suited for managing symbolic links to paths not under
3513 will refuse to run if certain preconditions are not met.
3514 If a file contains merge conflicts, these conflicts must be resolved first.
3515 If a file is found to be out of date relative to the head commit on the
3516 work tree's current branch, the file must be updated with
3518 before it can be staged (however, this does not prevent the file from
3519 becoming out-of-date at some point after having been staged).
3527 commands will refuse to run while staged changes exist.
3528 If staged changes cannot be committed because a staged path
3529 is out of date, the path must be unstaged with
3531 before it can be updated with
3533 and may then be staged again if necessary.
3538 .Op Fl F Ar response-script
3542 Merge staged changes back into the work tree and put affected paths
3543 back into non-staged status.
3546 is specified, unstage all staged changes across the entire work tree.
3547 Otherwise, unstage changes at or within the specified paths.
3549 Show the status of each affected file, using the following status codes:
3550 .Bl -column YXZ description
3551 .It G Ta file was unstaged
3552 .It C Ta file was unstaged and conflicts occurred during merge
3553 .It ! Ta changes destined for a missing file were not merged
3554 .It D Ta file was staged as deleted and still is deleted
3555 .It d Ta file's deletion was prevented by local modifications
3556 .It \(a~ Ta changes destined for a non-regular file were not merged
3563 .It Fl F Ar response-script
3571 responses line-by-line from the specified
3573 file instead of prompting interactively.
3575 Instead of unstaging the entire content of a changed file, interactively
3576 select or reject changes for unstaging based on
3580 (keep change staged), and
3582 (quit unstaging this file) responses.
3583 If a file is staged in modified status, individual patches derived from the
3584 staged file content can be unstaged.
3585 Files staged in added or deleted status may only be unstaged in their entirety.
3591 .Op Fl r Ar repository-path
3594 Parse and print contents of objects to standard output in a line-based
3596 Content of commit, tree, and tag objects is printed in a way similar
3597 to the actual content stored in such objects.
3598 Blob object contents are printed as they would appear in files on disk.
3600 Attempt to interpret each argument as a reference, a tag name, or
3601 an object ID SHA1 hash.
3602 References will be resolved to an object ID.
3603 Tag names will resolved to a tag object.
3604 An abbreviated hash argument will be expanded to a full SHA1 hash
3605 automatically, provided the abbreviation is unique.
3607 If none of the above interpretations produce a valid result, or if the
3609 option is used, attempt to interpret the argument as a path which will
3610 be resolved to the ID of an object found at this path in the repository.
3617 Look up paths in the specified
3619 If this option is not used, paths are looked up in the commit resolved
3620 via the repository's HEAD reference.
3622 The expected argument is a commit ID SHA1 hash, or a reference name
3623 or keyword which will be resolved to a commit ID.
3624 An abbreviated hash argument will be expanded to a full SHA1 hash
3625 automatically, provided the abbreviation is unique.
3630 resolve to the work tree's base commit and branch head, respectively.
3631 The former is only valid if invoked in a work tree, while the latter will
3632 resolve to the tip of the work tree's current branch if invoked in a
3633 work tree, otherwise it will resolve to the repository's HEAD reference.
3634 Keywords and references may be appended with
3638 modifiers and an optional integer N to denote the
3639 Nth descendant or antecedent by first parent traversal, respectively;
3642 denotes the work tree branch head's 2nd generation ancestor, and
3644 denotes the 4th generation descendant of the work tree's base commit.
3647 will denote the 8th generation ancestor of the commit resolved by the
3654 modifier without a trailing integer has an implicit
3663 Interpret all arguments as paths only.
3664 This option can be used to resolve ambiguity in cases where paths
3665 look like tag names, reference names, or object IDs.
3666 .It Fl r Ar repository-path
3667 Use the repository at the specified path.
3668 If not specified, assume the repository is located at or above the current
3670 If this directory is a
3672 work tree, use the repository path associated with this work tree.
3674 .It Cm info Op Ar path ...
3675 Display meta-data stored in a work tree.
3680 The work tree to use is resolved implicitly by walking upwards from the
3681 current working directory.
3685 arguments are specified, show additional per-file information for tracked
3686 files located at or within these paths.
3689 argument corresponds to the work tree's root directory, display information
3690 for all tracked files.
3693 .Bl -tag -width GOT_IGNORE_GITCONFIG
3695 The author's name and email address, such as
3696 .Dq An Flan Hacker Aq Mt flan_hacker@openbsd.org .
3707 may fail to parse commits without an email address in author data,
3711 environment variables with a missing email address.
3713 .Ev GOT_AUTHOR will be overridden by configuration settings in
3719 configuration settings in the repository's
3726 configuration settings contained in Git's global
3728 configuration file will only be used if neither
3732 environment variable provide author information.
3733 .It Ev GOT_IGNORE_GITCONFIG
3734 If this variable is set then any remote repository definitions or author
3735 information found in Git configuration files will be ignored.
3736 .It Ev GOT_LOG_DEFAULT_LIMIT
3737 The default limit on the number of commits traversed by
3739 If set to zero, the limit is unbounded.
3740 This variable will be silently ignored if it is set to a non-numeric value.
3741 .It Ev VISUAL , EDITOR
3742 The editor spawned by
3750 text editor will be spawned.
3753 .Bl -tag -width packed-refs -compact
3755 Repository-wide configuration settings for
3759 configuration file located in the root directory of a Git repository
3760 supersedes any relevant settings in Git's
3764 .It Pa .got/got.conf
3765 Worktree-specific configuration settings for
3769 configuration file in the
3771 meta-data directory of a work tree supersedes any relevant settings in
3774 configuration file and Git's
3781 Enable tab-completion of
3786 .Dl $ set -A complete_got_1 -- $(got -h 2>&1 | sed -n s/commands://p)
3788 Clone an existing Git repository for use with
3792 .Dl $ got clone ssh://git@github.com/openbsd/src.git
3794 Unfortunately, many of the popular Git hosting sites do not offer anonymous
3796 Such sites will require an account to be created, and a public SSH key to be
3797 uploaded to this account, before repository access via ssh:// URLs will work.
3799 Use of HTTP URLs currently requires
3803 .Dl $ git clone --bare https://github.com/openbsd/src.git
3805 Alternatively, for quick and dirty local testing of
3807 a new Git repository could be created and populated with files,
3808 e.g. from a temporary CVS checkout located at
3811 .Dl $ gotadmin init /var/git/src.git
3812 .Dl $ got import -r /var/git/src.git -I CVS -I obj /tmp/src
3814 Check out a work tree from the Git repository to /usr/src:
3816 .Dl $ got checkout /var/git/src.git /usr/src
3818 View local changes in a work tree directory:
3820 .Dl $ got diff | less
3822 In a work tree, display files in a potentially problematic state:
3824 .Dl $ got status -s 'C!~?'
3826 Interactively revert selected local changes in a work tree directory:
3828 .Dl $ got revert -p -R\ .
3830 In a work tree or a git repository directory, list all branch references:
3834 As above, but list the most recently modified branches only:
3836 .Dl $ got branch -lt | head
3838 In a work tree or a git repository directory, create a new branch called
3839 .Dq unified-buffer-cache
3840 which is forked off the
3844 .Dl $ got branch -c master unified-buffer-cache
3846 Switch an existing work tree to the branch
3847 .Dq unified-buffer-cache .
3848 Local changes in the work tree will be preserved and merged if necessary:
3850 .Dl $ got update -b unified-buffer-cache
3852 Create a new commit from local changes in a work tree directory.
3853 This new commit will become the head commit of the work tree's current branch:
3857 In a work tree or a git repository directory, view changes committed in
3858 the 3 most recent commits to the work tree's branch, or the branch resolved
3859 via the repository's HEAD reference, respectively:
3861 .Dl $ got log -p -l 3
3863 As above, but display changes in the order in which
3865 could apply them in sequence:
3867 .Dl $ got log -p -l 3 -R
3869 In a work tree or a git repository directory, log the history of a subdirectory:
3871 .Dl $ got log sys/uvm
3873 While operating inside a work tree, paths are specified relative to the current
3874 working directory, so this command will log the subdirectory
3877 .Dl $ cd sys/uvm && got log\ .
3879 And this command has the same effect:
3881 .Dl $ cd sys/dev/usb && got log ../../uvm
3883 And this command displays work tree meta-data about all tracked files:
3886 .Dl $ got info\ . | less
3888 Add new files and remove obsolete files in a work tree directory:
3890 .Dl $ got add sys/uvm/uvm_ubc.c
3891 .Dl $ got remove sys/uvm/uvm_vnode.c
3893 Create a new commit from local changes in a work tree directory
3894 with a pre-defined log message.
3896 .Dl $ got commit -m 'unify the buffer cache'
3898 Alternatively, create a new commit from local changes in a work tree
3899 directory with a log message that has been prepared in the file
3902 .Dl $ got commit -F /tmp/msg
3904 Update any work tree checked out from the
3905 .Dq unified-buffer-cache
3906 branch to the latest commit on this branch:
3910 Roll file content on the unified-buffer-cache branch back by one commit,
3911 and then fetch the rolled-back change into the work tree as a local change
3912 to be amended and perhaps committed again:
3914 .Dl $ got backout unified-buffer-cache
3915 .Dl $ got commit -m 'roll back previous'
3916 .Dl $ # now back out the previous backout :-)
3917 .Dl $ got backout unified-buffer-cache
3919 Fetch new changes on the remote repository's
3921 branch, making them visible on the local repository's
3928 In a repository created with a HTTP URL and
3929 .Cm git clone --bare
3932 command must be used instead:
3934 .Dl $ cd /var/git/src.git
3935 .Dl $ git fetch origin master:refs/remotes/origin/master
3939 branch to merge the new changes that are now visible on the
3944 .Dl $ got update -b origin/master
3945 .Dl $ got rebase master
3948 .Dq unified-buffer-cache
3949 branch on top of the new head commit of the
3953 .Dl $ got update -b master
3954 .Dl $ got rebase unified-buffer-cache
3956 Create a patch from all changes on the unified-buffer-cache branch.
3957 The patch can be mailed out for review and applied to
3961 .Dl $ got diff master unified-buffer-cache > /tmp/ubc.diff
3963 Edit the entire commit history of the
3964 .Dq unified-buffer-cache
3967 .Dl $ got update -b unified-buffer-cache
3968 .Dl $ got update -c master
3971 Before working against existing branches in a repository cloned with
3972 .Cm git clone --bare
3977 must be configured to map all references in the remote repository
3980 namespace of the local repository.
3981 This can be achieved by setting Git's
3982 .Pa remote.origin.fetch
3983 configuration variable to the value
3984 .Dq +refs/heads/*:refs/remotes/origin/*
3989 .Dl $ cd /var/git/repo
3990 .Dl $ git config remote.origin.fetch '+refs/heads/*:refs/remotes/origin/*'
3994 option must be disabled:
3996 .Dl $ cd /var/git/repo
3997 .Dl $ git config remote.origin.mirror false
3999 Alternatively, the following
4001 configuration item can be added manually to the Git repository's
4005 .Dl [remote \&"origin\&"]
4007 .Dl fetch = +refs/heads/*:refs/remotes/origin/*
4010 This configuration leaves the local repository's
4012 namespace free for use by local branches checked out with
4014 and, if needed, created with
4017 .Dq refs/remotes/origin
4018 namespace can now be updated with incoming changes from the remote
4023 without extra command line arguments.
4024 Newly fetched changes can be examined with
4027 Display changes on the remote repository's version of the
4029 branch, as of the last time
4033 .Dl $ got log -c origin/master | less
4035 As shown here, most commands accept abbreviated reference names such as
4038 .Dq refs/remotes/origin/master .
4039 The latter is only needed in case of ambiguity.
4042 can be used to merge changes which are visible on the
4047 This will also merge local changes, if any, with the incoming changes:
4049 .Dl $ got update -b origin/master
4050 .Dl $ got rebase master
4052 In order to make changes committed to the
4053 .Dq unified-buffer-cache
4057 .Dq unified-buffer-cache
4058 branch can be rebased onto the
4062 .Dl $ got update -b master
4063 .Dl $ got rebase unified-buffer-cache
4066 .Dq unified-buffer-cache
4067 branch can now be made visible on the
4071 Because the rebase operation switched the work tree to the
4072 .Dq unified-buffer-cache
4073 branch, the work tree must be switched back to the
4077 .Dl $ got update -b master
4078 .Dl $ got integrate unified-buffer-cache
4082 branch, log messages for local changes can now be amended with
4084 by other developers and any other important new information:
4086 .Dl $ got update -c origin/master
4087 .Dl $ got histedit -m
4089 If the remote repository offers write access, local changes on the
4091 branch can be sent to the remote repository with
4095 can be run without further arguments.
4096 The arguments shown here match defaults, provided the work tree's
4097 current branch is the
4101 .Dl $ got send -b master origin
4103 If the remote repository requires the HTTPS protocol, the
4105 command must be used instead:
4107 .Dl $ cd /var/git/src.git
4108 .Dl $ git push origin master
4110 When making contributions to projects which use the
4112 workflow, SSH protocol repository access needs to be set up first.
4113 Once an account has been created on a Git hosting site it should
4114 be possible to upload a public SSH key for repository access
4119 workflow will usually involve two remote repositories.
4120 In the real-life example below, the
4122 repository was forked from the
4124 repository by using the Git hosting site's web interface.
4127 file in the local repository describes both remote repositories:
4128 .Bd -literal -offset indent
4129 # Jelmers's repository, which accepts pull requests
4131 server git@github.com
4133 repository "/jelmer/dulwich"
4137 # Stefan's fork, used as the default remote repository
4139 server git@github.com
4141 repository "/stspdotname/dulwich"
4146 With this configuration, Stefan can create commits on
4147 .Dq refs/heads/master
4148 and send them to the
4150 repository by running:
4152 .Dl $ got send -b master origin
4154 The changes can now be proposed to Jelmer by opening a pull request
4155 via the Git hosting site's web interface.
4156 If Jelmer requests further changes to be made, additional commits
4157 can be created on the
4159 branch and be added to the pull request by running
4163 If Jelmer prefers additional commits to be
4165 then the following commands can be used to achieve this:
4167 .Dl $ got update -b master
4168 .Dl $ got update -c origin/master
4169 .Dl $ got histedit -f
4170 .Dl $ got send -f -b master origin
4172 In addition to reviewing the pull request in the web user interface,
4173 Jelmer can fetch the pull request's branch into his local repository
4174 and create a local branch which contains the proposed changes:
4176 .Dl $ got fetch -R refs/pull/1046/head origin
4177 .Dl $ got branch -c refs/remotes/origin/pull/1046/head pr1046
4179 Once Jelmer has accepted the pull request, Stefan can fetch the
4180 merged changes, and possibly several other new changes, by running:
4182 .Dl $ got fetch upstream
4184 The merged changes will now be visible under the reference
4185 .Dq refs/remotes/upstream/master .
4188 branch can now be rebased on top of the latest changes
4191 .Dl $ got update -b upstream/master
4192 .Dl $ got rebase master
4194 As an alternative to
4196 branches can be merged with
4199 .Dl $ got update -b master
4200 .Dl $ got merge upstream/master
4202 The question of whether to rebase or merge branches is philosophical.
4203 When in doubt, refer to the software project's policies set by project
4206 As a final step, the forked repository's copy of the master branch needs
4207 to be kept in sync by sending the new changes there:
4209 .Dl $ got send -f -b master origin
4211 If multiple pull requests need to be managed in parallel, a separate branch
4212 must be created for each pull request with
4214 Each such branch can then be used as above, in place of
4215 .Dq refs/heads/master .
4216 Changes for any accepted pull requests will still appear under
4217 .Dq refs/remotes/upstream/master,
4218 regardless of which branch was used in the forked repository to
4219 create a pull request.
4223 .Xr git-repository 5 ,
4224 .Xr got-worktree 5 ,
4228 .An Anthony J. Bentley Aq Mt bentley@openbsd.org
4229 .An Christian Weisgerber Aq Mt naddy@openbsd.org
4230 .An Hiltjo Posthuma Aq Mt hiltjo@codemadness.org
4231 .An Josh Rickmar Aq Mt jrick@zettaport.com
4232 .An Joshua Stein Aq Mt jcs@openbsd.org
4233 .An Klemens Nanni Aq Mt kn@openbsd.org
4234 .An Martin Pieuchot Aq Mt mpi@openbsd.org
4235 .An Neels Hofmeyr Aq Mt neels@hofmeyr.de
4236 .An Omar Polo Aq Mt op@openbsd.org
4237 .An Ori Bernstein Aq Mt ori@openbsd.org
4238 .An Sebastien Marie Aq Mt semarie@openbsd.org
4239 .An Stefan Sperling Aq Mt stsp@openbsd.org
4240 .An Steven McDonald Aq Mt steven@steven-mcdonald.id.au
4241 .An Theo Buehler Aq Mt tb@openbsd.org
4242 .An Thomas Adam Aq Mt thomas@xteddy.org
4243 .An Tracey Emery Aq Mt tracey@traceyemery.net
4244 .An Yang Zhong Aq Mt yzhong@freebsdfoundation.org
4251 were derived from code under copyright by:
4253 .An Caldera International
4254 .An Daniel Hartmeier
4259 .An Jean-Francois Brousseau
4265 .An Niklas Hallqvist
4270 .An Xavier Santolaria
4273 contains code contributed to the public domain by
4274 .An Austin Appleby .
4277 is a work-in-progress and some features remain to be implemented.
4279 At present, the user has to fall back on
4281 to perform some tasks.
4285 Reading from remote repositories over HTTP or HTTPS protocols requires
4290 Writing to remote repositories over HTTP or HTTPS protocols requires
4293 The creation of merge commits with more than two parent commits requires
4296 In situations where files or directories were moved around
4298 will not automatically merge changes to new locations and
4300 will usually produce better results.
