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
1046 argument is a commit ID SHA1 hash, or a reference name or a keyword
1047 which will be resolved to a commit ID.
1048 This option has no effect if the specified
1058 .Op Fl r Ar repository-path
1059 .Op Ar object1 Ar object2 | Ar path ...
1062 When invoked within a work tree without any arguments, display all
1063 local changes in the work tree.
1066 arguments are specified, only show changes within the specified paths.
1068 If two arguments are provided, treat each argument as a reference, a tag
1069 name, or an object ID SHA1 hash, and display differences between the
1070 corresponding objects.
1071 Both objects must be of the same type (blobs, trees, or commits).
1072 An abbreviated hash argument will be expanded to a full SHA1 hash
1073 automatically, provided the abbreviation is unique.
1074 If none of these interpretations produce a valid result or if the
1079 is running in a work tree, attempt to interpret the two arguments as paths.
1086 Treat file contents as ASCII text even if binary data is detected.
1088 Set the number of context lines shown in the diff.
1089 By default, 3 lines of context are shown.
1091 Show differences between commits in the repository.
1092 This option may be used up to two times.
1093 When used only once, show differences between the specified
1095 and its first parent commit.
1096 When used twice, show differences between the two specified commits.
1100 option is used, all non-option arguments will be interpreted as paths.
1103 arguments are provided, only show differences for the specified paths.
1107 argument is a commit ID SHA1 hash, or a reference name or a keyword
1108 which will be resolved to a commit ID.
1109 An abbreviated hash argument will be expanded to a full SHA1 hash
1110 automatically, provided the abbreviation is unique.
1115 resolve to the work tree's base commit and branch head, respectively.
1116 The former is only valid if invoked in a work tree, while the latter will
1117 resolve to the tip of the work tree's current branch if invoked in a
1118 work tree, otherwise it will resolve to the repository's HEAD reference.
1119 Keywords and references may be appended with
1123 modifiers and an optional integer N to denote the
1124 Nth descendant or antecedent, respectively, by first parent traversal;
1127 denotes the HEAD reference's 2nd generation ancestor, and
1129 denotes the 4th generation descendant of the work tree's base commit.
1132 will denote the 8th generation descendant of the commit resolved by the
1135 If an integer does not follow the
1141 is implicitly appended
1148 Cannot be used together with the
1152 Display diffstat of changes before the actual diff by annotating each file path
1153 or blob hash being diffed with the total number of lines added and removed.
1154 A summary line will display the total number of changes across all files.
1156 Interpret all arguments as paths only.
1157 This option can be used to resolve ambiguity in cases where paths
1158 look like tag names, reference names, or object IDs.
1159 This option is only valid when
1161 is invoked in a work tree.
1162 .It Fl r Ar repository-path
1163 Use the repository at the specified path.
1164 If not specified, assume the repository is located at or above the current
1166 If this directory is a
1168 work tree, use the repository path associated with this work tree.
1170 Show changes staged with
1172 instead of showing local changes in the work tree.
1173 This option is only valid when
1175 is invoked in a work tree.
1177 Ignore whitespace-only changes.
1183 .Op Fl r Ar repository-path
1187 Display line-by-line history of a file at the specified path.
1194 Start traversing history at the specified
1196 The expected argument is a commit ID SHA1 hash, or a reference name
1197 or a keyword which will be resolved to a commit ID.
1198 An abbreviated hash argument will be expanded to a full SHA1 hash
1199 automatically, provided the abbreviation is unique.
1204 resolve to the work tree's base commit and branch head, respectively.
1205 The former is only valid if invoked in a work tree, while the latter will
1206 resolve to the tip of the work tree's current branch if invoked in a
1207 work tree, otherwise it will resolve to the repository's HEAD reference.
1208 Keywords and references may be appended with
1212 modifiers and an optional integer N to denote the
1213 Nth descendant or antecedent by first parent traversal, respectively;
1216 denotes the work tree branch head's 2nd generation ancestor, and
1218 denotes the 4th generation descendant of the work tree's base commit.
1221 will denote the 5th generation ancestor of the commit resolved by the
1228 modifier without a trailing integer has an implicit
1236 .It Fl r Ar repository-path
1237 Use the repository at the specified path.
1238 If not specified, assume the repository is located at or above the current
1240 If this directory is a
1242 work tree, use the repository path associated with this work tree.
1249 .Op Fl r Ar repository-path
1253 Display a listing of files and directories at the specified
1254 directory path in the repository.
1255 Entries shown in this listing may carry one of the following trailing
1257 .Bl -column YXZ description
1258 .It @ Ta entry is a symbolic link
1259 .It / Ta entry is a directory
1260 .It * Ta entry is an executable file
1261 .It $ Ta entry is a Git submodule
1264 Symbolic link entries are also annotated with the target path of the link.
1268 is specified, list the repository path corresponding to the current
1269 directory of the work tree, or the root directory of the repository
1270 if there is no work tree.
1277 List files and directories as they appear in the specified
1280 The expected argument is a commit ID SHA1 hash, or a reference name
1281 or a keyword which will be resolved to a commit ID.
1282 An abbreviated hash argument will be expanded to a full SHA1 hash
1283 automatically, provided the abbreviation is unique.
1288 resolve to the work tree's base commit and branch head, respectively.
1289 The former is only valid if invoked in a work tree, while the latter will
1290 resolve to the tip of the work tree's current branch if invoked in a
1291 work tree, otherwise it will resolve to the repository's HEAD reference.
1292 Keywords and references may be appended with
1296 modifiers and an optional integer N to denote the
1297 Nth descendant or antecedent by first parent traversal, respectively;
1300 denotes the work tree branch head's 2nd generation ancestor, and
1302 denotes the 4th generation descendant of the work tree's base commit.
1305 will denote the 3rd generation ancestor of the commit resolved by the
1312 modifier without a trailing integer has an implicit
1321 Show object IDs of files (blob objects) and directories (tree objects).
1323 Recurse into sub-directories in the repository.
1324 .It Fl r Ar repository-path
1325 Use the repository at the specified path.
1326 If not specified, assume the repository is located at or above the current
1328 If this directory is a
1330 work tree, use the repository path associated with this work tree.
1336 .Op Fl r Ar repository-path
1337 .Op Fl s Ar reference
1340 Manage references in a repository.
1342 References may be listed, created, deleted, and changed.
1343 When creating, deleting, or changing a reference the specified
1345 must be an absolute reference name, i.e. it must begin with
1353 Create a reference or change an existing reference.
1354 The reference with the specified
1356 will point at the specified
1361 argument is an ID SHA1 hash or an existing reference or tag name
1362 or a keyword which will be resolved to the ID of a corresponding commit,
1363 tree, tag, or blob object.
1364 An abbreviated hash argument will be expanded to a full SHA1 hash
1365 automatically, provided the abbreviation is unique.
1370 resolve to the work tree's base commit and branch head, respectively.
1371 The former is only valid if invoked in a work tree, while the latter will
1372 resolve to the tip of the work tree's current branch if invoked in a
1373 work tree, otherwise it will resolve to the repository's HEAD reference.
1374 Keywords and reference names may be appended with
1378 modifiers and an optional integer N to denote the
1379 Nth descendant or antecedent by first parent traversal, respectively;
1382 denotes the work tree branch head's 2nd generation ancestor, and
1384 will denote the 3rd generation ancestor of the commit resolved by the
1387 If an integer does not follow the
1393 is implicitly appended
1400 Cannot be used together with any other options except
1403 Delete the reference with the specified
1405 from the repository.
1406 Any commit, tree, tag, and blob objects belonging to deleted references
1407 remain in the repository and may be removed separately with
1408 Git's garbage collector or
1409 .Cm gotadmin cleanup .
1410 Cannot be used together with any other options except
1413 List references in the repository.
1416 is specified, list all existing references in the repository.
1419 is a reference namespace, list all references in this namespace.
1420 Otherwise, show only the reference with the given
1422 Cannot be used together with any other options except
1426 .It Fl r Ar repository-path
1427 Use the repository at the specified path.
1428 If not specified, assume the repository is located at or above the current
1430 If this directory is a
1432 work tree, use the repository path associated with this work tree.
1433 .It Fl s Ar reference
1434 Create a symbolic reference, or change an existing symbolic reference.
1435 The symbolic reference with the specified
1437 will point at the specified
1439 which must already exist in the repository.
1440 Care should be taken not to create loops between references when
1441 this option is used.
1442 Cannot be used together with any other options except
1445 Sort listed references by modification time (most recently modified first)
1446 instead of sorting by lexicographical order.
1447 Use of this option requires the
1449 option to be used as well.
1457 .Op Fl r Ar repository-path
1461 Create, list, or delete branches.
1463 Local branches are managed via references which live in the
1465 reference namespace.
1468 command creates references in this namespace only.
1470 When deleting branches, the specified
1474 reference namespace first.
1475 If no corresponding branch is found, the
1477 namespace will be searched next.
1479 If invoked in a work tree without any arguments, print the name of the
1480 work tree's current branch.
1484 argument is passed, attempt to create a branch reference with the given name.
1485 By default the new branch reference will point at the latest commit on the
1486 work tree's current branch if invoked in a work tree, and otherwise to a commit
1487 resolved via the repository's HEAD reference.
1489 If invoked in a work tree, once the branch was created successfully
1490 switch the work tree's head reference to the newly created branch and
1491 update files across the entire work tree, just like
1492 .Cm got update -b Ar name
1494 Show the status of each affected file, using the following status codes:
1495 .Bl -column YXZ description
1496 .It U Ta file was updated and contained no local changes
1497 .It G Ta file was updated and local changes were merged cleanly
1498 .It C Ta file was updated and conflicts occurred during merge
1499 .It D Ta file was deleted
1500 .It A Ta new file was added
1501 .It \(a~ Ta versioned file is obstructed by a non-regular file
1502 .It ! Ta a missing versioned file was restored
1510 Make a newly created branch reference point at the specified
1512 The expected argument is a commit ID SHA1 hash, or a reference name or keyword
1513 which will be resolved to a commit ID.
1514 An abbreviated hash argument will be expanded to a full SHA1 hash
1515 automatically, provided the abbreviation is unique.
1520 resolve to the work tree's base commit and branch head, respectively.
1521 The former is only valid if invoked in a work tree, while the latter will
1522 resolve to the tip of the work tree's current branch if invoked in a
1523 work tree, otherwise it will resolve to the repository's HEAD reference.
1524 Keywords and references may be appended with
1528 modifiers and an optional integer N to denote the
1529 Nth descendant or antecedent by first parent traversal, respectively;
1532 denotes the work tree branch head's 2nd generation ancestor, and
1534 denotes the 4th generation descendant of the work tree's base commit.
1537 will denote the 3rd generation descendant of the commit resolved by the
1544 modifier without a trailing integer has an implicit
1553 Delete the branch with the specified
1559 reference namespace.
1561 Only the branch reference is deleted.
1562 Any commit, tree, and blob objects belonging to the branch
1563 remain in the repository and may be removed separately with
1564 Git's garbage collector or
1565 .Cm gotadmin cleanup .
1567 List all existing branches in the repository, including copies of remote
1568 repositories' branches in the
1570 reference namespace.
1572 If invoked in a work tree, the work tree's current branch is shown
1573 with one of the following annotations:
1574 .Bl -column YXZ description
1575 .It * Ta work tree's base commit and the base commit of all tracked files
1576 matches the branch tip
1577 .It \(a~ Ta work tree comprises mixed commits or its base commit is out-of-date
1580 Do not switch and update the work tree after creating a new branch.
1581 .It Fl r Ar repository-path
1582 Use the repository at the specified path.
1583 If not specified, assume the repository is located at or above the current
1585 If this directory is a
1587 work tree, use the repository path associated with this work tree.
1589 Sort listed branches by modification time (most recently modified first)
1590 instead of sorting by lexicographical order.
1593 reference namespace are listed before branches in
1596 Use of this option requires the
1598 option to be used as well.
1605 .Op Fl r Ar repository-path
1606 .Op Fl s Ar signer-id
1609 Manage tags in a repository.
1611 Tags are managed via references which live in the
1613 reference namespace.
1616 command operates on references in this namespace only.
1617 References in this namespace point at tag objects which contain a pointer
1618 to another object, a tag message, as well as author and timestamp information.
1620 Attempt to create a tag with the given
1622 and make this tag point at the given
1624 If no commit is specified, default to the latest commit on the work tree's
1625 current branch if invoked in a work tree, and to a commit resolved via
1626 the repository's HEAD reference otherwise.
1633 Make the newly created tag reference point at the specified
1637 argument is a commit ID SHA1 hash, or a reference or keyword
1638 which will be resolved to a commit ID.
1639 An abbreviated hash argument will be expanded to a full SHA1 hash
1640 automatically, provided the abbreviation is unique.
1645 resolve to the work tree's base commit and branch head, respectively.
1646 The former is only valid if invoked in a work tree, while the latter will
1647 resolve to the tip of the work tree's current branch if invoked in a
1648 work tree, otherwise it will resolve to the repository's HEAD reference.
1649 Keywords and references may be appended with
1653 modifiers and an optional integer N to denote the
1654 Nth descendant or antecedent by first parent traversal, respectively;
1657 denotes the work tree branch head's 2nd generation ancestor, and
1659 denotes the 4th generation descendant of the work tree's base commit.
1662 will denote the 3rd generation ancestor of the commit resolved by the
1669 modifier without a trailing integer has an implicit
1678 List all existing tags in the repository instead of creating a new tag.
1681 argument is passed, show only the tag with the given
1684 Use the specified tag message when creating the new tag.
1689 opens a temporary file in an editor where a tag message can be written.
1690 Quitting the editor without saving the file will abort the tag operation.
1691 .It Fl r Ar repository-path
1692 Use the repository at the specified path.
1693 If not specified, assume the repository is located at or above the current
1695 If this directory is a
1697 work tree, use the repository path associated with this work tree.
1698 .It Fl s Ar signer-id
1699 While creating a new tag, sign this tag with the identity given in
1702 For SSH-based signatures,
1704 is the path to a file which may refer to either a private SSH key,
1705 or a public SSH key with the private half available via
1708 will sign the tag object by invoking
1712 command, using the signature namespace
1714 for compatibility with
1717 Verify tag object signatures.
1720 is specified, show and verify the tag object with the provided name.
1721 Otherwise, list all tag objects and verify signatures where present.
1724 verifies SSH-based signatures by invoking
1727 .Fl Y Cm verify Fl f Ar allowed_signers .
1732 otherwise verification is impossible.
1735 During SSH signature creation and verification this option will be passed to
1737 Multiple -v options increase the verbosity.
1743 command will not delete tags or change existing tags.
1744 If a tag must be deleted, the
1746 command may be used to delete a tag's reference.
1747 This should only be done if the tag has not already been copied to
1754 Schedule unversioned files in a work tree for addition to the
1755 repository in the next commit.
1756 By default, files which match a
1758 ignore pattern will not be added.
1762 mentioned in the command line is not an unversioned file then
1765 To avoid unnecessary errors from paths picked up by file globbing patterns
1766 in the shell, paths in the argument list will be silently ignored if they
1769 at all, or if they are reported with one of the following status codes
1770 and do not have changes staged via
1772 .Bl -column YXZ description
1773 .It M Ta modified file
1774 .It A Ta file scheduled for addition in next commit
1775 .It C Ta modified or added file which contains merge conflicts
1776 .It m Ta modified file modes (executable bit only)
1784 Add files even if they match a
1788 Permit recursion into directories.
1789 If this option is not specified,
1791 will refuse to run if a specified
1799 .Op Fl s Ar status-codes
1803 Remove versioned files from a work tree and schedule them for deletion
1804 from the repository in the next commit.
1811 Perform the operation even if a file contains local modifications,
1812 and do not raise an error if a specified
1814 does not exist on disk.
1816 Keep affected files on disk.
1818 Permit recursion into directories.
1819 If this option is not specified,
1821 will refuse to run if a specified
1824 .It Fl s Ar status-codes
1825 Only delete files with a modification status matching one of the
1826 single-character status codes contained in the
1829 The following status codes may be specified:
1830 .Bl -column YXZ description
1831 .It M Ta modified file (this implies the
1834 .It ! Ta versioned file expected on disk but missing
1842 .Op Fl p Ar strip-count
1848 to files in a work tree.
1849 Files added or removed by a patch will be scheduled for addition or removal in
1852 The patch must be in the unified diff format as produced by
1859 diff when invoked with their
1864 argument is provided, read unified diff data from standard input instead.
1868 contains multiple patches, then attempt to apply each of them in sequence.
1870 Show the status of each affected file, using the following status codes:
1871 .Bl -column XYZ description
1872 .It M Ta file was modified
1873 .It G Ta file was merged using a merge-base found in the repository
1874 .It C Ta file was merged and conflicts occurred during merge
1875 .It D Ta file was deleted
1876 .It A Ta file was added
1877 .It # Ta failed to patch the file
1880 If a change does not match at its exact line number, attempt to
1881 apply it somewhere else in the file if a good spot can be found.
1882 Otherwise, the patch will fail to apply.
1886 will refuse to apply a patch if certain preconditions are not met.
1887 Files to be deleted must already be under version control, and must
1888 not have been scheduled for deletion already.
1889 Files to be added must not yet be under version control and must not
1890 already be present on disk.
1891 Files to be modified must already be under version control and may not
1892 contain conflict markers.
1894 If an error occurs, the
1896 operation will be aborted.
1897 Any changes made to the work tree up to this point will be left behind.
1898 Such changes can be viewed with
1900 and can be reverted with
1909 Attempt to locate files within the specified
1911 for use as a merge-base for 3-way merges.
1915 option is not used then
1917 will attempt to locate merge-bases via object IDs found in
1919 meta-data, such as produced by
1925 option is only recommended in the absence of such meta-data.
1927 Ideally, the specified
1929 should contain versions of files which the changes contained in the
1932 Files will be located by path, relative to the repository root.
1935 option is used then leading path components will be stripped
1936 before paths are looked up in the repository.
1938 In case no merge-base is available for a file, changes will be applied
1939 without doing a 3-way merge.
1940 Changes which do not apply cleanly may then be rejected entirely, rather
1941 than producing merge conflicts in the patched target file.
1945 argument is a commit ID SHA1 hash, or a reference name or a keyword
1946 which will be resolved to a commit ID.
1947 An abbreviated hash argument will be expanded to a full SHA1 hash
1948 automatically, provided the abbreviation is unique.
1953 resolve to the work tree's base commit and branch head, respectively.
1954 Keywords and references may be appended with
1958 modifiers and an optional integer N to denote the
1959 Nth descendant or antecedent by first parent traversal, respectively;
1962 denotes the work tree branch head's 2nd generation ancestor, and
1964 denotes the 4th generation descendant of the work tree's base commit.
1967 will denote the 3rd generation descendant of the commit resolved by the
1974 modifier without a trailing integer has an implicit
1983 Do not make any modifications to the work tree.
1984 This can be used to check whether a patch would apply without issues.
1987 contains diffs that affect the same file multiple times, the results
1988 displayed may be incorrect.
1989 .It Fl p Ar strip-count
1990 Specify the number of leading path components to strip from paths
1999 path prefixes generated by
2001 will be recognized and stripped automatically.
2003 Reverse the patch before applying it.
2009 .Op Fl F Ar response-script
2013 Revert any local changes in files at the specified paths in a work tree.
2014 File contents will be overwritten with those contained in the
2015 work tree's base commit.
2016 There is no way to bring discarded changes back after
2019 If a file was added with
2021 it will become an unversioned file again.
2022 If a file was deleted with
2024 it will be restored.
2030 .It Fl F Ar response-script
2038 responses line-by-line from the specified
2040 file instead of prompting interactively.
2042 Instead of reverting all changes in files, interactively select or reject
2043 changes to revert based on
2049 (quit reverting this file) responses.
2050 If a file is in modified status, individual patches derived from the
2051 modified file content can be reverted.
2052 Files in added or deleted status may only be reverted in their entirety.
2054 Permit recursion into directories.
2055 If this option is not specified,
2057 will refuse to run if a specified
2071 Create a new commit in the repository from changes in a work tree
2072 and use this commit as the new base commit for the work tree.
2075 is specified, commit all changes in the work tree.
2076 Otherwise, commit changes at or within the specified paths.
2078 If changes have been explicitly staged for commit with
2080 only commit staged changes and reject any specified paths which
2081 have not been staged.
2084 opens a temporary file in an editor where a log message can be written
2092 options are used together.
2093 Quitting the editor without saving the file will abort the commit operation.
2095 Show the status of each affected file, using the following status codes:
2096 .Bl -column YXZ description
2097 .It M Ta modified file
2098 .It D Ta file was deleted
2099 .It A Ta new file was added
2100 .It m Ta modified file modes (executable bit only)
2103 Files which are not part of the new commit will retain their previously
2104 recorded base commit.
2107 commands may refuse to run while the work tree contains files from
2108 multiple base commits.
2109 The base commit of such a work tree can be made consistent by running
2111 across the entire work tree.
2115 command requires the
2117 environment variable to be set,
2118 unless an author has been configured in
2124 configuration settings can be
2125 obtained from the repository's
2127 file or from Git's global
2136 Set author information in the newly created commit to
2138 This is useful when committing changes on behalf of someone else.
2141 argument must use the same format as the
2143 environment variable.
2145 In addition to storing author information, the newly created commit
2148 information which is obtained, as usual, from the
2150 environment variable, or
2152 or Git configuration settings.
2154 Allow committing files in conflicted status.
2156 Committing files with conflict markers should generally be avoided.
2157 Cases where conflict markers must be stored in the repository for
2158 some legitimate reason should be very rare.
2159 There are usually ways to avoid storing conflict markers verbatim by
2160 applying appropriate programming tricks.
2162 Use the prepared log message stored in the file found at
2164 when creating the new commit.
2166 opens a temporary file in an editor where the prepared log message can be
2167 reviewed and edited further if needed.
2168 Cannot be used together with the
2172 Use the specified log message when creating the new commit.
2173 Cannot be used together with the
2177 This option prevents
2179 from opening the commit message in an editor.
2180 It has no effect unless it is used together with the
2182 option and is intended for non-interactive use such as scripting.
2184 This option prevents
2186 from generating a diff of the to-be-committed changes in a temporary file
2187 which can be viewed while editing a commit message.
2189 Allow the addition of symbolic links which point outside of the path space
2190 that is under version control.
2193 will reject such symbolic links due to safety concerns.
2196 may decide to represent such a symbolic link as a regular file which contains
2197 the link's target path, rather than creating an actual symbolic link which
2198 points outside of the work tree.
2199 Use of this option is discouraged because external mechanisms such as
2201 are better suited for managing symbolic links to paths not under
2206 will refuse to run if certain preconditions are not met.
2207 If the work tree's current branch is not in the
2209 reference namespace, new commits may not be created on this branch.
2210 Local changes may only be committed if they are based on file content
2211 found in the most recent commit on the work tree's branch.
2212 If a path is found to be out of date,
2214 must be used first in order to merge local changes with changes made
2222 .Op Fl r Ar repository-path
2224 .Op Ar remote-repository
2227 Send new changes to a remote repository.
2229 .Ar remote-repository
2233 The remote repository's URL is obtained from the corresponding entry in
2237 file of the local repository, as created by
2240 All objects corresponding to new changes will be written to a temporary
2241 pack file which is then uploaded to the server.
2242 Upon success, references in the
2244 reference namespace of the local repository will be updated to point at
2245 the commits which have been sent.
2247 By default, changes will only be sent if they are based on up-to-date
2248 copies of relevant branches in the remote repository.
2249 If any changes to be sent are based on out-of-date copies or would
2250 otherwise break linear history of existing branches, new changes must
2251 be fetched from the server with
2253 and local branches must be rebased with
2260 option can be used to make exceptions to these requirements.
2267 Send all branches from the local repository's
2269 reference namespace.
2272 option is equivalent to listing all branches with multiple
2275 Cannot be used together with the
2281 from the local repository's
2283 reference namespace.
2284 This option may be specified multiple times to build a list of branches
2286 If this option is not specified, default to the work tree's current branch
2287 if invoked in a work tree, or to the repository's HEAD reference.
2288 Cannot be used together with the
2292 Delete the specified
2294 from the remote repository's
2296 reference namespace.
2297 This option may be specified multiple times to build a list of branches
2300 Only references are deleted.
2301 Any commit, tree, tag, and blob objects belonging to deleted branches
2302 may become subject to deletion by Git's garbage collector running on
2305 Requesting deletion of branches results in an error if the server
2306 does not support this feature or disallows the deletion of branches
2307 based on its configuration.
2309 Attempt to force the server to overwrite existing branches or tags
2310 in the remote repository, even when
2316 would usually be required before changes can be sent.
2317 The server may reject forced requests regardless, depending on its
2320 Any commit, tree, tag, and blob objects belonging to overwritten branches
2321 or tags may become subject to deletion by Git's garbage collector running
2326 reference namespace is globally shared between all repositories.
2329 option to overwrite tags is discouraged because it can lead to
2330 inconsistencies between the tags present in different repositories.
2331 In general, creating a new tag with a different name is recommended
2332 instead of overwriting an existing tag.
2336 option is particularly discouraged if changes being sent are based
2337 on an out-of-date copy of a branch in the remote repository.
2338 Instead of using the
2340 option, new changes should
2343 and local branches should be rebased with
2347 followed by another attempt to send the changes.
2351 option should only be needed in situations where the remote repository's
2352 copy of a branch or tag is known to be out-of-date and is considered
2354 The risks of creating inconsistencies between different repositories
2355 should also be taken into account.
2357 Suppress progress reporting output.
2358 The same option will be passed to
2361 .It Fl r Ar repository-path
2362 Use the repository at the specified path.
2363 If not specified, assume the repository is located at or above the current
2365 If this directory is a
2367 work tree, use the repository path associated with this work tree.
2369 Attempt to send all tags from the local repository's
2371 reference namespace.
2374 option is equivalent to listing all tags with multiple
2377 Cannot be used together with the
2383 from the local repository's
2385 reference namespace, in addition to any branches that are being sent.
2388 option may be specified multiple times to build a list of tags to send.
2389 No tags will be sent if the
2393 Raise an error if the specified
2395 already exists in the remote repository, unless the
2397 option is used to overwrite the server's copy of the tag.
2398 In general, creating a new tag with a different name is recommended
2399 instead of overwriting an existing tag.
2401 Cannot be used together with the
2408 to print debugging messages to standard error output.
2409 The same option will be passed to
2412 Multiple -v options increase the verbosity.
2422 Merge changes from a single
2427 should be on a different branch than the work tree's base commit.
2429 The expected argument is a commit ID SHA1 hash, or a reference name or
2430 keyword which will be resolved to a commit ID.
2431 An abbreviated hash argument will be expanded to a full SHA1 hash
2432 automatically, provided the abbreviation is unique.
2437 resolve to the work tree's base commit and branch head, respectively.
2438 Keywords and references may be appended with
2442 modifiers and an optional integer N to denote the
2443 Nth descendant or antecedent by first parent traversal, respectively;
2446 denotes the work tree branch head's 2nd generation ancestor, and
2448 denotes the 4th generation descendant of the work tree's base commit.
2451 will denote the 3rd generation descendant of the commit resolved by the
2458 modifier without a trailing integer has an implicit
2467 Show the status of each affected file, using the following status codes:
2468 .Bl -column YXZ description
2469 .It G Ta file was merged
2470 .It C Ta file was merged and conflicts occurred during merge
2471 .It ! Ta changes destined for a missing file were not merged
2472 .It D Ta file was deleted
2473 .It d Ta file's deletion was prevented by local modifications
2474 .It A Ta new file was added
2475 .It \(a~ Ta changes destined for a non-regular file were not merged
2476 .It ? Ta changes destined for an unversioned file were not merged
2479 The merged changes will appear as local changes in the work tree, which
2482 amended manually or with further
2488 If invoked in a work tree where no
2493 operation is taking place,
2495 creates a record of commits which have been merged into the work tree.
2496 When a file changed by
2500 the log messages of relevant merged commits will then appear in the editor,
2501 where the messages should be further adjusted to convey the reasons for
2502 cherrypicking the changes.
2503 Upon exiting the editor, if the time stamp of the log message file
2504 is unchanged or the log message is empty,
2506 will fail with an unmodified or empty log message error.
2508 If all the changes in all files touched by a given commit are discarded,
2511 this commit's log message record will also disappear.
2514 will refuse to run if certain preconditions are not met.
2515 If the work tree contains multiple base commits, it must first be updated
2516 to a single base commit with
2518 If any relevant files already contain merge conflicts, these
2519 conflicts must be resolved first.
2527 Display a list of commit log messages recorded by cherrypick operations,
2528 represented by references in the
2529 .Dq refs/got/worktree
2530 reference namespace.
2533 is specified, only show the log message of the specified commit.
2535 If invoked in a work tree, only log messages recorded by cherrypick operations
2536 in the current work tree will be displayed.
2537 Otherwise, all commit log messages will be displayed irrespective of the
2538 work tree in which they were created.
2539 This option cannot be used with
2542 Delete log messages created by previous cherrypick operations, represented by
2544 .Dq refs/got/worktree
2545 reference namespace.
2548 is specified, only delete the log message of the specified commit.
2550 If invoked in a work tree, only log messages recorded by cherrypick operations
2551 in the current work tree will be deleted.
2552 Otherwise, all commit log messages will be deleted irrespective of the
2553 work tree in which they were created.
2554 This option cannot be used with
2565 Reverse-merge changes from a single
2570 should be on the same branch as the work tree's base commit.
2572 The expected argument is a commit ID SHA1 hash, or a reference name
2573 or keyword which will be resolved to a commit ID.
2574 An abbreviated hash argument will be expanded to a full SHA1 hash
2575 automatically, provided the abbreviation is unique.
2580 resolve to the work tree's base commit and branch head, respectively.
2581 Keywords and references may be appended with
2585 modifiers and an optional integer N to denote the
2586 Nth descendant or antecedent by first parent traversal, respectively;
2589 denotes the work tree branch head's 2nd generation ancestor, and
2591 denotes the 4th generation descendant of the work tree's base commit.
2594 will denote the 5th generation descendant of the commit resolved by the
2601 modifier without a trailing integer has an implicit
2610 Show the status of each affected file, using the following status codes:
2611 .Bl -column YXZ description
2612 .It G Ta file was merged
2613 .It C Ta file was merged and conflicts occurred during merge
2614 .It ! Ta changes destined for a missing file were not merged
2615 .It D Ta file was deleted
2616 .It d Ta file's deletion was prevented by local modifications
2617 .It A Ta new file was added
2618 .It \(a~ Ta changes destined for a non-regular file were not merged
2619 .It ? Ta changes destined for an unversioned file were not merged
2622 The reverse-merged changes will appear as local changes in the work tree,
2623 which may be viewed with
2625 amended manually or with further
2631 If invoked in a work tree where no
2636 operation is taking place,
2638 creates a record of commits which have been reverse-merged into the work tree.
2639 When a file changed by
2643 the log messages of relevant reverse-merged commits will then appear in
2644 the editor, where the messages should be further adjusted to convey the
2645 reasons for backing out the changes.
2646 Upon exiting the editor, if the time stamp of the log message file
2647 is unchanged or the log message is empty,
2649 will fail with an unmodified or empty log message error.
2651 If all the changes in all files touched by a given commit are discarded,
2654 this commit's log message record will also disappear.
2657 will refuse to run if certain preconditions are not met.
2658 If the work tree contains multiple base commits, it must first be updated
2659 to a single base commit with
2661 If any relevant files already contain merge conflicts, these
2662 conflicts must be resolved first.
2670 Display a list of commit log messages recorded by backout operations,
2671 represented by references in the
2672 .Dq refs/got/worktree
2673 reference namespace.
2676 is specified, only show the log message of the specified commit.
2678 If invoked in a work tree, only log messages recorded by backout operations
2679 in the current work tree will be displayed.
2680 Otherwise, all commit log messages will be displayed irrespective of the
2681 work tree in which they were created.
2682 This option cannot be used with
2685 Delete log messages created by previous backout operations, represented by
2687 .Dq refs/got/worktree
2688 reference namespace.
2691 is specified, only delete the log message of the specified commit.
2693 If invoked in a work tree, only log messages recorded by backout operations
2694 in the current work tree will be deleted.
2695 Otherwise, all commit log messages will be deleted irrespective of the
2696 work tree in which they were created.
2697 This option cannot be used with
2708 Rebase commits on the specified
2710 onto the tip of the current branch of the work tree.
2713 must share common ancestry with the work tree's current branch.
2714 Rebasing begins with the first descendant commit of the youngest
2715 common ancestor commit shared by the specified
2717 and the work tree's current branch, and stops once the tip commit
2724 is used as intended, the specified
2726 represents a local commit history and may already contain changes
2727 that are not yet visible in any other repositories.
2728 The work tree's current branch, which must be set with
2732 operation, represents a branch from a remote repository which shares
2733 a common history with the specified
2735 but has progressed, and perhaps diverged, due to commits added to the
2738 Rebased commits are accumulated on a temporary branch which the work tree
2739 will remain switched to throughout the entire rebase operation.
2740 Commits on this branch represent the same changes with the same log
2741 messages as their counterparts on the original
2743 but with different commit IDs.
2744 Once rebasing has completed successfully, the temporary branch becomes
2745 the new version of the specified
2747 and the work tree is automatically switched to it.
2748 If author information is available via the
2750 environment variable,
2756 configuration settings, this author information will be used to identify
2761 Old commits in their pre-rebase state are automatically backed up in the
2762 .Dq refs/got/backup/rebase
2763 reference namespace.
2764 As long as these references are not removed older versions of rebased
2765 commits will remain in the repository and can be viewed with the
2768 Removal of these references makes objects which become unreachable via
2769 any reference subject to removal by Git's garbage collector or
2770 .Cm gotadmin cleanup .
2772 While rebasing commits, show the status of each affected file,
2773 using the following status codes:
2774 .Bl -column YXZ description
2775 .It G Ta file was merged
2776 .It C Ta file was merged and conflicts occurred during merge
2777 .It ! Ta changes destined for a missing file were not merged
2778 .It D Ta file was deleted
2779 .It d Ta file's deletion was prevented by local modifications
2780 .It A Ta new file was added
2781 .It \(a~ Ta changes destined for a non-regular file were not merged
2782 .It ? Ta changes destined for an unversioned file were not merged
2785 If merge conflicts occur, the rebase operation is interrupted and may
2786 be continued once conflicts have been resolved.
2787 If any files with destined changes are found to be missing or unversioned,
2788 or if files could not be deleted due to differences in deleted content,
2789 the rebase operation will be interrupted to prevent potentially incomplete
2790 changes from being committed to the repository without user intervention.
2791 The work tree may be modified as desired and the rebase operation can be
2792 continued once the changes present in the work tree are considered complete.
2793 Alternatively, the rebase operation may be aborted which will leave
2795 unmodified and the work tree switched back to its original branch.
2797 If a merge conflict is resolved in a way which renders the merged
2798 change into a no-op change, the corresponding commit will be elided
2799 when the rebase operation continues.
2802 will refuse to run if certain preconditions are not met.
2807 reference namespace, the branch may not be rebased.
2808 If the work tree is not yet fully updated to the tip commit of its
2809 branch, then the work tree must first be updated with
2811 If changes have been staged with
2813 these changes must first be committed with
2817 If the work tree contains local changes, these changes must first be
2824 contains changes to files outside of the work tree's path prefix,
2825 the work tree cannot be used to rebase this branch.
2834 commands will refuse to run while a rebase operation is in progress.
2835 Other commands which manipulate the work tree may be used for
2836 conflict resolution purposes.
2840 is already based on the work tree's current branch, then no commits
2841 need to be rebased and
2843 will simply switch the work tree to the specified
2845 and update files in the work tree accordingly.
2852 Abort an interrupted rebase operation.
2853 If this option is used, no other command-line arguments are allowed.
2855 Allow a rebase operation to continue with files in conflicted status.
2856 This option should generally be avoided, and can only be used with the
2860 Continue an interrupted rebase operation.
2861 If this option is used, no other command-line arguments are allowed except
2864 Show a list of past rebase operations, represented by references in the
2865 .Dq refs/got/backup/rebase
2866 reference namespace.
2868 Display the author, date, and log message of each backed up commit,
2869 the object ID of the corresponding post-rebase commit, and
2870 the object ID of their common ancestor commit.
2871 Given these object IDs,
2878 options can be used to examine the history of either version of the branch,
2883 option can be used to create a new branch from a pre-rebase state if desired.
2887 is specified, only show commits which at some point in time represented this
2889 Otherwise, list all backed up commits for any branches.
2891 If this option is used,
2893 does not require a work tree.
2894 None of the other options can be used together with
2897 Delete backups created by past rebase operations, represented by references
2899 .Dq refs/got/backup/rebase
2900 reference namespace.
2904 is specified, only delete backups which at some point in time represented
2906 Otherwise, delete all references found within
2907 .Dq refs/got/backup/rebase .
2909 Any commit, tree, tag, and blob objects belonging to deleted backups
2910 remain in the repository and may be removed separately with
2911 Git's garbage collector or
2912 .Cm gotadmin cleanup .
2914 If this option is used,
2916 does not require a work tree.
2917 None of the other options can be used together with
2924 .Op Fl F Ar histedit-script
2928 Edit commit history between the work tree's current base commit and
2929 the tip commit of the work tree's current branch.
2933 command requires the
2935 environment variable to be set,
2936 unless an author has been configured in
2942 configuration settings can be obtained from the repository's
2944 file or from Git's global
2950 operation, the work tree's current branch must be set with
2952 to the branch which should be edited, unless this branch is already the
2953 current branch of the work tree.
2954 The tip of this branch represents the upper bound (inclusive) of commits
2959 Furthermore, the work tree's base commit
2962 to a point in this branch's commit history where editing should begin.
2963 This commit represents the lower bound (non-inclusive) of commits touched
2968 Editing of commit history is controlled via a
2970 which can be written in an editor based on a template, passed on the
2971 command line, or generated with the
2978 Quitting the editor without saving the file will abort the histedit operation.
2980 The format of the histedit script is line-based.
2981 Each line in the script begins with a command name, followed by
2982 whitespace and an argument.
2983 For most commands, the expected argument is a commit ID SHA1 hash.
2984 Any remaining text on the line is ignored.
2985 Lines which begin with the
2987 character are ignored entirely.
2989 The available histedit script commands are as follows:
2990 .Bl -column YXZ pick-commit
2991 .It Cm pick Ar commit Ta Use the specified commit as it is.
2992 .It Cm edit Ar commit Ta Apply the changes from the specified commit, but
2993 then interrupt the histedit operation for amending, without creating a commit.
2994 While the histedit operation is interrupted arbitrary files may be edited,
2995 and commands which manipulate the work tree can be used freely.
3000 commands can be used to add new files or remove existing ones.
3003 command can be used to eliminate arbitrary changes from files in the work tree.
3006 command may be used to prepare a subset of changes for inclusion in the
3010 command can be used to insert arbitrary commits into the edited history.
3011 Regular editing of history must eventually be resumed by running
3012 .Cm got histedit -c .
3013 .It Cm fold Ar commit Ta Combine the specified commit with the next commit
3014 listed further below that will be used.
3015 .It Cm drop Ar commit Ta Remove this commit from the edited history.
3016 .It Cm mesg Oo Ar log-message Oc Ta Create a new log message for the commit of
3021 command on the previous line of the histedit script.
3024 argument provides a new single-line log message to use.
3027 argument is omitted, open an editor where a new log message can be written.
3030 Every commit in the history being edited must be mentioned in the script.
3031 Lines may be re-ordered to change the order of commits in the edited history.
3032 No commit may be listed more than once.
3034 Edited commits are accumulated on a temporary branch which the work tree
3035 will remain switched to throughout the entire histedit operation.
3036 Once history editing has completed successfully, the temporary branch becomes
3037 the new version of the work tree's branch and the work tree is automatically
3040 Old commits in their pre-histedit state are automatically backed up in the
3041 .Dq refs/got/backup/histedit
3042 reference namespace.
3043 As long as these references are not removed older versions of edited
3044 commits will remain in the repository and can be viewed with the
3047 Removal of these references makes objects which become unreachable via
3048 any reference subject to removal by Git's garbage collector or
3049 .Cm gotadmin cleanup .
3051 While merging commits, show the status of each affected file,
3052 using the following status codes:
3053 .Bl -column YXZ description
3054 .It G Ta file was merged
3055 .It C Ta file was merged and conflicts occurred during merge
3056 .It ! Ta changes destined for a missing file were not merged
3057 .It D Ta file was deleted
3058 .It d Ta file's deletion was prevented by local modifications
3059 .It A Ta new file was added
3060 .It \(a~ Ta changes destined for a non-regular file were not merged
3061 .It ? Ta changes destined for an unversioned file were not merged
3064 If merge conflicts occur, the histedit operation is interrupted and may
3065 be continued once conflicts have been resolved.
3066 If any files with destined changes are found to be missing or unversioned,
3067 or if files could not be deleted due to differences in deleted content,
3068 the histedit operation will be interrupted to prevent potentially incomplete
3069 changes from being committed to the repository without user intervention.
3070 The work tree may be modified as desired and the histedit operation can be
3071 continued once the changes present in the work tree are considered complete.
3072 Alternatively, the histedit operation may be aborted which will leave
3073 the work tree switched back to its original branch.
3075 If a merge conflict is resolved in a way which renders the merged
3076 change into a no-op change, the corresponding commit will be elided
3077 when the histedit operation continues.
3080 will refuse to run if certain preconditions are not met.
3081 If the work tree's current branch is not in the
3083 reference namespace, the history of the branch may not be edited.
3084 If the work tree contains multiple base commits, it must first be updated
3085 to a single base commit with
3087 If changes have been staged with
3089 these changes must first be committed with
3093 If the work tree contains local changes, these changes must first be
3098 If the edited history contains changes to files outside of the work tree's
3099 path prefix, the work tree cannot be used to edit the history of this branch.
3107 commands will refuse to run while a histedit operation is in progress.
3108 Other commands which manipulate the work tree may be used, and the
3110 command may be used to commit arbitrary changes to the temporary branch
3111 while the histedit operation is interrupted.
3118 Abort an interrupted histedit operation.
3119 If this option is used, no other command-line arguments are allowed.
3121 Allow a histedit operation to continue with files in conflicted status.
3122 This option should generally be avoided, and can only be used with the
3126 Continue an interrupted histedit operation.
3127 If this option is used, no other command-line arguments are allowed except
3131 This option is a quick equivalent to a histedit script which drops all
3135 option can only be used when starting a new histedit operation.
3136 If this option is used, no other command-line arguments are allowed.
3138 Interrupt the histedit operation for editing after merging each commit.
3139 This option is a quick equivalent to a histedit script which uses the
3141 command for all commits.
3144 option can only be used when starting a new histedit operation.
3145 If this option is used, no other command-line arguments are allowed.
3146 .It Fl F Ar histedit-script
3149 instead of opening a temporary file in an editor where a histedit script
3152 Fold all commits into a single commit.
3153 This option is a quick equivalent to a histedit script which folds all
3154 commits, combining them all into one commit.
3157 option can only be used when starting a new histedit operation.
3158 If this option is used, no other command-line arguments are allowed.
3160 Show a list of past histedit operations, represented by references in the
3161 .Dq refs/got/backup/histedit
3162 reference namespace.
3164 Display the author, date, and log message of each backed up commit,
3165 the object ID of the corresponding post-histedit commit, and
3166 the object ID of their common ancestor commit.
3167 Given these object IDs,
3174 options can be used to examine the history of either version of the branch,
3179 option can be used to create a new branch from a pre-histedit state if desired.
3183 is specified, only show commits which at some point in time represented this
3185 Otherwise, list all backed up commits for any branches.
3187 If this option is used,
3189 does not require a work tree.
3190 None of the other options can be used together with
3193 Edit log messages only.
3194 This option is a quick equivalent to a histedit script which edits
3195 only log messages but otherwise leaves every picked commit as-is.
3198 option can only be used when starting a new histedit operation.
3199 If this option is used, no other command-line arguments are allowed.
3201 Delete backups created by past histedit operations, represented by references
3203 .Dq refs/got/backup/histedit
3204 reference namespace.
3208 is specified, only delete backups which at some point in time represented
3210 Otherwise, delete all references found within
3211 .Dq refs/got/backup/histedit .
3213 Any commit, tree, tag, and blob objects belonging to deleted backups
3214 remain in the repository and may be removed separately with
3215 Git's garbage collector or
3216 .Cm gotadmin cleanup .
3218 If this option is used,
3220 does not require a work tree.
3221 None of the other options can be used together with
3225 .It Cm integrate Ar branch
3227 Integrate the specified
3229 into the work tree's current branch.
3230 Files in the work tree are updated to match the contents on the integrated
3232 and the reference of the work tree's branch is changed to point at the
3233 head commit of the integrated
3236 Both branches can be considered equivalent after integration since they
3237 will be pointing at the same commit.
3238 Both branches remain available for future work, if desired.
3239 In case the integrated
3241 is no longer needed it may be deleted with
3244 Show the status of each affected file, using the following status codes:
3245 .Bl -column YXZ description
3246 .It U Ta file was updated
3247 .It D Ta file was deleted
3248 .It A Ta new file was added
3249 .It \(a~ Ta versioned file is obstructed by a non-regular file
3250 .It ! Ta a missing versioned file was restored
3254 will refuse to run if certain preconditions are not met.
3255 Most importantly, the
3257 must have been rebased onto the work tree's current branch with
3259 before it can be integrated, in order to linearize commit history and
3260 resolve merge conflicts.
3261 If the work tree contains multiple base commits, it must first be updated
3262 to a single base commit with
3264 If changes have been staged with
3266 these changes must first be committed with
3270 If the work tree contains local changes, these changes must first be
3284 into the current branch of the work tree.
3285 If the branches have diverged, creates a merge commit.
3288 already includes all commits from the work tree's branch, updates the work
3289 tree's branch to be the same as
3291 without creating a commit, and updates the work tree to the most recent commit
3294 If a linear project history is desired, then use of
3296 should be preferred over
3298 However, even strictly linear projects may require merge commits in order
3299 to merge in new versions of third-party code stored on vendor branches
3303 Merge commits are commits based on multiple parent commits.
3304 The tip commit of the work tree's current branch, which must be in the
3306 reference namespace and must be set with
3310 operation, will be used as the first parent.
3311 The tip commit of the specified
3313 will be used as the second parent.
3315 No ancestral relationship between the two branches is required.
3316 If the two branches have already been merged previously, only new changes
3319 It is not possible to create merge commits with more than two parents.
3320 If more than one branch needs to be merged, then multiple merge commits
3321 with two parents each can be created in sequence.
3323 While merging changes found on the
3325 into the work tree, show the status of each affected file,
3326 using the following status codes:
3327 .Bl -column YXZ description
3328 .It G Ta file was merged
3329 .It C Ta file was merged and conflicts occurred during merge
3330 .It ! Ta changes destined for a missing file were not merged
3331 .It D Ta file was deleted
3332 .It d Ta file's deletion was prevented by local modifications
3333 .It A Ta new file was added
3334 .It \(a~ Ta changes destined for a non-regular file were not merged
3335 .It ? Ta changes destined for an unversioned file were not merged
3338 If merge conflicts occur, the merge operation is interrupted and conflicts
3339 must be resolved before the merge operation can continue.
3340 If any files with destined changes are found to be missing or unversioned,
3341 or if files could not be deleted due to differences in deleted content,
3342 the merge operation will be interrupted to prevent potentially incomplete
3343 changes from being committed to the repository without user intervention.
3344 The work tree may be modified as desired and the merge can be continued
3345 once the changes present in the work tree are considered complete.
3346 Alternatively, the merge operation may be aborted which will leave
3347 the work tree's current branch unmodified.
3350 will refuse to run if certain preconditions are not met.
3351 If the work tree's current branch is not in the
3353 reference namespace then the work tree must first be switched to a
3358 If the work tree is not yet fully updated to the tip commit of its
3359 branch, then the work tree must first be updated with
3361 If the work tree contains multiple base commits, it must first be updated
3362 to a single base commit with
3364 If changes have been staged with
3366 these changes must first be committed with
3370 If the work tree contains local changes, these changes must first be
3377 contains changes to files outside of the work tree's path prefix,
3378 the work tree cannot be used to merge this branch.
3388 commands will refuse to run while a merge operation is in progress.
3389 Other commands which manipulate the work tree may be used for
3390 conflict resolution purposes.
3397 Abort an interrupted merge operation.
3398 If this option is used, no other command-line arguments are allowed.
3400 Allow a merge operation to continue with files in conflicted status.
3401 This option should generally be avoided, and can only be used with the
3405 Continue an interrupted merge operation.
3406 If this option is used, no other command-line arguments are allowed except
3409 Create a merge commit even if the branches have not diverged.
3411 Merge changes into the work tree as usual but do not create a merge
3413 The merge result can be adjusted as desired before a merge commit is
3416 Alternatively, the merge may be aborted with
3423 .Op Fl F Ar response-script
3427 Stage local changes for inclusion in the next commit.
3430 is specified, stage all changes in the work tree.
3431 Otherwise, stage changes at or within the specified paths.
3432 Paths may be staged if they are added, modified, or deleted according to
3435 Show the status of each affected file, using the following status codes:
3436 .Bl -column YXZ description
3437 .It A Ta file addition has been staged
3438 .It M Ta file modification has been staged
3439 .It D Ta file deletion has been staged
3442 Staged file contents are saved in newly created blob objects in the repository.
3443 These blobs will be referred to by tree objects once staged changes have been
3446 Staged changes affect the behaviour of
3451 While paths with staged changes exist, the
3453 command will refuse to commit any paths which do not have staged changes.
3454 Local changes created on top of staged changes can only be committed if
3455 the path is staged again, or if the staged changes are committed first.
3458 command will show both local changes and staged changes.
3461 command is able to display local changes relative to staged changes,
3462 and to display staged changes relative to the repository.
3465 command cannot revert staged changes but may be used to revert
3466 local changes created on top of staged changes.
3472 .It Fl F Ar response-script
3480 responses line-by-line from the specified
3482 file instead of prompting interactively.
3484 Instead of staging new changes, list paths which are already staged,
3485 along with the IDs of staged blob objects and stage status codes.
3486 If paths were provided on the command line, show the staged paths
3487 among the specified paths.
3488 Otherwise, show all staged paths.
3490 Instead of staging the entire content of a changed file, interactively
3491 select or reject changes for staging based on
3495 (reject change), and
3497 (quit staging this file) responses.
3498 If a file is in modified status, individual patches derived from the
3499 modified file content can be staged.
3500 Files in added or deleted status may only be staged or rejected in
3503 Allow staging of symbolic links which point outside of the path space
3504 that is under version control.
3507 will reject such symbolic links due to safety concerns.
3510 may decide to represent such a symbolic link as a regular file which contains
3511 the link's target path, rather than creating an actual symbolic link which
3512 points outside of the work tree.
3513 Use of this option is discouraged because external mechanisms such as
3515 are better suited for managing symbolic links to paths not under
3520 will refuse to run if certain preconditions are not met.
3521 If a file contains merge conflicts, these conflicts must be resolved first.
3522 If a file is found to be out of date relative to the head commit on the
3523 work tree's current branch, the file must be updated with
3525 before it can be staged (however, this does not prevent the file from
3526 becoming out-of-date at some point after having been staged).
3534 commands will refuse to run while staged changes exist.
3535 If staged changes cannot be committed because a staged path
3536 is out of date, the path must be unstaged with
3538 before it can be updated with
3540 and may then be staged again if necessary.
3545 .Op Fl F Ar response-script
3549 Merge staged changes back into the work tree and put affected paths
3550 back into non-staged status.
3553 is specified, unstage all staged changes across the entire work tree.
3554 Otherwise, unstage changes at or within the specified paths.
3556 Show the status of each affected file, using the following status codes:
3557 .Bl -column YXZ description
3558 .It G Ta file was unstaged
3559 .It C Ta file was unstaged and conflicts occurred during merge
3560 .It ! Ta changes destined for a missing file were not merged
3561 .It D Ta file was staged as deleted and still is deleted
3562 .It d Ta file's deletion was prevented by local modifications
3563 .It \(a~ Ta changes destined for a non-regular file were not merged
3570 .It Fl F Ar response-script
3578 responses line-by-line from the specified
3580 file instead of prompting interactively.
3582 Instead of unstaging the entire content of a changed file, interactively
3583 select or reject changes for unstaging based on
3587 (keep change staged), and
3589 (quit unstaging this file) responses.
3590 If a file is staged in modified status, individual patches derived from the
3591 staged file content can be unstaged.
3592 Files staged in added or deleted status may only be unstaged in their entirety.
3598 .Op Fl r Ar repository-path
3601 Parse and print contents of objects to standard output in a line-based
3603 Content of commit, tree, and tag objects is printed in a way similar
3604 to the actual content stored in such objects.
3605 Blob object contents are printed as they would appear in files on disk.
3607 Attempt to interpret each argument as a reference, a tag name, or
3608 an object ID SHA1 hash.
3609 References will be resolved to an object ID.
3610 Tag names will resolved to a tag object.
3611 An abbreviated hash argument will be expanded to a full SHA1 hash
3612 automatically, provided the abbreviation is unique.
3614 If none of the above interpretations produce a valid result, or if the
3616 option is used, attempt to interpret the argument as a path which will
3617 be resolved to the ID of an object found at this path in the repository.
3624 Look up paths in the specified
3626 If this option is not used, paths are looked up in the commit resolved
3627 via the repository's HEAD reference.
3629 The expected argument is a commit ID SHA1 hash, or a reference name
3630 or keyword which will be resolved to a commit ID.
3631 An abbreviated hash argument will be expanded to a full SHA1 hash
3632 automatically, provided the abbreviation is unique.
3637 resolve to the work tree's base commit and branch head, respectively.
3638 The former is only valid if invoked in a work tree, while the latter will
3639 resolve to the tip of the work tree's current branch if invoked in a
3640 work tree, otherwise it will resolve to the repository's HEAD reference.
3641 Keywords and references may be appended with
3645 modifiers and an optional integer N to denote the
3646 Nth descendant or antecedent by first parent traversal, respectively;
3649 denotes the work tree branch head's 2nd generation ancestor, and
3651 denotes the 4th generation descendant of the work tree's base commit.
3654 will denote the 8th generation ancestor of the commit resolved by the
3661 modifier without a trailing integer has an implicit
3670 Interpret all arguments as paths only.
3671 This option can be used to resolve ambiguity in cases where paths
3672 look like tag names, reference names, or object IDs.
3673 .It Fl r Ar repository-path
3674 Use the repository at the specified path.
3675 If not specified, assume the repository is located at or above the current
3677 If this directory is a
3679 work tree, use the repository path associated with this work tree.
3681 .It Cm info Op Ar path ...
3682 Display meta-data stored in a work tree.
3687 The work tree to use is resolved implicitly by walking upwards from the
3688 current working directory.
3692 arguments are specified, show additional per-file information for tracked
3693 files located at or within these paths.
3696 argument corresponds to the work tree's root directory, display information
3697 for all tracked files.
3700 .Bl -tag -width GOT_IGNORE_GITCONFIG
3702 The author's name and email address, such as
3703 .Dq An Flan Hacker Aq Mt flan_hacker@openbsd.org .
3714 may fail to parse commits without an email address in author data,
3718 environment variables with a missing email address.
3720 .Ev GOT_AUTHOR will be overridden by configuration settings in
3726 configuration settings in the repository's
3733 configuration settings contained in Git's global
3735 configuration file will only be used if neither
3739 environment variable provide author information.
3740 .It Ev GOT_IGNORE_GITCONFIG
3741 If this variable is set then any remote repository definitions or author
3742 information found in Git configuration files will be ignored.
3743 .It Ev GOT_LOG_DEFAULT_LIMIT
3744 The default limit on the number of commits traversed by
3746 If set to zero, the limit is unbounded.
3747 This variable will be silently ignored if it is set to a non-numeric value.
3748 .It Ev VISUAL , EDITOR
3749 The editor spawned by
3757 text editor will be spawned.
3760 .Bl -tag -width packed-refs -compact
3762 Repository-wide configuration settings for
3766 configuration file located in the root directory of a Git repository
3767 supersedes any relevant settings in Git's
3771 .It Pa .got/got.conf
3772 Worktree-specific configuration settings for
3776 configuration file in the
3778 meta-data directory of a work tree supersedes any relevant settings in
3781 configuration file and Git's
3788 Enable tab-completion of
3793 .Dl $ set -A complete_got_1 -- $(got -h 2>&1 | sed -n s/commands://p)
3795 Clone an existing Git repository for use with
3799 .Dl $ got clone ssh://git@github.com/openbsd/src.git
3801 Unfortunately, many of the popular Git hosting sites do not offer anonymous
3803 Such sites will require an account to be created, and a public SSH key to be
3804 uploaded to this account, before repository access via ssh:// URLs will work.
3806 Use of HTTP URLs currently requires
3810 .Dl $ git clone --bare https://github.com/openbsd/src.git
3812 Alternatively, for quick and dirty local testing of
3814 a new Git repository could be created and populated with files,
3815 e.g. from a temporary CVS checkout located at
3818 .Dl $ gotadmin init /var/git/src.git
3819 .Dl $ got import -r /var/git/src.git -I CVS -I obj /tmp/src
3821 Check out a work tree from the Git repository to /usr/src:
3823 .Dl $ got checkout /var/git/src.git /usr/src
3825 View local changes in a work tree directory:
3827 .Dl $ got diff | less
3829 In a work tree, display files in a potentially problematic state:
3831 .Dl $ got status -s 'C!~?'
3833 Interactively revert selected local changes in a work tree directory:
3835 .Dl $ got revert -p -R\ .
3837 In a work tree or a git repository directory, list all branch references:
3841 As above, but list the most recently modified branches only:
3843 .Dl $ got branch -lt | head
3845 In a work tree or a git repository directory, create a new branch called
3846 .Dq unified-buffer-cache
3847 which is forked off the
3851 .Dl $ got branch -c master unified-buffer-cache
3853 Switch an existing work tree to the branch
3854 .Dq unified-buffer-cache .
3855 Local changes in the work tree will be preserved and merged if necessary:
3857 .Dl $ got update -b unified-buffer-cache
3859 Create a new commit from local changes in a work tree directory.
3860 This new commit will become the head commit of the work tree's current branch:
3864 In a work tree or a git repository directory, view changes committed in
3865 the 3 most recent commits to the work tree's branch, or the branch resolved
3866 via the repository's HEAD reference, respectively:
3868 .Dl $ got log -p -l 3
3870 As above, but display changes in the order in which
3872 could apply them in sequence:
3874 .Dl $ got log -p -l 3 -R
3876 In a work tree or a git repository directory, log the history of a subdirectory:
3878 .Dl $ got log sys/uvm
3880 While operating inside a work tree, paths are specified relative to the current
3881 working directory, so this command will log the subdirectory
3884 .Dl $ cd sys/uvm && got log\ .
3886 And this command has the same effect:
3888 .Dl $ cd sys/dev/usb && got log ../../uvm
3890 And this command displays work tree meta-data about all tracked files:
3893 .Dl $ got info\ . | less
3895 Add new files and remove obsolete files in a work tree directory:
3897 .Dl $ got add sys/uvm/uvm_ubc.c
3898 .Dl $ got remove sys/uvm/uvm_vnode.c
3900 Create a new commit from local changes in a work tree directory
3901 with a pre-defined log message.
3903 .Dl $ got commit -m 'unify the buffer cache'
3905 Alternatively, create a new commit from local changes in a work tree
3906 directory with a log message that has been prepared in the file
3909 .Dl $ got commit -F /tmp/msg
3911 Update any work tree checked out from the
3912 .Dq unified-buffer-cache
3913 branch to the latest commit on this branch:
3917 Roll file content on the unified-buffer-cache branch back by one commit,
3918 and then fetch the rolled-back change into the work tree as a local change
3919 to be amended and perhaps committed again:
3921 .Dl $ got backout unified-buffer-cache
3922 .Dl $ got commit -m 'roll back previous'
3923 .Dl $ # now back out the previous backout :-)
3924 .Dl $ got backout unified-buffer-cache
3926 Fetch new changes on the remote repository's
3928 branch, making them visible on the local repository's
3935 In a repository created with a HTTP URL and
3936 .Cm git clone --bare
3939 command must be used instead:
3941 .Dl $ cd /var/git/src.git
3942 .Dl $ git fetch origin master:refs/remotes/origin/master
3946 branch to merge the new changes that are now visible on the
3951 .Dl $ got update -b origin/master
3952 .Dl $ got rebase master
3955 .Dq unified-buffer-cache
3956 branch on top of the new head commit of the
3960 .Dl $ got update -b master
3961 .Dl $ got rebase unified-buffer-cache
3963 Create a patch from all changes on the unified-buffer-cache branch.
3964 The patch can be mailed out for review and applied to
3968 .Dl $ got diff master unified-buffer-cache > /tmp/ubc.diff
3970 Edit the entire commit history of the
3971 .Dq unified-buffer-cache
3974 .Dl $ got update -b unified-buffer-cache
3975 .Dl $ got update -c master
3978 Before working against existing branches in a repository cloned with
3979 .Cm git clone --bare
3984 must be configured to map all references in the remote repository
3987 namespace of the local repository.
3988 This can be achieved by setting Git's
3989 .Pa remote.origin.fetch
3990 configuration variable to the value
3991 .Dq +refs/heads/*:refs/remotes/origin/*
3996 .Dl $ cd /var/git/repo
3997 .Dl $ git config remote.origin.fetch '+refs/heads/*:refs/remotes/origin/*'
4001 option must be disabled:
4003 .Dl $ cd /var/git/repo
4004 .Dl $ git config remote.origin.mirror false
4006 Alternatively, the following
4008 configuration item can be added manually to the Git repository's
4012 .Dl [remote \&"origin\&"]
4014 .Dl fetch = +refs/heads/*:refs/remotes/origin/*
4017 This configuration leaves the local repository's
4019 namespace free for use by local branches checked out with
4021 and, if needed, created with
4024 .Dq refs/remotes/origin
4025 namespace can now be updated with incoming changes from the remote
4030 without extra command line arguments.
4031 Newly fetched changes can be examined with
4034 Display changes on the remote repository's version of the
4036 branch, as of the last time
4040 .Dl $ got log -c origin/master | less
4042 As shown here, most commands accept abbreviated reference names such as
4045 .Dq refs/remotes/origin/master .
4046 The latter is only needed in case of ambiguity.
4049 can be used to merge changes which are visible on the
4054 This will also merge local changes, if any, with the incoming changes:
4056 .Dl $ got update -b origin/master
4057 .Dl $ got rebase master
4059 In order to make changes committed to the
4060 .Dq unified-buffer-cache
4064 .Dq unified-buffer-cache
4065 branch can be rebased onto the
4069 .Dl $ got update -b master
4070 .Dl $ got rebase unified-buffer-cache
4073 .Dq unified-buffer-cache
4074 branch can now be made visible on the
4078 Because the rebase operation switched the work tree to the
4079 .Dq unified-buffer-cache
4080 branch, the work tree must be switched back to the
4084 .Dl $ got update -b master
4085 .Dl $ got integrate unified-buffer-cache
4089 branch, log messages for local changes can now be amended with
4091 by other developers and any other important new information:
4093 .Dl $ got update -c origin/master
4094 .Dl $ got histedit -m
4096 If the remote repository offers write access, local changes on the
4098 branch can be sent to the remote repository with
4102 can be run without further arguments.
4103 The arguments shown here match defaults, provided the work tree's
4104 current branch is the
4108 .Dl $ got send -b master origin
4110 If the remote repository requires the HTTPS protocol, the
4112 command must be used instead:
4114 .Dl $ cd /var/git/src.git
4115 .Dl $ git push origin master
4117 When making contributions to projects which use the
4119 workflow, SSH protocol repository access needs to be set up first.
4120 Once an account has been created on a Git hosting site it should
4121 be possible to upload a public SSH key for repository access
4126 workflow will usually involve two remote repositories.
4127 In the real-life example below, the
4129 repository was forked from the
4131 repository by using the Git hosting site's web interface.
4134 file in the local repository describes both remote repositories:
4135 .Bd -literal -offset indent
4136 # Jelmers's repository, which accepts pull requests
4138 server git@github.com
4140 repository "/jelmer/dulwich"
4144 # Stefan's fork, used as the default remote repository
4146 server git@github.com
4148 repository "/stspdotname/dulwich"
4153 With this configuration, Stefan can create commits on
4154 .Dq refs/heads/master
4155 and send them to the
4157 repository by running:
4159 .Dl $ got send -b master origin
4161 The changes can now be proposed to Jelmer by opening a pull request
4162 via the Git hosting site's web interface.
4163 If Jelmer requests further changes to be made, additional commits
4164 can be created on the
4166 branch and be added to the pull request by running
4170 If Jelmer prefers additional commits to be
4172 then the following commands can be used to achieve this:
4174 .Dl $ got update -b master
4175 .Dl $ got update -c origin/master
4176 .Dl $ got histedit -f
4177 .Dl $ got send -f -b master origin
4179 In addition to reviewing the pull request in the web user interface,
4180 Jelmer can fetch the pull request's branch into his local repository
4181 and create a local branch which contains the proposed changes:
4183 .Dl $ got fetch -R refs/pull/1046/head origin
4184 .Dl $ got branch -c refs/remotes/origin/pull/1046/head pr1046
4186 Once Jelmer has accepted the pull request, Stefan can fetch the
4187 merged changes, and possibly several other new changes, by running:
4189 .Dl $ got fetch upstream
4191 The merged changes will now be visible under the reference
4192 .Dq refs/remotes/upstream/master .
4195 branch can now be rebased on top of the latest changes
4198 .Dl $ got update -b upstream/master
4199 .Dl $ got rebase master
4201 As an alternative to
4203 branches can be merged with
4206 .Dl $ got update -b master
4207 .Dl $ got merge upstream/master
4209 The question of whether to rebase or merge branches is philosophical.
4210 When in doubt, refer to the software project's policies set by project
4213 As a final step, the forked repository's copy of the master branch needs
4214 to be kept in sync by sending the new changes there:
4216 .Dl $ got send -f -b master origin
4218 If multiple pull requests need to be managed in parallel, a separate branch
4219 must be created for each pull request with
4221 Each such branch can then be used as above, in place of
4222 .Dq refs/heads/master .
4223 Changes for any accepted pull requests will still appear under
4224 .Dq refs/remotes/upstream/master,
4225 regardless of which branch was used in the forked repository to
4226 create a pull request.
4230 .Xr git-repository 5 ,
4231 .Xr got-worktree 5 ,
4235 .An Anthony J. Bentley Aq Mt bentley@openbsd.org
4236 .An Christian Weisgerber Aq Mt naddy@openbsd.org
4237 .An Hiltjo Posthuma Aq Mt hiltjo@codemadness.org
4238 .An Josh Rickmar Aq Mt jrick@zettaport.com
4239 .An Joshua Stein Aq Mt jcs@openbsd.org
4240 .An Klemens Nanni Aq Mt kn@openbsd.org
4241 .An Martin Pieuchot Aq Mt mpi@openbsd.org
4242 .An Neels Hofmeyr Aq Mt neels@hofmeyr.de
4243 .An Omar Polo Aq Mt op@openbsd.org
4244 .An Ori Bernstein Aq Mt ori@openbsd.org
4245 .An Sebastien Marie Aq Mt semarie@openbsd.org
4246 .An Stefan Sperling Aq Mt stsp@openbsd.org
4247 .An Steven McDonald Aq Mt steven@steven-mcdonald.id.au
4248 .An Theo Buehler Aq Mt tb@openbsd.org
4249 .An Thomas Adam Aq Mt thomas@xteddy.org
4250 .An Tracey Emery Aq Mt tracey@traceyemery.net
4251 .An Yang Zhong Aq Mt yzhong@freebsdfoundation.org
4258 were derived from code under copyright by:
4260 .An Caldera International
4261 .An Daniel Hartmeier
4266 .An Jean-Francois Brousseau
4272 .An Niklas Hallqvist
4277 .An Xavier Santolaria
4280 contains code contributed to the public domain by
4281 .An Austin Appleby .
4284 is a work-in-progress and some features remain to be implemented.
4286 At present, the user has to fall back on
4288 to perform some tasks.
4292 Reading from remote repositories over HTTP or HTTPS protocols requires
4297 Writing to remote repositories over HTTP or HTTPS protocols requires
4300 The creation of merge commits with more than two parent commits requires
4303 In situations where files or directories were moved around
4305 will not automatically merge changes to new locations and
4307 will usually produce better results.
