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
826 If the work tree contains the results of an interrupted
830 operation then display a message which shows the branches involved.
837 Show unversioned files even if they match an ignore pattern.
838 .It Fl S Ar status-codes
839 Suppress the output of files with a modification status matching any of the
840 single-character status codes contained in the
843 Any combination of codes from the above list of possible status codes
845 For staged files, status codes displayed in either column will be matched.
846 Cannot be used together with the
849 .It Fl s Ar status-codes
850 Only show files with a modification status matching any of the
851 single-character status codes contained in the
854 Any combination of codes from the above list of possible status codes
856 For staged files, status codes displayed in either column will be matched.
857 Cannot be used together with the
862 For compatibility with
873 files in each traversed directory and will not display unversioned files
874 which match these patterns.
875 Ignore patterns which end with a slash,
877 will only match directories.
882 supports consecutive asterisks,
884 which will match an arbitrary amount of directories.
888 only supports a single ignore pattern per line.
892 does not support negated ignore patterns prefixed with
894 and gives no special significance to the location of path component separators,
903 .Op Fl r Ar repository-path
904 .Op Fl S Ar search-pattern
908 Display history of a repository.
911 is specified, show only commits which modified this path.
912 If invoked in a work tree, the
914 is interpreted relative to the current working directory,
915 and the work tree's path prefix is implicitly prepended.
916 Otherwise, the path is interpreted relative to the repository root.
923 Display individual commits which were merged into the current branch
927 shows the linear history of the current branch only.
929 Set the number of context lines shown in diffs with
931 By default, 3 lines of context are shown.
933 Start traversing history at the specified
935 If this option is not specified, default to the work tree's current branch
936 if invoked in a work tree, or to the repository's HEAD reference.
940 argument is a commit ID SHA1 hash, or a reference name or a keyword
941 which will be resolved to a commit ID.
942 An abbreviated hash argument will be expanded to a full SHA1 hash
943 automatically, provided the abbreviation is unique.
948 resolve to the work tree's base commit and branch head, respectively.
949 The former is only valid if invoked in a work tree, while the latter will
950 resolve to the tip of the work tree's current branch if invoked in a
951 work tree, otherwise it will resolve to the repository's HEAD reference.
952 Keywords and references may be appended with
956 modifiers and an optional integer N to denote the
957 Nth descendant or antecedent, respectively, by first parent traversal;
960 denotes the HEAD reference's 2nd generation ancestor, and
962 denotes the 4th generation descendant of the work tree's base commit.
965 will denote the 3rd generation descendant of the commit resolved by the
972 modifier without a trailing integer has an implicit
981 Display diffstat of changes introduced in each commit.
982 Cannot be used with the
987 option (diffstat displays a list of changed paths).
989 Limit history traversal to a given number of commits.
990 If this option is not specified, a default limit value of zero is used,
991 which is treated as an unbounded limit.
993 .Ev GOT_LOG_DEFAULT_LIMIT
994 environment variable may be set to change this default value.
996 Display the list of file paths changed in each commit, using the following
998 .Bl -column YXZ description
999 .It M Ta modified file
1000 .It D Ta file was deleted
1001 .It A Ta new file was added
1002 .It m Ta modified file modes (executable bit only)
1005 Cannot be used with the
1009 Display the patch of modifications made in each commit.
1012 is specified, only show the patch of modifications at or within this path.
1013 Cannot be used with the
1017 Determine a set of commits to display as usual, but display these commits
1019 .It Fl r Ar repository-path
1020 Use the repository at the specified path.
1021 If not specified, assume the repository is located at or above the current
1023 If this directory is a
1025 work tree, use the repository path associated with this work tree.
1026 .It Fl S Ar search-pattern
1027 If specified, show only commits with a log message, author name,
1028 committer name, or ID SHA1 hash matched by the extended regular
1030 .Ar search-pattern .
1031 Lines in committed patches will be matched if
1034 File paths changed by a commit will be matched if
1037 Regular expression syntax is documented in
1040 Display a short one-line summary of each commit, instead of the default
1042 Cannot be used together with the
1048 Display commits in topological order.
1049 This option has no effect without the
1051 option because a linear history is sorted in topological order by definition.
1052 Topological sorting is disabled by default because the present implementation
1053 requires that commit history is fully traversed before any output can be shown.
1055 Stop traversing commit history immediately after the specified
1062 argument is a commit ID SHA1 hash, or a reference name or a keyword
1063 which will be resolved to a commit ID.
1064 This option has no effect if the specified
1074 .Op Fl r Ar repository-path
1075 .Op Ar object1 Ar object2 | Ar path ...
1078 When invoked within a work tree without any arguments, display all
1079 local changes in the work tree.
1082 arguments are specified, only show changes within the specified paths.
1084 If two arguments are provided, treat each argument as a reference, a tag
1085 name, or an object ID SHA1 hash, and display differences between the
1086 corresponding objects.
1087 Both objects must be of the same type (blobs, trees, or commits).
1088 An abbreviated hash argument will be expanded to a full SHA1 hash
1089 automatically, provided the abbreviation is unique.
1090 If none of these interpretations produce a valid result or if the
1095 is running in a work tree, attempt to interpret the two arguments as paths.
1102 Treat file contents as ASCII text even if binary data is detected.
1104 Set the number of context lines shown in the diff.
1105 By default, 3 lines of context are shown.
1107 Show differences between commits in the repository.
1108 This option may be used up to two times.
1109 When used only once, show differences between the specified
1111 and its first parent commit.
1112 When used twice, show differences between the two specified commits.
1116 option is used, all non-option arguments will be interpreted as paths.
1119 arguments are provided, only show differences for the specified paths.
1123 argument is a commit ID SHA1 hash, or a reference name or a keyword
1124 which will be resolved to a commit ID.
1125 An abbreviated hash argument will be expanded to a full SHA1 hash
1126 automatically, provided the abbreviation is unique.
1131 resolve to the work tree's base commit and branch head, respectively.
1132 The former is only valid if invoked in a work tree, while the latter will
1133 resolve to the tip of the work tree's current branch if invoked in a
1134 work tree, otherwise it will resolve to the repository's HEAD reference.
1135 Keywords and references may be appended with
1139 modifiers and an optional integer N to denote the
1140 Nth descendant or antecedent, respectively, by first parent traversal;
1143 denotes the HEAD reference's 2nd generation ancestor, and
1145 denotes the 4th generation descendant of the work tree's base commit.
1148 will denote the 8th generation descendant of the commit resolved by the
1151 If an integer does not follow the
1157 is implicitly appended
1164 Cannot be used together with the
1168 Display diffstat of changes before the actual diff by annotating each file path
1169 or blob hash being diffed with the total number of lines added and removed.
1170 A summary line will display the total number of changes across all files.
1172 Interpret all arguments as paths only.
1173 This option can be used to resolve ambiguity in cases where paths
1174 look like tag names, reference names, or object IDs.
1175 This option is only valid when
1177 is invoked in a work tree.
1178 .It Fl r Ar repository-path
1179 Use the repository at the specified path.
1180 If not specified, assume the repository is located at or above the current
1182 If this directory is a
1184 work tree, use the repository path associated with this work tree.
1186 Show changes staged with
1188 instead of showing local changes in the work tree.
1189 This option is only valid when
1191 is invoked in a work tree.
1193 Ignore whitespace-only changes.
1199 .Op Fl r Ar repository-path
1203 Display line-by-line history of a file at the specified path.
1210 Start traversing history at the specified
1212 The expected argument is a commit ID SHA1 hash, or a reference name
1213 or a keyword which will be resolved to a commit ID.
1214 An abbreviated hash argument will be expanded to a full SHA1 hash
1215 automatically, provided the abbreviation is unique.
1220 resolve to the work tree's base commit and branch head, respectively.
1221 The former is only valid if invoked in a work tree, while the latter will
1222 resolve to the tip of the work tree's current branch if invoked in a
1223 work tree, otherwise it will resolve to the repository's HEAD reference.
1224 Keywords and references may be appended with
1228 modifiers and an optional integer N to denote the
1229 Nth descendant or antecedent by first parent traversal, respectively;
1232 denotes the work tree branch head's 2nd generation ancestor, and
1234 denotes the 4th generation descendant of the work tree's base commit.
1237 will denote the 5th generation ancestor of the commit resolved by the
1244 modifier without a trailing integer has an implicit
1252 .It Fl r Ar repository-path
1253 Use the repository at the specified path.
1254 If not specified, assume the repository is located at or above the current
1256 If this directory is a
1258 work tree, use the repository path associated with this work tree.
1265 .Op Fl r Ar repository-path
1269 Display a listing of files and directories at the specified
1270 directory path in the repository.
1271 Entries shown in this listing may carry one of the following trailing
1273 .Bl -column YXZ description
1274 .It @ Ta entry is a symbolic link
1275 .It / Ta entry is a directory
1276 .It * Ta entry is an executable file
1277 .It $ Ta entry is a Git submodule
1280 Symbolic link entries are also annotated with the target path of the link.
1284 is specified, list the repository path corresponding to the current
1285 directory of the work tree, or the root directory of the repository
1286 if there is no work tree.
1293 List files and directories as they appear in the specified
1296 The expected argument is a commit ID SHA1 hash, or a reference name
1297 or a keyword which will be resolved to a commit ID.
1298 An abbreviated hash argument will be expanded to a full SHA1 hash
1299 automatically, provided the abbreviation is unique.
1304 resolve to the work tree's base commit and branch head, respectively.
1305 The former is only valid if invoked in a work tree, while the latter will
1306 resolve to the tip of the work tree's current branch if invoked in a
1307 work tree, otherwise it will resolve to the repository's HEAD reference.
1308 Keywords and references may be appended with
1312 modifiers and an optional integer N to denote the
1313 Nth descendant or antecedent by first parent traversal, respectively;
1316 denotes the work tree branch head's 2nd generation ancestor, and
1318 denotes the 4th generation descendant of the work tree's base commit.
1321 will denote the 3rd generation ancestor of the commit resolved by the
1328 modifier without a trailing integer has an implicit
1337 Show object IDs of files (blob objects) and directories (tree objects).
1339 Recurse into sub-directories in the repository.
1340 .It Fl r Ar repository-path
1341 Use the repository at the specified path.
1342 If not specified, assume the repository is located at or above the current
1344 If this directory is a
1346 work tree, use the repository path associated with this work tree.
1352 .Op Fl r Ar repository-path
1353 .Op Fl s Ar reference
1356 Manage references in a repository.
1358 References may be listed, created, deleted, and changed.
1359 When creating, deleting, or changing a reference the specified
1361 must be an absolute reference name, i.e. it must begin with
1369 Create a reference or change an existing reference.
1370 The reference with the specified
1372 will point at the specified
1377 argument is an ID SHA1 hash or an existing reference or tag name
1378 or a keyword which will be resolved to the ID of a corresponding commit,
1379 tree, tag, or blob object.
1380 An abbreviated hash argument will be expanded to a full SHA1 hash
1381 automatically, provided the abbreviation is unique.
1386 resolve to the work tree's base commit and branch head, respectively.
1387 The former is only valid if invoked in a work tree, while the latter will
1388 resolve to the tip of the work tree's current branch if invoked in a
1389 work tree, otherwise it will resolve to the repository's HEAD reference.
1390 Keywords and reference names may be appended with
1394 modifiers and an optional integer N to denote the
1395 Nth descendant or antecedent by first parent traversal, respectively;
1398 denotes the work tree branch head's 2nd generation ancestor, and
1400 will denote the 3rd generation ancestor of the commit resolved by the
1403 If an integer does not follow the
1409 is implicitly appended
1416 Cannot be used together with any other options except
1419 Delete the reference with the specified
1421 from the repository.
1422 Any commit, tree, tag, and blob objects belonging to deleted references
1423 remain in the repository and may be removed separately with
1424 Git's garbage collector or
1425 .Cm gotadmin cleanup .
1426 Cannot be used together with any other options except
1429 List references in the repository.
1432 is specified, list all existing references in the repository.
1435 is a reference namespace, list all references in this namespace.
1436 Otherwise, show only the reference with the given
1438 Cannot be used together with any other options except
1442 .It Fl r Ar repository-path
1443 Use the repository at the specified path.
1444 If not specified, assume the repository is located at or above the current
1446 If this directory is a
1448 work tree, use the repository path associated with this work tree.
1449 .It Fl s Ar reference
1450 Create a symbolic reference, or change an existing symbolic reference.
1451 The symbolic reference with the specified
1453 will point at the specified
1455 which must already exist in the repository.
1456 Care should be taken not to create loops between references when
1457 this option is used.
1458 Cannot be used together with any other options except
1461 Sort listed references by modification time (most recently modified first)
1462 instead of sorting by lexicographical order.
1463 Use of this option requires the
1465 option to be used as well.
1473 .Op Fl r Ar repository-path
1477 Create, list, or delete branches.
1479 Local branches are managed via references which live in the
1481 reference namespace.
1484 command creates references in this namespace only.
1486 When deleting branches, the specified
1490 reference namespace first.
1491 If no corresponding branch is found, the
1493 namespace will be searched next.
1495 If invoked in a work tree without any arguments, print the name of the
1496 work tree's current branch.
1500 argument is passed, attempt to create a branch reference with the given name.
1501 By default the new branch reference will point at the latest commit on the
1502 work tree's current branch if invoked in a work tree, and otherwise to a commit
1503 resolved via the repository's HEAD reference.
1505 If invoked in a work tree, once the branch was created successfully
1506 switch the work tree's head reference to the newly created branch and
1507 update files across the entire work tree, just like
1508 .Cm got update -b Ar name
1510 Show the status of each affected file, using the following status codes:
1511 .Bl -column YXZ description
1512 .It U Ta file was updated and contained no local changes
1513 .It G Ta file was updated and local changes were merged cleanly
1514 .It C Ta file was updated and conflicts occurred during merge
1515 .It D Ta file was deleted
1516 .It A Ta new file was added
1517 .It \(a~ Ta versioned file is obstructed by a non-regular file
1518 .It ! Ta a missing versioned file was restored
1526 Make a newly created branch reference point at the specified
1528 The expected argument is a commit ID SHA1 hash, or a reference name or keyword
1529 which will be resolved to a commit ID.
1530 An abbreviated hash argument will be expanded to a full SHA1 hash
1531 automatically, provided the abbreviation is unique.
1536 resolve to the work tree's base commit and branch head, respectively.
1537 The former is only valid if invoked in a work tree, while the latter will
1538 resolve to the tip of the work tree's current branch if invoked in a
1539 work tree, otherwise it will resolve to the repository's HEAD reference.
1540 Keywords and references may be appended with
1544 modifiers and an optional integer N to denote the
1545 Nth descendant or antecedent by first parent traversal, respectively;
1548 denotes the work tree branch head's 2nd generation ancestor, and
1550 denotes the 4th generation descendant of the work tree's base commit.
1553 will denote the 3rd generation descendant of the commit resolved by the
1560 modifier without a trailing integer has an implicit
1569 Delete the branch with the specified
1575 reference namespace.
1577 Only the branch reference is deleted.
1578 Any commit, tree, and blob objects belonging to the branch
1579 remain in the repository and may be removed separately with
1580 Git's garbage collector or
1581 .Cm gotadmin cleanup .
1583 List all existing branches in the repository, including copies of remote
1584 repositories' branches in the
1586 reference namespace.
1588 If invoked in a work tree, the work tree's current branch is shown
1589 with one of the following annotations:
1590 .Bl -column YXZ description
1591 .It * Ta work tree's base commit and the base commit of all tracked files
1592 matches the branch tip
1593 .It \(a~ Ta work tree comprises mixed commits or its base commit is out-of-date
1596 Do not switch and update the work tree after creating a new branch.
1597 .It Fl r Ar repository-path
1598 Use the repository at the specified path.
1599 If not specified, assume the repository is located at or above the current
1601 If this directory is a
1603 work tree, use the repository path associated with this work tree.
1605 Sort listed branches by modification time (most recently modified first)
1606 instead of sorting by lexicographical order.
1609 reference namespace are listed before branches in
1612 Use of this option requires the
1614 option to be used as well.
1621 .Op Fl r Ar repository-path
1622 .Op Fl s Ar signer-id
1625 Manage tags in a repository.
1627 Tags are managed via references which live in the
1629 reference namespace.
1632 command operates on references in this namespace only.
1633 References in this namespace point at tag objects which contain a pointer
1634 to another object, a tag message, as well as author and timestamp information.
1636 Attempt to create a tag with the given
1638 and make this tag point at the given
1640 If no commit is specified, default to the latest commit on the work tree's
1641 current branch if invoked in a work tree, and to a commit resolved via
1642 the repository's HEAD reference otherwise.
1649 Make the newly created tag reference point at the specified
1653 argument is a commit ID SHA1 hash, or a reference or keyword
1654 which will be resolved to a commit ID.
1655 An abbreviated hash argument will be expanded to a full SHA1 hash
1656 automatically, provided the abbreviation is unique.
1661 resolve to the work tree's base commit and branch head, respectively.
1662 The former is only valid if invoked in a work tree, while the latter will
1663 resolve to the tip of the work tree's current branch if invoked in a
1664 work tree, otherwise it will resolve to the repository's HEAD reference.
1665 Keywords and references may be appended with
1669 modifiers and an optional integer N to denote the
1670 Nth descendant or antecedent by first parent traversal, respectively;
1673 denotes the work tree branch head's 2nd generation ancestor, and
1675 denotes the 4th generation descendant of the work tree's base commit.
1678 will denote the 3rd generation ancestor of the commit resolved by the
1685 modifier without a trailing integer has an implicit
1694 List all existing tags in the repository instead of creating a new tag.
1697 argument is passed, show only the tag with the given
1700 Use the specified tag message when creating the new tag.
1705 opens a temporary file in an editor where a tag message can be written.
1706 Quitting the editor without saving the file will abort the tag operation.
1707 .It Fl r Ar repository-path
1708 Use the repository at the specified path.
1709 If not specified, assume the repository is located at or above the current
1711 If this directory is a
1713 work tree, use the repository path associated with this work tree.
1714 .It Fl s Ar signer-id
1715 While creating a new tag, sign this tag with the identity given in
1718 For SSH-based signatures,
1720 is the path to a file which may refer to either a private SSH key,
1721 or a public SSH key with the private half available via
1724 will sign the tag object by invoking
1728 command, using the signature namespace
1730 for compatibility with
1733 Verify tag object signatures.
1736 is specified, show and verify the tag object with the provided name.
1737 Otherwise, list all tag objects and verify signatures where present.
1740 verifies SSH-based signatures by invoking
1743 .Fl Y Cm verify Fl f Ar allowed_signers .
1748 otherwise verification is impossible.
1751 During SSH signature creation and verification this option will be passed to
1753 Multiple -v options increase the verbosity.
1759 command will not delete tags or change existing tags.
1760 If a tag must be deleted, the
1762 command may be used to delete a tag's reference.
1763 This should only be done if the tag has not already been copied to
1770 Schedule unversioned files in a work tree for addition to the
1771 repository in the next commit.
1772 By default, files which match a
1774 ignore pattern will not be added.
1778 mentioned in the command line is not an unversioned file then
1781 To avoid unnecessary errors from paths picked up by file globbing patterns
1782 in the shell, paths in the argument list will be silently ignored if they
1785 at all, or if they are reported with one of the following status codes
1786 and do not have changes staged via
1788 .Bl -column YXZ description
1789 .It M Ta modified file
1790 .It A Ta file scheduled for addition in next commit
1791 .It C Ta modified or added file which contains merge conflicts
1792 .It m Ta modified file modes (executable bit only)
1800 Add files even if they match a
1804 Permit recursion into directories.
1805 If this option is not specified,
1807 will refuse to run if a specified
1815 .Op Fl s Ar status-codes
1819 Remove versioned files from a work tree and schedule them for deletion
1820 from the repository in the next commit.
1827 Perform the operation even if a file contains local modifications,
1828 and do not raise an error if a specified
1830 does not exist on disk.
1832 Keep affected files on disk.
1834 Permit recursion into directories.
1835 If this option is not specified,
1837 will refuse to run if a specified
1840 .It Fl s Ar status-codes
1841 Only delete files with a modification status matching one of the
1842 single-character status codes contained in the
1845 The following status codes may be specified:
1846 .Bl -column YXZ description
1847 .It M Ta modified file (this implies the
1850 .It ! Ta versioned file expected on disk but missing
1858 .Op Fl p Ar strip-count
1864 to files in a work tree.
1865 Files added or removed by a patch will be scheduled for addition or removal in
1868 The patch must be in the unified diff format as produced by
1875 diff when invoked with their
1880 argument is provided, read unified diff data from standard input instead.
1884 contains multiple patches, then attempt to apply each of them in sequence.
1886 Show the status of each affected file, using the following status codes:
1887 .Bl -column XYZ description
1888 .It M Ta file was modified
1889 .It G Ta file was merged using a merge-base found in the repository
1890 .It C Ta file was merged and conflicts occurred during merge
1891 .It D Ta file was deleted
1892 .It A Ta file was added
1893 .It # Ta failed to patch the file
1896 If a change does not match at its exact line number, attempt to
1897 apply it somewhere else in the file if a good spot can be found.
1898 Otherwise, the patch will fail to apply.
1902 will refuse to apply a patch if certain preconditions are not met.
1903 Files to be deleted must already be under version control, and must
1904 not have been scheduled for deletion already.
1905 Files to be added must not yet be under version control and must not
1906 already be present on disk.
1907 Files to be modified must already be under version control and may not
1908 contain conflict markers.
1910 If an error occurs, the
1912 operation will be aborted.
1913 Any changes made to the work tree up to this point will be left behind.
1914 Such changes can be viewed with
1916 and can be reverted with
1925 Attempt to locate files within the specified
1927 for use as a merge-base for 3-way merges.
1931 option is not used then
1933 will attempt to locate merge-bases via object IDs found in
1935 meta-data, such as produced by
1941 option is only recommended in the absence of such meta-data.
1943 Ideally, the specified
1945 should contain versions of files which the changes contained in the
1948 Files will be located by path, relative to the repository root.
1951 option is used then leading path components will be stripped
1952 before paths are looked up in the repository.
1954 In case no merge-base is available for a file, changes will be applied
1955 without doing a 3-way merge.
1956 Changes which do not apply cleanly may then be rejected entirely, rather
1957 than producing merge conflicts in the patched target file.
1961 argument is a commit ID SHA1 hash, or a reference name or a keyword
1962 which will be resolved to a commit ID.
1963 An abbreviated hash argument will be expanded to a full SHA1 hash
1964 automatically, provided the abbreviation is unique.
1969 resolve to the work tree's base commit and branch head, respectively.
1970 Keywords and references may be appended with
1974 modifiers and an optional integer N to denote the
1975 Nth descendant or antecedent by first parent traversal, respectively;
1978 denotes the work tree branch head's 2nd generation ancestor, and
1980 denotes the 4th generation descendant of the work tree's base commit.
1983 will denote the 3rd generation descendant of the commit resolved by the
1990 modifier without a trailing integer has an implicit
1999 Do not make any modifications to the work tree.
2000 This can be used to check whether a patch would apply without issues.
2003 contains diffs that affect the same file multiple times, the results
2004 displayed may be incorrect.
2005 .It Fl p Ar strip-count
2006 Specify the number of leading path components to strip from paths
2015 path prefixes generated by
2017 will be recognized and stripped automatically.
2019 Reverse the patch before applying it.
2025 .Op Fl F Ar response-script
2029 Revert any local changes in files at the specified paths in a work tree.
2030 File contents will be overwritten with those contained in the
2031 work tree's base commit.
2032 There is no way to bring discarded changes back after
2035 If a file was added with
2037 it will become an unversioned file again.
2038 If a file was deleted with
2040 it will be restored.
2046 .It Fl F Ar response-script
2054 responses line-by-line from the specified
2056 file instead of prompting interactively.
2058 Instead of reverting all changes in files, interactively select or reject
2059 changes to revert based on
2065 (quit reverting this file) responses.
2066 If a file is in modified status, individual patches derived from the
2067 modified file content can be reverted.
2068 Files in added or deleted status may only be reverted in their entirety.
2070 Permit recursion into directories.
2071 If this option is not specified,
2073 will refuse to run if a specified
2087 Create a new commit in the repository from changes in a work tree
2088 and use this commit as the new base commit for the work tree.
2091 is specified, commit all changes in the work tree.
2092 Otherwise, commit changes at or within the specified paths.
2094 If changes have been explicitly staged for commit with
2096 only commit staged changes and reject any specified paths which
2097 have not been staged.
2100 opens a temporary file in an editor where a log message can be written
2108 options are used together.
2109 Quitting the editor without saving the file will abort the commit operation.
2111 Show the status of each affected file, using the following status codes:
2112 .Bl -column YXZ description
2113 .It M Ta modified file
2114 .It D Ta file was deleted
2115 .It A Ta new file was added
2116 .It m Ta modified file modes (executable bit only)
2119 Files which are not part of the new commit will retain their previously
2120 recorded base commit.
2123 commands may refuse to run while the work tree contains files from
2124 multiple base commits.
2125 The base commit of such a work tree can be made consistent by running
2127 across the entire work tree.
2131 command requires the
2133 environment variable to be set,
2134 unless an author has been configured in
2140 configuration settings can be
2141 obtained from the repository's
2143 file or from Git's global
2152 Set author information in the newly created commit to
2154 This is useful when committing changes on behalf of someone else.
2157 argument must use the same format as the
2159 environment variable.
2161 In addition to storing author information, the newly created commit
2164 information which is obtained, as usual, from the
2166 environment variable, or
2168 or Git configuration settings.
2170 Allow committing files in conflicted status.
2172 Committing files with conflict markers should generally be avoided.
2173 Cases where conflict markers must be stored in the repository for
2174 some legitimate reason should be very rare.
2175 There are usually ways to avoid storing conflict markers verbatim by
2176 applying appropriate programming tricks.
2178 Use the prepared log message stored in the file found at
2180 when creating the new commit.
2182 opens a temporary file in an editor where the prepared log message can be
2183 reviewed and edited further if needed.
2184 Cannot be used together with the
2188 Use the specified log message when creating the new commit.
2189 Cannot be used together with the
2193 This option prevents
2195 from opening the commit message in an editor.
2196 It has no effect unless it is used together with the
2198 option and is intended for non-interactive use such as scripting.
2200 This option prevents
2202 from generating a diff of the to-be-committed changes in a temporary file
2203 which can be viewed while editing a commit message.
2205 Allow the addition of symbolic links which point outside of the path space
2206 that is under version control.
2209 will reject such symbolic links due to safety concerns.
2212 may decide to represent such a symbolic link as a regular file which contains
2213 the link's target path, rather than creating an actual symbolic link which
2214 points outside of the work tree.
2215 Use of this option is discouraged because external mechanisms such as
2217 are better suited for managing symbolic links to paths not under
2222 will refuse to run if certain preconditions are not met.
2223 If the work tree's current branch is not in the
2225 reference namespace, new commits may not be created on this branch.
2226 Local changes may only be committed if they are based on file content
2227 found in the most recent commit on the work tree's branch.
2228 If a path is found to be out of date,
2230 must be used first in order to merge local changes with changes made
2238 .Op Fl r Ar repository-path
2240 .Op Ar remote-repository
2243 Send new changes to a remote repository.
2245 .Ar remote-repository
2249 The remote repository's URL is obtained from the corresponding entry in
2253 file of the local repository, as created by
2256 All objects corresponding to new changes will be written to a temporary
2257 pack file which is then uploaded to the server.
2258 Upon success, references in the
2260 reference namespace of the local repository will be updated to point at
2261 the commits which have been sent.
2263 By default, changes will only be sent if they are based on up-to-date
2264 copies of relevant branches in the remote repository.
2265 If any changes to be sent are based on out-of-date copies or would
2266 otherwise break linear history of existing branches, new changes must
2267 be fetched from the server with
2269 and local branches must be rebased with
2276 option can be used to make exceptions to these requirements.
2283 Send all branches from the local repository's
2285 reference namespace.
2288 option is equivalent to listing all branches with multiple
2291 Cannot be used together with the
2297 from the local repository's
2299 reference namespace.
2300 This option may be specified multiple times to build a list of branches
2302 If this option is not specified, default to the work tree's current branch
2303 if invoked in a work tree, or to the repository's HEAD reference.
2304 Cannot be used together with the
2308 Delete the specified
2310 from the remote repository's
2312 reference namespace.
2313 This option may be specified multiple times to build a list of branches
2316 Only references are deleted.
2317 Any commit, tree, tag, and blob objects belonging to deleted branches
2318 may become subject to deletion by Git's garbage collector running on
2321 Requesting deletion of branches results in an error if the server
2322 does not support this feature or disallows the deletion of branches
2323 based on its configuration.
2325 Attempt to force the server to overwrite existing branches or tags
2326 in the remote repository, even when
2332 would usually be required before changes can be sent.
2333 The server may reject forced requests regardless, depending on its
2336 Any commit, tree, tag, and blob objects belonging to overwritten branches
2337 or tags may become subject to deletion by Git's garbage collector running
2342 reference namespace is globally shared between all repositories.
2345 option to overwrite tags is discouraged because it can lead to
2346 inconsistencies between the tags present in different repositories.
2347 In general, creating a new tag with a different name is recommended
2348 instead of overwriting an existing tag.
2352 option is particularly discouraged if changes being sent are based
2353 on an out-of-date copy of a branch in the remote repository.
2354 Instead of using the
2356 option, new changes should
2359 and local branches should be rebased with
2363 followed by another attempt to send the changes.
2367 option should only be needed in situations where the remote repository's
2368 copy of a branch or tag is known to be out-of-date and is considered
2370 The risks of creating inconsistencies between different repositories
2371 should also be taken into account.
2373 Suppress progress reporting output.
2374 The same option will be passed to
2377 .It Fl r Ar repository-path
2378 Use the repository at the specified path.
2379 If not specified, assume the repository is located at or above the current
2381 If this directory is a
2383 work tree, use the repository path associated with this work tree.
2385 Attempt to send all tags from the local repository's
2387 reference namespace.
2390 option is equivalent to listing all tags with multiple
2393 Cannot be used together with the
2399 from the local repository's
2401 reference namespace, in addition to any branches that are being sent.
2404 option may be specified multiple times to build a list of tags to send.
2405 No tags will be sent if the
2409 Raise an error if the specified
2411 already exists in the remote repository, unless the
2413 option is used to overwrite the server's copy of the tag.
2414 In general, creating a new tag with a different name is recommended
2415 instead of overwriting an existing tag.
2417 Cannot be used together with the
2424 to print debugging messages to standard error output.
2425 The same option will be passed to
2428 Multiple -v options increase the verbosity.
2438 Merge changes from a single
2443 should be on a different branch than the work tree's base commit.
2445 The expected argument is a commit ID SHA1 hash, or a reference name or
2446 keyword which will be resolved to a commit ID.
2447 An abbreviated hash argument will be expanded to a full SHA1 hash
2448 automatically, provided the abbreviation is unique.
2453 resolve to the work tree's base commit and branch head, respectively.
2454 Keywords and references may be appended with
2458 modifiers and an optional integer N to denote the
2459 Nth descendant or antecedent by first parent traversal, respectively;
2462 denotes the work tree branch head's 2nd generation ancestor, and
2464 denotes the 4th generation descendant of the work tree's base commit.
2467 will denote the 3rd generation descendant of the commit resolved by the
2474 modifier without a trailing integer has an implicit
2483 Show the status of each affected file, using the following status codes:
2484 .Bl -column YXZ description
2485 .It G Ta file was merged
2486 .It C Ta file was merged and conflicts occurred during merge
2487 .It ! Ta changes destined for a missing file were not merged
2488 .It D Ta file was deleted
2489 .It d Ta file's deletion was prevented by local modifications
2490 .It A Ta new file was added
2491 .It \(a~ Ta changes destined for a non-regular file were not merged
2492 .It ? Ta changes destined for an unversioned file were not merged
2495 The merged changes will appear as local changes in the work tree, which
2498 amended manually or with further
2504 If invoked in a work tree where no
2509 operation is taking place,
2511 creates a record of commits which have been merged into the work tree.
2512 When a file changed by
2516 the log messages of relevant merged commits will then appear in the editor,
2517 where the messages should be further adjusted to convey the reasons for
2518 cherrypicking the changes.
2519 Upon exiting the editor, if the time stamp of the log message file
2520 is unchanged or the log message is empty,
2522 will fail with an unmodified or empty log message error.
2524 If all the changes in all files touched by a given commit are discarded,
2527 this commit's log message record will also disappear.
2530 will refuse to run if certain preconditions are not met.
2531 If the work tree contains multiple base commits, it must first be updated
2532 to a single base commit with
2534 If any relevant files already contain merge conflicts, these
2535 conflicts must be resolved first.
2543 Display a list of commit log messages recorded by cherrypick operations,
2544 represented by references in the
2545 .Dq refs/got/worktree
2546 reference namespace.
2549 is specified, only show the log message of the specified commit.
2551 If invoked in a work tree, only log messages recorded by cherrypick operations
2552 in the current work tree will be displayed.
2553 Otherwise, all commit log messages will be displayed irrespective of the
2554 work tree in which they were created.
2555 This option cannot be used with
2558 Delete log messages created by previous cherrypick operations, represented by
2560 .Dq refs/got/worktree
2561 reference namespace.
2564 is specified, only delete the log message of the specified commit.
2566 If invoked in a work tree, only log messages recorded by cherrypick operations
2567 in the current work tree will be deleted.
2568 Otherwise, all commit log messages will be deleted irrespective of the
2569 work tree in which they were created.
2570 This option cannot be used with
2581 Reverse-merge changes from a single
2586 should be on the same branch as the work tree's base commit.
2588 The expected argument is a commit ID SHA1 hash, or a reference name
2589 or keyword which will be resolved to a commit ID.
2590 An abbreviated hash argument will be expanded to a full SHA1 hash
2591 automatically, provided the abbreviation is unique.
2596 resolve to the work tree's base commit and branch head, respectively.
2597 Keywords and references may be appended with
2601 modifiers and an optional integer N to denote the
2602 Nth descendant or antecedent by first parent traversal, respectively;
2605 denotes the work tree branch head's 2nd generation ancestor, and
2607 denotes the 4th generation descendant of the work tree's base commit.
2610 will denote the 5th generation descendant of the commit resolved by the
2617 modifier without a trailing integer has an implicit
2626 Show the status of each affected file, using the following status codes:
2627 .Bl -column YXZ description
2628 .It G Ta file was merged
2629 .It C Ta file was merged and conflicts occurred during merge
2630 .It ! Ta changes destined for a missing file were not merged
2631 .It D Ta file was deleted
2632 .It d Ta file's deletion was prevented by local modifications
2633 .It A Ta new file was added
2634 .It \(a~ Ta changes destined for a non-regular file were not merged
2635 .It ? Ta changes destined for an unversioned file were not merged
2638 The reverse-merged changes will appear as local changes in the work tree,
2639 which may be viewed with
2641 amended manually or with further
2647 If invoked in a work tree where no
2652 operation is taking place,
2654 creates a record of commits which have been reverse-merged into the work tree.
2655 When a file changed by
2659 the log messages of relevant reverse-merged commits will then appear in
2660 the editor, where the messages should be further adjusted to convey the
2661 reasons for backing out the changes.
2662 Upon exiting the editor, if the time stamp of the log message file
2663 is unchanged or the log message is empty,
2665 will fail with an unmodified or empty log message error.
2667 If all the changes in all files touched by a given commit are discarded,
2670 this commit's log message record will also disappear.
2673 will refuse to run if certain preconditions are not met.
2674 If the work tree contains multiple base commits, it must first be updated
2675 to a single base commit with
2677 If any relevant files already contain merge conflicts, these
2678 conflicts must be resolved first.
2686 Display a list of commit log messages recorded by backout operations,
2687 represented by references in the
2688 .Dq refs/got/worktree
2689 reference namespace.
2692 is specified, only show the log message of the specified commit.
2694 If invoked in a work tree, only log messages recorded by backout operations
2695 in the current work tree will be displayed.
2696 Otherwise, all commit log messages will be displayed irrespective of the
2697 work tree in which they were created.
2698 This option cannot be used with
2701 Delete log messages created by previous backout operations, represented by
2703 .Dq refs/got/worktree
2704 reference namespace.
2707 is specified, only delete the log message of the specified commit.
2709 If invoked in a work tree, only log messages recorded by backout operations
2710 in the current work tree will be deleted.
2711 Otherwise, all commit log messages will be deleted irrespective of the
2712 work tree in which they were created.
2713 This option cannot be used with
2724 Rebase commits on the specified
2726 onto the tip of the current branch of the work tree.
2729 must share common ancestry with the work tree's current branch.
2730 Rebasing begins with the first descendant commit of the youngest
2731 common ancestor commit shared by the specified
2733 and the work tree's current branch, and stops once the tip commit
2740 is used as intended, the specified
2742 represents a local commit history and may already contain changes
2743 that are not yet visible in any other repositories.
2744 The work tree's current branch, which must be set with
2748 operation, represents a branch from a remote repository which shares
2749 a common history with the specified
2751 but has progressed, and perhaps diverged, due to commits added to the
2754 Rebased commits are accumulated on a temporary branch which the work tree
2755 will remain switched to throughout the entire rebase operation.
2756 Commits on this branch represent the same changes with the same log
2757 messages as their counterparts on the original
2759 but with different commit IDs.
2760 Once rebasing has completed successfully, the temporary branch becomes
2761 the new version of the specified
2763 and the work tree is automatically switched to it.
2764 If author information is available via the
2766 environment variable,
2772 configuration settings, this author information will be used to identify
2777 Old commits in their pre-rebase state are automatically backed up in the
2778 .Dq refs/got/backup/rebase
2779 reference namespace.
2780 As long as these references are not removed older versions of rebased
2781 commits will remain in the repository and can be viewed with the
2784 Removal of these references makes objects which become unreachable via
2785 any reference subject to removal by Git's garbage collector or
2786 .Cm gotadmin cleanup .
2788 While rebasing commits, show the status of each affected file,
2789 using the following status codes:
2790 .Bl -column YXZ description
2791 .It G Ta file was merged
2792 .It C Ta file was merged and conflicts occurred during merge
2793 .It ! Ta changes destined for a missing file were not merged
2794 .It D Ta file was deleted
2795 .It d Ta file's deletion was prevented by local modifications
2796 .It A Ta new file was added
2797 .It \(a~ Ta changes destined for a non-regular file were not merged
2798 .It ? Ta changes destined for an unversioned file were not merged
2801 If merge conflicts occur, the rebase operation is interrupted and may
2802 be continued once conflicts have been resolved.
2803 If any files with destined changes are found to be missing or unversioned,
2804 or if files could not be deleted due to differences in deleted content,
2805 the rebase operation will be interrupted to prevent potentially incomplete
2806 changes from being committed to the repository without user intervention.
2807 The work tree may be modified as desired and the rebase operation can be
2808 continued once the changes present in the work tree are considered complete.
2809 Alternatively, the rebase operation may be aborted which will leave
2811 unmodified and the work tree switched back to its original branch.
2813 If a merge conflict is resolved in a way which renders the merged
2814 change into a no-op change, the corresponding commit will be elided
2815 when the rebase operation continues.
2818 will refuse to run if certain preconditions are not met.
2823 reference namespace, the branch may not be rebased.
2824 If the work tree is not yet fully updated to the tip commit of its
2825 branch, then the work tree must first be updated with
2827 If changes have been staged with
2829 these changes must first be committed with
2833 If the work tree contains local changes, these changes must first be
2840 contains changes to files outside of the work tree's path prefix,
2841 the work tree cannot be used to rebase this branch.
2850 commands will refuse to run while a rebase operation is in progress.
2851 Other commands which manipulate the work tree may be used for
2852 conflict resolution purposes.
2856 is already based on the work tree's current branch, then no commits
2857 need to be rebased and
2859 will simply switch the work tree to the specified
2861 and update files in the work tree accordingly.
2868 Abort an interrupted rebase operation.
2869 If this option is used, no other command-line arguments are allowed.
2871 Allow a rebase operation to continue with files in conflicted status.
2872 This option should generally be avoided, and can only be used with the
2876 Continue an interrupted rebase operation.
2877 If this option is used, no other command-line arguments are allowed except
2880 Show a list of past rebase operations, represented by references in the
2881 .Dq refs/got/backup/rebase
2882 reference namespace.
2884 Display the author, date, and log message of each backed up commit,
2885 the object ID of the corresponding post-rebase commit, and
2886 the object ID of their common ancestor commit.
2887 Given these object IDs,
2894 options can be used to examine the history of either version of the branch,
2899 option can be used to create a new branch from a pre-rebase state if desired.
2903 is specified, only show commits which at some point in time represented this
2905 Otherwise, list all backed up commits for any branches.
2907 If this option is used,
2909 does not require a work tree.
2910 None of the other options can be used together with
2913 Delete backups created by past rebase operations, represented by references
2915 .Dq refs/got/backup/rebase
2916 reference namespace.
2920 is specified, only delete backups which at some point in time represented
2922 Otherwise, delete all references found within
2923 .Dq refs/got/backup/rebase .
2925 Any commit, tree, tag, and blob objects belonging to deleted backups
2926 remain in the repository and may be removed separately with
2927 Git's garbage collector or
2928 .Cm gotadmin cleanup .
2930 If this option is used,
2932 does not require a work tree.
2933 None of the other options can be used together with
2940 .Op Fl F Ar histedit-script
2944 Edit commit history between the work tree's current base commit and
2945 the tip commit of the work tree's current branch.
2949 command requires the
2951 environment variable to be set,
2952 unless an author has been configured in
2958 configuration settings can be obtained from the repository's
2960 file or from Git's global
2966 operation, the work tree's current branch must be set with
2968 to the branch which should be edited, unless this branch is already the
2969 current branch of the work tree.
2970 The tip of this branch represents the upper bound (inclusive) of commits
2975 Furthermore, the work tree's base commit
2978 to a point in this branch's commit history where editing should begin.
2979 This commit represents the lower bound (non-inclusive) of commits touched
2984 Editing of commit history is controlled via a
2986 which can be written in an editor based on a template, passed on the
2987 command line, or generated with the
2994 Quitting the editor without saving the file will abort the histedit operation.
2996 The format of the histedit script is line-based.
2997 Each line in the script begins with a command name, followed by
2998 whitespace and an argument.
2999 For most commands, the expected argument is a commit ID SHA1 hash.
3000 Any remaining text on the line is ignored.
3001 Lines which begin with the
3003 character are ignored entirely.
3005 The available histedit script commands are as follows:
3006 .Bl -column YXZ pick-commit
3007 .It Cm pick Ar commit Ta Use the specified commit as it is.
3008 .It Cm edit Ar commit Ta Apply the changes from the specified commit, but
3009 then interrupt the histedit operation for amending, without creating a commit.
3010 While the histedit operation is interrupted arbitrary files may be edited,
3011 and commands which manipulate the work tree can be used freely.
3016 commands can be used to add new files or remove existing ones.
3019 command can be used to eliminate arbitrary changes from files in the work tree.
3022 command may be used to prepare a subset of changes for inclusion in the
3026 command can be used to insert arbitrary commits into the edited history.
3027 Regular editing of history must eventually be resumed by running
3028 .Cm got histedit -c .
3029 .It Cm fold Ar commit Ta Combine the specified commit with the next commit
3030 listed further below that will be used.
3031 .It Cm drop Ar commit Ta Remove this commit from the edited history.
3032 .It Cm mesg Ar commit Ta Open an editor to create a new log message for this
3036 Every commit in the history being edited must be mentioned in the script.
3037 Lines may be re-ordered to change the order of commits in the edited history.
3038 No commit may be listed more than once.
3040 Edited commits are accumulated on a temporary branch which the work tree
3041 will remain switched to throughout the entire histedit operation.
3042 Once history editing has completed successfully, the temporary branch becomes
3043 the new version of the work tree's branch and the work tree is automatically
3046 Old commits in their pre-histedit state are automatically backed up in the
3047 .Dq refs/got/backup/histedit
3048 reference namespace.
3049 As long as these references are not removed older versions of edited
3050 commits will remain in the repository and can be viewed with the
3053 Removal of these references makes objects which become unreachable via
3054 any reference subject to removal by Git's garbage collector or
3055 .Cm gotadmin cleanup .
3057 While merging commits, show the status of each affected file,
3058 using the following status codes:
3059 .Bl -column YXZ description
3060 .It G Ta file was merged
3061 .It C Ta file was merged and conflicts occurred during merge
3062 .It ! Ta changes destined for a missing file were not merged
3063 .It D Ta file was deleted
3064 .It d Ta file's deletion was prevented by local modifications
3065 .It A Ta new file was added
3066 .It \(a~ Ta changes destined for a non-regular file were not merged
3067 .It ? Ta changes destined for an unversioned file were not merged
3070 If merge conflicts occur, the histedit operation is interrupted and may
3071 be continued once conflicts have been resolved.
3072 If any files with destined changes are found to be missing or unversioned,
3073 or if files could not be deleted due to differences in deleted content,
3074 the histedit operation will be interrupted to prevent potentially incomplete
3075 changes from being committed to the repository without user intervention.
3076 The work tree may be modified as desired and the histedit operation can be
3077 continued once the changes present in the work tree are considered complete.
3078 Alternatively, the histedit operation may be aborted which will leave
3079 the work tree switched back to its original branch.
3081 If a merge conflict is resolved in a way which renders the merged
3082 change into a no-op change, the corresponding commit will be elided
3083 when the histedit operation continues.
3086 will refuse to run if certain preconditions are not met.
3087 If the work tree's current branch is not in the
3089 reference namespace, the history of the branch may not be edited.
3090 If the work tree contains multiple base commits, it must first be updated
3091 to a single base commit with
3093 If changes have been staged with
3095 these changes must first be committed with
3099 If the work tree contains local changes, these changes must first be
3104 If the edited history contains changes to files outside of the work tree's
3105 path prefix, the work tree cannot be used to edit the history of this branch.
3113 commands will refuse to run while a histedit operation is in progress.
3114 Other commands which manipulate the work tree may be used, and the
3116 command may be used to commit arbitrary changes to the temporary branch
3117 while the histedit operation is interrupted.
3124 Abort an interrupted histedit operation.
3125 If this option is used, no other command-line arguments are allowed.
3127 Allow a histedit operation to continue with files in conflicted status.
3128 This option should generally be avoided, and can only be used with the
3132 Continue an interrupted histedit operation.
3133 If this option is used, no other command-line arguments are allowed except
3137 This option is a quick equivalent to a histedit script which drops all
3141 option can only be used when starting a new histedit operation.
3142 If this option is used, no other command-line arguments are allowed.
3144 Interrupt the histedit operation for editing after merging each commit.
3145 This option is a quick equivalent to a histedit script which uses the
3147 command for all commits.
3150 option can only be used when starting a new histedit operation.
3151 If this option is used, no other command-line arguments are allowed.
3152 .It Fl F Ar histedit-script
3155 instead of opening a temporary file in an editor where a histedit script
3158 Fold all commits into a single commit.
3159 This option is a quick equivalent to a histedit script which folds all
3160 commits, combining them all into one commit.
3163 option can only be used when starting a new histedit operation.
3164 If this option is used, no other command-line arguments are allowed.
3166 Show a list of past histedit operations, represented by references in the
3167 .Dq refs/got/backup/histedit
3168 reference namespace.
3170 Display the author, date, and log message of each backed up commit,
3171 the object ID of the corresponding post-histedit commit, and
3172 the object ID of their common ancestor commit.
3173 Given these object IDs,
3180 options can be used to examine the history of either version of the branch,
3185 option can be used to create a new branch from a pre-histedit state if desired.
3189 is specified, only show commits which at some point in time represented this
3191 Otherwise, list all backed up commits for any branches.
3193 If this option is used,
3195 does not require a work tree.
3196 None of the other options can be used together with
3199 Edit log messages only.
3200 This option is a quick equivalent to a histedit script which edits
3201 only log messages but otherwise leaves every picked commit as-is.
3204 option can only be used when starting a new histedit operation.
3205 If this option is used, no other command-line arguments are allowed.
3207 Delete backups created by past histedit operations, represented by references
3209 .Dq refs/got/backup/histedit
3210 reference namespace.
3214 is specified, only delete backups which at some point in time represented
3216 Otherwise, delete all references found within
3217 .Dq refs/got/backup/histedit .
3219 Any commit, tree, tag, and blob objects belonging to deleted backups
3220 remain in the repository and may be removed separately with
3221 Git's garbage collector or
3222 .Cm gotadmin cleanup .
3224 If this option is used,
3226 does not require a work tree.
3227 None of the other options can be used together with
3231 .It Cm integrate Ar branch
3233 Integrate the specified
3235 into the work tree's current branch.
3236 Files in the work tree are updated to match the contents on the integrated
3238 and the reference of the work tree's branch is changed to point at the
3239 head commit of the integrated
3242 Both branches can be considered equivalent after integration since they
3243 will be pointing at the same commit.
3244 Both branches remain available for future work, if desired.
3245 In case the integrated
3247 is no longer needed it may be deleted with
3250 Show the status of each affected file, using the following status codes:
3251 .Bl -column YXZ description
3252 .It U Ta file was updated
3253 .It D Ta file was deleted
3254 .It A Ta new file was added
3255 .It \(a~ Ta versioned file is obstructed by a non-regular file
3256 .It ! Ta a missing versioned file was restored
3260 will refuse to run if certain preconditions are not met.
3261 Most importantly, the
3263 must have been rebased onto the work tree's current branch with
3265 before it can be integrated, in order to linearize commit history and
3266 resolve merge conflicts.
3267 If the work tree contains multiple base commits, it must first be updated
3268 to a single base commit with
3270 If changes have been staged with
3272 these changes must first be committed with
3276 If the work tree contains local changes, these changes must first be
3290 into the current branch of the work tree.
3291 If the branches have diverged, merge changes into the work tree
3292 and create a merge commit.
3293 Otherwise, if the specified
3295 is already based on the work tree's current branch, make the work tree's
3296 current branch equivalent to the specified
3298 and update files in the work tree accordingly.
3300 Merge commits are commits based on multiple parent commits.
3301 The tip commit of the work tree's current branch will be used as the
3303 The tip commit of the specified
3305 will be used as the second parent.
3306 The work tree's current branch
3309 reference namespace and can be set with
3315 No ancestral relationship between the two branches is required.
3316 If the two branches have already been merged previously, only new changes
3319 It is not possible to create merge commits with more than two parents.
3320 If more than one branch needs to be merged, then multiple merge commits
3321 with two parents each can be created in sequence.
3323 If a linear project history is desired, then use of
3325 should generally be preferred over
3327 However, even strictly linear projects may require occasional merge commits,
3328 for example in order to merge in new versions of third-party code stored
3331 branches created with
3334 While merging changes found on the
3336 into the work tree, show the status of each affected file,
3337 using the following status codes:
3338 .Bl -column YXZ description
3339 .It G Ta file was merged
3340 .It C Ta file was merged and conflicts occurred during merge
3341 .It ! Ta changes destined for a missing file were not merged
3342 .It D Ta file was deleted
3343 .It d Ta file's deletion was prevented by local modifications
3344 .It A Ta new file was added
3345 .It \(a~ Ta changes destined for a non-regular file were not merged
3346 .It ? Ta changes destined for an unversioned file were not merged
3349 If merge conflicts occur, the merge operation is interrupted and conflicts
3350 must be resolved before the merge operation can continue.
3351 If any files with destined changes are found to be missing or unversioned,
3352 or if files could not be deleted due to differences in deleted content,
3353 the merge operation will be interrupted to prevent potentially incomplete
3354 changes from being committed to the repository without user intervention.
3355 The work tree may be modified as desired and the merge can be continued
3356 once the changes present in the work tree are considered complete.
3357 Alternatively, the merge operation may be aborted which will leave
3358 the work tree's current branch unmodified.
3361 will refuse to run if certain preconditions are not met.
3362 If the work tree's current branch is not in the
3364 reference namespace then the work tree must first be switched to a
3369 If the work tree is not yet fully updated to the tip commit of its
3370 branch, then the work tree must first be updated with
3372 If the work tree contains multiple base commits, it must first be updated
3373 to a single base commit with
3375 If changes have been staged with
3377 these changes must first be committed with
3381 If the work tree contains local changes, these changes must first be
3388 contains changes to files outside of the work tree's path prefix,
3389 the work tree cannot be used to merge this branch.
3399 commands will refuse to run while a merge operation is in progress.
3400 Other commands which manipulate the work tree may be used for
3401 conflict resolution purposes.
3408 Abort an interrupted merge operation.
3409 If this option is used, no other command-line arguments are allowed.
3411 Allow a merge operation to continue with files in conflicted status.
3412 This option should generally be avoided, and can only be used with the
3416 Continue an interrupted merge operation.
3417 If this option is used, no other command-line arguments are allowed except
3420 Create a merge commit even if the branches have not diverged.
3422 Merge changes into the work tree as usual but do not create a merge
3424 The merge result can be adjusted as desired before a merge commit is
3427 Alternatively, the merge may be aborted with
3434 .Op Fl F Ar response-script
3438 Stage local changes for inclusion in the next commit.
3441 is specified, stage all changes in the work tree.
3442 Otherwise, stage changes at or within the specified paths.
3443 Paths may be staged if they are added, modified, or deleted according to
3446 Show the status of each affected file, using the following status codes:
3447 .Bl -column YXZ description
3448 .It A Ta file addition has been staged
3449 .It M Ta file modification has been staged
3450 .It D Ta file deletion has been staged
3453 Staged file contents are saved in newly created blob objects in the repository.
3454 These blobs will be referred to by tree objects once staged changes have been
3457 Staged changes affect the behaviour of
3462 While paths with staged changes exist, the
3464 command will refuse to commit any paths which do not have staged changes.
3465 Local changes created on top of staged changes can only be committed if
3466 the path is staged again, or if the staged changes are committed first.
3469 command will show both local changes and staged changes.
3472 command is able to display local changes relative to staged changes,
3473 and to display staged changes relative to the repository.
3476 command cannot revert staged changes but may be used to revert
3477 local changes created on top of staged changes.
3483 .It Fl F Ar response-script
3491 responses line-by-line from the specified
3493 file instead of prompting interactively.
3495 Instead of staging new changes, list paths which are already staged,
3496 along with the IDs of staged blob objects and stage status codes.
3497 If paths were provided on the command line, show the staged paths
3498 among the specified paths.
3499 Otherwise, show all staged paths.
3501 Instead of staging the entire content of a changed file, interactively
3502 select or reject changes for staging based on
3506 (reject change), and
3508 (quit staging this file) responses.
3509 If a file is in modified status, individual patches derived from the
3510 modified file content can be staged.
3511 Files in added or deleted status may only be staged or rejected in
3514 Allow staging of symbolic links which point outside of the path space
3515 that is under version control.
3518 will reject such symbolic links due to safety concerns.
3521 may decide to represent such a symbolic link as a regular file which contains
3522 the link's target path, rather than creating an actual symbolic link which
3523 points outside of the work tree.
3524 Use of this option is discouraged because external mechanisms such as
3526 are better suited for managing symbolic links to paths not under
3531 will refuse to run if certain preconditions are not met.
3532 If a file contains merge conflicts, these conflicts must be resolved first.
3533 If a file is found to be out of date relative to the head commit on the
3534 work tree's current branch, the file must be updated with
3536 before it can be staged (however, this does not prevent the file from
3537 becoming out-of-date at some point after having been staged).
3545 commands will refuse to run while staged changes exist.
3546 If staged changes cannot be committed because a staged path
3547 is out of date, the path must be unstaged with
3549 before it can be updated with
3551 and may then be staged again if necessary.
3556 .Op Fl F Ar response-script
3560 Merge staged changes back into the work tree and put affected paths
3561 back into non-staged status.
3564 is specified, unstage all staged changes across the entire work tree.
3565 Otherwise, unstage changes at or within the specified paths.
3567 Show the status of each affected file, using the following status codes:
3568 .Bl -column YXZ description
3569 .It G Ta file was unstaged
3570 .It C Ta file was unstaged and conflicts occurred during merge
3571 .It ! Ta changes destined for a missing file were not merged
3572 .It D Ta file was staged as deleted and still is deleted
3573 .It d Ta file's deletion was prevented by local modifications
3574 .It \(a~ Ta changes destined for a non-regular file were not merged
3581 .It Fl F Ar response-script
3589 responses line-by-line from the specified
3591 file instead of prompting interactively.
3593 Instead of unstaging the entire content of a changed file, interactively
3594 select or reject changes for unstaging based on
3598 (keep change staged), and
3600 (quit unstaging this file) responses.
3601 If a file is staged in modified status, individual patches derived from the
3602 staged file content can be unstaged.
3603 Files staged in added or deleted status may only be unstaged in their entirety.
3609 .Op Fl r Ar repository-path
3612 Parse and print contents of objects to standard output in a line-based
3614 Content of commit, tree, and tag objects is printed in a way similar
3615 to the actual content stored in such objects.
3616 Blob object contents are printed as they would appear in files on disk.
3618 Attempt to interpret each argument as a reference, a tag name, or
3619 an object ID SHA1 hash.
3620 References will be resolved to an object ID.
3621 Tag names will resolved to a tag object.
3622 An abbreviated hash argument will be expanded to a full SHA1 hash
3623 automatically, provided the abbreviation is unique.
3625 If none of the above interpretations produce a valid result, or if the
3627 option is used, attempt to interpret the argument as a path which will
3628 be resolved to the ID of an object found at this path in the repository.
3635 Look up paths in the specified
3637 If this option is not used, paths are looked up in the commit resolved
3638 via the repository's HEAD reference.
3640 The expected argument is a commit ID SHA1 hash, or a reference name
3641 or keyword which will be resolved to a commit ID.
3642 An abbreviated hash argument will be expanded to a full SHA1 hash
3643 automatically, provided the abbreviation is unique.
3648 resolve to the work tree's base commit and branch head, respectively.
3649 The former is only valid if invoked in a work tree, while the latter will
3650 resolve to the tip of the work tree's current branch if invoked in a
3651 work tree, otherwise it will resolve to the repository's HEAD reference.
3652 Keywords and references may be appended with
3656 modifiers and an optional integer N to denote the
3657 Nth descendant or antecedent by first parent traversal, respectively;
3660 denotes the work tree branch head's 2nd generation ancestor, and
3662 denotes the 4th generation descendant of the work tree's base commit.
3665 will denote the 8th generation ancestor of the commit resolved by the
3672 modifier without a trailing integer has an implicit
3681 Interpret all arguments as paths only.
3682 This option can be used to resolve ambiguity in cases where paths
3683 look like tag names, reference names, or object IDs.
3684 .It Fl r Ar repository-path
3685 Use the repository at the specified path.
3686 If not specified, assume the repository is located at or above the current
3688 If this directory is a
3690 work tree, use the repository path associated with this work tree.
3692 .It Cm info Op Ar path ...
3693 Display meta-data stored in a work tree.
3698 The work tree to use is resolved implicitly by walking upwards from the
3699 current working directory.
3703 arguments are specified, show additional per-file information for tracked
3704 files located at or within these paths.
3707 argument corresponds to the work tree's root directory, display information
3708 for all tracked files.
3711 .Bl -tag -width GOT_IGNORE_GITCONFIG
3713 The author's name and email address, such as
3714 .Qq An Flan Hacker Aq Mt flan_hacker@openbsd.org .
3725 may fail to parse commits without an email address in author data,
3729 environment variables with a missing email address.
3731 .Ev GOT_AUTHOR will be overridden by configuration settings in
3737 configuration settings in the repository's
3744 configuration settings contained in Git's global
3746 configuration file will only be used if neither
3750 environment variable provide author information.
3751 .It Ev GOT_IGNORE_GITCONFIG
3752 If this variable is set then any remote repository definitions or author
3753 information found in Git configuration files will be ignored.
3754 .It Ev GOT_LOG_DEFAULT_LIMIT
3755 The default limit on the number of commits traversed by
3757 If set to zero, the limit is unbounded.
3758 This variable will be silently ignored if it is set to a non-numeric value.
3759 .It Ev VISUAL , EDITOR
3760 The editor spawned by
3768 text editor will be spawned.
3771 .Bl -tag -width packed-refs -compact
3773 Repository-wide configuration settings for
3777 configuration file located in the root directory of a Git repository
3778 supersedes any relevant settings in Git's
3782 .It Pa .got/got.conf
3783 Worktree-specific configuration settings for
3787 configuration file in the
3789 meta-data directory of a work tree supersedes any relevant settings in
3792 configuration file and Git's
3799 Enable tab-completion of
3804 .Dl $ set -A complete_got_1 -- $(got -h 2>&1 | sed -n s/commands://p)
3806 Clone an existing Git repository for use with
3810 .Dl $ got clone ssh://git@github.com/openbsd/src.git
3812 Unfortunately, many of the popular Git hosting sites do not offer anonymous
3814 Such sites will require an account to be created, and a public SSH key to be
3815 uploaded to this account, before repository access via ssh:// URLs will work.
3817 Use of HTTP URLs currently requires
3821 .Dl $ git clone --bare https://github.com/openbsd/src.git
3823 Alternatively, for quick and dirty local testing of
3825 a new Git repository could be created and populated with files,
3826 e.g. from a temporary CVS checkout located at
3829 .Dl $ gotadmin init /var/git/src.git
3830 .Dl $ got import -r /var/git/src.git -I CVS -I obj /tmp/src
3832 Check out a work tree from the Git repository to /usr/src:
3834 .Dl $ got checkout /var/git/src.git /usr/src
3836 View local changes in a work tree directory:
3838 .Dl $ got diff | less
3840 In a work tree, display files in a potentially problematic state:
3842 .Dl $ got status -s 'C!~?'
3844 Interactively revert selected local changes in a work tree directory:
3846 .Dl $ got revert -p -R\ .
3848 In a work tree or a git repository directory, list all branch references:
3852 As above, but list the most recently modified branches only:
3854 .Dl $ got branch -lt | head
3856 In a work tree or a git repository directory, create a new branch called
3857 .Dq unified-buffer-cache
3858 which is forked off the
3862 .Dl $ got branch -c master unified-buffer-cache
3864 Switch an existing work tree to the branch
3865 .Dq unified-buffer-cache .
3866 Local changes in the work tree will be preserved and merged if necessary:
3868 .Dl $ got update -b unified-buffer-cache
3870 Create a new commit from local changes in a work tree directory.
3871 This new commit will become the head commit of the work tree's current branch:
3875 In a work tree or a git repository directory, view changes committed in
3876 the 3 most recent commits to the work tree's branch, or the branch resolved
3877 via the repository's HEAD reference, respectively:
3879 .Dl $ got log -p -l 3
3881 As above, but display changes in the order in which
3883 could apply them in sequence:
3885 .Dl $ got log -p -l 3 -R
3887 In a work tree or a git repository directory, log the history of a subdirectory:
3889 .Dl $ got log sys/uvm
3891 While operating inside a work tree, paths are specified relative to the current
3892 working directory, so this command will log the subdirectory
3895 .Dl $ cd sys/uvm && got log\ .
3897 And this command has the same effect:
3899 .Dl $ cd sys/dev/usb && got log ../../uvm
3901 And this command displays work tree meta-data about all tracked files:
3904 .Dl $ got info\ . | less
3906 Add new files and remove obsolete files in a work tree directory:
3908 .Dl $ got add sys/uvm/uvm_ubc.c
3909 .Dl $ got remove sys/uvm/uvm_vnode.c
3911 Create a new commit from local changes in a work tree directory
3912 with a pre-defined log message.
3914 .Dl $ got commit -m 'unify the buffer cache'
3916 Alternatively, create a new commit from local changes in a work tree
3917 directory with a log message that has been prepared in the file
3920 .Dl $ got commit -F /tmp/msg
3922 Update any work tree checked out from the
3923 .Dq unified-buffer-cache
3924 branch to the latest commit on this branch:
3928 Roll file content on the unified-buffer-cache branch back by one commit,
3929 and then fetch the rolled-back change into the work tree as a local change
3930 to be amended and perhaps committed again:
3932 .Dl $ got backout unified-buffer-cache
3933 .Dl $ got commit -m 'roll back previous'
3934 .Dl $ # now back out the previous backout :-)
3935 .Dl $ got backout unified-buffer-cache
3937 Fetch new changes on the remote repository's
3939 branch, making them visible on the local repository's
3946 In a repository created with a HTTP URL and
3947 .Cm git clone --bare
3950 command must be used instead:
3952 .Dl $ cd /var/git/src.git
3953 .Dl $ git fetch origin master:refs/remotes/origin/master
3957 branch to merge the new changes that are now visible on the
3962 .Dl $ got update -b origin/master
3963 .Dl $ got rebase master
3966 .Dq unified-buffer-cache
3967 branch on top of the new head commit of the
3971 .Dl $ got update -b master
3972 .Dl $ got rebase unified-buffer-cache
3974 Create a patch from all changes on the unified-buffer-cache branch.
3975 The patch can be mailed out for review and applied to
3979 .Dl $ got diff master unified-buffer-cache > /tmp/ubc.diff
3981 Edit the entire commit history of the
3982 .Dq unified-buffer-cache
3985 .Dl $ got update -b unified-buffer-cache
3986 .Dl $ got update -c master
3989 Before working against existing branches in a repository cloned with
3990 .Cm git clone --bare
3995 must be configured to map all references in the remote repository
3998 namespace of the local repository.
3999 This can be achieved by setting Git's
4000 .Pa remote.origin.fetch
4001 configuration variable to the value
4002 .Dq +refs/heads/*:refs/remotes/origin/*
4007 .Dl $ cd /var/git/repo
4008 .Dl $ git config remote.origin.fetch '+refs/heads/*:refs/remotes/origin/*'
4012 option must be disabled:
4014 .Dl $ cd /var/git/repo
4015 .Dl $ git config remote.origin.mirror false
4017 Alternatively, the following
4019 configuration item can be added manually to the Git repository's
4023 .Dl [remote \&"origin\&"]
4025 .Dl fetch = +refs/heads/*:refs/remotes/origin/*
4028 This configuration leaves the local repository's
4030 namespace free for use by local branches checked out with
4032 and, if needed, created with
4035 .Dq refs/remotes/origin
4036 namespace can now be updated with incoming changes from the remote
4041 without extra command line arguments.
4042 Newly fetched changes can be examined with
4045 Display changes on the remote repository's version of the
4047 branch, as of the last time
4051 .Dl $ got log -c origin/master | less
4053 As shown here, most commands accept abbreviated reference names such as
4056 .Dq refs/remotes/origin/master .
4057 The latter is only needed in case of ambiguity.
4060 can be used to merge changes which are visible on the
4065 This will also merge local changes, if any, with the incoming changes:
4067 .Dl $ got update -b origin/master
4068 .Dl $ got rebase master
4070 In order to make changes committed to the
4071 .Dq unified-buffer-cache
4075 .Dq unified-buffer-cache
4076 branch can be rebased onto the
4080 .Dl $ got update -b master
4081 .Dl $ got rebase unified-buffer-cache
4084 .Dq unified-buffer-cache
4085 branch can now be made visible on the
4089 Because the rebase operation switched the work tree to the
4090 .Dq unified-buffer-cache
4091 branch, the work tree must be switched back to the
4095 .Dl $ got update -b master
4096 .Dl $ got integrate unified-buffer-cache
4100 branch, log messages for local changes can now be amended with
4102 by other developers and any other important new information:
4104 .Dl $ got update -c origin/master
4105 .Dl $ got histedit -m
4107 If the remote repository offers write access, local changes on the
4109 branch can be sent to the remote repository with
4113 can be run without further arguments.
4114 The arguments shown here match defaults, provided the work tree's
4115 current branch is the
4119 .Dl $ got send -b master origin
4121 If the remote repository requires the HTTPS protocol, the
4123 command must be used instead:
4125 .Dl $ cd /var/git/src.git
4126 .Dl $ git push origin master
4128 When making contributions to projects which use the
4130 workflow, SSH protocol repository access needs to be set up first.
4131 Once an account has been created on a Git hosting site it should
4132 be possible to upload a public SSH key for repository access
4137 workflow will usually involve two remote repositories.
4138 In the real-life example below, the
4140 repository was forked from the
4142 repository by using the Git hosting site's web interface.
4145 file in the local repository describes both remote repositories:
4146 .Bd -literal -offset indent
4147 # Jelmers's repository, which accepts pull requests
4149 server git@github.com
4151 repository "/jelmer/dulwich"
4155 # Stefan's fork, used as the default remote repository
4157 server git@github.com
4159 repository "/stspdotname/dulwich"
4164 With this configuration, Stefan can create commits on
4165 .Dq refs/heads/master
4166 and send them to the
4168 repository by running:
4170 .Dl $ got send -b master origin
4172 The changes can now be proposed to Jelmer by opening a pull request
4173 via the Git hosting site's web interface.
4174 If Jelmer requests further changes to be made, additional commits
4175 can be created on the
4177 branch and be added to the pull request by running
4181 If Jelmer prefers additional commits to be
4183 then the following commands can be used to achieve this:
4185 .Dl $ got update -b master
4186 .Dl $ got update -c origin/master
4187 .Dl $ got histedit -f
4188 .Dl $ got send -f -b master origin
4190 In addition to reviewing the pull request in the web user interface,
4191 Jelmer can fetch the pull request's branch into his local repository
4192 and create a local branch which contains the proposed changes:
4194 .Dl $ got fetch -R refs/pull/1046/head origin
4195 .Dl $ got branch -c refs/remotes/origin/pull/1046/head pr1046
4197 Once Jelmer has accepted the pull request, Stefan can fetch the
4198 merged changes, and possibly several other new changes, by running:
4200 .Dl $ got fetch upstream
4202 The merged changes will now be visible under the reference
4203 .Dq refs/remotes/upstream/master .
4206 branch can now be rebased on top of the latest changes
4209 .Dl $ got update -b upstream/master
4210 .Dl $ got rebase master
4212 As an alternative to
4214 branches can be merged with
4217 .Dl $ got update -b master
4218 .Dl $ got merge upstream/master
4220 The question of whether to rebase or merge branches is philosophical.
4221 When in doubt, refer to the software project's policies set by project
4224 As a final step, the forked repository's copy of the master branch needs
4225 to be kept in sync by sending the new changes there:
4227 .Dl $ got send -f -b master origin
4229 If multiple pull requests need to be managed in parallel, a separate branch
4230 must be created for each pull request with
4232 Each such branch can then be used as above, in place of
4233 .Dq refs/heads/master .
4234 Changes for any accepted pull requests will still appear under
4235 .Dq refs/remotes/upstream/master,
4236 regardless of which branch was used in the forked repository to
4237 create a pull request.
4241 .Xr git-repository 5 ,
4242 .Xr got-worktree 5 ,
4246 .An Anthony J. Bentley Aq Mt bentley@openbsd.org
4247 .An Christian Weisgerber Aq Mt naddy@openbsd.org
4248 .An Hiltjo Posthuma Aq Mt hiltjo@codemadness.org
4249 .An Josh Rickmar Aq Mt jrick@zettaport.com
4250 .An Joshua Stein Aq Mt jcs@openbsd.org
4251 .An Klemens Nanni Aq Mt kn@openbsd.org
4252 .An Martin Pieuchot Aq Mt mpi@openbsd.org
4253 .An Neels Hofmeyr Aq Mt neels@hofmeyr.de
4254 .An Omar Polo Aq Mt op@openbsd.org
4255 .An Ori Bernstein Aq Mt ori@openbsd.org
4256 .An Sebastien Marie Aq Mt semarie@openbsd.org
4257 .An Stefan Sperling Aq Mt stsp@openbsd.org
4258 .An Steven McDonald Aq Mt steven@steven-mcdonald.id.au
4259 .An Theo Buehler Aq Mt tb@openbsd.org
4260 .An Thomas Adam Aq Mt thomas@xteddy.org
4261 .An Tracey Emery Aq Mt tracey@traceyemery.net
4262 .An Yang Zhong Aq Mt yzhong@freebsdfoundation.org
4269 were derived from code under copyright by:
4271 .An Caldera International
4272 .An Daniel Hartmeier
4277 .An Jean-Francois Brousseau
4283 .An Niklas Hallqvist
4288 .An Xavier Santolaria
4291 contains code contributed to the public domain by
4292 .An Austin Appleby .
4295 is a work-in-progress and some features remain to be implemented.
4297 At present, the user has to fall back on
4299 to perform some tasks.
4303 Reading from remote repositories over HTTP or HTTPS protocols requires
4308 Writing to remote repositories over HTTP or HTTPS protocols requires
4311 The creation of merge commits with more than two parent commits requires
4314 In situations where files or directories were moved around
4316 will not automatically merge changes to new locations and
4318 will usually produce better results.
