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
981 option (diffstat displays a list of changed paths).
983 Limit history traversal to a given number of commits.
984 If this option is not specified, a default limit value of zero is used,
985 which is treated as an unbounded limit.
987 .Ev GOT_LOG_DEFAULT_LIMIT
988 environment variable may be set to change this default value.
990 Display the list of file paths changed in each commit, using the following
992 .Bl -column YXZ description
993 .It M Ta modified file
994 .It D Ta file was deleted
995 .It A Ta new file was added
996 .It m Ta modified file modes (executable bit only)
999 Cannot be used with the
1003 Display the patch of modifications made in each commit.
1006 is specified, only show the patch of modifications at or within this path.
1007 Cannot be used with the
1011 Determine a set of commits to display as usual, but display these commits
1013 .It Fl r Ar repository-path
1014 Use the repository at the specified path.
1015 If not specified, assume the repository is located at or above the current
1017 If this directory is a
1019 work tree, use the repository path associated with this work tree.
1020 .It Fl S Ar search-pattern
1021 If specified, show only commits with a log message, author name,
1022 committer name, or ID SHA1 hash matched by the extended regular
1024 .Ar search-pattern .
1025 Lines in committed patches will be matched if
1028 File paths changed by a commit will be matched if
1031 Regular expression syntax is documented in
1034 Display a short one-line summary of each commit, instead of the default
1036 Cannot be used together with the
1042 Display commits in topological order.
1043 This option has no effect without the
1045 option because a linear history is sorted in topological order by definition.
1046 Topological sorting is disabled by default because the present implementation
1047 requires that commit history is fully traversed before any output can be shown.
1049 Stop traversing commit history immediately after the specified
1056 argument is a commit ID SHA1 hash, or a reference name or a keyword
1057 which will be resolved to a commit ID.
1058 This option has no effect if the specified
1068 .Op Fl r Ar repository-path
1069 .Op Ar object1 Ar object2 | Ar path ...
1072 When invoked within a work tree without any arguments, display all
1073 local changes in the work tree.
1076 arguments are specified, only show changes within the specified paths.
1078 If two arguments are provided, treat each argument as a reference, a tag
1079 name, or an object ID SHA1 hash, and display differences between the
1080 corresponding objects.
1081 Both objects must be of the same type (blobs, trees, or commits).
1082 An abbreviated hash argument will be expanded to a full SHA1 hash
1083 automatically, provided the abbreviation is unique.
1084 If none of these interpretations produce a valid result or if the
1089 is running in a work tree, attempt to interpret the two arguments as paths.
1096 Treat file contents as ASCII text even if binary data is detected.
1098 Set the number of context lines shown in the diff.
1099 By default, 3 lines of context are shown.
1101 Show differences between commits in the repository.
1102 This option may be used up to two times.
1103 When used only once, show differences between the specified
1105 and its first parent commit.
1106 When used twice, show differences between the two specified commits.
1110 option is used, all non-option arguments will be interpreted as paths.
1113 arguments are provided, only show differences for the specified paths.
1117 argument is a commit ID SHA1 hash, or a reference name or a keyword
1118 which will be resolved to a commit ID.
1119 An abbreviated hash argument will be expanded to a full SHA1 hash
1120 automatically, provided the abbreviation is unique.
1125 resolve to the work tree's base commit and branch head, respectively.
1126 The former is only valid if invoked in a work tree, while the latter will
1127 resolve to the tip of the work tree's current branch if invoked in a
1128 work tree, otherwise it will resolve to the repository's HEAD reference.
1129 Keywords and references may be appended with
1133 modifiers and an optional integer N to denote the
1134 Nth descendant or antecedent, respectively, by first parent traversal;
1137 denotes the HEAD reference's 2nd generation ancestor, and
1139 denotes the 4th generation descendant of the work tree's base commit.
1142 will denote the 8th generation descendant of the commit resolved by the
1145 If an integer does not follow the
1151 is implicitly appended
1158 Cannot be used together with the
1162 Display diffstat of changes before the actual diff by annotating each file path
1163 or blob hash being diffed with the total number of lines added and removed.
1164 A summary line will display the total number of changes across all files.
1166 Interpret all arguments as paths only.
1167 This option can be used to resolve ambiguity in cases where paths
1168 look like tag names, reference names, or object IDs.
1169 This option is only valid when
1171 is invoked in a work tree.
1172 .It Fl r Ar repository-path
1173 Use the repository at the specified path.
1174 If not specified, assume the repository is located at or above the current
1176 If this directory is a
1178 work tree, use the repository path associated with this work tree.
1180 Show changes staged with
1182 instead of showing local changes in the work tree.
1183 This option is only valid when
1185 is invoked in a work tree.
1187 Ignore whitespace-only changes.
1193 .Op Fl r Ar repository-path
1197 Display line-by-line history of a file at the specified path.
1204 Start traversing history at the specified
1206 The expected argument is a commit ID SHA1 hash, or a reference name
1207 or a keyword which will be resolved to a commit ID.
1208 An abbreviated hash argument will be expanded to a full SHA1 hash
1209 automatically, provided the abbreviation is unique.
1214 resolve to the work tree's base commit and branch head, respectively.
1215 The former is only valid if invoked in a work tree, while the latter will
1216 resolve to the tip of the work tree's current branch if invoked in a
1217 work tree, otherwise it will resolve to the repository's HEAD reference.
1218 Keywords and references may be appended with
1222 modifiers and an optional integer N to denote the
1223 Nth descendant or antecedent by first parent traversal, respectively;
1226 denotes the work tree branch head's 2nd generation ancestor, and
1228 denotes the 4th generation descendant of the work tree's base commit.
1231 will denote the 5th generation ancestor of the commit resolved by the
1238 modifier without a trailing integer has an implicit
1246 .It Fl r Ar repository-path
1247 Use the repository at the specified path.
1248 If not specified, assume the repository is located at or above the current
1250 If this directory is a
1252 work tree, use the repository path associated with this work tree.
1259 .Op Fl r Ar repository-path
1263 Display a listing of files and directories at the specified
1264 directory path in the repository.
1265 Entries shown in this listing may carry one of the following trailing
1267 .Bl -column YXZ description
1268 .It @ Ta entry is a symbolic link
1269 .It / Ta entry is a directory
1270 .It * Ta entry is an executable file
1271 .It $ Ta entry is a Git submodule
1274 Symbolic link entries are also annotated with the target path of the link.
1278 is specified, list the repository path corresponding to the current
1279 directory of the work tree, or the root directory of the repository
1280 if there is no work tree.
1287 List files and directories as they appear in the specified
1290 The expected argument is a commit ID SHA1 hash, or a reference name
1291 or a keyword which will be resolved to a commit ID.
1292 An abbreviated hash argument will be expanded to a full SHA1 hash
1293 automatically, provided the abbreviation is unique.
1298 resolve to the work tree's base commit and branch head, respectively.
1299 The former is only valid if invoked in a work tree, while the latter will
1300 resolve to the tip of the work tree's current branch if invoked in a
1301 work tree, otherwise it will resolve to the repository's HEAD reference.
1302 Keywords and references may be appended with
1306 modifiers and an optional integer N to denote the
1307 Nth descendant or antecedent by first parent traversal, respectively;
1310 denotes the work tree branch head's 2nd generation ancestor, and
1312 denotes the 4th generation descendant of the work tree's base commit.
1315 will denote the 3rd generation ancestor of the commit resolved by the
1322 modifier without a trailing integer has an implicit
1331 Show object IDs of files (blob objects) and directories (tree objects).
1333 Recurse into sub-directories in the repository.
1334 .It Fl r Ar repository-path
1335 Use the repository at the specified path.
1336 If not specified, assume the repository is located at or above the current
1338 If this directory is a
1340 work tree, use the repository path associated with this work tree.
1346 .Op Fl r Ar repository-path
1347 .Op Fl s Ar reference
1350 Manage references in a repository.
1352 References may be listed, created, deleted, and changed.
1353 When creating, deleting, or changing a reference the specified
1355 must be an absolute reference name, i.e. it must begin with
1363 Create a reference or change an existing reference.
1364 The reference with the specified
1366 will point at the specified
1371 argument is an ID SHA1 hash or an existing reference or tag name
1372 or a keyword which will be resolved to the ID of a corresponding commit,
1373 tree, tag, or blob object.
1374 An abbreviated hash argument will be expanded to a full SHA1 hash
1375 automatically, provided the abbreviation is unique.
1380 resolve to the work tree's base commit and branch head, respectively.
1381 The former is only valid if invoked in a work tree, while the latter will
1382 resolve to the tip of the work tree's current branch if invoked in a
1383 work tree, otherwise it will resolve to the repository's HEAD reference.
1384 Keywords and reference names may be appended with
1388 modifiers and an optional integer N to denote the
1389 Nth descendant or antecedent by first parent traversal, respectively;
1392 denotes the work tree branch head's 2nd generation ancestor, and
1394 will denote the 3rd generation ancestor of the commit resolved by the
1397 If an integer does not follow the
1403 is implicitly appended
1410 Cannot be used together with any other options except
1413 Delete the reference with the specified
1415 from the repository.
1416 Any commit, tree, tag, and blob objects belonging to deleted references
1417 remain in the repository and may be removed separately with
1418 Git's garbage collector or
1419 .Cm gotadmin cleanup .
1420 Cannot be used together with any other options except
1423 List references in the repository.
1426 is specified, list all existing references in the repository.
1429 is a reference namespace, list all references in this namespace.
1430 Otherwise, show only the reference with the given
1432 Cannot be used together with any other options except
1436 .It Fl r Ar repository-path
1437 Use the repository at the specified path.
1438 If not specified, assume the repository is located at or above the current
1440 If this directory is a
1442 work tree, use the repository path associated with this work tree.
1443 .It Fl s Ar reference
1444 Create a symbolic reference, or change an existing symbolic reference.
1445 The symbolic reference with the specified
1447 will point at the specified
1449 which must already exist in the repository.
1450 Care should be taken not to create loops between references when
1451 this option is used.
1452 Cannot be used together with any other options except
1455 Sort listed references by modification time (most recently modified first)
1456 instead of sorting by lexicographical order.
1457 Use of this option requires the
1459 option to be used as well.
1467 .Op Fl r Ar repository-path
1471 Create, list, or delete branches.
1473 Local branches are managed via references which live in the
1475 reference namespace.
1478 command creates references in this namespace only.
1480 When deleting branches, the specified
1484 reference namespace first.
1485 If no corresponding branch is found, the
1487 namespace will be searched next.
1489 If invoked in a work tree without any arguments, print the name of the
1490 work tree's current branch.
1494 argument is passed, attempt to create a branch reference with the given name.
1495 By default the new branch reference will point at the latest commit on the
1496 work tree's current branch if invoked in a work tree, and otherwise to a commit
1497 resolved via the repository's HEAD reference.
1499 If invoked in a work tree, once the branch was created successfully
1500 switch the work tree's head reference to the newly created branch and
1501 update files across the entire work tree, just like
1502 .Cm got update -b Ar name
1504 Show the status of each affected file, using the following status codes:
1505 .Bl -column YXZ description
1506 .It U Ta file was updated and contained no local changes
1507 .It G Ta file was updated and local changes were merged cleanly
1508 .It C Ta file was updated and conflicts occurred during merge
1509 .It D Ta file was deleted
1510 .It A Ta new file was added
1511 .It \(a~ Ta versioned file is obstructed by a non-regular file
1512 .It ! Ta a missing versioned file was restored
1520 Make a newly created branch reference point at the specified
1522 The expected argument is a commit ID SHA1 hash, or a reference name or keyword
1523 which will be resolved to a commit ID.
1524 An abbreviated hash argument will be expanded to a full SHA1 hash
1525 automatically, provided the abbreviation is unique.
1530 resolve to the work tree's base commit and branch head, respectively.
1531 The former is only valid if invoked in a work tree, while the latter will
1532 resolve to the tip of the work tree's current branch if invoked in a
1533 work tree, otherwise it will resolve to the repository's HEAD reference.
1534 Keywords and references may be appended with
1538 modifiers and an optional integer N to denote the
1539 Nth descendant or antecedent by first parent traversal, respectively;
1542 denotes the work tree branch head's 2nd generation ancestor, and
1544 denotes the 4th generation descendant of the work tree's base commit.
1547 will denote the 3rd generation descendant of the commit resolved by the
1554 modifier without a trailing integer has an implicit
1563 Delete the branch with the specified
1569 reference namespace.
1571 Only the branch reference is deleted.
1572 Any commit, tree, and blob objects belonging to the branch
1573 remain in the repository and may be removed separately with
1574 Git's garbage collector or
1575 .Cm gotadmin cleanup .
1577 List all existing branches in the repository, including copies of remote
1578 repositories' branches in the
1580 reference namespace.
1582 If invoked in a work tree, the work tree's current branch is shown
1583 with one of the following annotations:
1584 .Bl -column YXZ description
1585 .It * Ta work tree's base commit and the base commit of all tracked files
1586 matches the branch tip
1587 .It \(a~ Ta work tree comprises mixed commits or its base commit is out-of-date
1590 Do not switch and update the work tree after creating a new branch.
1591 .It Fl r Ar repository-path
1592 Use the repository at the specified path.
1593 If not specified, assume the repository is located at or above the current
1595 If this directory is a
1597 work tree, use the repository path associated with this work tree.
1599 Sort listed branches by modification time (most recently modified first)
1600 instead of sorting by lexicographical order.
1603 reference namespace are listed before branches in
1606 Use of this option requires the
1608 option to be used as well.
1615 .Op Fl r Ar repository-path
1616 .Op Fl s Ar signer-id
1619 Manage tags in a repository.
1621 Tags are managed via references which live in the
1623 reference namespace.
1626 command operates on references in this namespace only.
1627 References in this namespace point at tag objects which contain a pointer
1628 to another object, a tag message, as well as author and timestamp information.
1630 Attempt to create a tag with the given
1632 and make this tag point at the given
1634 If no commit is specified, default to the latest commit on the work tree's
1635 current branch if invoked in a work tree, and to a commit resolved via
1636 the repository's HEAD reference otherwise.
1643 Make the newly created tag reference point at the specified
1647 argument is a commit ID SHA1 hash, or a reference or keyword
1648 which will be resolved to a commit ID.
1649 An abbreviated hash argument will be expanded to a full SHA1 hash
1650 automatically, provided the abbreviation is unique.
1655 resolve to the work tree's base commit and branch head, respectively.
1656 The former is only valid if invoked in a work tree, while the latter will
1657 resolve to the tip of the work tree's current branch if invoked in a
1658 work tree, otherwise it will resolve to the repository's HEAD reference.
1659 Keywords and references may be appended with
1663 modifiers and an optional integer N to denote the
1664 Nth descendant or antecedent by first parent traversal, respectively;
1667 denotes the work tree branch head's 2nd generation ancestor, and
1669 denotes the 4th generation descendant of the work tree's base commit.
1672 will denote the 3rd generation ancestor of the commit resolved by the
1679 modifier without a trailing integer has an implicit
1688 List all existing tags in the repository instead of creating a new tag.
1691 argument is passed, show only the tag with the given
1694 Use the specified tag message when creating the new tag.
1699 opens a temporary file in an editor where a tag message can be written.
1700 Quitting the editor without saving the file will abort the tag operation.
1701 .It Fl r Ar repository-path
1702 Use the repository at the specified path.
1703 If not specified, assume the repository is located at or above the current
1705 If this directory is a
1707 work tree, use the repository path associated with this work tree.
1708 .It Fl s Ar signer-id
1709 While creating a new tag, sign this tag with the identity given in
1712 For SSH-based signatures,
1714 is the path to a file which may refer to either a private SSH key,
1715 or a public SSH key with the private half available via
1718 will sign the tag object by invoking
1722 command, using the signature namespace
1724 for compatibility with
1727 Verify tag object signatures.
1730 is specified, show and verify the tag object with the provided name.
1731 Otherwise, list all tag objects and verify signatures where present.
1734 verifies SSH-based signatures by invoking
1737 .Fl Y Cm verify Fl f Ar allowed_signers .
1742 otherwise verification is impossible.
1745 During SSH signature creation and verification this option will be passed to
1747 Multiple -v options increase the verbosity.
1753 command will not delete tags or change existing tags.
1754 If a tag must be deleted, the
1756 command may be used to delete a tag's reference.
1757 This should only be done if the tag has not already been copied to
1764 Schedule unversioned files in a work tree for addition to the
1765 repository in the next commit.
1766 By default, files which match a
1768 ignore pattern will not be added.
1772 mentioned in the command line is not an unversioned file then
1775 To avoid unnecessary errors from paths picked up by file globbing patterns
1776 in the shell, paths in the argument list will be silently ignored if they
1779 at all, or if they are reported with one of the following status codes
1780 and do not have changes staged via
1782 .Bl -column YXZ description
1783 .It M Ta modified file
1784 .It A Ta file scheduled for addition in next commit
1785 .It C Ta modified or added file which contains merge conflicts
1786 .It m Ta modified file modes (executable bit only)
1794 Add files even if they match a
1798 Permit recursion into directories.
1799 If this option is not specified,
1801 will refuse to run if a specified
1809 .Op Fl s Ar status-codes
1813 Remove versioned files from a work tree and schedule them for deletion
1814 from the repository in the next commit.
1821 Perform the operation even if a file contains local modifications,
1822 and do not raise an error if a specified
1824 does not exist on disk.
1826 Keep affected files on disk.
1828 Permit recursion into directories.
1829 If this option is not specified,
1831 will refuse to run if a specified
1834 .It Fl s Ar status-codes
1835 Only delete files with a modification status matching one of the
1836 single-character status codes contained in the
1839 The following status codes may be specified:
1840 .Bl -column YXZ description
1841 .It M Ta modified file (this implies the
1844 .It ! Ta versioned file expected on disk but missing
1852 .Op Fl p Ar strip-count
1858 to files in a work tree.
1859 Files added or removed by a patch will be scheduled for addition or removal in
1862 The patch must be in the unified diff format as produced by
1869 diff when invoked with their
1874 argument is provided, read unified diff data from standard input instead.
1878 contains multiple patches, then attempt to apply each of them in sequence.
1880 Show the status of each affected file, using the following status codes:
1881 .Bl -column XYZ description
1882 .It M Ta file was modified
1883 .It G Ta file was merged using a merge-base found in the repository
1884 .It C Ta file was merged and conflicts occurred during merge
1885 .It D Ta file was deleted
1886 .It A Ta file was added
1887 .It # Ta failed to patch the file
1890 If a change does not match at its exact line number, attempt to
1891 apply it somewhere else in the file if a good spot can be found.
1892 Otherwise, the patch will fail to apply.
1896 will refuse to apply a patch if certain preconditions are not met.
1897 Files to be deleted must already be under version control, and must
1898 not have been scheduled for deletion already.
1899 Files to be added must not yet be under version control and must not
1900 already be present on disk.
1901 Files to be modified must already be under version control and may not
1902 contain conflict markers.
1904 If an error occurs, the
1906 operation will be aborted.
1907 Any changes made to the work tree up to this point will be left behind.
1908 Such changes can be viewed with
1910 and can be reverted with
1919 Attempt to locate files within the specified
1921 for use as a merge-base for 3-way merges.
1925 option is not used then
1927 will attempt to locate merge-bases via object IDs found in
1929 meta-data, such as produced by
1935 option is only recommended in the absence of such meta-data.
1937 Ideally, the specified
1939 should contain versions of files which the changes contained in the
1942 Files will be located by path, relative to the repository root.
1945 option is used then leading path components will be stripped
1946 before paths are looked up in the repository.
1948 In case no merge-base is available for a file, changes will be applied
1949 without doing a 3-way merge.
1950 Changes which do not apply cleanly may then be rejected entirely, rather
1951 than producing merge conflicts in the patched target file.
1955 argument is a commit ID SHA1 hash, or a reference name or a keyword
1956 which will be resolved to a commit ID.
1957 An abbreviated hash argument will be expanded to a full SHA1 hash
1958 automatically, provided the abbreviation is unique.
1963 resolve to the work tree's base commit and branch head, respectively.
1964 Keywords and references may be appended with
1968 modifiers and an optional integer N to denote the
1969 Nth descendant or antecedent by first parent traversal, respectively;
1972 denotes the work tree branch head's 2nd generation ancestor, and
1974 denotes the 4th generation descendant of the work tree's base commit.
1977 will denote the 3rd generation descendant of the commit resolved by the
1984 modifier without a trailing integer has an implicit
1993 Do not make any modifications to the work tree.
1994 This can be used to check whether a patch would apply without issues.
1997 contains diffs that affect the same file multiple times, the results
1998 displayed may be incorrect.
1999 .It Fl p Ar strip-count
2000 Specify the number of leading path components to strip from paths
2009 path prefixes generated by
2011 will be recognized and stripped automatically.
2013 Reverse the patch before applying it.
2019 .Op Fl F Ar response-script
2023 Revert any local changes in files at the specified paths in a work tree.
2024 File contents will be overwritten with those contained in the
2025 work tree's base commit.
2026 There is no way to bring discarded changes back after
2029 If a file was added with
2031 it will become an unversioned file again.
2032 If a file was deleted with
2034 it will be restored.
2040 .It Fl F Ar response-script
2048 responses line-by-line from the specified
2050 file instead of prompting interactively.
2052 Instead of reverting all changes in files, interactively select or reject
2053 changes to revert based on
2059 (quit reverting this file) responses.
2060 If a file is in modified status, individual patches derived from the
2061 modified file content can be reverted.
2062 Files in added or deleted status may only be reverted in their entirety.
2064 Permit recursion into directories.
2065 If this option is not specified,
2067 will refuse to run if a specified
2081 Create a new commit in the repository from changes in a work tree
2082 and use this commit as the new base commit for the work tree.
2085 is specified, commit all changes in the work tree.
2086 Otherwise, commit changes at or within the specified paths.
2088 If changes have been explicitly staged for commit with
2090 only commit staged changes and reject any specified paths which
2091 have not been staged.
2094 opens a temporary file in an editor where a log message can be written
2102 options are used together.
2103 Quitting the editor without saving the file will abort the commit operation.
2105 Show the status of each affected file, using the following status codes:
2106 .Bl -column YXZ description
2107 .It M Ta modified file
2108 .It D Ta file was deleted
2109 .It A Ta new file was added
2110 .It m Ta modified file modes (executable bit only)
2113 Files which are not part of the new commit will retain their previously
2114 recorded base commit.
2117 commands may refuse to run while the work tree contains files from
2118 multiple base commits.
2119 The base commit of such a work tree can be made consistent by running
2121 across the entire work tree.
2125 command requires the
2127 environment variable to be set,
2128 unless an author has been configured in
2134 configuration settings can be
2135 obtained from the repository's
2137 file or from Git's global
2146 Set author information in the newly created commit to
2148 This is useful when committing changes on behalf of someone else.
2151 argument must use the same format as the
2153 environment variable.
2155 In addition to storing author information, the newly created commit
2158 information which is obtained, as usual, from the
2160 environment variable, or
2162 or Git configuration settings.
2164 Allow committing files in conflicted status.
2166 Committing files with conflict markers should generally be avoided.
2167 Cases where conflict markers must be stored in the repository for
2168 some legitimate reason should be very rare.
2169 There are usually ways to avoid storing conflict markers verbatim by
2170 applying appropriate programming tricks.
2172 Use the prepared log message stored in the file found at
2174 when creating the new commit.
2176 opens a temporary file in an editor where the prepared log message can be
2177 reviewed and edited further if needed.
2178 Cannot be used together with the
2182 Use the specified log message when creating the new commit.
2183 Cannot be used together with the
2187 This option prevents
2189 from opening the commit message in an editor.
2190 It has no effect unless it is used together with the
2192 option and is intended for non-interactive use such as scripting.
2194 This option prevents
2196 from generating a diff of the to-be-committed changes in a temporary file
2197 which can be viewed while editing a commit message.
2199 Allow the addition of symbolic links which point outside of the path space
2200 that is under version control.
2203 will reject such symbolic links due to safety concerns.
2206 may decide to represent such a symbolic link as a regular file which contains
2207 the link's target path, rather than creating an actual symbolic link which
2208 points outside of the work tree.
2209 Use of this option is discouraged because external mechanisms such as
2211 are better suited for managing symbolic links to paths not under
2216 will refuse to run if certain preconditions are not met.
2217 If the work tree's current branch is not in the
2219 reference namespace, new commits may not be created on this branch.
2220 Local changes may only be committed if they are based on file content
2221 found in the most recent commit on the work tree's branch.
2222 If a path is found to be out of date,
2224 must be used first in order to merge local changes with changes made
2232 .Op Fl r Ar repository-path
2234 .Op Ar remote-repository
2237 Send new changes to a remote repository.
2239 .Ar remote-repository
2243 The remote repository's URL is obtained from the corresponding entry in
2247 file of the local repository, as created by
2250 All objects corresponding to new changes will be written to a temporary
2251 pack file which is then uploaded to the server.
2252 Upon success, references in the
2254 reference namespace of the local repository will be updated to point at
2255 the commits which have been sent.
2257 By default, changes will only be sent if they are based on up-to-date
2258 copies of relevant branches in the remote repository.
2259 If any changes to be sent are based on out-of-date copies or would
2260 otherwise break linear history of existing branches, new changes must
2261 be fetched from the server with
2263 and local branches must be rebased with
2270 option can be used to make exceptions to these requirements.
2277 Send all branches from the local repository's
2279 reference namespace.
2282 option is equivalent to listing all branches with multiple
2285 Cannot be used together with the
2291 from the local repository's
2293 reference namespace.
2294 This option may be specified multiple times to build a list of branches
2296 If this option is not specified, default to the work tree's current branch
2297 if invoked in a work tree, or to the repository's HEAD reference.
2298 Cannot be used together with the
2302 Delete the specified
2304 from the remote repository's
2306 reference namespace.
2307 This option may be specified multiple times to build a list of branches
2310 Only references are deleted.
2311 Any commit, tree, tag, and blob objects belonging to deleted branches
2312 may become subject to deletion by Git's garbage collector running on
2315 Requesting deletion of branches results in an error if the server
2316 does not support this feature or disallows the deletion of branches
2317 based on its configuration.
2319 Attempt to force the server to overwrite existing branches or tags
2320 in the remote repository, even when
2326 would usually be required before changes can be sent.
2327 The server may reject forced requests regardless, depending on its
2330 Any commit, tree, tag, and blob objects belonging to overwritten branches
2331 or tags may become subject to deletion by Git's garbage collector running
2336 reference namespace is globally shared between all repositories.
2339 option to overwrite tags is discouraged because it can lead to
2340 inconsistencies between the tags present in different repositories.
2341 In general, creating a new tag with a different name is recommended
2342 instead of overwriting an existing tag.
2346 option is particularly discouraged if changes being sent are based
2347 on an out-of-date copy of a branch in the remote repository.
2348 Instead of using the
2350 option, new changes should
2353 and local branches should be rebased with
2357 followed by another attempt to send the changes.
2361 option should only be needed in situations where the remote repository's
2362 copy of a branch or tag is known to be out-of-date and is considered
2364 The risks of creating inconsistencies between different repositories
2365 should also be taken into account.
2367 Suppress progress reporting output.
2368 The same option will be passed to
2371 .It Fl r Ar repository-path
2372 Use the repository at the specified path.
2373 If not specified, assume the repository is located at or above the current
2375 If this directory is a
2377 work tree, use the repository path associated with this work tree.
2379 Attempt to send all tags from the local repository's
2381 reference namespace.
2384 option is equivalent to listing all tags with multiple
2387 Cannot be used together with the
2393 from the local repository's
2395 reference namespace, in addition to any branches that are being sent.
2398 option may be specified multiple times to build a list of tags to send.
2399 No tags will be sent if the
2403 Raise an error if the specified
2405 already exists in the remote repository, unless the
2407 option is used to overwrite the server's copy of the tag.
2408 In general, creating a new tag with a different name is recommended
2409 instead of overwriting an existing tag.
2411 Cannot be used together with the
2418 to print debugging messages to standard error output.
2419 The same option will be passed to
2422 Multiple -v options increase the verbosity.
2432 Merge changes from a single
2437 should be on a different branch than the work tree's base commit.
2439 The expected argument is a commit ID SHA1 hash, or a reference name or
2440 keyword which will be resolved to a commit ID.
2441 An abbreviated hash argument will be expanded to a full SHA1 hash
2442 automatically, provided the abbreviation is unique.
2447 resolve to the work tree's base commit and branch head, respectively.
2448 Keywords and references may be appended with
2452 modifiers and an optional integer N to denote the
2453 Nth descendant or antecedent by first parent traversal, respectively;
2456 denotes the work tree branch head's 2nd generation ancestor, and
2458 denotes the 4th generation descendant of the work tree's base commit.
2461 will denote the 3rd generation descendant of the commit resolved by the
2468 modifier without a trailing integer has an implicit
2477 Show the status of each affected file, using the following status codes:
2478 .Bl -column YXZ description
2479 .It G Ta file was merged
2480 .It C Ta file was merged and conflicts occurred during merge
2481 .It ! Ta changes destined for a missing file were not merged
2482 .It D Ta file was deleted
2483 .It d Ta file's deletion was prevented by local modifications
2484 .It A Ta new file was added
2485 .It \(a~ Ta changes destined for a non-regular file were not merged
2486 .It ? Ta changes destined for an unversioned file were not merged
2489 The merged changes will appear as local changes in the work tree, which
2492 amended manually or with further
2498 If invoked in a work tree where no
2503 operation is taking place,
2505 creates a record of commits which have been merged into the work tree.
2506 When a file changed by
2510 the log messages of relevant merged commits will then appear in the editor,
2511 where the messages should be further adjusted to convey the reasons for
2512 cherrypicking the changes.
2513 Upon exiting the editor, if the time stamp of the log message file
2514 is unchanged or the log message is empty,
2516 will fail with an unmodified or empty log message error.
2518 If all the changes in all files touched by a given commit are discarded,
2521 this commit's log message record will also disappear.
2524 will refuse to run if certain preconditions are not met.
2525 If the work tree contains multiple base commits, it must first be updated
2526 to a single base commit with
2528 If any relevant files already contain merge conflicts, these
2529 conflicts must be resolved first.
2537 Display a list of commit log messages recorded by cherrypick operations,
2538 represented by references in the
2539 .Dq refs/got/worktree
2540 reference namespace.
2543 is specified, only show the log message of the specified commit.
2545 If invoked in a work tree, only log messages recorded by cherrypick operations
2546 in the current work tree will be displayed.
2547 Otherwise, all commit log messages will be displayed irrespective of the
2548 work tree in which they were created.
2549 This option cannot be used with
2552 Delete log messages created by previous cherrypick operations, represented by
2554 .Dq refs/got/worktree
2555 reference namespace.
2558 is specified, only delete the log message of the specified commit.
2560 If invoked in a work tree, only log messages recorded by cherrypick operations
2561 in the current work tree will be deleted.
2562 Otherwise, all commit log messages will be deleted irrespective of the
2563 work tree in which they were created.
2564 This option cannot be used with
2575 Reverse-merge changes from a single
2580 should be on the same branch as the work tree's base commit.
2582 The expected argument is a commit ID SHA1 hash, or a reference name
2583 or keyword which will be resolved to a commit ID.
2584 An abbreviated hash argument will be expanded to a full SHA1 hash
2585 automatically, provided the abbreviation is unique.
2590 resolve to the work tree's base commit and branch head, respectively.
2591 Keywords and references may be appended with
2595 modifiers and an optional integer N to denote the
2596 Nth descendant or antecedent by first parent traversal, respectively;
2599 denotes the work tree branch head's 2nd generation ancestor, and
2601 denotes the 4th generation descendant of the work tree's base commit.
2604 will denote the 5th generation descendant of the commit resolved by the
2611 modifier without a trailing integer has an implicit
2620 Show the status of each affected file, using the following status codes:
2621 .Bl -column YXZ description
2622 .It G Ta file was merged
2623 .It C Ta file was merged and conflicts occurred during merge
2624 .It ! Ta changes destined for a missing file were not merged
2625 .It D Ta file was deleted
2626 .It d Ta file's deletion was prevented by local modifications
2627 .It A Ta new file was added
2628 .It \(a~ Ta changes destined for a non-regular file were not merged
2629 .It ? Ta changes destined for an unversioned file were not merged
2632 The reverse-merged changes will appear as local changes in the work tree,
2633 which may be viewed with
2635 amended manually or with further
2641 If invoked in a work tree where no
2646 operation is taking place,
2648 creates a record of commits which have been reverse-merged into the work tree.
2649 When a file changed by
2653 the log messages of relevant reverse-merged commits will then appear in
2654 the editor, where the messages should be further adjusted to convey the
2655 reasons for backing out the changes.
2656 Upon exiting the editor, if the time stamp of the log message file
2657 is unchanged or the log message is empty,
2659 will fail with an unmodified or empty log message error.
2661 If all the changes in all files touched by a given commit are discarded,
2664 this commit's log message record will also disappear.
2667 will refuse to run if certain preconditions are not met.
2668 If the work tree contains multiple base commits, it must first be updated
2669 to a single base commit with
2671 If any relevant files already contain merge conflicts, these
2672 conflicts must be resolved first.
2680 Display a list of commit log messages recorded by backout operations,
2681 represented by references in the
2682 .Dq refs/got/worktree
2683 reference namespace.
2686 is specified, only show the log message of the specified commit.
2688 If invoked in a work tree, only log messages recorded by backout operations
2689 in the current work tree will be displayed.
2690 Otherwise, all commit log messages will be displayed irrespective of the
2691 work tree in which they were created.
2692 This option cannot be used with
2695 Delete log messages created by previous backout operations, represented by
2697 .Dq refs/got/worktree
2698 reference namespace.
2701 is specified, only delete the log message of the specified commit.
2703 If invoked in a work tree, only log messages recorded by backout operations
2704 in the current work tree will be deleted.
2705 Otherwise, all commit log messages will be deleted irrespective of the
2706 work tree in which they were created.
2707 This option cannot be used with
2718 Rebase commits on the specified
2720 onto the tip of the current branch of the work tree.
2723 must share common ancestry with the work tree's current branch.
2724 Rebasing begins with the first descendant commit of the youngest
2725 common ancestor commit shared by the specified
2727 and the work tree's current branch, and stops once the tip commit
2734 is used as intended, the specified
2736 represents a local commit history and may already contain changes
2737 that are not yet visible in any other repositories.
2738 The work tree's current branch, which must be set with
2742 operation, represents a branch from a remote repository which shares
2743 a common history with the specified
2745 but has progressed, and perhaps diverged, due to commits added to the
2748 Rebased commits are accumulated on a temporary branch which the work tree
2749 will remain switched to throughout the entire rebase operation.
2750 Commits on this branch represent the same changes with the same log
2751 messages as their counterparts on the original
2753 but with different commit IDs.
2754 Once rebasing has completed successfully, the temporary branch becomes
2755 the new version of the specified
2757 and the work tree is automatically switched to it.
2758 If author information is available via the
2760 environment variable,
2766 configuration settings, this author information will be used to identify
2771 Old commits in their pre-rebase state are automatically backed up in the
2772 .Dq refs/got/backup/rebase
2773 reference namespace.
2774 As long as these references are not removed older versions of rebased
2775 commits will remain in the repository and can be viewed with the
2778 Removal of these references makes objects which become unreachable via
2779 any reference subject to removal by Git's garbage collector or
2780 .Cm gotadmin cleanup .
2782 While rebasing commits, show the status of each affected file,
2783 using the following status codes:
2784 .Bl -column YXZ description
2785 .It G Ta file was merged
2786 .It C Ta file was merged and conflicts occurred during merge
2787 .It ! Ta changes destined for a missing file were not merged
2788 .It D Ta file was deleted
2789 .It d Ta file's deletion was prevented by local modifications
2790 .It A Ta new file was added
2791 .It \(a~ Ta changes destined for a non-regular file were not merged
2792 .It ? Ta changes destined for an unversioned file were not merged
2795 If merge conflicts occur, the rebase operation is interrupted and may
2796 be continued once conflicts have been resolved.
2797 If any files with destined changes are found to be missing or unversioned,
2798 or if files could not be deleted due to differences in deleted content,
2799 the rebase operation will be interrupted to prevent potentially incomplete
2800 changes from being committed to the repository without user intervention.
2801 The work tree may be modified as desired and the rebase operation can be
2802 continued once the changes present in the work tree are considered complete.
2803 Alternatively, the rebase operation may be aborted which will leave
2805 unmodified and the work tree switched back to its original branch.
2807 If a merge conflict is resolved in a way which renders the merged
2808 change into a no-op change, the corresponding commit will be elided
2809 when the rebase operation continues.
2812 will refuse to run if certain preconditions are not met.
2817 reference namespace, the branch may not be rebased.
2818 If the work tree is not yet fully updated to the tip commit of its
2819 branch, then the work tree must first be updated with
2821 If changes have been staged with
2823 these changes must first be committed with
2827 If the work tree contains local changes, these changes must first be
2834 contains changes to files outside of the work tree's path prefix,
2835 the work tree cannot be used to rebase this branch.
2844 commands will refuse to run while a rebase operation is in progress.
2845 Other commands which manipulate the work tree may be used for
2846 conflict resolution purposes.
2850 is already based on the work tree's current branch, then no commits
2851 need to be rebased and
2853 will simply switch the work tree to the specified
2855 and update files in the work tree accordingly.
2862 Abort an interrupted rebase operation.
2863 If this option is used, no other command-line arguments are allowed.
2865 Allow a rebase operation to continue with files in conflicted status.
2866 This option should generally be avoided, and can only be used with the
2870 Continue an interrupted rebase operation.
2871 If this option is used, no other command-line arguments are allowed except
2874 Show a list of past rebase operations, represented by references in the
2875 .Dq refs/got/backup/rebase
2876 reference namespace.
2878 Display the author, date, and log message of each backed up commit,
2879 the object ID of the corresponding post-rebase commit, and
2880 the object ID of their common ancestor commit.
2881 Given these object IDs,
2888 options can be used to examine the history of either version of the branch,
2893 option can be used to create a new branch from a pre-rebase state if desired.
2897 is specified, only show commits which at some point in time represented this
2899 Otherwise, list all backed up commits for any branches.
2901 If this option is used,
2903 does not require a work tree.
2904 None of the other options can be used together with
2907 Delete backups created by past rebase operations, represented by references
2909 .Dq refs/got/backup/rebase
2910 reference namespace.
2914 is specified, only delete backups which at some point in time represented
2916 Otherwise, delete all references found within
2917 .Dq refs/got/backup/rebase .
2919 Any commit, tree, tag, and blob objects belonging to deleted backups
2920 remain in the repository and may be removed separately with
2921 Git's garbage collector or
2922 .Cm gotadmin cleanup .
2924 If this option is used,
2926 does not require a work tree.
2927 None of the other options can be used together with
2934 .Op Fl F Ar histedit-script
2938 Edit commit history between the work tree's current base commit and
2939 the tip commit of the work tree's current branch.
2943 command requires the
2945 environment variable to be set,
2946 unless an author has been configured in
2952 configuration settings can be obtained from the repository's
2954 file or from Git's global
2960 operation, the work tree's current branch must be set with
2962 to the branch which should be edited, unless this branch is already the
2963 current branch of the work tree.
2964 The tip of this branch represents the upper bound (inclusive) of commits
2969 Furthermore, the work tree's base commit
2972 to a point in this branch's commit history where editing should begin.
2973 This commit represents the lower bound (non-inclusive) of commits touched
2978 Editing of commit history is controlled via a
2980 which can be written in an editor based on a template, passed on the
2981 command line, or generated with the
2988 Quitting the editor without saving the file will abort the histedit operation.
2990 The format of the histedit script is line-based.
2991 Each line in the script begins with a command name, followed by
2992 whitespace and an argument.
2993 For most commands, the expected argument is a commit ID SHA1 hash.
2994 Any remaining text on the line is ignored.
2995 Lines which begin with the
2997 character are ignored entirely.
2999 The available histedit script commands are as follows:
3000 .Bl -column YXZ pick-commit
3001 .It Cm pick Ar commit Ta Use the specified commit as it is.
3002 .It Cm edit Ar commit Ta Apply the changes from the specified commit, but
3003 then interrupt the histedit operation for amending, without creating a commit.
3004 While the histedit operation is interrupted arbitrary files may be edited,
3005 and commands which manipulate the work tree can be used freely.
3010 commands can be used to add new files or remove existing ones.
3013 command can be used to eliminate arbitrary changes from files in the work tree.
3016 command may be used to prepare a subset of changes for inclusion in the
3020 command can be used to insert arbitrary commits into the edited history.
3021 Regular editing of history must eventually be resumed by running
3022 .Cm got histedit -c .
3023 .It Cm fold Ar commit Ta Combine the specified commit with the next commit
3024 listed further below that will be used.
3025 .It Cm drop Ar commit Ta Remove this commit from the edited history.
3026 .It Cm mesg Ar commit Ta Open an editor to create a new log message for this
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, merge changes into the work tree
3286 and create a merge commit.
3287 Otherwise, if the specified
3289 is already based on the work tree's current branch, make the work tree's
3290 current branch equivalent to the specified
3292 and update files in the work tree accordingly.
3294 Merge commits are commits based on multiple parent commits.
3295 The tip commit of the work tree's current branch will be used as the
3297 The tip commit of the specified
3299 will be used as the second parent.
3300 The work tree's current branch
3303 reference namespace and can be set with
3309 No ancestral relationship between the two branches is required.
3310 If the two branches have already been merged previously, only new changes
3313 It is not possible to create merge commits with more than two parents.
3314 If more than one branch needs to be merged, then multiple merge commits
3315 with two parents each can be created in sequence.
3317 If a linear project history is desired, then use of
3319 should generally be preferred over
3321 However, even strictly linear projects may require occasional merge commits,
3322 for example in order to merge in new versions of third-party code stored
3325 branches created with
3328 While merging changes found on the
3330 into the work tree, show the status of each affected file,
3331 using the following status codes:
3332 .Bl -column YXZ description
3333 .It G Ta file was merged
3334 .It C Ta file was merged and conflicts occurred during merge
3335 .It ! Ta changes destined for a missing file were not merged
3336 .It D Ta file was deleted
3337 .It d Ta file's deletion was prevented by local modifications
3338 .It A Ta new file was added
3339 .It \(a~ Ta changes destined for a non-regular file were not merged
3340 .It ? Ta changes destined for an unversioned file were not merged
3343 If merge conflicts occur, the merge operation is interrupted and conflicts
3344 must be resolved before the merge operation can continue.
3345 If any files with destined changes are found to be missing or unversioned,
3346 or if files could not be deleted due to differences in deleted content,
3347 the merge operation will be interrupted to prevent potentially incomplete
3348 changes from being committed to the repository without user intervention.
3349 The work tree may be modified as desired and the merge can be continued
3350 once the changes present in the work tree are considered complete.
3351 Alternatively, the merge operation may be aborted which will leave
3352 the work tree's current branch unmodified.
3355 will refuse to run if certain preconditions are not met.
3356 If the work tree's current branch is not in the
3358 reference namespace then the work tree must first be switched to a
3363 If the work tree is not yet fully updated to the tip commit of its
3364 branch, then the work tree must first be updated with
3366 If the work tree contains multiple base commits, it must first be updated
3367 to a single base commit with
3369 If changes have been staged with
3371 these changes must first be committed with
3375 If the work tree contains local changes, these changes must first be
3382 contains changes to files outside of the work tree's path prefix,
3383 the work tree cannot be used to merge this branch.
3393 commands will refuse to run while a merge operation is in progress.
3394 Other commands which manipulate the work tree may be used for
3395 conflict resolution purposes.
3402 Abort an interrupted merge operation.
3403 If this option is used, no other command-line arguments are allowed.
3405 Allow a merge operation to continue with files in conflicted status.
3406 This option should generally be avoided, and can only be used with the
3410 Continue an interrupted merge operation.
3411 If this option is used, no other command-line arguments are allowed except
3414 Create a merge commit even if the branches have not diverged.
3416 Merge changes into the work tree as usual but do not create a merge
3418 The merge result can be adjusted as desired before a merge commit is
3421 Alternatively, the merge may be aborted with
3428 .Op Fl F Ar response-script
3432 Stage local changes for inclusion in the next commit.
3435 is specified, stage all changes in the work tree.
3436 Otherwise, stage changes at or within the specified paths.
3437 Paths may be staged if they are added, modified, or deleted according to
3440 Show the status of each affected file, using the following status codes:
3441 .Bl -column YXZ description
3442 .It A Ta file addition has been staged
3443 .It M Ta file modification has been staged
3444 .It D Ta file deletion has been staged
3447 Staged file contents are saved in newly created blob objects in the repository.
3448 These blobs will be referred to by tree objects once staged changes have been
3451 Staged changes affect the behaviour of
3456 While paths with staged changes exist, the
3458 command will refuse to commit any paths which do not have staged changes.
3459 Local changes created on top of staged changes can only be committed if
3460 the path is staged again, or if the staged changes are committed first.
3463 command will show both local changes and staged changes.
3466 command is able to display local changes relative to staged changes,
3467 and to display staged changes relative to the repository.
3470 command cannot revert staged changes but may be used to revert
3471 local changes created on top of staged changes.
3477 .It Fl F Ar response-script
3485 responses line-by-line from the specified
3487 file instead of prompting interactively.
3489 Instead of staging new changes, list paths which are already staged,
3490 along with the IDs of staged blob objects and stage status codes.
3491 If paths were provided on the command line, show the staged paths
3492 among the specified paths.
3493 Otherwise, show all staged paths.
3495 Instead of staging the entire content of a changed file, interactively
3496 select or reject changes for staging based on
3500 (reject change), and
3502 (quit staging this file) responses.
3503 If a file is in modified status, individual patches derived from the
3504 modified file content can be staged.
3505 Files in added or deleted status may only be staged or rejected in
3508 Allow staging of symbolic links which point outside of the path space
3509 that is under version control.
3512 will reject such symbolic links due to safety concerns.
3515 may decide to represent such a symbolic link as a regular file which contains
3516 the link's target path, rather than creating an actual symbolic link which
3517 points outside of the work tree.
3518 Use of this option is discouraged because external mechanisms such as
3520 are better suited for managing symbolic links to paths not under
3525 will refuse to run if certain preconditions are not met.
3526 If a file contains merge conflicts, these conflicts must be resolved first.
3527 If a file is found to be out of date relative to the head commit on the
3528 work tree's current branch, the file must be updated with
3530 before it can be staged (however, this does not prevent the file from
3531 becoming out-of-date at some point after having been staged).
3539 commands will refuse to run while staged changes exist.
3540 If staged changes cannot be committed because a staged path
3541 is out of date, the path must be unstaged with
3543 before it can be updated with
3545 and may then be staged again if necessary.
3550 .Op Fl F Ar response-script
3554 Merge staged changes back into the work tree and put affected paths
3555 back into non-staged status.
3558 is specified, unstage all staged changes across the entire work tree.
3559 Otherwise, unstage changes at or within the specified paths.
3561 Show the status of each affected file, using the following status codes:
3562 .Bl -column YXZ description
3563 .It G Ta file was unstaged
3564 .It C Ta file was unstaged and conflicts occurred during merge
3565 .It ! Ta changes destined for a missing file were not merged
3566 .It D Ta file was staged as deleted and still is deleted
3567 .It d Ta file's deletion was prevented by local modifications
3568 .It \(a~ Ta changes destined for a non-regular file were not merged
3575 .It Fl F Ar response-script
3583 responses line-by-line from the specified
3585 file instead of prompting interactively.
3587 Instead of unstaging the entire content of a changed file, interactively
3588 select or reject changes for unstaging based on
3592 (keep change staged), and
3594 (quit unstaging this file) responses.
3595 If a file is staged in modified status, individual patches derived from the
3596 staged file content can be unstaged.
3597 Files staged in added or deleted status may only be unstaged in their entirety.
3603 .Op Fl r Ar repository-path
3606 Parse and print contents of objects to standard output in a line-based
3608 Content of commit, tree, and tag objects is printed in a way similar
3609 to the actual content stored in such objects.
3610 Blob object contents are printed as they would appear in files on disk.
3612 Attempt to interpret each argument as a reference, a tag name, or
3613 an object ID SHA1 hash.
3614 References will be resolved to an object ID.
3615 Tag names will resolved to a tag object.
3616 An abbreviated hash argument will be expanded to a full SHA1 hash
3617 automatically, provided the abbreviation is unique.
3619 If none of the above interpretations produce a valid result, or if the
3621 option is used, attempt to interpret the argument as a path which will
3622 be resolved to the ID of an object found at this path in the repository.
3629 Look up paths in the specified
3631 If this option is not used, paths are looked up in the commit resolved
3632 via the repository's HEAD reference.
3634 The expected argument is a commit ID SHA1 hash, or a reference name
3635 or keyword which will be resolved to a commit ID.
3636 An abbreviated hash argument will be expanded to a full SHA1 hash
3637 automatically, provided the abbreviation is unique.
3642 resolve to the work tree's base commit and branch head, respectively.
3643 The former is only valid if invoked in a work tree, while the latter will
3644 resolve to the tip of the work tree's current branch if invoked in a
3645 work tree, otherwise it will resolve to the repository's HEAD reference.
3646 Keywords and references may be appended with
3650 modifiers and an optional integer N to denote the
3651 Nth descendant or antecedent by first parent traversal, respectively;
3654 denotes the work tree branch head's 2nd generation ancestor, and
3656 denotes the 4th generation descendant of the work tree's base commit.
3659 will denote the 8th generation ancestor of the commit resolved by the
3666 modifier without a trailing integer has an implicit
3675 Interpret all arguments as paths only.
3676 This option can be used to resolve ambiguity in cases where paths
3677 look like tag names, reference names, or object IDs.
3678 .It Fl r Ar repository-path
3679 Use the repository at the specified path.
3680 If not specified, assume the repository is located at or above the current
3682 If this directory is a
3684 work tree, use the repository path associated with this work tree.
3686 .It Cm info Op Ar path ...
3687 Display meta-data stored in a work tree.
3692 The work tree to use is resolved implicitly by walking upwards from the
3693 current working directory.
3697 arguments are specified, show additional per-file information for tracked
3698 files located at or within these paths.
3701 argument corresponds to the work tree's root directory, display information
3702 for all tracked files.
3705 .Bl -tag -width GOT_IGNORE_GITCONFIG
3707 The author's name and email address, such as
3708 .Qq An Flan Hacker Aq Mt flan_hacker@openbsd.org .
3719 may fail to parse commits without an email address in author data,
3723 environment variables with a missing email address.
3725 .Ev GOT_AUTHOR will be overridden by configuration settings in
3731 configuration settings in the repository's
3738 configuration settings contained in Git's global
3740 configuration file will only be used if neither
3744 environment variable provide author information.
3745 .It Ev GOT_IGNORE_GITCONFIG
3746 If this variable is set then any remote repository definitions or author
3747 information found in Git configuration files will be ignored.
3748 .It Ev GOT_LOG_DEFAULT_LIMIT
3749 The default limit on the number of commits traversed by
3751 If set to zero, the limit is unbounded.
3752 This variable will be silently ignored if it is set to a non-numeric value.
3753 .It Ev VISUAL , EDITOR
3754 The editor spawned by
3762 text editor will be spawned.
3765 .Bl -tag -width packed-refs -compact
3767 Repository-wide configuration settings for
3771 configuration file located in the root directory of a Git repository
3772 supersedes any relevant settings in Git's
3776 .It Pa .got/got.conf
3777 Worktree-specific configuration settings for
3781 configuration file in the
3783 meta-data directory of a work tree supersedes any relevant settings in
3786 configuration file and Git's
3793 Enable tab-completion of
3798 .Dl $ set -A complete_got_1 -- $(got -h 2>&1 | sed -n s/commands://p)
3800 Clone an existing Git repository for use with
3804 .Dl $ got clone ssh://git@github.com/openbsd/src.git
3806 Unfortunately, many of the popular Git hosting sites do not offer anonymous
3808 Such sites will require an account to be created, and a public SSH key to be
3809 uploaded to this account, before repository access via ssh:// URLs will work.
3811 Use of HTTP URLs currently requires
3815 .Dl $ git clone --bare https://github.com/openbsd/src.git
3817 Alternatively, for quick and dirty local testing of
3819 a new Git repository could be created and populated with files,
3820 e.g. from a temporary CVS checkout located at
3823 .Dl $ gotadmin init /var/git/src.git
3824 .Dl $ got import -r /var/git/src.git -I CVS -I obj /tmp/src
3826 Check out a work tree from the Git repository to /usr/src:
3828 .Dl $ got checkout /var/git/src.git /usr/src
3830 View local changes in a work tree directory:
3832 .Dl $ got diff | less
3834 In a work tree, display files in a potentially problematic state:
3836 .Dl $ got status -s 'C!~?'
3838 Interactively revert selected local changes in a work tree directory:
3840 .Dl $ got revert -p -R\ .
3842 In a work tree or a git repository directory, list all branch references:
3846 As above, but list the most recently modified branches only:
3848 .Dl $ got branch -lt | head
3850 In a work tree or a git repository directory, create a new branch called
3851 .Dq unified-buffer-cache
3852 which is forked off the
3856 .Dl $ got branch -c master unified-buffer-cache
3858 Switch an existing work tree to the branch
3859 .Dq unified-buffer-cache .
3860 Local changes in the work tree will be preserved and merged if necessary:
3862 .Dl $ got update -b unified-buffer-cache
3864 Create a new commit from local changes in a work tree directory.
3865 This new commit will become the head commit of the work tree's current branch:
3869 In a work tree or a git repository directory, view changes committed in
3870 the 3 most recent commits to the work tree's branch, or the branch resolved
3871 via the repository's HEAD reference, respectively:
3873 .Dl $ got log -p -l 3
3875 As above, but display changes in the order in which
3877 could apply them in sequence:
3879 .Dl $ got log -p -l 3 -R
3881 In a work tree or a git repository directory, log the history of a subdirectory:
3883 .Dl $ got log sys/uvm
3885 While operating inside a work tree, paths are specified relative to the current
3886 working directory, so this command will log the subdirectory
3889 .Dl $ cd sys/uvm && got log\ .
3891 And this command has the same effect:
3893 .Dl $ cd sys/dev/usb && got log ../../uvm
3895 And this command displays work tree meta-data about all tracked files:
3898 .Dl $ got info\ . | less
3900 Add new files and remove obsolete files in a work tree directory:
3902 .Dl $ got add sys/uvm/uvm_ubc.c
3903 .Dl $ got remove sys/uvm/uvm_vnode.c
3905 Create a new commit from local changes in a work tree directory
3906 with a pre-defined log message.
3908 .Dl $ got commit -m 'unify the buffer cache'
3910 Alternatively, create a new commit from local changes in a work tree
3911 directory with a log message that has been prepared in the file
3914 .Dl $ got commit -F /tmp/msg
3916 Update any work tree checked out from the
3917 .Dq unified-buffer-cache
3918 branch to the latest commit on this branch:
3922 Roll file content on the unified-buffer-cache branch back by one commit,
3923 and then fetch the rolled-back change into the work tree as a local change
3924 to be amended and perhaps committed again:
3926 .Dl $ got backout unified-buffer-cache
3927 .Dl $ got commit -m 'roll back previous'
3928 .Dl $ # now back out the previous backout :-)
3929 .Dl $ got backout unified-buffer-cache
3931 Fetch new changes on the remote repository's
3933 branch, making them visible on the local repository's
3940 In a repository created with a HTTP URL and
3941 .Cm git clone --bare
3944 command must be used instead:
3946 .Dl $ cd /var/git/src.git
3947 .Dl $ git fetch origin master:refs/remotes/origin/master
3951 branch to merge the new changes that are now visible on the
3956 .Dl $ got update -b origin/master
3957 .Dl $ got rebase master
3960 .Dq unified-buffer-cache
3961 branch on top of the new head commit of the
3965 .Dl $ got update -b master
3966 .Dl $ got rebase unified-buffer-cache
3968 Create a patch from all changes on the unified-buffer-cache branch.
3969 The patch can be mailed out for review and applied to
3973 .Dl $ got diff master unified-buffer-cache > /tmp/ubc.diff
3975 Edit the entire commit history of the
3976 .Dq unified-buffer-cache
3979 .Dl $ got update -b unified-buffer-cache
3980 .Dl $ got update -c master
3983 Before working against existing branches in a repository cloned with
3984 .Cm git clone --bare
3989 must be configured to map all references in the remote repository
3992 namespace of the local repository.
3993 This can be achieved by setting Git's
3994 .Pa remote.origin.fetch
3995 configuration variable to the value
3996 .Dq +refs/heads/*:refs/remotes/origin/*
4001 .Dl $ cd /var/git/repo
4002 .Dl $ git config remote.origin.fetch '+refs/heads/*:refs/remotes/origin/*'
4006 option must be disabled:
4008 .Dl $ cd /var/git/repo
4009 .Dl $ git config remote.origin.mirror false
4011 Alternatively, the following
4013 configuration item can be added manually to the Git repository's
4017 .Dl [remote \&"origin\&"]
4019 .Dl fetch = +refs/heads/*:refs/remotes/origin/*
4022 This configuration leaves the local repository's
4024 namespace free for use by local branches checked out with
4026 and, if needed, created with
4029 .Dq refs/remotes/origin
4030 namespace can now be updated with incoming changes from the remote
4035 without extra command line arguments.
4036 Newly fetched changes can be examined with
4039 Display changes on the remote repository's version of the
4041 branch, as of the last time
4045 .Dl $ got log -c origin/master | less
4047 As shown here, most commands accept abbreviated reference names such as
4050 .Dq refs/remotes/origin/master .
4051 The latter is only needed in case of ambiguity.
4054 can be used to merge changes which are visible on the
4059 This will also merge local changes, if any, with the incoming changes:
4061 .Dl $ got update -b origin/master
4062 .Dl $ got rebase master
4064 In order to make changes committed to the
4065 .Dq unified-buffer-cache
4069 .Dq unified-buffer-cache
4070 branch can be rebased onto the
4074 .Dl $ got update -b master
4075 .Dl $ got rebase unified-buffer-cache
4078 .Dq unified-buffer-cache
4079 branch can now be made visible on the
4083 Because the rebase operation switched the work tree to the
4084 .Dq unified-buffer-cache
4085 branch, the work tree must be switched back to the
4089 .Dl $ got update -b master
4090 .Dl $ got integrate unified-buffer-cache
4094 branch, log messages for local changes can now be amended with
4096 by other developers and any other important new information:
4098 .Dl $ got update -c origin/master
4099 .Dl $ got histedit -m
4101 If the remote repository offers write access, local changes on the
4103 branch can be sent to the remote repository with
4107 can be run without further arguments.
4108 The arguments shown here match defaults, provided the work tree's
4109 current branch is the
4113 .Dl $ got send -b master origin
4115 If the remote repository requires the HTTPS protocol, the
4117 command must be used instead:
4119 .Dl $ cd /var/git/src.git
4120 .Dl $ git push origin master
4122 When making contributions to projects which use the
4124 workflow, SSH protocol repository access needs to be set up first.
4125 Once an account has been created on a Git hosting site it should
4126 be possible to upload a public SSH key for repository access
4131 workflow will usually involve two remote repositories.
4132 In the real-life example below, the
4134 repository was forked from the
4136 repository by using the Git hosting site's web interface.
4139 file in the local repository describes both remote repositories:
4140 .Bd -literal -offset indent
4141 # Jelmers's repository, which accepts pull requests
4143 server git@github.com
4145 repository "/jelmer/dulwich"
4149 # Stefan's fork, used as the default remote repository
4151 server git@github.com
4153 repository "/stspdotname/dulwich"
4158 With this configuration, Stefan can create commits on
4159 .Dq refs/heads/master
4160 and send them to the
4162 repository by running:
4164 .Dl $ got send -b master origin
4166 The changes can now be proposed to Jelmer by opening a pull request
4167 via the Git hosting site's web interface.
4168 If Jelmer requests further changes to be made, additional commits
4169 can be created on the
4171 branch and be added to the pull request by running
4175 If Jelmer prefers additional commits to be
4177 then the following commands can be used to achieve this:
4179 .Dl $ got update -b master
4180 .Dl $ got update -c origin/master
4181 .Dl $ got histedit -f
4182 .Dl $ got send -f -b master origin
4184 In addition to reviewing the pull request in the web user interface,
4185 Jelmer can fetch the pull request's branch into his local repository
4186 and create a local branch which contains the proposed changes:
4188 .Dl $ got fetch -R refs/pull/1046/head origin
4189 .Dl $ got branch -c refs/remotes/origin/pull/1046/head pr1046
4191 Once Jelmer has accepted the pull request, Stefan can fetch the
4192 merged changes, and possibly several other new changes, by running:
4194 .Dl $ got fetch upstream
4196 The merged changes will now be visible under the reference
4197 .Dq refs/remotes/upstream/master .
4200 branch can now be rebased on top of the latest changes
4203 .Dl $ got update -b upstream/master
4204 .Dl $ got rebase master
4206 As an alternative to
4208 branches can be merged with
4211 .Dl $ got update -b master
4212 .Dl $ got merge upstream/master
4214 The question of whether to rebase or merge branches is philosophical.
4215 When in doubt, refer to the software project's policies set by project
4218 As a final step, the forked repository's copy of the master branch needs
4219 to be kept in sync by sending the new changes there:
4221 .Dl $ got send -f -b master origin
4223 If multiple pull requests need to be managed in parallel, a separate branch
4224 must be created for each pull request with
4226 Each such branch can then be used as above, in place of
4227 .Dq refs/heads/master .
4228 Changes for any accepted pull requests will still appear under
4229 .Dq refs/remotes/upstream/master,
4230 regardless of which branch was used in the forked repository to
4231 create a pull request.
4235 .Xr git-repository 5 ,
4236 .Xr got-worktree 5 ,
4240 .An Anthony J. Bentley Aq Mt bentley@openbsd.org
4241 .An Christian Weisgerber Aq Mt naddy@openbsd.org
4242 .An Hiltjo Posthuma Aq Mt hiltjo@codemadness.org
4243 .An Josh Rickmar Aq Mt jrick@zettaport.com
4244 .An Joshua Stein Aq Mt jcs@openbsd.org
4245 .An Klemens Nanni Aq Mt kn@openbsd.org
4246 .An Martin Pieuchot Aq Mt mpi@openbsd.org
4247 .An Neels Hofmeyr Aq Mt neels@hofmeyr.de
4248 .An Omar Polo Aq Mt op@openbsd.org
4249 .An Ori Bernstein Aq Mt ori@openbsd.org
4250 .An Sebastien Marie Aq Mt semarie@openbsd.org
4251 .An Stefan Sperling Aq Mt stsp@openbsd.org
4252 .An Steven McDonald Aq Mt steven@steven-mcdonald.id.au
4253 .An Theo Buehler Aq Mt tb@openbsd.org
4254 .An Thomas Adam Aq Mt thomas@xteddy.org
4255 .An Tracey Emery Aq Mt tracey@traceyemery.net
4256 .An Yang Zhong Aq Mt yzhong@freebsdfoundation.org
4263 were derived from code under copyright by:
4265 .An Caldera International
4266 .An Daniel Hartmeier
4271 .An Jean-Francois Brousseau
4277 .An Niklas Hallqvist
4282 .An Xavier Santolaria
4285 contains code contributed to the public domain by
4286 .An Austin Appleby .
4289 is a work-in-progress and some features remain to be implemented.
4291 At present, the user has to fall back on
4293 to perform some tasks.
4297 Reading from remote repositories over HTTP or HTTPS protocols requires
4302 Writing to remote repositories over HTTP or HTTPS protocols requires
4305 The creation of merge commits with more than two parent commits requires
4308 In situations where files or directories were moved around
4310 will not automatically merge changes to new locations and
4312 will usually produce better results.
