2 .\" Copyright (c) 2017 Martin Pieuchot
3 .\" Copyright (c) 2018, 2019, 2020 Stefan Sperling
5 .\" Permission to use, copy, modify, and distribute this software for any
6 .\" purpose with or without fee is hereby granted, provided that the above
7 .\" copyright notice and this permission notice appear in all copies.
9 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
30 is a version control system which stores the history of tracked files
31 in a Git repository, as used by the Git version control system.
32 This repository format is described in
33 .Xr git-repository 5 .
38 version control system because every copy of a repository is writeable.
39 Modifications made to files can be synchronized between repositories
44 must be checked out from the repository for modification.
45 Checked out files are stored in a
47 which can be placed at an arbitrary directory in the filesystem hierarchy.
48 The on-disk format of this work tree is described in
52 provides global and command-specific options.
53 Global options must precede the command name, and are as follows:
54 .Bl -tag -width tenletters
56 Display usage information and exit immediately.
58 Display program version and exit immediately.
64 .Bl -tag -width checkout
71 .Op Fl r Ar repository-path
75 Create an initial commit in a repository from the file hierarchy
78 The created commit will not have any parent commits, i.e. it will be a
80 Also create a new reference which provides a branch name for the newly
82 Show the path of each imported file to indicate progress.
88 environment variable to be set,
89 unless an author has been configured in
95 configuration settings can be obtained from the repository's
97 file or from Git's global
108 If this option is not specified, a branch corresponding to the repository's
109 HEAD reference will be used.
110 Use of this option is required if the branch resolved via the repository's
111 HEAD reference already exists.
113 Ignore files or directories with a name which matches the specified
115 This option may be specified multiple times to build a list of ignore patterns.
118 follows the globbing rules documented in
120 Ignore patterns which end with a slash,
122 will only match directories.
124 Use the specified log message when creating the new commit.
129 opens a temporary file in an editor where a log message can be written.
130 Quitting the editor without saving the file will abort the import operation.
131 .It Fl r Ar repository-path
132 Use the repository at the specified path.
133 If not specified, assume the repository is located at or above the current
141 .Op Fl R Ar reference
146 Clone a Git repository at the specified
152 is specified, the directory name will be derived from the name of the
155 will refuse to run if the
161 specifies a protocol scheme, a server hostname, an optional port number
162 separated from the hostname by a colon, and a path to the repository on
164 .Lk scheme://hostname:port/path/to/repository
166 The following protocol schemes are supported:
167 .Bl -tag -width git+ssh
169 The Git protocol as implemented by the
172 Use of this protocol is discouraged since it supports neither authentication
175 The Git protocol wrapped in an authenticated and encrypted
178 With this protocol the hostname may contain an embedded username for
183 Short alias for git+ssh.
186 Objects in the cloned repository are stored in a pack file which is downloaded
188 This pack file will then be indexed to facilitate access to the objects stored
190 If any objects in the pack file are stored in deltified form, all deltas will
191 be fully resolved in order to compute the ID of such objects.
192 This can take some time.
193 More details about the pack file format are documented in
194 .Xr git-repository 5 .
197 creates a remote repository entry in the
201 files of the cloned repository to store the
207 arguments for future use by
217 Fetch all branches from the remote repository's
219 reference namespace and set
220 .Cm fetch_all_branches
221 in the cloned repository's
223 file for future use by
225 If this option is not specified, a branch resolved via the remote
226 repository's HEAD reference will be fetched.
227 Cannot be used together with the
233 from the remote repository's
236 This option may be specified multiple times to build a list of branches
238 If the branch corresponding to the remote repository's HEAD reference is not
239 in this list, the cloned repository's HEAD reference will be set to the first
240 branch which was fetched.
241 If this option is not specified, a branch resolved via the remote
242 repository's HEAD reference will be fetched.
243 Cannot be used together with the
247 List branches and tags available for fetching from the remote repository
248 and exit immediately.
249 Cannot be used together with any of the other options except
254 Create the cloned repository as a mirror of the original repository.
255 This is useful if the cloned repository will not be used to store
256 locally created commits.
262 files will be set up with the
264 option enabled, such that
268 will write incoming changes directly to branches in the
270 reference namespace, rather than to branches in the
273 This avoids the usual requirement of having to run
279 in order to make incoming changes appear on branches in the
282 But maintaining custom changes in the cloned repository becomes difficult
283 since such changes will be at risk of being discarded whenever incoming
286 Suppress progress reporting output.
287 The same option will be passed to
290 .It Fl R Ar reference
291 In addition to the branches and tags that will be fetched, fetch an arbitrary
293 from the remote repository's
296 This option may be specified multiple times to build a list of additional
300 may either be a path to a specific reference, or a reference namespace
301 which will cause all references in this namespace to be fetched.
303 Each reference will be mapped into the cloned repository's
305 namespace, unless the
307 option is used to mirror references directly into the cloned repository's
312 will refuse to fetch references from the remote repository's
321 to print debugging messages to standard error output.
322 This option will be passed to
325 Multiple -v options increase the verbosity.
333 .Op Fl R Ar reference
334 .Op Fl r Ar repository-path
335 .Op Ar remote-repository
338 Fetch new changes from a remote repository.
340 .Ar remote-repository
344 The remote repository's URL is obtained from the corresponding entry in
348 file of the local repository, as created by
351 By default, any branches configured in
354 .Ar remote-repository
358 is invoked in a work tree then this work tree's current branch will be
359 fetched, too, provided it is present on the server.
360 If no branches to fetch can be found in
362 or via a work tree, or said branches are not found on the server, a branch
363 resolved via the remote repository's HEAD reference will be fetched.
364 Likewise, if a HEAD reference for the
365 .Ar remote-repository
366 exists but its target no longer matches the remote HEAD, then
367 the new target branch will be fetched.
368 This default behaviour can be overridden with the
374 New changes will be stored in a separate pack file downloaded from the server.
375 Optionally, separate pack files stored in the repository can be combined with
378 By default, branch references in the
380 reference namespace will be updated to point at the newly fetched commits.
385 command can then be used to make new changes visible on branches in the
387 namespace, merging incoming changes with the changes on those branches
390 If the repository was created as a mirror with
392 then all branches in the
394 namespace will be updated directly to match the corresponding branches in
395 the remote repository.
396 If those branches contained local commits, these commits will no longer be
397 reachable via a reference and will therefore be at risk of being discarded
398 by Git's garbage collector or
399 .Cm gotadmin cleanup .
400 Maintaining custom changes in a mirror repository is therefore discouraged.
402 In any case, references in the
404 namespace will always be fetched and mapped directly to local references
405 in the same namespace.
412 Fetch all branches from the remote repository's
415 This option can be enabled by default for specific repositories in
417 Cannot be used together with the
423 from the remote repository's
426 This option may be specified multiple times to build a list of branches
428 Cannot be used together with the
432 Delete branches and tags from the local repository which are no longer
433 present in the remote repository.
434 Only references are deleted.
435 Any commit, tree, tag, and blob objects belonging to deleted branches or
436 tags remain in the repository and may be removed separately with
437 Git's garbage collector or
438 .Cm gotadmin cleanup .
440 List branches and tags available for fetching from the remote repository
441 and exit immediately.
442 Cannot be used together with any of the other options except
448 Suppress progress reporting output.
449 The same option will be passed to
452 .It Fl R Ar reference
453 In addition to the branches and tags that will be fetched, fetch an arbitrary
455 from the remote repository's
458 This option may be specified multiple times to build a list of additional
462 may either be a path to a specific reference, or a reference namespace
463 which will cause all references in this namespace to be fetched.
465 Each reference will be mapped into the local repository's
467 namespace, unless the local repository was created as a mirror with
469 in which case references will be mapped directly into the local repository's
473 Once a reference has been fetched, a branch based on it can be created with
478 will refuse to fetch references from the remote repository's
483 .It Fl r Ar repository-path
484 Use the repository at the specified path.
485 If not specified, assume the repository is located at or above the current
487 If this directory is a
489 work tree, use the repository path associated with this work tree.
491 Allow existing references in the
493 namespace to be updated if they have changed on the server.
494 If not specified, only new tag references will be created.
499 to print debugging messages to standard error output.
500 The same option will be passed to
503 Multiple -v options increase the verbosity.
506 Delete all references which correspond to a particular
507 .Ar remote-repository
508 instead of fetching new changes.
509 This can be useful when a remote repository is being removed from
515 .Ar remote-repository
516 argument is mandatory and no other options except
523 Only references are deleted.
524 Any commit, tree, tag, and blob objects fetched from a remote repository
525 will generally be stored in pack files and may be removed separately with
527 and Git's garbage collector.
535 .Op Fl p Ar path-prefix
537 .Op Ar work-tree-path
540 Copy files from a repository into a new work tree.
541 Show the status of each affected file, using the following status codes:
542 .Bl -column YXZ description
543 .It A Ta new file was added
544 .It E Ta file already exists in work tree's meta-data
549 is not specified, either use the last component of
550 .Ar repository path ,
553 was specified use the last component of
561 Check out files from a commit on the specified
563 If this option is not specified, a branch resolved via the repository's HEAD
564 reference will be used.
566 Check out files from the specified
568 on the selected branch.
569 If this option is not specified, the most recent commit on the selected
574 argument is a commit ID SHA1 hash, or a reference name or a keyword
575 which will be resolved to a commit ID.
576 An abbreviated hash argument will be expanded to a full SHA1 hash
577 automatically, provided the abbreviation is unique.
582 resolve to the repository's HEAD reference, or, if the
584 option is used, the head of the checked-out
586 Keywords and reference names may be appended with
590 modifiers and an optional integer N to denote the
591 Nth descendant or antecedent by first parent traversal, respectively;
594 denotes the work tree branch head's 2nd generation ancestor, and
596 will denote the 3rd generation ancestor of the commit resolved by the
599 If an integer does not follow the
605 is implicitly appended
614 is not contained in the selected branch, a different branch which contains
615 this commit must be specified with the
618 If no such branch is known, a new branch must be created for this
624 Checking out work trees with an unknown branch is intentionally not supported.
626 Proceed with the checkout operation even if the directory at
629 Existing files will be left intact.
630 .It Fl p Ar path-prefix
631 Restrict the work tree to a subset of the repository's tree hierarchy.
632 Only files beneath the specified
636 Silence progress output.
647 Update an existing work tree to a different
649 Change existing files in the work tree as necessary to match file contents
651 Preserve any local changes in the work tree and merge them with the
654 Files which already contain merge conflicts will not be updated to avoid
655 further complications.
656 Such files will be updated when
658 is run again after merge conflicts have been resolved.
659 If the conflicting changes are no longer needed, affected files can be
666 Show the status of each affected file, using the following status codes:
667 .Bl -column YXZ description
668 .It U Ta file was updated and contained no local changes
669 .It G Ta file was updated and local changes were merged cleanly
670 .It C Ta file was updated and conflicts occurred during merge
671 .It D Ta file was deleted
672 .It d Ta file's deletion was prevented by local modifications
673 .It A Ta new file was added
674 .It \(a~ Ta versioned file is obstructed by a non-regular file
675 .It ! Ta a missing versioned file was restored
676 .It # Ta file was not updated because it contains merge conflicts
677 .It ? Ta changes destined for an unversioned file were not merged
682 is specified, update the entire work tree.
683 Otherwise, restrict the update operation to files at or within the
685 Each path is required to exist in the update operation's target commit.
686 Files in the work tree outside specified paths will remain unchanged and
687 will retain their previously recorded base commit.
690 commands may refuse to run while the work tree contains files from
691 multiple base commits.
692 The base commit of such a work tree can be made consistent by running
694 across the entire work tree.
697 is incompatible with the
702 cannot update paths with staged changes.
703 If changes have been staged with
705 these changes must first be committed with
715 Switch the work tree's branch reference to the specified
717 before updating the work tree.
718 This option requires that all paths in the work tree are updated.
720 As usual, any local changes in the work tree will be preserved.
721 This can be useful when switching to a newly created branch in order
722 to commit existing local changes to this branch.
724 Any local changes must be dealt with separately in order to obtain a
725 work tree with pristine file contents corresponding exactly to the specified
727 Such changes could first be committed to a different branch with
729 or could be discarded with
732 Update the work tree to the specified
734 If this option is not specified, the most recent commit on the work tree's
739 argument is a commit ID SHA1 hash, or a reference name or a keyword
740 which will be resolved to a commit ID.
741 An abbreviated hash argument will be expanded to a full SHA1 hash
742 automatically, provided the abbreviation is unique.
747 resolve to the work tree's base commit and branch head, respectively.
748 Keywords and reference names may be appended with
752 modifiers and an optional integer N to denote the
753 Nth descendant or antecedent, respectively, by first parent traversal;
756 denotes the work tree branch head's 2nd generation ancestor, and
758 denotes the 4th generation descendant of the work tree's base commit.
761 will denote the 3rd generation ancestor of the commit resolved by the
764 If an integer does not follow the
770 is implicitly appended
777 Silence progress output.
783 .Op Fl S Ar status-codes
784 .Op Fl s Ar status-codes
788 Show the current modification status of files in a work tree,
789 using the following status codes:
790 .Bl -column YXZ description
791 .It M Ta modified file
792 .It A Ta file scheduled for addition in next commit
793 .It D Ta file scheduled for deletion in next commit
794 .It C Ta modified or added file which contains merge conflicts
795 .It ! Ta versioned file was expected on disk but is missing
796 .It \(a~ Ta versioned file is obstructed by a non-regular file
797 .It ? Ta unversioned item not tracked by
799 .It m Ta modified file modes (executable bit only)
800 .It N Ta non-existent
802 specified on the command line
807 is specified, show modifications in the entire work tree.
808 Otherwise, show modifications at or within the specified paths.
810 If changes have been staged with
812 staged changes are shown in the second output column, using the following
814 .Bl -column YXZ description
815 .It M Ta file modification is staged
816 .It A Ta file addition is staged
817 .It D Ta file deletion is staged
820 Changes created on top of staged changes are indicated in the first column:
821 .Bl -column YXZ description
822 .It MM Ta file was modified after earlier changes have been staged
823 .It MA Ta file was modified after having been staged for addition
831 Show unversioned files even if they match an ignore pattern.
832 .It Fl S Ar status-codes
833 Suppress the output of files with a modification status matching any of the
834 single-character status codes contained in the
837 Any combination of codes from the above list of possible status codes
839 For staged files, status codes displayed in either column will be matched.
840 Cannot be used together with the
843 .It Fl s Ar status-codes
844 Only show files with a modification status matching any of the
845 single-character status codes contained in the
848 Any combination of codes from the above list of possible status codes
850 For staged files, status codes displayed in either column will be matched.
851 Cannot be used together with the
856 For compatibility with
867 files in each traversed directory and will not display unversioned files
868 which match these patterns.
869 Ignore patterns which end with a slash,
871 will only match directories.
876 supports consecutive asterisks,
878 which will match an arbitrary amount of directories.
882 only supports a single ignore pattern per line.
886 does not support negated ignore patterns prefixed with
888 and gives no special significance to the location of path component separators,
897 .Op Fl r Ar repository-path
898 .Op Fl S Ar search-pattern
902 Display history of a repository.
905 is specified, show only commits which modified this path.
906 If invoked in a work tree, the
908 is interpreted relative to the current working directory,
909 and the work tree's path prefix is implicitly prepended.
910 Otherwise, the path is interpreted relative to the repository root.
917 Display individual commits which were merged into the current branch
921 shows the linear history of the current branch only.
923 Set the number of context lines shown in diffs with
925 By default, 3 lines of context are shown.
927 Start traversing history at the specified
929 If this option is not specified, default to the work tree's current branch
930 if invoked in a work tree, or to the repository's HEAD reference.
934 argument is a commit ID SHA1 hash, or a reference name or a keyword
935 which will be resolved to a commit ID.
936 An abbreviated hash argument will be expanded to a full SHA1 hash
937 automatically, provided the abbreviation is unique.
942 resolve to the work tree's base commit and branch head, respectively.
943 The former is only valid if invoked in a work tree, while the latter will
944 resolve to the tip of the work tree's current branch if invoked in a
945 work tree, otherwise it will resolve to the repository's HEAD reference.
946 Keywords and references may be appended with
950 modifiers and an optional integer N to denote the
951 Nth descendant or antecedent, respectively, by first parent traversal;
954 denotes the HEAD reference's 2nd generation ancestor, and
956 denotes the 4th generation descendant of the work tree's base commit.
959 will denote the 3rd generation descendant of the commit resolved by the
966 modifier without a trailing integer has an implicit
975 Display diffstat of changes introduced in each commit.
976 Cannot be used with the
981 option (diffstat displays a list of changed paths).
983 Limit history traversal to a given number of commits.
984 If this option is not specified, a default limit value of zero is used,
985 which is treated as an unbounded limit.
987 .Ev GOT_LOG_DEFAULT_LIMIT
988 environment variable may be set to change this default value.
990 Display the list of file paths changed in each commit, using the following
992 .Bl -column YXZ description
993 .It M Ta modified file
994 .It D Ta file was deleted
995 .It A Ta new file was added
996 .It m Ta modified file modes (executable bit only)
999 Cannot be used with the
1003 Display the patch of modifications made in each commit.
1006 is specified, only show the patch of modifications at or within this path.
1007 Cannot be used with the
1011 Determine a set of commits to display as usual, but display these commits
1013 .It Fl r Ar repository-path
1014 Use the repository at the specified path.
1015 If not specified, assume the repository is located at or above the current
1017 If this directory is a
1019 work tree, use the repository path associated with this work tree.
1020 .It Fl S Ar search-pattern
1021 If specified, show only commits with a log message, author name,
1022 committer name, or ID SHA1 hash matched by the extended regular
1024 .Ar search-pattern .
1025 Lines in committed patches will be matched if
1028 File paths changed by a commit will be matched if
1031 Regular expression syntax is documented in
1034 Display a short one-line summary of each commit, instead of the default
1036 Cannot be used together with the
1042 Stop traversing commit history immediately after the specified
1049 argument is a commit ID SHA1 hash, or a reference name or a keyword
1050 which will be resolved to a commit ID.
1051 This option has no effect if the specified
1061 .Op Fl r Ar repository-path
1062 .Op Ar object1 Ar object2 | Ar path ...
1065 When invoked within a work tree without any arguments, display all
1066 local changes in the work tree.
1069 arguments are specified, only show changes within the specified paths.
1071 If two arguments are provided, treat each argument as a reference, a tag
1072 name, or an object ID SHA1 hash, and display differences between the
1073 corresponding objects.
1074 Both objects must be of the same type (blobs, trees, or commits).
1075 An abbreviated hash argument will be expanded to a full SHA1 hash
1076 automatically, provided the abbreviation is unique.
1077 If none of these interpretations produce a valid result or if the
1082 is running in a work tree, attempt to interpret the two arguments as paths.
1089 Treat file contents as ASCII text even if binary data is detected.
1091 Set the number of context lines shown in the diff.
1092 By default, 3 lines of context are shown.
1094 Show differences between commits in the repository.
1095 This option may be used up to two times.
1096 When used only once, show differences between the specified
1098 and its first parent commit.
1099 When used twice, show differences between the two specified commits.
1103 option is used, all non-option arguments will be interpreted as paths.
1106 arguments are provided, only show differences for the specified paths.
1110 argument is a commit ID SHA1 hash, or a reference name or a keyword
1111 which will be resolved to a commit ID.
1112 An abbreviated hash argument will be expanded to a full SHA1 hash
1113 automatically, provided the abbreviation is unique.
1118 resolve to the work tree's base commit and branch head, respectively.
1119 The former is only valid if invoked in a work tree, while the latter will
1120 resolve to the tip of the work tree's current branch if invoked in a
1121 work tree, otherwise it will resolve to the repository's HEAD reference.
1122 Keywords and references may be appended with
1126 modifiers and an optional integer N to denote the
1127 Nth descendant or antecedent, respectively, by first parent traversal;
1130 denotes the HEAD reference's 2nd generation ancestor, and
1132 denotes the 4th generation descendant of the work tree's base commit.
1135 will denote the 8th generation descendant of the commit resolved by the
1138 If an integer does not follow the
1144 is implicitly appended
1151 Cannot be used together with the
1155 Display diffstat of changes before the actual diff by annotating each file path
1156 or blob hash being diffed with the total number of lines added and removed.
1157 A summary line will display the total number of changes across all files.
1159 Interpret all arguments as paths only.
1160 This option can be used to resolve ambiguity in cases where paths
1161 look like tag names, reference names, or object IDs.
1162 This option is only valid when
1164 is invoked in a work tree.
1165 .It Fl r Ar repository-path
1166 Use the repository at the specified path.
1167 If not specified, assume the repository is located at or above the current
1169 If this directory is a
1171 work tree, use the repository path associated with this work tree.
1173 Show changes staged with
1175 instead of showing local changes in the work tree.
1176 This option is only valid when
1178 is invoked in a work tree.
1180 Ignore whitespace-only changes.
1186 .Op Fl r Ar repository-path
1190 Display line-by-line history of a file at the specified path.
1197 Start traversing history at the specified
1199 The expected argument is a commit ID SHA1 hash, or a reference name
1200 or a keyword which will be resolved to a commit ID.
1201 An abbreviated hash argument will be expanded to a full SHA1 hash
1202 automatically, provided the abbreviation is unique.
1207 resolve to the work tree's base commit and branch head, respectively.
1208 The former is only valid if invoked in a work tree, while the latter will
1209 resolve to the tip of the work tree's current branch if invoked in a
1210 work tree, otherwise it will resolve to the repository's HEAD reference.
1211 Keywords and references may be appended with
1215 modifiers and an optional integer N to denote the
1216 Nth descendant or antecedent by first parent traversal, respectively;
1219 denotes the work tree branch head's 2nd generation ancestor, and
1221 denotes the 4th generation descendant of the work tree's base commit.
1224 will denote the 5th generation ancestor of the commit resolved by the
1231 modifier without a trailing integer has an implicit
1239 .It Fl r Ar repository-path
1240 Use the repository at the specified path.
1241 If not specified, assume the repository is located at or above the current
1243 If this directory is a
1245 work tree, use the repository path associated with this work tree.
1252 .Op Fl r Ar repository-path
1256 Display a listing of files and directories at the specified
1257 directory path in the repository.
1258 Entries shown in this listing may carry one of the following trailing
1260 .Bl -column YXZ description
1261 .It @ Ta entry is a symbolic link
1262 .It / Ta entry is a directory
1263 .It * Ta entry is an executable file
1264 .It $ Ta entry is a Git submodule
1267 Symbolic link entries are also annotated with the target path of the link.
1271 is specified, list the repository path corresponding to the current
1272 directory of the work tree, or the root directory of the repository
1273 if there is no work tree.
1280 List files and directories as they appear in the specified
1283 The expected argument is a commit ID SHA1 hash, or a reference name
1284 or a keyword which will be resolved to a commit ID.
1285 An abbreviated hash argument will be expanded to a full SHA1 hash
1286 automatically, provided the abbreviation is unique.
1291 resolve to the work tree's base commit and branch head, respectively.
1292 The former is only valid if invoked in a work tree, while the latter will
1293 resolve to the tip of the work tree's current branch if invoked in a
1294 work tree, otherwise it will resolve to the repository's HEAD reference.
1295 Keywords and references may be appended with
1299 modifiers and an optional integer N to denote the
1300 Nth descendant or antecedent by first parent traversal, respectively;
1303 denotes the work tree branch head's 2nd generation ancestor, and
1305 denotes the 4th generation descendant of the work tree's base commit.
1308 will denote the 3rd generation ancestor of the commit resolved by the
1315 modifier without a trailing integer has an implicit
1324 Show object IDs of files (blob objects) and directories (tree objects).
1326 Recurse into sub-directories in the repository.
1327 .It Fl r Ar repository-path
1328 Use the repository at the specified path.
1329 If not specified, assume the repository is located at or above the current
1331 If this directory is a
1333 work tree, use the repository path associated with this work tree.
1339 .Op Fl r Ar repository-path
1340 .Op Fl s Ar reference
1343 Manage references in a repository.
1345 References may be listed, created, deleted, and changed.
1346 When creating, deleting, or changing a reference the specified
1348 must be an absolute reference name, i.e. it must begin with
1356 Create a reference or change an existing reference.
1357 The reference with the specified
1359 will point at the specified
1364 argument is an ID SHA1 hash or an existing reference or tag name
1365 or a keyword which will be resolved to the ID of a corresponding commit,
1366 tree, tag, or blob object.
1367 An abbreviated hash argument will be expanded to a full SHA1 hash
1368 automatically, provided the abbreviation is unique.
1373 resolve to the work tree's base commit and branch head, respectively.
1374 The former is only valid if invoked in a work tree, while the latter will
1375 resolve to the tip of the work tree's current branch if invoked in a
1376 work tree, otherwise it will resolve to the repository's HEAD reference.
1377 Keywords and reference names may be appended with
1381 modifiers and an optional integer N to denote the
1382 Nth descendant or antecedent by first parent traversal, respectively;
1385 denotes the work tree branch head's 2nd generation ancestor, and
1387 will denote the 3rd generation ancestor of the commit resolved by the
1390 If an integer does not follow the
1396 is implicitly appended
1403 Cannot be used together with any other options except
1406 Delete the reference with the specified
1408 from the repository.
1409 Any commit, tree, tag, and blob objects belonging to deleted references
1410 remain in the repository and may be removed separately with
1411 Git's garbage collector or
1412 .Cm gotadmin cleanup .
1413 Cannot be used together with any other options except
1416 List references in the repository.
1419 is specified, list all existing references in the repository.
1422 is a reference namespace, list all references in this namespace.
1423 Otherwise, show only the reference with the given
1425 Cannot be used together with any other options except
1429 .It Fl r Ar repository-path
1430 Use the repository at the specified path.
1431 If not specified, assume the repository is located at or above the current
1433 If this directory is a
1435 work tree, use the repository path associated with this work tree.
1436 .It Fl s Ar reference
1437 Create a symbolic reference, or change an existing symbolic reference.
1438 The symbolic reference with the specified
1440 will point at the specified
1442 which must already exist in the repository.
1443 Care should be taken not to create loops between references when
1444 this option is used.
1445 Cannot be used together with any other options except
1448 Sort listed references by modification time (most recently modified first)
1449 instead of sorting by lexicographical order.
1450 Use of this option requires the
1452 option to be used as well.
1460 .Op Fl r Ar repository-path
1464 Create, list, or delete branches.
1466 Local branches are managed via references which live in the
1468 reference namespace.
1471 command creates references in this namespace only.
1473 When deleting branches, the specified
1477 reference namespace first.
1478 If no corresponding branch is found, the
1480 namespace will be searched next.
1482 If invoked in a work tree without any arguments, print the name of the
1483 work tree's current branch.
1487 argument is passed, attempt to create a branch reference with the given name.
1488 By default the new branch reference will point at the latest commit on the
1489 work tree's current branch if invoked in a work tree, and otherwise to a commit
1490 resolved via the repository's HEAD reference.
1492 If invoked in a work tree, once the branch was created successfully
1493 switch the work tree's head reference to the newly created branch and
1494 update files across the entire work tree, just like
1495 .Cm got update -b Ar name
1497 Show the status of each affected file, using the following status codes:
1498 .Bl -column YXZ description
1499 .It U Ta file was updated and contained no local changes
1500 .It G Ta file was updated and local changes were merged cleanly
1501 .It C Ta file was updated and conflicts occurred during merge
1502 .It D Ta file was deleted
1503 .It A Ta new file was added
1504 .It \(a~ Ta versioned file is obstructed by a non-regular file
1505 .It ! Ta a missing versioned file was restored
1513 Make a newly created branch reference point at the specified
1515 The expected argument is a commit ID SHA1 hash, or a reference name or keyword
1516 which will be resolved to a commit ID.
1517 An abbreviated hash argument will be expanded to a full SHA1 hash
1518 automatically, provided the abbreviation is unique.
1523 resolve to the work tree's base commit and branch head, respectively.
1524 The former is only valid if invoked in a work tree, while the latter will
1525 resolve to the tip of the work tree's current branch if invoked in a
1526 work tree, otherwise it will resolve to the repository's HEAD reference.
1527 Keywords and references may be appended with
1531 modifiers and an optional integer N to denote the
1532 Nth descendant or antecedent by first parent traversal, respectively;
1535 denotes the work tree branch head's 2nd generation ancestor, and
1537 denotes the 4th generation descendant of the work tree's base commit.
1540 will denote the 3rd generation descendant of the commit resolved by the
1547 modifier without a trailing integer has an implicit
1556 Delete the branch with the specified
1562 reference namespace.
1564 Only the branch reference is deleted.
1565 Any commit, tree, and blob objects belonging to the branch
1566 remain in the repository and may be removed separately with
1567 Git's garbage collector or
1568 .Cm gotadmin cleanup .
1570 List all existing branches in the repository, including copies of remote
1571 repositories' branches in the
1573 reference namespace.
1575 If invoked in a work tree, the work tree's current branch is shown
1576 with one of the following annotations:
1577 .Bl -column YXZ description
1578 .It * Ta work tree's base commit and the base commit of all tracked files
1579 matches the branch tip
1580 .It \(a~ Ta work tree comprises mixed commits or its base commit is out-of-date
1583 Do not switch and update the work tree after creating a new branch.
1584 .It Fl r Ar repository-path
1585 Use the repository at the specified path.
1586 If not specified, assume the repository is located at or above the current
1588 If this directory is a
1590 work tree, use the repository path associated with this work tree.
1592 Sort listed branches by modification time (most recently modified first)
1593 instead of sorting by lexicographical order.
1596 reference namespace are listed before branches in
1599 Use of this option requires the
1601 option to be used as well.
1608 .Op Fl r Ar repository-path
1609 .Op Fl s Ar signer-id
1612 Manage tags in a repository.
1614 Tags are managed via references which live in the
1616 reference namespace.
1619 command operates on references in this namespace only.
1620 References in this namespace point at tag objects which contain a pointer
1621 to another object, a tag message, as well as author and timestamp information.
1623 Attempt to create a tag with the given
1625 and make this tag point at the given
1627 If no commit is specified, default to the latest commit on the work tree's
1628 current branch if invoked in a work tree, and to a commit resolved via
1629 the repository's HEAD reference otherwise.
1636 Make the newly created tag reference point at the specified
1640 argument is a commit ID SHA1 hash, or a reference or keyword
1641 which will be resolved to a commit ID.
1642 An abbreviated hash argument will be expanded to a full SHA1 hash
1643 automatically, provided the abbreviation is unique.
1648 resolve to the work tree's base commit and branch head, respectively.
1649 The former is only valid if invoked in a work tree, while the latter will
1650 resolve to the tip of the work tree's current branch if invoked in a
1651 work tree, otherwise it will resolve to the repository's HEAD reference.
1652 Keywords and references may be appended with
1656 modifiers and an optional integer N to denote the
1657 Nth descendant or antecedent by first parent traversal, respectively;
1660 denotes the work tree branch head's 2nd generation ancestor, and
1662 denotes the 4th generation descendant of the work tree's base commit.
1665 will denote the 3rd generation ancestor of the commit resolved by the
1672 modifier without a trailing integer has an implicit
1681 List all existing tags in the repository instead of creating a new tag.
1684 argument is passed, show only the tag with the given
1687 Use the specified tag message when creating the new tag.
1692 opens a temporary file in an editor where a tag message can be written.
1693 Quitting the editor without saving the file will abort the tag operation.
1694 .It Fl r Ar repository-path
1695 Use the repository at the specified path.
1696 If not specified, assume the repository is located at or above the current
1698 If this directory is a
1700 work tree, use the repository path associated with this work tree.
1701 .It Fl s Ar signer-id
1702 While creating a new tag, sign this tag with the identity given in
1705 For SSH-based signatures,
1707 is the path to a file which may refer to either a private SSH key,
1708 or a public SSH key with the private half available via
1711 will sign the tag object by invoking
1715 command, using the signature namespace
1717 for compatibility with
1720 Verify tag object signatures.
1723 is specified, show and verify the tag object with the provided name.
1724 Otherwise, list all tag objects and verify signatures where present.
1727 verifies SSH-based signatures by invoking
1730 .Fl Y Cm verify Fl f Ar allowed_signers .
1735 otherwise verification is impossible.
1738 During SSH signature creation and verification this option will be passed to
1740 Multiple -v options increase the verbosity.
1746 command will not delete tags or change existing tags.
1747 If a tag must be deleted, the
1749 command may be used to delete a tag's reference.
1750 This should only be done if the tag has not already been copied to
1757 Schedule unversioned files in a work tree for addition to the
1758 repository in the next commit.
1759 By default, files which match a
1761 ignore pattern will not be added.
1765 mentioned in the command line is not an unversioned file then
1768 To avoid unnecessary errors from paths picked up by file globbing patterns
1769 in the shell, paths in the argument list will be silently ignored if they
1772 at all, or if they are reported with one of the following status codes
1773 and do not have changes staged via
1775 .Bl -column YXZ description
1776 .It M Ta modified file
1777 .It A Ta file scheduled for addition in next commit
1778 .It C Ta modified or added file which contains merge conflicts
1779 .It m Ta modified file modes (executable bit only)
1787 Add files even if they match a
1791 Permit recursion into directories.
1792 If this option is not specified,
1794 will refuse to run if a specified
1802 .Op Fl s Ar status-codes
1806 Remove versioned files from a work tree and schedule them for deletion
1807 from the repository in the next commit.
1814 Perform the operation even if a file contains local modifications,
1815 and do not raise an error if a specified
1817 does not exist on disk.
1819 Keep affected files on disk.
1821 Permit recursion into directories.
1822 If this option is not specified,
1824 will refuse to run if a specified
1827 .It Fl s Ar status-codes
1828 Only delete files with a modification status matching one of the
1829 single-character status codes contained in the
1832 The following status codes may be specified:
1833 .Bl -column YXZ description
1834 .It M Ta modified file (this implies the
1837 .It ! Ta versioned file expected on disk but missing
1845 .Op Fl p Ar strip-count
1851 to files in a work tree.
1852 Files added or removed by a patch will be scheduled for addition or removal in
1855 The patch must be in the unified diff format as produced by
1862 diff when invoked with their
1867 argument is provided, read unified diff data from standard input instead.
1871 contains multiple patches, then attempt to apply each of them in sequence.
1873 Show the status of each affected file, using the following status codes:
1874 .Bl -column XYZ description
1875 .It M Ta file was modified
1876 .It G Ta file was merged using a merge-base found in the repository
1877 .It C Ta file was merged and conflicts occurred during merge
1878 .It D Ta file was deleted
1879 .It A Ta file was added
1880 .It # Ta failed to patch the file
1883 If a change does not match at its exact line number, attempt to
1884 apply it somewhere else in the file if a good spot can be found.
1885 Otherwise, the patch will fail to apply.
1889 will refuse to apply a patch if certain preconditions are not met.
1890 Files to be deleted must already be under version control, and must
1891 not have been scheduled for deletion already.
1892 Files to be added must not yet be under version control and must not
1893 already be present on disk.
1894 Files to be modified must already be under version control and may not
1895 contain conflict markers.
1897 If an error occurs, the
1899 operation will be aborted.
1900 Any changes made to the work tree up to this point will be left behind.
1901 Such changes can be viewed with
1903 and can be reverted with
1912 Attempt to locate files within the specified
1914 for use as a merge-base for 3-way merges.
1918 option is not used then
1920 will attempt to locate merge-bases via object IDs found in
1922 meta-data, such as produced by
1928 option is only recommended in the absence of such meta-data.
1930 Ideally, the specified
1932 should contain versions of files which the changes contained in the
1935 Files will be located by path, relative to the repository root.
1938 option is used then leading path components will be stripped
1939 before paths are looked up in the repository.
1941 In case no merge-base is available for a file, changes will be applied
1942 without doing a 3-way merge.
1943 Changes which do not apply cleanly may then be rejected entirely, rather
1944 than producing merge conflicts in the patched target file.
1948 argument is a commit ID SHA1 hash, or a reference name or a keyword
1949 which will be resolved to a commit ID.
1950 An abbreviated hash argument will be expanded to a full SHA1 hash
1951 automatically, provided the abbreviation is unique.
1956 resolve to the work tree's base commit and branch head, respectively.
1957 Keywords and references may be appended with
1961 modifiers and an optional integer N to denote the
1962 Nth descendant or antecedent by first parent traversal, respectively;
1965 denotes the work tree branch head's 2nd generation ancestor, and
1967 denotes the 4th generation descendant of the work tree's base commit.
1970 will denote the 3rd generation descendant of the commit resolved by the
1977 modifier without a trailing integer has an implicit
1986 Do not make any modifications to the work tree.
1987 This can be used to check whether a patch would apply without issues.
1990 contains diffs that affect the same file multiple times, the results
1991 displayed may be incorrect.
1992 .It Fl p Ar strip-count
1993 Specify the number of leading path components to strip from paths
2002 path prefixes generated by
2004 will be recognized and stripped automatically.
2006 Reverse the patch before applying it.
2012 .Op Fl F Ar response-script
2016 Revert any local changes in files at the specified paths in a work tree.
2017 File contents will be overwritten with those contained in the
2018 work tree's base commit.
2019 There is no way to bring discarded changes back after
2022 If a file was added with
2024 it will become an unversioned file again.
2025 If a file was deleted with
2027 it will be restored.
2033 .It Fl F Ar response-script
2041 responses line-by-line from the specified
2043 file instead of prompting interactively.
2045 Instead of reverting all changes in files, interactively select or reject
2046 changes to revert based on
2052 (quit reverting this file) responses.
2053 If a file is in modified status, individual patches derived from the
2054 modified file content can be reverted.
2055 Files in added or deleted status may only be reverted in their entirety.
2057 Permit recursion into directories.
2058 If this option is not specified,
2060 will refuse to run if a specified
2074 Create a new commit in the repository from changes in a work tree
2075 and use this commit as the new base commit for the work tree.
2078 is specified, commit all changes in the work tree.
2079 Otherwise, commit changes at or within the specified paths.
2081 If changes have been explicitly staged for commit with
2083 only commit staged changes and reject any specified paths which
2084 have not been staged.
2087 opens a temporary file in an editor where a log message can be written
2095 options are used together.
2096 Quitting the editor without saving the file will abort the commit operation.
2098 Show the status of each affected file, using the following status codes:
2099 .Bl -column YXZ description
2100 .It M Ta modified file
2101 .It D Ta file was deleted
2102 .It A Ta new file was added
2103 .It m Ta modified file modes (executable bit only)
2106 Files which are not part of the new commit will retain their previously
2107 recorded base commit.
2110 commands may refuse to run while the work tree contains files from
2111 multiple base commits.
2112 The base commit of such a work tree can be made consistent by running
2114 across the entire work tree.
2118 command requires the
2120 environment variable to be set,
2121 unless an author has been configured in
2127 configuration settings can be
2128 obtained from the repository's
2130 file or from Git's global
2139 Set author information in the newly created commit to
2141 This is useful when committing changes on behalf of someone else.
2144 argument must use the same format as the
2146 environment variable.
2148 In addition to storing author information, the newly created commit
2151 information which is obtained, as usual, from the
2153 environment variable, or
2155 or Git configuration settings.
2157 Allow committing files in conflicted status.
2159 Committing files with conflict markers should generally be avoided.
2160 Cases where conflict markers must be stored in the repository for
2161 some legitimate reason should be very rare.
2162 There are usually ways to avoid storing conflict markers verbatim by
2163 applying appropriate programming tricks.
2165 Use the prepared log message stored in the file found at
2167 when creating the new commit.
2169 opens a temporary file in an editor where the prepared log message can be
2170 reviewed and edited further if needed.
2171 Cannot be used together with the
2175 Use the specified log message when creating the new commit.
2176 Cannot be used together with the
2180 This option prevents
2182 from opening the commit message in an editor.
2183 It has no effect unless it is used together with the
2185 option and is intended for non-interactive use such as scripting.
2187 This option prevents
2189 from generating a diff of the to-be-committed changes in a temporary file
2190 which can be viewed while editing a commit message.
2192 Allow the addition of symbolic links which point outside of the path space
2193 that is under version control.
2196 will reject such symbolic links due to safety concerns.
2199 may decide to represent such a symbolic link as a regular file which contains
2200 the link's target path, rather than creating an actual symbolic link which
2201 points outside of the work tree.
2202 Use of this option is discouraged because external mechanisms such as
2204 are better suited for managing symbolic links to paths not under
2209 will refuse to run if certain preconditions are not met.
2210 If the work tree's current branch is not in the
2212 reference namespace, new commits may not be created on this branch.
2213 Local changes may only be committed if they are based on file content
2214 found in the most recent commit on the work tree's branch.
2215 If a path is found to be out of date,
2217 must be used first in order to merge local changes with changes made
2225 .Op Fl r Ar repository-path
2227 .Op Ar remote-repository
2230 Send new changes to a remote repository.
2232 .Ar remote-repository
2236 The remote repository's URL is obtained from the corresponding entry in
2240 file of the local repository, as created by
2243 All objects corresponding to new changes will be written to a temporary
2244 pack file which is then uploaded to the server.
2245 Upon success, references in the
2247 reference namespace of the local repository will be updated to point at
2248 the commits which have been sent.
2250 By default, changes will only be sent if they are based on up-to-date
2251 copies of relevant branches in the remote repository.
2252 If any changes to be sent are based on out-of-date copies or would
2253 otherwise break linear history of existing branches, new changes must
2254 be fetched from the server with
2256 and local branches must be rebased with
2263 option can be used to make exceptions to these requirements.
2270 Send all branches from the local repository's
2272 reference namespace.
2275 option is equivalent to listing all branches with multiple
2278 Cannot be used together with the
2284 from the local repository's
2286 reference namespace.
2287 This option may be specified multiple times to build a list of branches
2289 If this option is not specified, default to the work tree's current branch
2290 if invoked in a work tree, or to the repository's HEAD reference.
2291 Cannot be used together with the
2295 Delete the specified
2297 from the remote repository's
2299 reference namespace.
2300 This option may be specified multiple times to build a list of branches
2303 Only references are deleted.
2304 Any commit, tree, tag, and blob objects belonging to deleted branches
2305 may become subject to deletion by Git's garbage collector running on
2308 Requesting deletion of branches results in an error if the server
2309 does not support this feature or disallows the deletion of branches
2310 based on its configuration.
2312 Attempt to force the server to overwrite existing branches or tags
2313 in the remote repository, even when
2319 would usually be required before changes can be sent.
2320 The server may reject forced requests regardless, depending on its
2323 Any commit, tree, tag, and blob objects belonging to overwritten branches
2324 or tags may become subject to deletion by Git's garbage collector running
2329 reference namespace is globally shared between all repositories.
2332 option to overwrite tags is discouraged because it can lead to
2333 inconsistencies between the tags present in different repositories.
2334 In general, creating a new tag with a different name is recommended
2335 instead of overwriting an existing tag.
2339 option is particularly discouraged if changes being sent are based
2340 on an out-of-date copy of a branch in the remote repository.
2341 Instead of using the
2343 option, new changes should
2346 and local branches should be rebased with
2350 followed by another attempt to send the changes.
2354 option should only be needed in situations where the remote repository's
2355 copy of a branch or tag is known to be out-of-date and is considered
2357 The risks of creating inconsistencies between different repositories
2358 should also be taken into account.
2360 Suppress progress reporting output.
2361 The same option will be passed to
2364 .It Fl r Ar repository-path
2365 Use the repository at the specified path.
2366 If not specified, assume the repository is located at or above the current
2368 If this directory is a
2370 work tree, use the repository path associated with this work tree.
2372 Attempt to send all tags from the local repository's
2374 reference namespace.
2377 option is equivalent to listing all tags with multiple
2380 Cannot be used together with the
2386 from the local repository's
2388 reference namespace, in addition to any branches that are being sent.
2391 option may be specified multiple times to build a list of tags to send.
2392 No tags will be sent if the
2396 Raise an error if the specified
2398 already exists in the remote repository, unless the
2400 option is used to overwrite the server's copy of the tag.
2401 In general, creating a new tag with a different name is recommended
2402 instead of overwriting an existing tag.
2404 Cannot be used together with the
2411 to print debugging messages to standard error output.
2412 The same option will be passed to
2415 Multiple -v options increase the verbosity.
2425 Merge changes from a single
2430 should be on a different branch than the work tree's base commit.
2432 The expected argument is a commit ID SHA1 hash, or a reference name or
2433 keyword which will be resolved to a commit ID.
2434 An abbreviated hash argument will be expanded to a full SHA1 hash
2435 automatically, provided the abbreviation is unique.
2440 resolve to the work tree's base commit and branch head, respectively.
2441 Keywords and references may be appended with
2445 modifiers and an optional integer N to denote the
2446 Nth descendant or antecedent by first parent traversal, respectively;
2449 denotes the work tree branch head's 2nd generation ancestor, and
2451 denotes the 4th generation descendant of the work tree's base commit.
2454 will denote the 3rd generation descendant of the commit resolved by the
2461 modifier without a trailing integer has an implicit
2470 Show the status of each affected file, using the following status codes:
2471 .Bl -column YXZ description
2472 .It G Ta file was merged
2473 .It C Ta file was merged and conflicts occurred during merge
2474 .It ! Ta changes destined for a missing file were not merged
2475 .It D Ta file was deleted
2476 .It d Ta file's deletion was prevented by local modifications
2477 .It A Ta new file was added
2478 .It \(a~ Ta changes destined for a non-regular file were not merged
2479 .It ? Ta changes destined for an unversioned file were not merged
2482 The merged changes will appear as local changes in the work tree, which
2485 amended manually or with further
2491 If invoked in a work tree where no
2496 operation is taking place,
2498 creates a record of commits which have been merged into the work tree.
2499 When a file changed by
2503 the log messages of relevant merged commits will then appear in the editor,
2504 where the messages should be further adjusted to convey the reasons for
2505 cherrypicking the changes.
2506 Upon exiting the editor, if the time stamp of the log message file
2507 is unchanged or the log message is empty,
2509 will fail with an unmodified or empty log message error.
2511 If all the changes in all files touched by a given commit are discarded,
2514 this commit's log message record will also disappear.
2517 will refuse to run if certain preconditions are not met.
2518 If the work tree contains multiple base commits, it must first be updated
2519 to a single base commit with
2521 If any relevant files already contain merge conflicts, these
2522 conflicts must be resolved first.
2530 Display a list of commit log messages recorded by cherrypick operations,
2531 represented by references in the
2532 .Dq refs/got/worktree
2533 reference namespace.
2536 is specified, only show the log message of the specified commit.
2538 If invoked in a work tree, only log messages recorded by cherrypick operations
2539 in the current work tree will be displayed.
2540 Otherwise, all commit log messages will be displayed irrespective of the
2541 work tree in which they were created.
2542 This option cannot be used with
2545 Delete log messages created by previous cherrypick operations, represented by
2547 .Dq refs/got/worktree
2548 reference namespace.
2551 is specified, only delete the log message of the specified commit.
2553 If invoked in a work tree, only log messages recorded by cherrypick operations
2554 in the current work tree will be deleted.
2555 Otherwise, all commit log messages will be deleted irrespective of the
2556 work tree in which they were created.
2557 This option cannot be used with
2568 Reverse-merge changes from a single
2573 should be on the same branch as the work tree's base commit.
2575 The expected argument is a commit ID SHA1 hash, or a reference name
2576 or keyword which will be resolved to a commit ID.
2577 An abbreviated hash argument will be expanded to a full SHA1 hash
2578 automatically, provided the abbreviation is unique.
2583 resolve to the work tree's base commit and branch head, respectively.
2584 Keywords and references may be appended with
2588 modifiers and an optional integer N to denote the
2589 Nth descendant or antecedent by first parent traversal, respectively;
2592 denotes the work tree branch head's 2nd generation ancestor, and
2594 denotes the 4th generation descendant of the work tree's base commit.
2597 will denote the 5th generation descendant of the commit resolved by the
2604 modifier without a trailing integer has an implicit
2613 Show the status of each affected file, using the following status codes:
2614 .Bl -column YXZ description
2615 .It G Ta file was merged
2616 .It C Ta file was merged and conflicts occurred during merge
2617 .It ! Ta changes destined for a missing file were not merged
2618 .It D Ta file was deleted
2619 .It d Ta file's deletion was prevented by local modifications
2620 .It A Ta new file was added
2621 .It \(a~ Ta changes destined for a non-regular file were not merged
2622 .It ? Ta changes destined for an unversioned file were not merged
2625 The reverse-merged changes will appear as local changes in the work tree,
2626 which may be viewed with
2628 amended manually or with further
2634 If invoked in a work tree where no
2639 operation is taking place,
2641 creates a record of commits which have been reverse-merged into the work tree.
2642 When a file changed by
2646 the log messages of relevant reverse-merged commits will then appear in
2647 the editor, where the messages should be further adjusted to convey the
2648 reasons for backing out the changes.
2649 Upon exiting the editor, if the time stamp of the log message file
2650 is unchanged or the log message is empty,
2652 will fail with an unmodified or empty log message error.
2654 If all the changes in all files touched by a given commit are discarded,
2657 this commit's log message record will also disappear.
2660 will refuse to run if certain preconditions are not met.
2661 If the work tree contains multiple base commits, it must first be updated
2662 to a single base commit with
2664 If any relevant files already contain merge conflicts, these
2665 conflicts must be resolved first.
2673 Display a list of commit log messages recorded by backout operations,
2674 represented by references in the
2675 .Dq refs/got/worktree
2676 reference namespace.
2679 is specified, only show the log message of the specified commit.
2681 If invoked in a work tree, only log messages recorded by backout operations
2682 in the current work tree will be displayed.
2683 Otherwise, all commit log messages will be displayed irrespective of the
2684 work tree in which they were created.
2685 This option cannot be used with
2688 Delete log messages created by previous backout operations, represented by
2690 .Dq refs/got/worktree
2691 reference namespace.
2694 is specified, only delete the log message of the specified commit.
2696 If invoked in a work tree, only log messages recorded by backout operations
2697 in the current work tree will be deleted.
2698 Otherwise, all commit log messages will be deleted irrespective of the
2699 work tree in which they were created.
2700 This option cannot be used with
2711 Rebase commits on the specified
2713 onto the tip of the current branch of the work tree.
2716 must share common ancestry with the work tree's current branch.
2717 Rebasing begins with the first descendant commit of the youngest
2718 common ancestor commit shared by the specified
2720 and the work tree's current branch, and stops once the tip commit
2727 is used as intended, the specified
2729 represents a local commit history and may already contain changes
2730 that are not yet visible in any other repositories.
2731 The work tree's current branch, which must be set with
2735 operation, represents a branch from a remote repository which shares
2736 a common history with the specified
2738 but has progressed, and perhaps diverged, due to commits added to the
2741 Rebased commits are accumulated on a temporary branch which the work tree
2742 will remain switched to throughout the entire rebase operation.
2743 Commits on this branch represent the same changes with the same log
2744 messages as their counterparts on the original
2746 but with different commit IDs.
2747 Once rebasing has completed successfully, the temporary branch becomes
2748 the new version of the specified
2750 and the work tree is automatically switched to it.
2751 If author information is available via the
2753 environment variable,
2759 configuration settings, this author information will be used to identify
2764 Old commits in their pre-rebase state are automatically backed up in the
2765 .Dq refs/got/backup/rebase
2766 reference namespace.
2767 As long as these references are not removed older versions of rebased
2768 commits will remain in the repository and can be viewed with the
2771 Removal of these references makes objects which become unreachable via
2772 any reference subject to removal by Git's garbage collector or
2773 .Cm gotadmin cleanup .
2775 While rebasing commits, show the status of each affected file,
2776 using the following status codes:
2777 .Bl -column YXZ description
2778 .It G Ta file was merged
2779 .It C Ta file was merged and conflicts occurred during merge
2780 .It ! Ta changes destined for a missing file were not merged
2781 .It D Ta file was deleted
2782 .It d Ta file's deletion was prevented by local modifications
2783 .It A Ta new file was added
2784 .It \(a~ Ta changes destined for a non-regular file were not merged
2785 .It ? Ta changes destined for an unversioned file were not merged
2788 If merge conflicts occur, the rebase operation is interrupted and may
2789 be continued once conflicts have been resolved.
2790 If any files with destined changes are found to be missing or unversioned,
2791 or if files could not be deleted due to differences in deleted content,
2792 the rebase operation will be interrupted to prevent potentially incomplete
2793 changes from being committed to the repository without user intervention.
2794 The work tree may be modified as desired and the rebase operation can be
2795 continued once the changes present in the work tree are considered complete.
2796 Alternatively, the rebase operation may be aborted which will leave
2798 unmodified and the work tree switched back to its original branch.
2800 If a merge conflict is resolved in a way which renders the merged
2801 change into a no-op change, the corresponding commit will be elided
2802 when the rebase operation continues.
2805 will refuse to run if certain preconditions are not met.
2810 reference namespace, the branch may not be rebased.
2811 If the work tree is not yet fully updated to the tip commit of its
2812 branch, then the work tree must first be updated with
2814 If changes have been staged with
2816 these changes must first be committed with
2820 If the work tree contains local changes, these changes must first be
2827 contains changes to files outside of the work tree's path prefix,
2828 the work tree cannot be used to rebase this branch.
2837 commands will refuse to run while a rebase operation is in progress.
2838 Other commands which manipulate the work tree may be used for
2839 conflict resolution purposes.
2843 is already based on the work tree's current branch, then no commits
2844 need to be rebased and
2846 will simply switch the work tree to the specified
2848 and update files in the work tree accordingly.
2855 Abort an interrupted rebase operation.
2856 If this option is used, no other command-line arguments are allowed.
2858 Allow a rebase operation to continue with files in conflicted status.
2859 This option should generally be avoided, and can only be used with the
2863 Continue an interrupted rebase operation.
2864 If this option is used, no other command-line arguments are allowed except
2867 Show a list of past rebase operations, represented by references in the
2868 .Dq refs/got/backup/rebase
2869 reference namespace.
2871 Display the author, date, and log message of each backed up commit,
2872 the object ID of the corresponding post-rebase commit, and
2873 the object ID of their common ancestor commit.
2874 Given these object IDs,
2881 options can be used to examine the history of either version of the branch,
2886 option can be used to create a new branch from a pre-rebase state if desired.
2890 is specified, only show commits which at some point in time represented this
2892 Otherwise, list all backed up commits for any branches.
2894 If this option is used,
2896 does not require a work tree.
2897 None of the other options can be used together with
2900 Delete backups created by past rebase operations, represented by references
2902 .Dq refs/got/backup/rebase
2903 reference namespace.
2907 is specified, only delete backups which at some point in time represented
2909 Otherwise, delete all references found within
2910 .Dq refs/got/backup/rebase .
2912 Any commit, tree, tag, and blob objects belonging to deleted backups
2913 remain in the repository and may be removed separately with
2914 Git's garbage collector or
2915 .Cm gotadmin cleanup .
2917 If this option is used,
2919 does not require a work tree.
2920 None of the other options can be used together with
2927 .Op Fl F Ar histedit-script
2931 Edit commit history between the work tree's current base commit and
2932 the tip commit of the work tree's current branch.
2936 command requires the
2938 environment variable to be set,
2939 unless an author has been configured in
2945 configuration settings can be obtained from the repository's
2947 file or from Git's global
2953 operation, the work tree's current branch must be set with
2955 to the branch which should be edited, unless this branch is already the
2956 current branch of the work tree.
2957 The tip of this branch represents the upper bound (inclusive) of commits
2962 Furthermore, the work tree's base commit
2965 to a point in this branch's commit history where editing should begin.
2966 This commit represents the lower bound (non-inclusive) of commits touched
2971 Editing of commit history is controlled via a
2973 which can be written in an editor based on a template, passed on the
2974 command line, or generated with the
2981 Quitting the editor without saving the file will abort the histedit operation.
2983 The format of the histedit script is line-based.
2984 Each line in the script begins with a command name, followed by
2985 whitespace and an argument.
2986 For most commands, the expected argument is a commit ID SHA1 hash.
2987 Any remaining text on the line is ignored.
2988 Lines which begin with the
2990 character are ignored entirely.
2992 The available histedit script commands are as follows:
2993 .Bl -column YXZ pick-commit
2994 .It Cm pick Ar commit Ta Use the specified commit as it is.
2995 .It Cm edit Ar commit Ta Apply the changes from the specified commit, but
2996 then interrupt the histedit operation for amending, without creating a commit.
2997 While the histedit operation is interrupted arbitrary files may be edited,
2998 and commands which manipulate the work tree can be used freely.
3003 commands can be used to add new files or remove existing ones.
3006 command can be used to eliminate arbitrary changes from files in the work tree.
3009 command may be used to prepare a subset of changes for inclusion in the
3013 command can be used to insert arbitrary commits into the edited history.
3014 Regular editing of history must eventually be resumed by running
3015 .Cm got histedit -c .
3016 .It Cm fold Ar commit Ta Combine the specified commit with the next commit
3017 listed further below that will be used.
3018 .It Cm drop Ar commit Ta Remove this commit from the edited history.
3019 .It Cm mesg Oo Ar log-message Oc Ta Create a new log message for the commit of
3024 command on the previous line of the histedit script.
3027 argument provides a new single-line log message to use.
3030 argument is omitted, open an editor where a new log message can be written.
3033 Every commit in the history being edited must be mentioned in the script.
3034 Lines may be re-ordered to change the order of commits in the edited history.
3035 No commit may be listed more than once.
3037 Edited commits are accumulated on a temporary branch which the work tree
3038 will remain switched to throughout the entire histedit operation.
3039 Once history editing has completed successfully, the temporary branch becomes
3040 the new version of the work tree's branch and the work tree is automatically
3043 Old commits in their pre-histedit state are automatically backed up in the
3044 .Dq refs/got/backup/histedit
3045 reference namespace.
3046 As long as these references are not removed older versions of edited
3047 commits will remain in the repository and can be viewed with the
3050 Removal of these references makes objects which become unreachable via
3051 any reference subject to removal by Git's garbage collector or
3052 .Cm gotadmin cleanup .
3054 While merging commits, show the status of each affected file,
3055 using the following status codes:
3056 .Bl -column YXZ description
3057 .It G Ta file was merged
3058 .It C Ta file was merged and conflicts occurred during merge
3059 .It ! Ta changes destined for a missing file were not merged
3060 .It D Ta file was deleted
3061 .It d Ta file's deletion was prevented by local modifications
3062 .It A Ta new file was added
3063 .It \(a~ Ta changes destined for a non-regular file were not merged
3064 .It ? Ta changes destined for an unversioned file were not merged
3067 If merge conflicts occur, the histedit operation is interrupted and may
3068 be continued once conflicts have been resolved.
3069 If any files with destined changes are found to be missing or unversioned,
3070 or if files could not be deleted due to differences in deleted content,
3071 the histedit operation will be interrupted to prevent potentially incomplete
3072 changes from being committed to the repository without user intervention.
3073 The work tree may be modified as desired and the histedit operation can be
3074 continued once the changes present in the work tree are considered complete.
3075 Alternatively, the histedit operation may be aborted which will leave
3076 the work tree switched back to its original branch.
3078 If a merge conflict is resolved in a way which renders the merged
3079 change into a no-op change, the corresponding commit will be elided
3080 when the histedit operation continues.
3083 will refuse to run if certain preconditions are not met.
3084 If the work tree's current branch is not in the
3086 reference namespace, the history of the branch may not be edited.
3087 If the work tree contains multiple base commits, it must first be updated
3088 to a single base commit with
3090 If changes have been staged with
3092 these changes must first be committed with
3096 If the work tree contains local changes, these changes must first be
3101 If the edited history contains changes to files outside of the work tree's
3102 path prefix, the work tree cannot be used to edit the history of this branch.
3110 commands will refuse to run while a histedit operation is in progress.
3111 Other commands which manipulate the work tree may be used, and the
3113 command may be used to commit arbitrary changes to the temporary branch
3114 while the histedit operation is interrupted.
3121 Abort an interrupted histedit operation.
3122 If this option is used, no other command-line arguments are allowed.
3124 Allow a histedit operation to continue with files in conflicted status.
3125 This option should generally be avoided, and can only be used with the
3129 Continue an interrupted histedit operation.
3130 If this option is used, no other command-line arguments are allowed except
3134 This option is a quick equivalent to a histedit script which drops all
3138 option can only be used when starting a new histedit operation.
3139 If this option is used, no other command-line arguments are allowed.
3141 Interrupt the histedit operation for editing after merging each commit.
3142 This option is a quick equivalent to a histedit script which uses the
3144 command for all commits.
3147 option can only be used when starting a new histedit operation.
3148 If this option is used, no other command-line arguments are allowed.
3149 .It Fl F Ar histedit-script
3152 instead of opening a temporary file in an editor where a histedit script
3155 Fold all commits into a single commit.
3156 This option is a quick equivalent to a histedit script which folds all
3157 commits, combining them all into one commit.
3160 option can only be used when starting a new histedit operation.
3161 If this option is used, no other command-line arguments are allowed.
3163 Show a list of past histedit operations, represented by references in the
3164 .Dq refs/got/backup/histedit
3165 reference namespace.
3167 Display the author, date, and log message of each backed up commit,
3168 the object ID of the corresponding post-histedit commit, and
3169 the object ID of their common ancestor commit.
3170 Given these object IDs,
3177 options can be used to examine the history of either version of the branch,
3182 option can be used to create a new branch from a pre-histedit state if desired.
3186 is specified, only show commits which at some point in time represented this
3188 Otherwise, list all backed up commits for any branches.
3190 If this option is used,
3192 does not require a work tree.
3193 None of the other options can be used together with
3196 Edit log messages only.
3197 This option is a quick equivalent to a histedit script which edits
3198 only log messages but otherwise leaves every picked commit as-is.
3201 option can only be used when starting a new histedit operation.
3202 If this option is used, no other command-line arguments are allowed.
3204 Delete backups created by past histedit operations, represented by references
3206 .Dq refs/got/backup/histedit
3207 reference namespace.
3211 is specified, only delete backups which at some point in time represented
3213 Otherwise, delete all references found within
3214 .Dq refs/got/backup/histedit .
3216 Any commit, tree, tag, and blob objects belonging to deleted backups
3217 remain in the repository and may be removed separately with
3218 Git's garbage collector or
3219 .Cm gotadmin cleanup .
3221 If this option is used,
3223 does not require a work tree.
3224 None of the other options can be used together with
3228 .It Cm integrate Ar branch
3230 Integrate the specified
3232 into the work tree's current branch.
3233 Files in the work tree are updated to match the contents on the integrated
3235 and the reference of the work tree's branch is changed to point at the
3236 head commit of the integrated
3239 Both branches can be considered equivalent after integration since they
3240 will be pointing at the same commit.
3241 Both branches remain available for future work, if desired.
3242 In case the integrated
3244 is no longer needed it may be deleted with
3247 Show the status of each affected file, using the following status codes:
3248 .Bl -column YXZ description
3249 .It U Ta file was updated
3250 .It D Ta file was deleted
3251 .It A Ta new file was added
3252 .It \(a~ Ta versioned file is obstructed by a non-regular file
3253 .It ! Ta a missing versioned file was restored
3257 will refuse to run if certain preconditions are not met.
3258 Most importantly, the
3260 must have been rebased onto the work tree's current branch with
3262 before it can be integrated, in order to linearize commit history and
3263 resolve merge conflicts.
3264 If the work tree contains multiple base commits, it must first be updated
3265 to a single base commit with
3267 If changes have been staged with
3269 these changes must first be committed with
3273 If the work tree contains local changes, these changes must first be
3287 into the current branch of the work tree.
3288 If the branches have diverged, creates a merge commit.
3291 already includes all commits from the work tree's branch, updates the work
3292 tree's branch to be the same as
3294 without creating a commit, and updates the work tree to the most recent commit
3297 If a linear project history is desired, then use of
3299 should be preferred over
3301 However, even strictly linear projects may require merge commits in order
3302 to merge in new versions of third-party code stored on vendor branches
3306 Merge commits are commits based on multiple parent commits.
3307 The tip commit of the work tree's current branch, which must be in the
3309 reference namespace and must be set with
3313 operation, will be used as the first parent.
3314 The tip commit of the specified
3316 will be used as the second parent.
3318 No ancestral relationship between the two branches is required.
3319 If the two branches have already been merged previously, only new changes
3322 It is not possible to create merge commits with more than two parents.
3323 If more than one branch needs to be merged, then multiple merge commits
3324 with two parents each can be created in sequence.
3326 While merging changes found on the
3328 into the work tree, show the status of each affected file,
3329 using the following status codes:
3330 .Bl -column YXZ description
3331 .It G Ta file was merged
3332 .It C Ta file was merged and conflicts occurred during merge
3333 .It ! Ta changes destined for a missing file were not merged
3334 .It D Ta file was deleted
3335 .It d Ta file's deletion was prevented by local modifications
3336 .It A Ta new file was added
3337 .It \(a~ Ta changes destined for a non-regular file were not merged
3338 .It ? Ta changes destined for an unversioned file were not merged
3341 If merge conflicts occur, the merge operation is interrupted and conflicts
3342 must be resolved before the merge operation can continue.
3343 If any files with destined changes are found to be missing or unversioned,
3344 or if files could not be deleted due to differences in deleted content,
3345 the merge operation will be interrupted to prevent potentially incomplete
3346 changes from being committed to the repository without user intervention.
3347 The work tree may be modified as desired and the merge can be continued
3348 once the changes present in the work tree are considered complete.
3349 Alternatively, the merge operation may be aborted which will leave
3350 the work tree's current branch unmodified.
3353 will refuse to run if certain preconditions are not met.
3354 If the work tree's current branch is not in the
3356 reference namespace then the work tree must first be switched to a
3361 If the work tree is not yet fully updated to the tip commit of its
3362 branch, then the work tree must first be updated with
3364 If the work tree contains multiple base commits, it must first be updated
3365 to a single base commit with
3367 If changes have been staged with
3369 these changes must first be committed with
3373 If the work tree contains local changes, these changes must first be
3380 contains changes to files outside of the work tree's path prefix,
3381 the work tree cannot be used to merge this branch.
3391 commands will refuse to run while a merge operation is in progress.
3392 Other commands which manipulate the work tree may be used for
3393 conflict resolution purposes.
3400 Abort an interrupted merge operation.
3401 If this option is used, no other command-line arguments are allowed.
3403 Allow a merge operation to continue with files in conflicted status.
3404 This option should generally be avoided, and can only be used with the
3408 Continue an interrupted merge operation.
3409 If this option is used, no other command-line arguments are allowed except
3412 Create a merge commit even if the branches have not diverged.
3414 Merge changes into the work tree as usual but do not create a merge
3416 The merge result can be adjusted as desired before a merge commit is
3419 Alternatively, the merge may be aborted with
3426 .Op Fl F Ar response-script
3430 Stage local changes for inclusion in the next commit.
3433 is specified, stage all changes in the work tree.
3434 Otherwise, stage changes at or within the specified paths.
3435 Paths may be staged if they are added, modified, or deleted according to
3438 Show the status of each affected file, using the following status codes:
3439 .Bl -column YXZ description
3440 .It A Ta file addition has been staged
3441 .It M Ta file modification has been staged
3442 .It D Ta file deletion has been staged
3445 Staged file contents are saved in newly created blob objects in the repository.
3446 These blobs will be referred to by tree objects once staged changes have been
3449 Staged changes affect the behaviour of
3454 While paths with staged changes exist, the
3456 command will refuse to commit any paths which do not have staged changes.
3457 Local changes created on top of staged changes can only be committed if
3458 the path is staged again, or if the staged changes are committed first.
3461 command will show both local changes and staged changes.
3464 command is able to display local changes relative to staged changes,
3465 and to display staged changes relative to the repository.
3468 command cannot revert staged changes but may be used to revert
3469 local changes created on top of staged changes.
3475 .It Fl F Ar response-script
3483 responses line-by-line from the specified
3485 file instead of prompting interactively.
3487 Instead of staging new changes, list paths which are already staged,
3488 along with the IDs of staged blob objects and stage status codes.
3489 If paths were provided on the command line, show the staged paths
3490 among the specified paths.
3491 Otherwise, show all staged paths.
3493 Instead of staging the entire content of a changed file, interactively
3494 select or reject changes for staging based on
3498 (reject change), and
3500 (quit staging this file) responses.
3501 If a file is in modified status, individual patches derived from the
3502 modified file content can be staged.
3503 Files in added or deleted status may only be staged or rejected in
3506 Allow staging of symbolic links which point outside of the path space
3507 that is under version control.
3510 will reject such symbolic links due to safety concerns.
3513 may decide to represent such a symbolic link as a regular file which contains
3514 the link's target path, rather than creating an actual symbolic link which
3515 points outside of the work tree.
3516 Use of this option is discouraged because external mechanisms such as
3518 are better suited for managing symbolic links to paths not under
3523 will refuse to run if certain preconditions are not met.
3524 If a file contains merge conflicts, these conflicts must be resolved first.
3525 If a file is found to be out of date relative to the head commit on the
3526 work tree's current branch, the file must be updated with
3528 before it can be staged (however, this does not prevent the file from
3529 becoming out-of-date at some point after having been staged).
3537 commands will refuse to run while staged changes exist.
3538 If staged changes cannot be committed because a staged path
3539 is out of date, the path must be unstaged with
3541 before it can be updated with
3543 and may then be staged again if necessary.
3548 .Op Fl F Ar response-script
3552 Merge staged changes back into the work tree and put affected paths
3553 back into non-staged status.
3556 is specified, unstage all staged changes across the entire work tree.
3557 Otherwise, unstage changes at or within the specified paths.
3559 Show the status of each affected file, using the following status codes:
3560 .Bl -column YXZ description
3561 .It G Ta file was unstaged
3562 .It C Ta file was unstaged and conflicts occurred during merge
3563 .It ! Ta changes destined for a missing file were not merged
3564 .It D Ta file was staged as deleted and still is deleted
3565 .It d Ta file's deletion was prevented by local modifications
3566 .It \(a~ Ta changes destined for a non-regular file were not merged
3573 .It Fl F Ar response-script
3581 responses line-by-line from the specified
3583 file instead of prompting interactively.
3585 Instead of unstaging the entire content of a changed file, interactively
3586 select or reject changes for unstaging based on
3590 (keep change staged), and
3592 (quit unstaging this file) responses.
3593 If a file is staged in modified status, individual patches derived from the
3594 staged file content can be unstaged.
3595 Files staged in added or deleted status may only be unstaged in their entirety.
3601 .Op Fl r Ar repository-path
3604 Parse and print contents of objects to standard output in a line-based
3606 Content of commit, tree, and tag objects is printed in a way similar
3607 to the actual content stored in such objects.
3608 Blob object contents are printed as they would appear in files on disk.
3610 Attempt to interpret each argument as a reference, a tag name, or
3611 an object ID SHA1 hash.
3612 References will be resolved to an object ID.
3613 Tag names will resolved to a tag object.
3614 An abbreviated hash argument will be expanded to a full SHA1 hash
3615 automatically, provided the abbreviation is unique.
3617 If none of the above interpretations produce a valid result, or if the
3619 option is used, attempt to interpret the argument as a path which will
3620 be resolved to the ID of an object found at this path in the repository.
3627 Look up paths in the specified
3629 If this option is not used, paths are looked up in the commit resolved
3630 via the repository's HEAD reference.
3632 The expected argument is a commit ID SHA1 hash, or a reference name
3633 or keyword which will be resolved to a commit ID.
3634 An abbreviated hash argument will be expanded to a full SHA1 hash
3635 automatically, provided the abbreviation is unique.
3640 resolve to the work tree's base commit and branch head, respectively.
3641 The former is only valid if invoked in a work tree, while the latter will
3642 resolve to the tip of the work tree's current branch if invoked in a
3643 work tree, otherwise it will resolve to the repository's HEAD reference.
3644 Keywords and references may be appended with
3648 modifiers and an optional integer N to denote the
3649 Nth descendant or antecedent by first parent traversal, respectively;
3652 denotes the work tree branch head's 2nd generation ancestor, and
3654 denotes the 4th generation descendant of the work tree's base commit.
3657 will denote the 8th generation ancestor of the commit resolved by the
3664 modifier without a trailing integer has an implicit
3673 Interpret all arguments as paths only.
3674 This option can be used to resolve ambiguity in cases where paths
3675 look like tag names, reference names, or object IDs.
3676 .It Fl r Ar repository-path
3677 Use the repository at the specified path.
3678 If not specified, assume the repository is located at or above the current
3680 If this directory is a
3682 work tree, use the repository path associated with this work tree.
3684 .It Cm info Op Ar path ...
3685 Display meta-data stored in a work tree.
3690 The work tree to use is resolved implicitly by walking upwards from the
3691 current working directory.
3695 arguments are specified, show additional per-file information for tracked
3696 files located at or within these paths.
3699 argument corresponds to the work tree's root directory, display information
3700 for all tracked files.
3703 .Bl -tag -width GOT_IGNORE_GITCONFIG
3705 The author's name and email address, such as
3706 .Dq An Flan Hacker Aq Mt flan_hacker@openbsd.org .
3717 may fail to parse commits without an email address in author data,
3721 environment variables with a missing email address.
3723 .Ev GOT_AUTHOR will be overridden by configuration settings in
3729 configuration settings in the repository's
3736 configuration settings contained in Git's global
3738 configuration file will only be used if neither
3742 environment variable provide author information.
3743 .It Ev GOT_IGNORE_GITCONFIG
3744 If this variable is set then any remote repository definitions or author
3745 information found in Git configuration files will be ignored.
3746 .It Ev GOT_LOG_DEFAULT_LIMIT
3747 The default limit on the number of commits traversed by
3749 If set to zero, the limit is unbounded.
3750 This variable will be silently ignored if it is set to a non-numeric value.
3751 .It Ev VISUAL , EDITOR
3752 The editor spawned by
3760 text editor will be spawned.
3763 .Bl -tag -width packed-refs -compact
3765 Repository-wide configuration settings for
3769 configuration file located in the root directory of a Git repository
3770 supersedes any relevant settings in Git's
3774 .It Pa .got/got.conf
3775 Worktree-specific configuration settings for
3779 configuration file in the
3781 meta-data directory of a work tree supersedes any relevant settings in
3784 configuration file and Git's
3791 Enable tab-completion of
3796 .Dl $ set -A complete_got_1 -- $(got -h 2>&1 | sed -n s/commands://p)
3798 Clone an existing Git repository for use with
3802 .Dl $ got clone ssh://git@github.com/openbsd/src.git
3804 Unfortunately, many of the popular Git hosting sites do not offer anonymous
3806 Such sites will require an account to be created, and a public SSH key to be
3807 uploaded to this account, before repository access via ssh:// URLs will work.
3809 Use of HTTP URLs currently requires
3813 .Dl $ git clone --bare https://github.com/openbsd/src.git
3815 Alternatively, for quick and dirty local testing of
3817 a new Git repository could be created and populated with files,
3818 e.g. from a temporary CVS checkout located at
3821 .Dl $ gotadmin init /var/git/src.git
3822 .Dl $ got import -r /var/git/src.git -I CVS -I obj /tmp/src
3824 Check out a work tree from the Git repository to /usr/src:
3826 .Dl $ got checkout /var/git/src.git /usr/src
3828 View local changes in a work tree directory:
3830 .Dl $ got diff | less
3832 In a work tree, display files in a potentially problematic state:
3834 .Dl $ got status -s 'C!~?'
3836 Interactively revert selected local changes in a work tree directory:
3838 .Dl $ got revert -p -R\ .
3840 In a work tree or a git repository directory, list all branch references:
3844 As above, but list the most recently modified branches only:
3846 .Dl $ got branch -lt | head
3848 In a work tree or a git repository directory, create a new branch called
3849 .Dq unified-buffer-cache
3850 which is forked off the
3854 .Dl $ got branch -c master unified-buffer-cache
3856 Switch an existing work tree to the branch
3857 .Dq unified-buffer-cache .
3858 Local changes in the work tree will be preserved and merged if necessary:
3860 .Dl $ got update -b unified-buffer-cache
3862 Create a new commit from local changes in a work tree directory.
3863 This new commit will become the head commit of the work tree's current branch:
3867 In a work tree or a git repository directory, view changes committed in
3868 the 3 most recent commits to the work tree's branch, or the branch resolved
3869 via the repository's HEAD reference, respectively:
3871 .Dl $ got log -p -l 3
3873 As above, but display changes in the order in which
3875 could apply them in sequence:
3877 .Dl $ got log -p -l 3 -R
3879 In a work tree or a git repository directory, log the history of a subdirectory:
3881 .Dl $ got log sys/uvm
3883 While operating inside a work tree, paths are specified relative to the current
3884 working directory, so this command will log the subdirectory
3887 .Dl $ cd sys/uvm && got log\ .
3889 And this command has the same effect:
3891 .Dl $ cd sys/dev/usb && got log ../../uvm
3893 And this command displays work tree meta-data about all tracked files:
3896 .Dl $ got info\ . | less
3898 Add new files and remove obsolete files in a work tree directory:
3900 .Dl $ got add sys/uvm/uvm_ubc.c
3901 .Dl $ got remove sys/uvm/uvm_vnode.c
3903 Create a new commit from local changes in a work tree directory
3904 with a pre-defined log message.
3906 .Dl $ got commit -m 'unify the buffer cache'
3908 Alternatively, create a new commit from local changes in a work tree
3909 directory with a log message that has been prepared in the file
3912 .Dl $ got commit -F /tmp/msg
3914 Update any work tree checked out from the
3915 .Dq unified-buffer-cache
3916 branch to the latest commit on this branch:
3920 Roll file content on the unified-buffer-cache branch back by one commit,
3921 and then fetch the rolled-back change into the work tree as a local change
3922 to be amended and perhaps committed again:
3924 .Dl $ got backout unified-buffer-cache
3925 .Dl $ got commit -m 'roll back previous'
3926 .Dl $ # now back out the previous backout :-)
3927 .Dl $ got backout unified-buffer-cache
3929 Fetch new changes on the remote repository's
3931 branch, making them visible on the local repository's
3938 In a repository created with a HTTP URL and
3939 .Cm git clone --bare
3942 command must be used instead:
3944 .Dl $ cd /var/git/src.git
3945 .Dl $ git fetch origin master:refs/remotes/origin/master
3949 branch to merge the new changes that are now visible on the
3954 .Dl $ got update -b origin/master
3955 .Dl $ got rebase master
3958 .Dq unified-buffer-cache
3959 branch on top of the new head commit of the
3963 .Dl $ got update -b master
3964 .Dl $ got rebase unified-buffer-cache
3966 Create a patch from all changes on the unified-buffer-cache branch.
3967 The patch can be mailed out for review and applied to
3971 .Dl $ got diff master unified-buffer-cache > /tmp/ubc.diff
3973 Edit the entire commit history of the
3974 .Dq unified-buffer-cache
3977 .Dl $ got update -b unified-buffer-cache
3978 .Dl $ got update -c master
3981 Before working against existing branches in a repository cloned with
3982 .Cm git clone --bare
3987 must be configured to map all references in the remote repository
3990 namespace of the local repository.
3991 This can be achieved by setting Git's
3992 .Pa remote.origin.fetch
3993 configuration variable to the value
3994 .Dq +refs/heads/*:refs/remotes/origin/*
3999 .Dl $ cd /var/git/repo
4000 .Dl $ git config remote.origin.fetch '+refs/heads/*:refs/remotes/origin/*'
4004 option must be disabled:
4006 .Dl $ cd /var/git/repo
4007 .Dl $ git config remote.origin.mirror false
4009 Alternatively, the following
4011 configuration item can be added manually to the Git repository's
4015 .Dl [remote \&"origin\&"]
4017 .Dl fetch = +refs/heads/*:refs/remotes/origin/*
4020 This configuration leaves the local repository's
4022 namespace free for use by local branches checked out with
4024 and, if needed, created with
4027 .Dq refs/remotes/origin
4028 namespace can now be updated with incoming changes from the remote
4033 without extra command line arguments.
4034 Newly fetched changes can be examined with
4037 Display changes on the remote repository's version of the
4039 branch, as of the last time
4043 .Dl $ got log -c origin/master | less
4045 As shown here, most commands accept abbreviated reference names such as
4048 .Dq refs/remotes/origin/master .
4049 The latter is only needed in case of ambiguity.
4052 can be used to merge changes which are visible on the
4057 This will also merge local changes, if any, with the incoming changes:
4059 .Dl $ got update -b origin/master
4060 .Dl $ got rebase master
4062 In order to make changes committed to the
4063 .Dq unified-buffer-cache
4067 .Dq unified-buffer-cache
4068 branch can be rebased onto the
4072 .Dl $ got update -b master
4073 .Dl $ got rebase unified-buffer-cache
4076 .Dq unified-buffer-cache
4077 branch can now be made visible on the
4081 Because the rebase operation switched the work tree to the
4082 .Dq unified-buffer-cache
4083 branch, the work tree must be switched back to the
4087 .Dl $ got update -b master
4088 .Dl $ got integrate unified-buffer-cache
4092 branch, log messages for local changes can now be amended with
4094 by other developers and any other important new information:
4096 .Dl $ got update -c origin/master
4097 .Dl $ got histedit -m
4099 If the remote repository offers write access, local changes on the
4101 branch can be sent to the remote repository with
4105 can be run without further arguments.
4106 The arguments shown here match defaults, provided the work tree's
4107 current branch is the
4111 .Dl $ got send -b master origin
4113 If the remote repository requires the HTTPS protocol, the
4115 command must be used instead:
4117 .Dl $ cd /var/git/src.git
4118 .Dl $ git push origin master
4120 When making contributions to projects which use the
4122 workflow, SSH protocol repository access needs to be set up first.
4123 Once an account has been created on a Git hosting site it should
4124 be possible to upload a public SSH key for repository access
4129 workflow will usually involve two remote repositories.
4130 In the real-life example below, the
4132 repository was forked from the
4134 repository by using the Git hosting site's web interface.
4137 file in the local repository describes both remote repositories:
4138 .Bd -literal -offset indent
4139 # Jelmers's repository, which accepts pull requests
4141 server git@github.com
4143 repository "/jelmer/dulwich"
4147 # Stefan's fork, used as the default remote repository
4149 server git@github.com
4151 repository "/stspdotname/dulwich"
4156 With this configuration, Stefan can create commits on
4157 .Dq refs/heads/master
4158 and send them to the
4160 repository by running:
4162 .Dl $ got send -b master origin
4164 The changes can now be proposed to Jelmer by opening a pull request
4165 via the Git hosting site's web interface.
4166 If Jelmer requests further changes to be made, additional commits
4167 can be created on the
4169 branch and be added to the pull request by running
4173 If Jelmer prefers additional commits to be
4175 then the following commands can be used to achieve this:
4177 .Dl $ got update -b master
4178 .Dl $ got update -c origin/master
4179 .Dl $ got histedit -f
4180 .Dl $ got send -f -b master origin
4182 In addition to reviewing the pull request in the web user interface,
4183 Jelmer can fetch the pull request's branch into his local repository
4184 and create a local branch which contains the proposed changes:
4186 .Dl $ got fetch -R refs/pull/1046/head origin
4187 .Dl $ got branch -c refs/remotes/origin/pull/1046/head pr1046
4189 Once Jelmer has accepted the pull request, Stefan can fetch the
4190 merged changes, and possibly several other new changes, by running:
4192 .Dl $ got fetch upstream
4194 The merged changes will now be visible under the reference
4195 .Dq refs/remotes/upstream/master .
4198 branch can now be rebased on top of the latest changes
4201 .Dl $ got update -b upstream/master
4202 .Dl $ got rebase master
4204 As an alternative to
4206 branches can be merged with
4209 .Dl $ got update -b master
4210 .Dl $ got merge upstream/master
4212 The question of whether to rebase or merge branches is philosophical.
4213 When in doubt, refer to the software project's policies set by project
4216 As a final step, the forked repository's copy of the master branch needs
4217 to be kept in sync by sending the new changes there:
4219 .Dl $ got send -f -b master origin
4221 If multiple pull requests need to be managed in parallel, a separate branch
4222 must be created for each pull request with
4224 Each such branch can then be used as above, in place of
4225 .Dq refs/heads/master .
4226 Changes for any accepted pull requests will still appear under
4227 .Dq refs/remotes/upstream/master,
4228 regardless of which branch was used in the forked repository to
4229 create a pull request.
4233 .Xr git-repository 5 ,
4234 .Xr got-worktree 5 ,
4238 .An Anthony J. Bentley Aq Mt bentley@openbsd.org
4239 .An Christian Weisgerber Aq Mt naddy@openbsd.org
4240 .An Hiltjo Posthuma Aq Mt hiltjo@codemadness.org
4241 .An Josh Rickmar Aq Mt jrick@zettaport.com
4242 .An Joshua Stein Aq Mt jcs@openbsd.org
4243 .An Klemens Nanni Aq Mt kn@openbsd.org
4244 .An Martin Pieuchot Aq Mt mpi@openbsd.org
4245 .An Neels Hofmeyr Aq Mt neels@hofmeyr.de
4246 .An Omar Polo Aq Mt op@openbsd.org
4247 .An Ori Bernstein Aq Mt ori@openbsd.org
4248 .An Sebastien Marie Aq Mt semarie@openbsd.org
4249 .An Stefan Sperling Aq Mt stsp@openbsd.org
4250 .An Steven McDonald Aq Mt steven@steven-mcdonald.id.au
4251 .An Theo Buehler Aq Mt tb@openbsd.org
4252 .An Thomas Adam Aq Mt thomas@xteddy.org
4253 .An Tracey Emery Aq Mt tracey@traceyemery.net
4254 .An Yang Zhong Aq Mt yzhong@freebsdfoundation.org
4261 were derived from code under copyright by:
4263 .An Caldera International
4264 .An Daniel Hartmeier
4269 .An Jean-Francois Brousseau
4275 .An Niklas Hallqvist
4280 .An Xavier Santolaria
4283 contains code contributed to the public domain by
4284 .An Austin Appleby .
4287 is a work-in-progress and some features remain to be implemented.
4289 At present, the user has to fall back on
4291 to perform some tasks.
4295 Reading from remote repositories over HTTP or HTTPS protocols requires
4300 Writing to remote repositories over HTTP or HTTPS protocols requires
4303 The creation of merge commits with more than two parent commits requires
4306 In situations where files or directories were moved around
4308 will not automatically merge changes to new locations and
4310 will usually produce better results.
