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 and the base commit of all tracked files
1570 matches the branch tip
1571 .It \(a~ Ta work tree comprises mixed commits or its base commit is out-of-date
1574 Do not switch and update the work tree after creating a new branch.
1575 .It Fl r Ar repository-path
1576 Use the repository at the specified path.
1577 If not specified, assume the repository is located at or above the current
1579 If this directory is a
1581 work tree, use the repository path associated with this work tree.
1583 Sort listed branches by modification time (most recently modified first)
1584 instead of sorting by lexicographical order.
1587 reference namespace are listed before branches in
1590 Use of this option requires the
1592 option to be used as well.
1599 .Op Fl r Ar repository-path
1600 .Op Fl s Ar signer-id
1603 Manage tags in a repository.
1605 Tags are managed via references which live in the
1607 reference namespace.
1610 command operates on references in this namespace only.
1611 References in this namespace point at tag objects which contain a pointer
1612 to another object, a tag message, as well as author and timestamp information.
1614 Attempt to create a tag with the given
1616 and make this tag point at the given
1618 If no commit is specified, default to the latest commit on the work tree's
1619 current branch if invoked in a work tree, and to a commit resolved via
1620 the repository's HEAD reference otherwise.
1627 Make the newly created tag reference point at the specified
1631 argument is a commit ID SHA1 hash, or a reference or keyword
1632 which will be resolved to a commit ID.
1633 An abbreviated hash argument will be expanded to a full SHA1 hash
1634 automatically, provided the abbreviation is unique.
1639 resolve to the work tree's base commit and branch head, respectively.
1640 The former is only valid if invoked in a work tree, while the latter will
1641 resolve to the tip of the work tree's current branch if invoked in a
1642 work tree, otherwise it will resolve to the repository's HEAD reference.
1643 Keywords and references may be appended with
1647 modifiers and an optional integer N to denote the
1648 Nth descendant or antecedent by first parent traversal, respectively;
1651 denotes the work tree branch head's 2nd generation ancestor, and
1653 denotes the 4th generation descendant of the work tree's base commit.
1656 will denote the 3rd generation ancestor of the commit resolved by the
1663 modifier without a trailing integer has an implicit
1672 List all existing tags in the repository instead of creating a new tag.
1675 argument is passed, show only the tag with the given
1678 Use the specified tag message when creating the new tag.
1683 opens a temporary file in an editor where a tag message can be written.
1684 Quitting the editor without saving the file will abort the tag operation.
1685 .It Fl r Ar repository-path
1686 Use the repository at the specified path.
1687 If not specified, assume the repository is located at or above the current
1689 If this directory is a
1691 work tree, use the repository path associated with this work tree.
1692 .It Fl s Ar signer-id
1693 While creating a new tag, sign this tag with the identity given in
1696 For SSH-based signatures,
1698 is the path to a file which may refer to either a private SSH key,
1699 or a public SSH key with the private half available via
1702 will sign the tag object by invoking
1706 command, using the signature namespace
1708 for compatibility with
1711 Verify tag object signatures.
1714 is specified, show and verify the tag object with the provided name.
1715 Otherwise, list all tag objects and verify signatures where present.
1718 verifies SSH-based signatures by invoking
1721 .Fl Y Cm verify Fl f Ar allowed_signers .
1726 otherwise verification is impossible.
1729 During SSH signature creation and verification this option will be passed to
1731 Multiple -v options increase the verbosity.
1737 command will not delete tags or change existing tags.
1738 If a tag must be deleted, the
1740 command may be used to delete a tag's reference.
1741 This should only be done if the tag has not already been copied to
1748 Schedule unversioned files in a work tree for addition to the
1749 repository in the next commit.
1750 By default, files which match a
1752 ignore pattern will not be added.
1756 mentioned in the command line is not an unversioned file then
1759 To avoid unnecessary errors from paths picked up by file globbing patterns
1760 in the shell, paths in the argument list will be silently ignored if they
1763 at all, or if they are reported with one of the following status codes
1764 and do not have changes staged via
1766 .Bl -column YXZ description
1767 .It M Ta modified file
1768 .It A Ta file scheduled for addition in next commit
1769 .It C Ta modified or added file which contains merge conflicts
1770 .It m Ta modified file modes (executable bit only)
1778 Add files even if they match a
1782 Permit recursion into directories.
1783 If this option is not specified,
1785 will refuse to run if a specified
1793 .Op Fl s Ar status-codes
1797 Remove versioned files from a work tree and schedule them for deletion
1798 from the repository in the next commit.
1805 Perform the operation even if a file contains local modifications,
1806 and do not raise an error if a specified
1808 does not exist on disk.
1810 Keep affected files on disk.
1812 Permit recursion into directories.
1813 If this option is not specified,
1815 will refuse to run if a specified
1818 .It Fl s Ar status-codes
1819 Only delete files with a modification status matching one of the
1820 single-character status codes contained in the
1823 The following status codes may be specified:
1824 .Bl -column YXZ description
1825 .It M Ta modified file (this implies the
1828 .It ! Ta versioned file expected on disk but missing
1836 .Op Fl p Ar strip-count
1842 to files in a work tree.
1843 Files added or removed by a patch will be scheduled for addition or removal in
1846 The patch must be in the unified diff format as produced by
1853 diff when invoked with their
1858 argument is provided, read unified diff data from standard input instead.
1862 contains multiple patches, then attempt to apply each of them in sequence.
1864 Show the status of each affected file, using the following status codes:
1865 .Bl -column XYZ description
1866 .It M Ta file was modified
1867 .It G Ta file was merged using a merge-base found in the repository
1868 .It C Ta file was merged and conflicts occurred during merge
1869 .It D Ta file was deleted
1870 .It A Ta file was added
1871 .It # Ta failed to patch the file
1874 If a change does not match at its exact line number, attempt to
1875 apply it somewhere else in the file if a good spot can be found.
1876 Otherwise, the patch will fail to apply.
1880 will refuse to apply a patch if certain preconditions are not met.
1881 Files to be deleted must already be under version control, and must
1882 not have been scheduled for deletion already.
1883 Files to be added must not yet be under version control and must not
1884 already be present on disk.
1885 Files to be modified must already be under version control and may not
1886 contain conflict markers.
1888 If an error occurs, the
1890 operation will be aborted.
1891 Any changes made to the work tree up to this point will be left behind.
1892 Such changes can be viewed with
1894 and can be reverted with
1903 Attempt to locate files within the specified
1905 for use as a merge-base for 3-way merges.
1909 option is not used then
1911 will attempt to locate merge-bases via object IDs found in
1913 meta-data, such as produced by
1919 option is only recommended in the absence of such meta-data.
1921 Ideally, the specified
1923 should contain versions of files which the changes contained in the
1926 Files will be located by path, relative to the repository root.
1929 option is used then leading path components will be stripped
1930 before paths are looked up in the repository.
1932 In case no merge-base is available for a file, changes will be applied
1933 without doing a 3-way merge.
1934 Changes which do not apply cleanly may then be rejected entirely, rather
1935 than producing merge conflicts in the patched target file.
1939 argument is a commit ID SHA1 hash, or a reference name or a keyword
1940 which will be resolved to a commit ID.
1941 An abbreviated hash argument will be expanded to a full SHA1 hash
1942 automatically, provided the abbreviation is unique.
1947 resolve to the work tree's base commit and branch head, respectively.
1948 Keywords and references may be appended with
1952 modifiers and an optional integer N to denote the
1953 Nth descendant or antecedent by first parent traversal, respectively;
1956 denotes the work tree branch head's 2nd generation ancestor, and
1958 denotes the 4th generation descendant of the work tree's base commit.
1961 will denote the 3rd generation descendant of the commit resolved by the
1968 modifier without a trailing integer has an implicit
1977 Do not make any modifications to the work tree.
1978 This can be used to check whether a patch would apply without issues.
1981 contains diffs that affect the same file multiple times, the results
1982 displayed may be incorrect.
1983 .It Fl p Ar strip-count
1984 Specify the number of leading path components to strip from paths
1993 path prefixes generated by
1995 will be recognized and stripped automatically.
1997 Reverse the patch before applying it.
2003 .Op Fl F Ar response-script
2007 Revert any local changes in files at the specified paths in a work tree.
2008 File contents will be overwritten with those contained in the
2009 work tree's base commit.
2010 There is no way to bring discarded changes back after
2013 If a file was added with
2015 it will become an unversioned file again.
2016 If a file was deleted with
2018 it will be restored.
2024 .It Fl F Ar response-script
2032 responses line-by-line from the specified
2034 file instead of prompting interactively.
2036 Instead of reverting all changes in files, interactively select or reject
2037 changes to revert based on
2043 (quit reverting this file) responses.
2044 If a file is in modified status, individual patches derived from the
2045 modified file content can be reverted.
2046 Files in added or deleted status may only be reverted in their entirety.
2048 Permit recursion into directories.
2049 If this option is not specified,
2051 will refuse to run if a specified
2065 Create a new commit in the repository from changes in a work tree
2066 and use this commit as the new base commit for the work tree.
2069 is specified, commit all changes in the work tree.
2070 Otherwise, commit changes at or within the specified paths.
2072 If changes have been explicitly staged for commit with
2074 only commit staged changes and reject any specified paths which
2075 have not been staged.
2078 opens a temporary file in an editor where a log message can be written
2086 options are used together.
2087 Quitting the editor without saving the file will abort the commit operation.
2089 Show the status of each affected file, using the following status codes:
2090 .Bl -column YXZ description
2091 .It M Ta modified file
2092 .It D Ta file was deleted
2093 .It A Ta new file was added
2094 .It m Ta modified file modes (executable bit only)
2097 Files which are not part of the new commit will retain their previously
2098 recorded base commit.
2101 commands may refuse to run while the work tree contains files from
2102 multiple base commits.
2103 The base commit of such a work tree can be made consistent by running
2105 across the entire work tree.
2109 command requires the
2111 environment variable to be set,
2112 unless an author has been configured in
2118 configuration settings can be
2119 obtained from the repository's
2121 file or from Git's global
2130 Set author information in the newly created commit to
2132 This is useful when committing changes on behalf of someone else.
2135 argument must use the same format as the
2137 environment variable.
2139 In addition to storing author information, the newly created commit
2142 information which is obtained, as usual, from the
2144 environment variable, or
2146 or Git configuration settings.
2148 Allow committing files in conflicted status.
2150 Committing files with conflict markers should generally be avoided.
2151 Cases where conflict markers must be stored in the repository for
2152 some legitimate reason should be very rare.
2153 There are usually ways to avoid storing conflict markers verbatim by
2154 applying appropriate programming tricks.
2156 Use the prepared log message stored in the file found at
2158 when creating the new commit.
2160 opens a temporary file in an editor where the prepared log message can be
2161 reviewed and edited further if needed.
2162 Cannot be used together with the
2166 Use the specified log message when creating the new commit.
2167 Cannot be used together with the
2171 This option prevents
2173 from opening the commit message in an editor.
2174 It has no effect unless it is used together with the
2176 option and is intended for non-interactive use such as scripting.
2178 This option prevents
2180 from generating a diff of the to-be-committed changes in a temporary file
2181 which can be viewed while editing a commit message.
2183 Allow the addition of symbolic links which point outside of the path space
2184 that is under version control.
2187 will reject such symbolic links due to safety concerns.
2190 may decide to represent such a symbolic link as a regular file which contains
2191 the link's target path, rather than creating an actual symbolic link which
2192 points outside of the work tree.
2193 Use of this option is discouraged because external mechanisms such as
2195 are better suited for managing symbolic links to paths not under
2200 will refuse to run if certain preconditions are not met.
2201 If the work tree's current branch is not in the
2203 reference namespace, new commits may not be created on this branch.
2204 Local changes may only be committed if they are based on file content
2205 found in the most recent commit on the work tree's branch.
2206 If a path is found to be out of date,
2208 must be used first in order to merge local changes with changes made
2216 .Op Fl r Ar repository-path
2218 .Op Ar remote-repository
2221 Send new changes to a remote repository.
2223 .Ar remote-repository
2227 The remote repository's URL is obtained from the corresponding entry in
2231 file of the local repository, as created by
2234 All objects corresponding to new changes will be written to a temporary
2235 pack file which is then uploaded to the server.
2236 Upon success, references in the
2238 reference namespace of the local repository will be updated to point at
2239 the commits which have been sent.
2241 By default, changes will only be sent if they are based on up-to-date
2242 copies of relevant branches in the remote repository.
2243 If any changes to be sent are based on out-of-date copies or would
2244 otherwise break linear history of existing branches, new changes must
2245 be fetched from the server with
2247 and local branches must be rebased with
2254 option can be used to make exceptions to these requirements.
2261 Send all branches from the local repository's
2263 reference namespace.
2266 option is equivalent to listing all branches with multiple
2269 Cannot be used together with the
2275 from the local repository's
2277 reference namespace.
2278 This option may be specified multiple times to build a list of branches
2280 If this option is not specified, default to the work tree's current branch
2281 if invoked in a work tree, or to the repository's HEAD reference.
2282 Cannot be used together with the
2286 Delete the specified
2288 from the remote repository's
2290 reference namespace.
2291 This option may be specified multiple times to build a list of branches
2294 Only references are deleted.
2295 Any commit, tree, tag, and blob objects belonging to deleted branches
2296 may become subject to deletion by Git's garbage collector running on
2299 Requesting deletion of branches results in an error if the server
2300 does not support this feature or disallows the deletion of branches
2301 based on its configuration.
2303 Attempt to force the server to overwrite existing branches or tags
2304 in the remote repository, even when
2310 would usually be required before changes can be sent.
2311 The server may reject forced requests regardless, depending on its
2314 Any commit, tree, tag, and blob objects belonging to overwritten branches
2315 or tags may become subject to deletion by Git's garbage collector running
2320 reference namespace is globally shared between all repositories.
2323 option to overwrite tags is discouraged because it can lead to
2324 inconsistencies between the tags present in different repositories.
2325 In general, creating a new tag with a different name is recommended
2326 instead of overwriting an existing tag.
2330 option is particularly discouraged if changes being sent are based
2331 on an out-of-date copy of a branch in the remote repository.
2332 Instead of using the
2334 option, new changes should
2337 and local branches should be rebased with
2341 followed by another attempt to send the changes.
2345 option should only be needed in situations where the remote repository's
2346 copy of a branch or tag is known to be out-of-date and is considered
2348 The risks of creating inconsistencies between different repositories
2349 should also be taken into account.
2351 Suppress progress reporting output.
2352 The same option will be passed to
2355 .It Fl r Ar repository-path
2356 Use the repository at the specified path.
2357 If not specified, assume the repository is located at or above the current
2359 If this directory is a
2361 work tree, use the repository path associated with this work tree.
2363 Attempt to send all tags from the local repository's
2365 reference namespace.
2368 option is equivalent to listing all tags with multiple
2371 Cannot be used together with the
2377 from the local repository's
2379 reference namespace, in addition to any branches that are being sent.
2382 option may be specified multiple times to build a list of tags to send.
2383 No tags will be sent if the
2387 Raise an error if the specified
2389 already exists in the remote repository, unless the
2391 option is used to overwrite the server's copy of the tag.
2392 In general, creating a new tag with a different name is recommended
2393 instead of overwriting an existing tag.
2395 Cannot be used together with the
2402 to print debugging messages to standard error output.
2403 The same option will be passed to
2406 Multiple -v options increase the verbosity.
2416 Merge changes from a single
2421 should be on a different branch than the work tree's base commit.
2423 The expected argument is a commit ID SHA1 hash, or a reference name or
2424 keyword which will be resolved to a commit ID.
2425 An abbreviated hash argument will be expanded to a full SHA1 hash
2426 automatically, provided the abbreviation is unique.
2431 resolve to the work tree's base commit and branch head, respectively.
2432 Keywords and references may be appended with
2436 modifiers and an optional integer N to denote the
2437 Nth descendant or antecedent by first parent traversal, respectively;
2440 denotes the work tree branch head's 2nd generation ancestor, and
2442 denotes the 4th generation descendant of the work tree's base commit.
2445 will denote the 3rd generation descendant of the commit resolved by the
2452 modifier without a trailing integer has an implicit
2461 Show the status of each affected file, using the following status codes:
2462 .Bl -column YXZ description
2463 .It G Ta file was merged
2464 .It C Ta file was merged and conflicts occurred during merge
2465 .It ! Ta changes destined for a missing file were not merged
2466 .It D Ta file was deleted
2467 .It d Ta file's deletion was prevented by local modifications
2468 .It A Ta new file was added
2469 .It \(a~ Ta changes destined for a non-regular file were not merged
2470 .It ? Ta changes destined for an unversioned file were not merged
2473 The merged changes will appear as local changes in the work tree, which
2476 amended manually or with further
2482 If invoked in a work tree where no
2487 operation is taking place,
2489 creates a record of commits which have been merged into the work tree.
2490 When a file changed by
2494 the log messages of relevant merged commits will then appear in the editor,
2495 where the messages should be further adjusted to convey the reasons for
2496 cherrypicking the changes.
2497 Upon exiting the editor, if the time stamp of the log message file
2498 is unchanged or the log message is empty,
2500 will fail with an unmodified or empty log message error.
2502 If all the changes in all files touched by a given commit are discarded,
2505 this commit's log message record will also disappear.
2508 will refuse to run if certain preconditions are not met.
2509 If the work tree contains multiple base commits, it must first be updated
2510 to a single base commit with
2512 If any relevant files already contain merge conflicts, these
2513 conflicts must be resolved first.
2521 Display a list of commit log messages recorded by cherrypick operations,
2522 represented by references in the
2523 .Dq refs/got/worktree
2524 reference namespace.
2527 is specified, only show the log message of the specified commit.
2529 If invoked in a work tree, only log messages recorded by cherrypick operations
2530 in the current work tree will be displayed.
2531 Otherwise, all commit log messages will be displayed irrespective of the
2532 work tree in which they were created.
2533 This option cannot be used with
2536 Delete log messages created by previous cherrypick operations, represented by
2538 .Dq refs/got/worktree
2539 reference namespace.
2542 is specified, only delete the log message of the specified commit.
2544 If invoked in a work tree, only log messages recorded by cherrypick operations
2545 in the current work tree will be deleted.
2546 Otherwise, all commit log messages will be deleted irrespective of the
2547 work tree in which they were created.
2548 This option cannot be used with
2559 Reverse-merge changes from a single
2564 should be on the same branch as the work tree's base commit.
2566 The expected argument is a commit ID SHA1 hash, or a reference name
2567 or keyword which will be resolved to a commit ID.
2568 An abbreviated hash argument will be expanded to a full SHA1 hash
2569 automatically, provided the abbreviation is unique.
2574 resolve to the work tree's base commit and branch head, respectively.
2575 Keywords and references may be appended with
2579 modifiers and an optional integer N to denote the
2580 Nth descendant or antecedent by first parent traversal, respectively;
2583 denotes the work tree branch head's 2nd generation ancestor, and
2585 denotes the 4th generation descendant of the work tree's base commit.
2588 will denote the 5th generation descendant of the commit resolved by the
2595 modifier without a trailing integer has an implicit
2604 Show the status of each affected file, using the following status codes:
2605 .Bl -column YXZ description
2606 .It G Ta file was merged
2607 .It C Ta file was merged and conflicts occurred during merge
2608 .It ! Ta changes destined for a missing file were not merged
2609 .It D Ta file was deleted
2610 .It d Ta file's deletion was prevented by local modifications
2611 .It A Ta new file was added
2612 .It \(a~ Ta changes destined for a non-regular file were not merged
2613 .It ? Ta changes destined for an unversioned file were not merged
2616 The reverse-merged changes will appear as local changes in the work tree,
2617 which may be viewed with
2619 amended manually or with further
2625 If invoked in a work tree where no
2630 operation is taking place,
2632 creates a record of commits which have been reverse-merged into the work tree.
2633 When a file changed by
2637 the log messages of relevant reverse-merged commits will then appear in
2638 the editor, where the messages should be further adjusted to convey the
2639 reasons for backing out the changes.
2640 Upon exiting the editor, if the time stamp of the log message file
2641 is unchanged or the log message is empty,
2643 will fail with an unmodified or empty log message error.
2645 If all the changes in all files touched by a given commit are discarded,
2648 this commit's log message record will also disappear.
2651 will refuse to run if certain preconditions are not met.
2652 If the work tree contains multiple base commits, it must first be updated
2653 to a single base commit with
2655 If any relevant files already contain merge conflicts, these
2656 conflicts must be resolved first.
2664 Display a list of commit log messages recorded by backout operations,
2665 represented by references in the
2666 .Dq refs/got/worktree
2667 reference namespace.
2670 is specified, only show the log message of the specified commit.
2672 If invoked in a work tree, only log messages recorded by backout operations
2673 in the current work tree will be displayed.
2674 Otherwise, all commit log messages will be displayed irrespective of the
2675 work tree in which they were created.
2676 This option cannot be used with
2679 Delete log messages created by previous backout operations, represented by
2681 .Dq refs/got/worktree
2682 reference namespace.
2685 is specified, only delete the log message of the specified commit.
2687 If invoked in a work tree, only log messages recorded by backout operations
2688 in the current work tree will be deleted.
2689 Otherwise, all commit log messages will be deleted irrespective of the
2690 work tree in which they were created.
2691 This option cannot be used with
2702 Rebase commits on the specified
2704 onto the tip of the current branch of the work tree.
2707 must share common ancestry with the work tree's current branch.
2708 Rebasing begins with the first descendant commit of the youngest
2709 common ancestor commit shared by the specified
2711 and the work tree's current branch, and stops once the tip commit
2718 is used as intended, the specified
2720 represents a local commit history and may already contain changes
2721 that are not yet visible in any other repositories.
2722 The work tree's current branch, which must be set with
2726 operation, represents a branch from a remote repository which shares
2727 a common history with the specified
2729 but has progressed, and perhaps diverged, due to commits added to the
2732 Rebased commits are accumulated on a temporary branch which the work tree
2733 will remain switched to throughout the entire rebase operation.
2734 Commits on this branch represent the same changes with the same log
2735 messages as their counterparts on the original
2737 but with different commit IDs.
2738 Once rebasing has completed successfully, the temporary branch becomes
2739 the new version of the specified
2741 and the work tree is automatically switched to it.
2742 If author information is available via the
2744 environment variable,
2750 configuration settings, this author information will be used to identify
2755 Old commits in their pre-rebase state are automatically backed up in the
2756 .Dq refs/got/backup/rebase
2757 reference namespace.
2758 As long as these references are not removed older versions of rebased
2759 commits will remain in the repository and can be viewed with the
2762 Removal of these references makes objects which become unreachable via
2763 any reference subject to removal by Git's garbage collector or
2764 .Cm gotadmin cleanup .
2766 While rebasing commits, show the status of each affected file,
2767 using the following status codes:
2768 .Bl -column YXZ description
2769 .It G Ta file was merged
2770 .It C Ta file was merged and conflicts occurred during merge
2771 .It ! Ta changes destined for a missing file were not merged
2772 .It D Ta file was deleted
2773 .It d Ta file's deletion was prevented by local modifications
2774 .It A Ta new file was added
2775 .It \(a~ Ta changes destined for a non-regular file were not merged
2776 .It ? Ta changes destined for an unversioned file were not merged
2779 If merge conflicts occur, the rebase operation is interrupted and may
2780 be continued once conflicts have been resolved.
2781 If any files with destined changes are found to be missing or unversioned,
2782 or if files could not be deleted due to differences in deleted content,
2783 the rebase operation will be interrupted to prevent potentially incomplete
2784 changes from being committed to the repository without user intervention.
2785 The work tree may be modified as desired and the rebase operation can be
2786 continued once the changes present in the work tree are considered complete.
2787 Alternatively, the rebase operation may be aborted which will leave
2789 unmodified and the work tree switched back to its original branch.
2791 If a merge conflict is resolved in a way which renders the merged
2792 change into a no-op change, the corresponding commit will be elided
2793 when the rebase operation continues.
2796 will refuse to run if certain preconditions are not met.
2801 reference namespace, the branch may not be rebased.
2802 If the work tree is not yet fully updated to the tip commit of its
2803 branch, then the work tree must first be updated with
2805 If changes have been staged with
2807 these changes must first be committed with
2811 If the work tree contains local changes, these changes must first be
2818 contains changes to files outside of the work tree's path prefix,
2819 the work tree cannot be used to rebase this branch.
2828 commands will refuse to run while a rebase operation is in progress.
2829 Other commands which manipulate the work tree may be used for
2830 conflict resolution purposes.
2834 is already based on the work tree's current branch, then no commits
2835 need to be rebased and
2837 will simply switch the work tree to the specified
2839 and update files in the work tree accordingly.
2846 Abort an interrupted rebase operation.
2847 If this option is used, no other command-line arguments are allowed.
2849 Allow a rebase operation to continue with files in conflicted status.
2850 This option should generally be avoided, and can only be used with the
2854 Continue an interrupted rebase operation.
2855 If this option is used, no other command-line arguments are allowed except
2858 Show a list of past rebase operations, represented by references in the
2859 .Dq refs/got/backup/rebase
2860 reference namespace.
2862 Display the author, date, and log message of each backed up commit,
2863 the object ID of the corresponding post-rebase commit, and
2864 the object ID of their common ancestor commit.
2865 Given these object IDs,
2872 options can be used to examine the history of either version of the branch,
2877 option can be used to create a new branch from a pre-rebase state if desired.
2881 is specified, only show commits which at some point in time represented this
2883 Otherwise, list all backed up commits for any branches.
2885 If this option is used,
2887 does not require a work tree.
2888 None of the other options can be used together with
2891 Delete backups created by past rebase operations, represented by references
2893 .Dq refs/got/backup/rebase
2894 reference namespace.
2898 is specified, only delete backups which at some point in time represented
2900 Otherwise, delete all references found within
2901 .Dq refs/got/backup/rebase .
2903 Any commit, tree, tag, and blob objects belonging to deleted backups
2904 remain in the repository and may be removed separately with
2905 Git's garbage collector or
2906 .Cm gotadmin cleanup .
2908 If this option is used,
2910 does not require a work tree.
2911 None of the other options can be used together with
2918 .Op Fl F Ar histedit-script
2922 Edit commit history between the work tree's current base commit and
2923 the tip commit of the work tree's current branch.
2927 command requires the
2929 environment variable to be set,
2930 unless an author has been configured in
2936 configuration settings can be obtained from the repository's
2938 file or from Git's global
2944 operation, the work tree's current branch must be set with
2946 to the branch which should be edited, unless this branch is already the
2947 current branch of the work tree.
2948 The tip of this branch represents the upper bound (inclusive) of commits
2953 Furthermore, the work tree's base commit
2956 to a point in this branch's commit history where editing should begin.
2957 This commit represents the lower bound (non-inclusive) of commits touched
2962 Editing of commit history is controlled via a
2964 which can be written in an editor based on a template, passed on the
2965 command line, or generated with the
2972 Quitting the editor without saving the file will abort the histedit operation.
2974 The format of the histedit script is line-based.
2975 Each line in the script begins with a command name, followed by
2976 whitespace and an argument.
2977 For most commands, the expected argument is a commit ID SHA1 hash.
2978 Any remaining text on the line is ignored.
2979 Lines which begin with the
2981 character are ignored entirely.
2983 The available histedit script commands are as follows:
2984 .Bl -column YXZ pick-commit
2985 .It Cm pick Ar commit Ta Use the specified commit as it is.
2986 .It Cm edit Ar commit Ta Apply the changes from the specified commit, but
2987 then interrupt the histedit operation for amending, without creating a commit.
2988 While the histedit operation is interrupted arbitrary files may be edited,
2989 and commands which manipulate the work tree can be used freely.
2994 commands can be used to add new files or remove existing ones.
2997 command can be used to eliminate arbitrary changes from files in the work tree.
3000 command may be used to prepare a subset of changes for inclusion in the
3004 command can be used to insert arbitrary commits into the edited history.
3005 Regular editing of history must eventually be resumed by running
3006 .Cm got histedit -c .
3007 .It Cm fold Ar commit Ta Combine the specified commit with the next commit
3008 listed further below that will be used.
3009 .It Cm drop Ar commit Ta Remove this commit from the edited history.
3010 .It Cm mesg Oo Ar log-message Oc Ta Create a new log message for the commit of
3015 command on the previous line of the histedit script.
3018 argument provides a new single-line log message to use.
3021 argument is omitted, open an editor where a new log message can be written.
3024 Every commit in the history being edited must be mentioned in the script.
3025 Lines may be re-ordered to change the order of commits in the edited history.
3026 No commit may be listed more than once.
3028 Edited commits are accumulated on a temporary branch which the work tree
3029 will remain switched to throughout the entire histedit operation.
3030 Once history editing has completed successfully, the temporary branch becomes
3031 the new version of the work tree's branch and the work tree is automatically
3034 Old commits in their pre-histedit state are automatically backed up in the
3035 .Dq refs/got/backup/histedit
3036 reference namespace.
3037 As long as these references are not removed older versions of edited
3038 commits will remain in the repository and can be viewed with the
3041 Removal of these references makes objects which become unreachable via
3042 any reference subject to removal by Git's garbage collector or
3043 .Cm gotadmin cleanup .
3045 While merging commits, show the status of each affected file,
3046 using the following status codes:
3047 .Bl -column YXZ description
3048 .It G Ta file was merged
3049 .It C Ta file was merged and conflicts occurred during merge
3050 .It ! Ta changes destined for a missing file were not merged
3051 .It D Ta file was deleted
3052 .It d Ta file's deletion was prevented by local modifications
3053 .It A Ta new file was added
3054 .It \(a~ Ta changes destined for a non-regular file were not merged
3055 .It ? Ta changes destined for an unversioned file were not merged
3058 If merge conflicts occur, the histedit operation is interrupted and may
3059 be continued once conflicts have been resolved.
3060 If any files with destined changes are found to be missing or unversioned,
3061 or if files could not be deleted due to differences in deleted content,
3062 the histedit operation will be interrupted to prevent potentially incomplete
3063 changes from being committed to the repository without user intervention.
3064 The work tree may be modified as desired and the histedit operation can be
3065 continued once the changes present in the work tree are considered complete.
3066 Alternatively, the histedit operation may be aborted which will leave
3067 the work tree switched back to its original branch.
3069 If a merge conflict is resolved in a way which renders the merged
3070 change into a no-op change, the corresponding commit will be elided
3071 when the histedit operation continues.
3074 will refuse to run if certain preconditions are not met.
3075 If the work tree's current branch is not in the
3077 reference namespace, the history of the branch may not be edited.
3078 If the work tree contains multiple base commits, it must first be updated
3079 to a single base commit with
3081 If changes have been staged with
3083 these changes must first be committed with
3087 If the work tree contains local changes, these changes must first be
3092 If the edited history contains changes to files outside of the work tree's
3093 path prefix, the work tree cannot be used to edit the history of this branch.
3101 commands will refuse to run while a histedit operation is in progress.
3102 Other commands which manipulate the work tree may be used, and the
3104 command may be used to commit arbitrary changes to the temporary branch
3105 while the histedit operation is interrupted.
3112 Abort an interrupted histedit operation.
3113 If this option is used, no other command-line arguments are allowed.
3115 Allow a histedit operation to continue with files in conflicted status.
3116 This option should generally be avoided, and can only be used with the
3120 Continue an interrupted histedit operation.
3121 If this option is used, no other command-line arguments are allowed except
3125 This option is a quick equivalent to a histedit script which drops all
3129 option can only be used when starting a new histedit operation.
3130 If this option is used, no other command-line arguments are allowed.
3132 Interrupt the histedit operation for editing after merging each commit.
3133 This option is a quick equivalent to a histedit script which uses the
3135 command for all commits.
3138 option can only be used when starting a new histedit operation.
3139 If this option is used, no other command-line arguments are allowed.
3140 .It Fl F Ar histedit-script
3143 instead of opening a temporary file in an editor where a histedit script
3146 Fold all commits into a single commit.
3147 This option is a quick equivalent to a histedit script which folds all
3148 commits, combining them all into one commit.
3151 option can only be used when starting a new histedit operation.
3152 If this option is used, no other command-line arguments are allowed.
3154 Show a list of past histedit operations, represented by references in the
3155 .Dq refs/got/backup/histedit
3156 reference namespace.
3158 Display the author, date, and log message of each backed up commit,
3159 the object ID of the corresponding post-histedit commit, and
3160 the object ID of their common ancestor commit.
3161 Given these object IDs,
3168 options can be used to examine the history of either version of the branch,
3173 option can be used to create a new branch from a pre-histedit state if desired.
3177 is specified, only show commits which at some point in time represented this
3179 Otherwise, list all backed up commits for any branches.
3181 If this option is used,
3183 does not require a work tree.
3184 None of the other options can be used together with
3187 Edit log messages only.
3188 This option is a quick equivalent to a histedit script which edits
3189 only log messages but otherwise leaves every picked commit as-is.
3192 option can only be used when starting a new histedit operation.
3193 If this option is used, no other command-line arguments are allowed.
3195 Delete backups created by past histedit operations, represented by references
3197 .Dq refs/got/backup/histedit
3198 reference namespace.
3202 is specified, only delete backups which at some point in time represented
3204 Otherwise, delete all references found within
3205 .Dq refs/got/backup/histedit .
3207 Any commit, tree, tag, and blob objects belonging to deleted backups
3208 remain in the repository and may be removed separately with
3209 Git's garbage collector or
3210 .Cm gotadmin cleanup .
3212 If this option is used,
3214 does not require a work tree.
3215 None of the other options can be used together with
3219 .It Cm integrate Ar branch
3221 Integrate the specified
3223 into the work tree's current branch.
3224 Files in the work tree are updated to match the contents on the integrated
3226 and the reference of the work tree's branch is changed to point at the
3227 head commit of the integrated
3230 Both branches can be considered equivalent after integration since they
3231 will be pointing at the same commit.
3232 Both branches remain available for future work, if desired.
3233 In case the integrated
3235 is no longer needed it may be deleted with
3238 Show the status of each affected file, using the following status codes:
3239 .Bl -column YXZ description
3240 .It U Ta file was updated
3241 .It D Ta file was deleted
3242 .It A Ta new file was added
3243 .It \(a~ Ta versioned file is obstructed by a non-regular file
3244 .It ! Ta a missing versioned file was restored
3248 will refuse to run if certain preconditions are not met.
3249 Most importantly, the
3251 must have been rebased onto the work tree's current branch with
3253 before it can be integrated, in order to linearize commit history and
3254 resolve merge conflicts.
3255 If the work tree contains multiple base commits, it must first be updated
3256 to a single base commit with
3258 If changes have been staged with
3260 these changes must first be committed with
3264 If the work tree contains local changes, these changes must first be
3278 into the current branch of the work tree.
3279 If the branches have diverged, creates a merge commit.
3282 already includes all commits from the work tree's branch, updates the work
3283 tree's branch to be the same as
3285 without creating a commit, and updates the work tree to the most recent commit
3288 If a linear project history is desired, then use of
3290 should be preferred over
3292 However, even strictly linear projects may require merge commits in order
3293 to merge in new versions of third-party code stored on vendor branches
3297 Merge commits are commits based on multiple parent commits.
3298 The tip commit of the work tree's current branch, which must be in the
3300 reference namespace and must be set with
3304 operation, will be used as the first parent.
3305 The tip commit of the specified
3307 will be used as the second parent.
3309 No ancestral relationship between the two branches is required.
3310 If the two branches have already been merged previously, only new changes
3313 It is not possible to create merge commits with more than two parents.
3314 If more than one branch needs to be merged, then multiple merge commits
3315 with two parents each can be created in sequence.
3317 While merging changes found on the
3319 into the work tree, show the status of each affected file,
3320 using the following status codes:
3321 .Bl -column YXZ description
3322 .It G Ta file was merged
3323 .It C Ta file was merged and conflicts occurred during merge
3324 .It ! Ta changes destined for a missing file were not merged
3325 .It D Ta file was deleted
3326 .It d Ta file's deletion was prevented by local modifications
3327 .It A Ta new file was added
3328 .It \(a~ Ta changes destined for a non-regular file were not merged
3329 .It ? Ta changes destined for an unversioned file were not merged
3332 If merge conflicts occur, the merge operation is interrupted and conflicts
3333 must be resolved before the merge operation can continue.
3334 If any files with destined changes are found to be missing or unversioned,
3335 or if files could not be deleted due to differences in deleted content,
3336 the merge operation will be interrupted to prevent potentially incomplete
3337 changes from being committed to the repository without user intervention.
3338 The work tree may be modified as desired and the merge can be continued
3339 once the changes present in the work tree are considered complete.
3340 Alternatively, the merge operation may be aborted which will leave
3341 the work tree's current branch unmodified.
3344 will refuse to run if certain preconditions are not met.
3345 If the work tree's current branch is not in the
3347 reference namespace then the work tree must first be switched to a
3352 If the work tree is not yet fully updated to the tip commit of its
3353 branch, then the work tree must first be updated with
3355 If the work tree contains multiple base commits, it must first be updated
3356 to a single base commit with
3358 If changes have been staged with
3360 these changes must first be committed with
3364 If the work tree contains local changes, these changes must first be
3371 contains changes to files outside of the work tree's path prefix,
3372 the work tree cannot be used to merge this branch.
3382 commands will refuse to run while a merge operation is in progress.
3383 Other commands which manipulate the work tree may be used for
3384 conflict resolution purposes.
3391 Abort an interrupted merge operation.
3392 If this option is used, no other command-line arguments are allowed.
3394 Allow a merge operation to continue with files in conflicted status.
3395 This option should generally be avoided, and can only be used with the
3399 Continue an interrupted merge operation.
3400 If this option is used, no other command-line arguments are allowed except
3403 Create a merge commit even if the branches have not diverged.
3405 Merge changes into the work tree as usual but do not create a merge
3407 The merge result can be adjusted as desired before a merge commit is
3410 Alternatively, the merge may be aborted with
3417 .Op Fl F Ar response-script
3421 Stage local changes for inclusion in the next commit.
3424 is specified, stage all changes in the work tree.
3425 Otherwise, stage changes at or within the specified paths.
3426 Paths may be staged if they are added, modified, or deleted according to
3429 Show the status of each affected file, using the following status codes:
3430 .Bl -column YXZ description
3431 .It A Ta file addition has been staged
3432 .It M Ta file modification has been staged
3433 .It D Ta file deletion has been staged
3436 Staged file contents are saved in newly created blob objects in the repository.
3437 These blobs will be referred to by tree objects once staged changes have been
3440 Staged changes affect the behaviour of
3445 While paths with staged changes exist, the
3447 command will refuse to commit any paths which do not have staged changes.
3448 Local changes created on top of staged changes can only be committed if
3449 the path is staged again, or if the staged changes are committed first.
3452 command will show both local changes and staged changes.
3455 command is able to display local changes relative to staged changes,
3456 and to display staged changes relative to the repository.
3459 command cannot revert staged changes but may be used to revert
3460 local changes created on top of staged changes.
3466 .It Fl F Ar response-script
3474 responses line-by-line from the specified
3476 file instead of prompting interactively.
3478 Instead of staging new changes, list paths which are already staged,
3479 along with the IDs of staged blob objects and stage status codes.
3480 If paths were provided on the command line, show the staged paths
3481 among the specified paths.
3482 Otherwise, show all staged paths.
3484 Instead of staging the entire content of a changed file, interactively
3485 select or reject changes for staging based on
3489 (reject change), and
3491 (quit staging this file) responses.
3492 If a file is in modified status, individual patches derived from the
3493 modified file content can be staged.
3494 Files in added or deleted status may only be staged or rejected in
3497 Allow staging of symbolic links which point outside of the path space
3498 that is under version control.
3501 will reject such symbolic links due to safety concerns.
3504 may decide to represent such a symbolic link as a regular file which contains
3505 the link's target path, rather than creating an actual symbolic link which
3506 points outside of the work tree.
3507 Use of this option is discouraged because external mechanisms such as
3509 are better suited for managing symbolic links to paths not under
3514 will refuse to run if certain preconditions are not met.
3515 If a file contains merge conflicts, these conflicts must be resolved first.
3516 If a file is found to be out of date relative to the head commit on the
3517 work tree's current branch, the file must be updated with
3519 before it can be staged (however, this does not prevent the file from
3520 becoming out-of-date at some point after having been staged).
3528 commands will refuse to run while staged changes exist.
3529 If staged changes cannot be committed because a staged path
3530 is out of date, the path must be unstaged with
3532 before it can be updated with
3534 and may then be staged again if necessary.
3539 .Op Fl F Ar response-script
3543 Merge staged changes back into the work tree and put affected paths
3544 back into non-staged status.
3547 is specified, unstage all staged changes across the entire work tree.
3548 Otherwise, unstage changes at or within the specified paths.
3550 Show the status of each affected file, using the following status codes:
3551 .Bl -column YXZ description
3552 .It G Ta file was unstaged
3553 .It C Ta file was unstaged and conflicts occurred during merge
3554 .It ! Ta changes destined for a missing file were not merged
3555 .It D Ta file was staged as deleted and still is deleted
3556 .It d Ta file's deletion was prevented by local modifications
3557 .It \(a~ Ta changes destined for a non-regular file were not merged
3564 .It Fl F Ar response-script
3572 responses line-by-line from the specified
3574 file instead of prompting interactively.
3576 Instead of unstaging the entire content of a changed file, interactively
3577 select or reject changes for unstaging based on
3581 (keep change staged), and
3583 (quit unstaging this file) responses.
3584 If a file is staged in modified status, individual patches derived from the
3585 staged file content can be unstaged.
3586 Files staged in added or deleted status may only be unstaged in their entirety.
3592 .Op Fl r Ar repository-path
3595 Parse and print contents of objects to standard output in a line-based
3597 Content of commit, tree, and tag objects is printed in a way similar
3598 to the actual content stored in such objects.
3599 Blob object contents are printed as they would appear in files on disk.
3601 Attempt to interpret each argument as a reference, a tag name, or
3602 an object ID SHA1 hash.
3603 References will be resolved to an object ID.
3604 Tag names will resolved to a tag object.
3605 An abbreviated hash argument will be expanded to a full SHA1 hash
3606 automatically, provided the abbreviation is unique.
3608 If none of the above interpretations produce a valid result, or if the
3610 option is used, attempt to interpret the argument as a path which will
3611 be resolved to the ID of an object found at this path in the repository.
3618 Look up paths in the specified
3620 If this option is not used, paths are looked up in the commit resolved
3621 via the repository's HEAD reference.
3623 The expected argument is a commit ID SHA1 hash, or a reference name
3624 or keyword which will be resolved to a commit ID.
3625 An abbreviated hash argument will be expanded to a full SHA1 hash
3626 automatically, provided the abbreviation is unique.
3631 resolve to the work tree's base commit and branch head, respectively.
3632 The former is only valid if invoked in a work tree, while the latter will
3633 resolve to the tip of the work tree's current branch if invoked in a
3634 work tree, otherwise it will resolve to the repository's HEAD reference.
3635 Keywords and references may be appended with
3639 modifiers and an optional integer N to denote the
3640 Nth descendant or antecedent by first parent traversal, respectively;
3643 denotes the work tree branch head's 2nd generation ancestor, and
3645 denotes the 4th generation descendant of the work tree's base commit.
3648 will denote the 8th generation ancestor of the commit resolved by the
3655 modifier without a trailing integer has an implicit
3664 Interpret all arguments as paths only.
3665 This option can be used to resolve ambiguity in cases where paths
3666 look like tag names, reference names, or object IDs.
3667 .It Fl r Ar repository-path
3668 Use the repository at the specified path.
3669 If not specified, assume the repository is located at or above the current
3671 If this directory is a
3673 work tree, use the repository path associated with this work tree.
3675 .It Cm info Op Ar path ...
3676 Display meta-data stored in a work tree.
3681 The work tree to use is resolved implicitly by walking upwards from the
3682 current working directory.
3686 arguments are specified, show additional per-file information for tracked
3687 files located at or within these paths.
3690 argument corresponds to the work tree's root directory, display information
3691 for all tracked files.
3694 .Bl -tag -width GOT_IGNORE_GITCONFIG
3696 The author's name and email address, such as
3697 .Dq An Flan Hacker Aq Mt flan_hacker@openbsd.org .
3708 may fail to parse commits without an email address in author data,
3712 environment variables with a missing email address.
3714 .Ev GOT_AUTHOR will be overridden by configuration settings in
3720 configuration settings in the repository's
3727 configuration settings contained in Git's global
3729 configuration file will only be used if neither
3733 environment variable provide author information.
3734 .It Ev GOT_IGNORE_GITCONFIG
3735 If this variable is set then any remote repository definitions or author
3736 information found in Git configuration files will be ignored.
3737 .It Ev GOT_LOG_DEFAULT_LIMIT
3738 The default limit on the number of commits traversed by
3740 If set to zero, the limit is unbounded.
3741 This variable will be silently ignored if it is set to a non-numeric value.
3742 .It Ev VISUAL , EDITOR
3743 The editor spawned by
3751 text editor will be spawned.
3754 .Bl -tag -width packed-refs -compact
3756 Repository-wide configuration settings for
3760 configuration file located in the root directory of a Git repository
3761 supersedes any relevant settings in Git's
3765 .It Pa .got/got.conf
3766 Worktree-specific configuration settings for
3770 configuration file in the
3772 meta-data directory of a work tree supersedes any relevant settings in
3775 configuration file and Git's
3782 Enable tab-completion of
3787 .Dl $ set -A complete_got_1 -- $(got -h 2>&1 | sed -n s/commands://p)
3789 Clone an existing Git repository for use with
3793 .Dl $ got clone ssh://git@github.com/openbsd/src.git
3795 Unfortunately, many of the popular Git hosting sites do not offer anonymous
3797 Such sites will require an account to be created, and a public SSH key to be
3798 uploaded to this account, before repository access via ssh:// URLs will work.
3800 Use of HTTP URLs currently requires
3804 .Dl $ git clone --bare https://github.com/openbsd/src.git
3806 Alternatively, for quick and dirty local testing of
3808 a new Git repository could be created and populated with files,
3809 e.g. from a temporary CVS checkout located at
3812 .Dl $ gotadmin init /var/git/src.git
3813 .Dl $ got import -r /var/git/src.git -I CVS -I obj /tmp/src
3815 Check out a work tree from the Git repository to /usr/src:
3817 .Dl $ got checkout /var/git/src.git /usr/src
3819 View local changes in a work tree directory:
3821 .Dl $ got diff | less
3823 In a work tree, display files in a potentially problematic state:
3825 .Dl $ got status -s 'C!~?'
3827 Interactively revert selected local changes in a work tree directory:
3829 .Dl $ got revert -p -R\ .
3831 In a work tree or a git repository directory, list all branch references:
3835 As above, but list the most recently modified branches only:
3837 .Dl $ got branch -lt | head
3839 In a work tree or a git repository directory, create a new branch called
3840 .Dq unified-buffer-cache
3841 which is forked off the
3845 .Dl $ got branch -c master unified-buffer-cache
3847 Switch an existing work tree to the branch
3848 .Dq unified-buffer-cache .
3849 Local changes in the work tree will be preserved and merged if necessary:
3851 .Dl $ got update -b unified-buffer-cache
3853 Create a new commit from local changes in a work tree directory.
3854 This new commit will become the head commit of the work tree's current branch:
3858 In a work tree or a git repository directory, view changes committed in
3859 the 3 most recent commits to the work tree's branch, or the branch resolved
3860 via the repository's HEAD reference, respectively:
3862 .Dl $ got log -p -l 3
3864 As above, but display changes in the order in which
3866 could apply them in sequence:
3868 .Dl $ got log -p -l 3 -R
3870 In a work tree or a git repository directory, log the history of a subdirectory:
3872 .Dl $ got log sys/uvm
3874 While operating inside a work tree, paths are specified relative to the current
3875 working directory, so this command will log the subdirectory
3878 .Dl $ cd sys/uvm && got log\ .
3880 And this command has the same effect:
3882 .Dl $ cd sys/dev/usb && got log ../../uvm
3884 And this command displays work tree meta-data about all tracked files:
3887 .Dl $ got info\ . | less
3889 Add new files and remove obsolete files in a work tree directory:
3891 .Dl $ got add sys/uvm/uvm_ubc.c
3892 .Dl $ got remove sys/uvm/uvm_vnode.c
3894 Create a new commit from local changes in a work tree directory
3895 with a pre-defined log message.
3897 .Dl $ got commit -m 'unify the buffer cache'
3899 Alternatively, create a new commit from local changes in a work tree
3900 directory with a log message that has been prepared in the file
3903 .Dl $ got commit -F /tmp/msg
3905 Update any work tree checked out from the
3906 .Dq unified-buffer-cache
3907 branch to the latest commit on this branch:
3911 Roll file content on the unified-buffer-cache branch back by one commit,
3912 and then fetch the rolled-back change into the work tree as a local change
3913 to be amended and perhaps committed again:
3915 .Dl $ got backout unified-buffer-cache
3916 .Dl $ got commit -m 'roll back previous'
3917 .Dl $ # now back out the previous backout :-)
3918 .Dl $ got backout unified-buffer-cache
3920 Fetch new changes on the remote repository's
3922 branch, making them visible on the local repository's
3929 In a repository created with a HTTP URL and
3930 .Cm git clone --bare
3933 command must be used instead:
3935 .Dl $ cd /var/git/src.git
3936 .Dl $ git fetch origin master:refs/remotes/origin/master
3940 branch to merge the new changes that are now visible on the
3945 .Dl $ got update -b origin/master
3946 .Dl $ got rebase master
3949 .Dq unified-buffer-cache
3950 branch on top of the new head commit of the
3954 .Dl $ got update -b master
3955 .Dl $ got rebase unified-buffer-cache
3957 Create a patch from all changes on the unified-buffer-cache branch.
3958 The patch can be mailed out for review and applied to
3962 .Dl $ got diff master unified-buffer-cache > /tmp/ubc.diff
3964 Edit the entire commit history of the
3965 .Dq unified-buffer-cache
3968 .Dl $ got update -b unified-buffer-cache
3969 .Dl $ got update -c master
3972 Before working against existing branches in a repository cloned with
3973 .Cm git clone --bare
3978 must be configured to map all references in the remote repository
3981 namespace of the local repository.
3982 This can be achieved by setting Git's
3983 .Pa remote.origin.fetch
3984 configuration variable to the value
3985 .Dq +refs/heads/*:refs/remotes/origin/*
3990 .Dl $ cd /var/git/repo
3991 .Dl $ git config remote.origin.fetch '+refs/heads/*:refs/remotes/origin/*'
3995 option must be disabled:
3997 .Dl $ cd /var/git/repo
3998 .Dl $ git config remote.origin.mirror false
4000 Alternatively, the following
4002 configuration item can be added manually to the Git repository's
4006 .Dl [remote \&"origin\&"]
4008 .Dl fetch = +refs/heads/*:refs/remotes/origin/*
4011 This configuration leaves the local repository's
4013 namespace free for use by local branches checked out with
4015 and, if needed, created with
4018 .Dq refs/remotes/origin
4019 namespace can now be updated with incoming changes from the remote
4024 without extra command line arguments.
4025 Newly fetched changes can be examined with
4028 Display changes on the remote repository's version of the
4030 branch, as of the last time
4034 .Dl $ got log -c origin/master | less
4036 As shown here, most commands accept abbreviated reference names such as
4039 .Dq refs/remotes/origin/master .
4040 The latter is only needed in case of ambiguity.
4043 can be used to merge changes which are visible on the
4048 This will also merge local changes, if any, with the incoming changes:
4050 .Dl $ got update -b origin/master
4051 .Dl $ got rebase master
4053 In order to make changes committed to the
4054 .Dq unified-buffer-cache
4058 .Dq unified-buffer-cache
4059 branch can be rebased onto the
4063 .Dl $ got update -b master
4064 .Dl $ got rebase unified-buffer-cache
4067 .Dq unified-buffer-cache
4068 branch can now be made visible on the
4072 Because the rebase operation switched the work tree to the
4073 .Dq unified-buffer-cache
4074 branch, the work tree must be switched back to the
4078 .Dl $ got update -b master
4079 .Dl $ got integrate unified-buffer-cache
4083 branch, log messages for local changes can now be amended with
4085 by other developers and any other important new information:
4087 .Dl $ got update -c origin/master
4088 .Dl $ got histedit -m
4090 If the remote repository offers write access, local changes on the
4092 branch can be sent to the remote repository with
4096 can be run without further arguments.
4097 The arguments shown here match defaults, provided the work tree's
4098 current branch is the
4102 .Dl $ got send -b master origin
4104 If the remote repository requires the HTTPS protocol, the
4106 command must be used instead:
4108 .Dl $ cd /var/git/src.git
4109 .Dl $ git push origin master
4111 When making contributions to projects which use the
4113 workflow, SSH protocol repository access needs to be set up first.
4114 Once an account has been created on a Git hosting site it should
4115 be possible to upload a public SSH key for repository access
4120 workflow will usually involve two remote repositories.
4121 In the real-life example below, the
4123 repository was forked from the
4125 repository by using the Git hosting site's web interface.
4128 file in the local repository describes both remote repositories:
4129 .Bd -literal -offset indent
4130 # Jelmers's repository, which accepts pull requests
4132 server git@github.com
4134 repository "/jelmer/dulwich"
4138 # Stefan's fork, used as the default remote repository
4140 server git@github.com
4142 repository "/stspdotname/dulwich"
4147 With this configuration, Stefan can create commits on
4148 .Dq refs/heads/master
4149 and send them to the
4151 repository by running:
4153 .Dl $ got send -b master origin
4155 The changes can now be proposed to Jelmer by opening a pull request
4156 via the Git hosting site's web interface.
4157 If Jelmer requests further changes to be made, additional commits
4158 can be created on the
4160 branch and be added to the pull request by running
4164 If Jelmer prefers additional commits to be
4166 then the following commands can be used to achieve this:
4168 .Dl $ got update -b master
4169 .Dl $ got update -c origin/master
4170 .Dl $ got histedit -f
4171 .Dl $ got send -f -b master origin
4173 In addition to reviewing the pull request in the web user interface,
4174 Jelmer can fetch the pull request's branch into his local repository
4175 and create a local branch which contains the proposed changes:
4177 .Dl $ got fetch -R refs/pull/1046/head origin
4178 .Dl $ got branch -c refs/remotes/origin/pull/1046/head pr1046
4180 Once Jelmer has accepted the pull request, Stefan can fetch the
4181 merged changes, and possibly several other new changes, by running:
4183 .Dl $ got fetch upstream
4185 The merged changes will now be visible under the reference
4186 .Dq refs/remotes/upstream/master .
4189 branch can now be rebased on top of the latest changes
4192 .Dl $ got update -b upstream/master
4193 .Dl $ got rebase master
4195 As an alternative to
4197 branches can be merged with
4200 .Dl $ got update -b master
4201 .Dl $ got merge upstream/master
4203 The question of whether to rebase or merge branches is philosophical.
4204 When in doubt, refer to the software project's policies set by project
4207 As a final step, the forked repository's copy of the master branch needs
4208 to be kept in sync by sending the new changes there:
4210 .Dl $ got send -f -b master origin
4212 If multiple pull requests need to be managed in parallel, a separate branch
4213 must be created for each pull request with
4215 Each such branch can then be used as above, in place of
4216 .Dq refs/heads/master .
4217 Changes for any accepted pull requests will still appear under
4218 .Dq refs/remotes/upstream/master,
4219 regardless of which branch was used in the forked repository to
4220 create a pull request.
4224 .Xr git-repository 5 ,
4225 .Xr got-worktree 5 ,
4229 .An Anthony J. Bentley Aq Mt bentley@openbsd.org
4230 .An Christian Weisgerber Aq Mt naddy@openbsd.org
4231 .An Hiltjo Posthuma Aq Mt hiltjo@codemadness.org
4232 .An Josh Rickmar Aq Mt jrick@zettaport.com
4233 .An Joshua Stein Aq Mt jcs@openbsd.org
4234 .An Klemens Nanni Aq Mt kn@openbsd.org
4235 .An Martin Pieuchot Aq Mt mpi@openbsd.org
4236 .An Neels Hofmeyr Aq Mt neels@hofmeyr.de
4237 .An Omar Polo Aq Mt op@openbsd.org
4238 .An Ori Bernstein Aq Mt ori@openbsd.org
4239 .An Sebastien Marie Aq Mt semarie@openbsd.org
4240 .An Stefan Sperling Aq Mt stsp@openbsd.org
4241 .An Steven McDonald Aq Mt steven@steven-mcdonald.id.au
4242 .An Theo Buehler Aq Mt tb@openbsd.org
4243 .An Thomas Adam Aq Mt thomas@xteddy.org
4244 .An Tracey Emery Aq Mt tracey@traceyemery.net
4245 .An Yang Zhong Aq Mt yzhong@freebsdfoundation.org
4252 were derived from code under copyright by:
4254 .An Caldera International
4255 .An Daniel Hartmeier
4260 .An Jean-Francois Brousseau
4266 .An Niklas Hallqvist
4271 .An Xavier Santolaria
4274 contains code contributed to the public domain by
4275 .An Austin Appleby .
4278 is a work-in-progress and some features remain to be implemented.
4280 At present, the user has to fall back on
4282 to perform some tasks.
4286 Reading from remote repositories over HTTP or HTTPS protocols requires
4291 Writing to remote repositories over HTTP or HTTPS protocols requires
4294 The creation of merge commits with more than two parent commits requires
4297 In situations where files or directories were moved around
4299 will not automatically merge changes to new locations and
4301 will usually produce better results.
