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
121 Use the specified log message when creating the new commit.
126 opens a temporary file in an editor where a log message can be written.
127 .It Fl r Ar repository-path
128 Use the repository at the specified path.
129 If not specified, assume the repository is located at or above the current
137 .Op Fl R Ar reference
142 Clone a Git repository at the specified
148 is specified, the directory name will be derived from the name of the
151 will refuse to run if the
157 specifies a protocol scheme, a server hostname, an optional port number
158 separated from the hostname by a colon, and a path to the repository on
160 .Lk scheme://hostname:port/path/to/repository
162 The following protocol schemes are supported:
163 .Bl -tag -width git+ssh
165 The Git protocol as implemented by the
168 Use of this protocol is discouraged since it supports neither authentication
171 The Git protocol wrapped in an authenticated and encrypted
174 With this protocol the hostname may contain an embedded username for
179 Short alias for git+ssh.
182 Objects in the cloned repository are stored in a pack file which is downloaded
184 This pack file will then be indexed to facilitate access to the objects stored
186 If any objects in the pack file are stored in deltified form, all deltas will
187 be fully resolved in order to compute the ID of such objects.
188 This can take some time.
189 More details about the pack file format are documented in
190 .Xr git-repository 5 .
193 creates a remote repository entry in the
197 files of the cloned repository to store the
203 arguments for future use by
213 Fetch all branches from the remote repository's
215 reference namespace and set
216 .Cm fetch_all_branches
217 in the cloned repository's
219 file for future use by
221 If this option is not specified, a branch resolved via the remote
222 repository's HEAD reference will be fetched.
223 Cannot be used together with the
229 from the remote repository's
232 This option may be specified multiple times to build a list of branches
234 If the branch corresponding to the remote repository's HEAD reference is not
235 in this list, the cloned repository's HEAD reference will be set to the first
236 branch which was fetched.
237 If this option is not specified, a branch resolved via the remote
238 repository's HEAD reference will be fetched.
239 Cannot be used together with the
243 List branches and tags available for fetching from the remote repository
244 and exit immediately.
245 Cannot be used together with any of the other options except
250 Create the cloned repository as a mirror of the original repository.
251 This is useful if the cloned repository will not be used to store
252 locally created commits.
258 files will be set up with the
260 option enabled, such that
264 will write incoming changes directly to branches in the
266 reference namespace, rather than to branches in the
269 This avoids the usual requirement of having to run
273 in order to make incoming changes appear on branches in the
276 But maintaining custom changes in the cloned repository becomes difficult
277 since such changes will be at risk of being discarded whenever incoming
280 Suppress progress reporting output.
281 The same option will be passed to
284 .It Fl R Ar reference
285 In addition to the branches and tags that will be fetched, fetch an arbitrary
287 from the remote repository's
290 This option may be specified multiple times to build a list of additional
294 may either be a path to a specific reference, or a reference namespace
295 which will cause all references in this namespace to be fetched.
297 Each reference will be mapped into the cloned repository's
299 namespace, unless the
301 option is used to mirror references directly into the cloned repository's
306 will refuse to fetch references from the remote repository's
315 to print debugging messages to standard error output.
316 This option will be passed to
319 Multiple -v options increase the verbosity.
327 .Op Fl R Ar reference
328 .Op Fl r Ar repository-path
329 .Op Ar remote-repository
332 Fetch new changes from a remote repository.
334 .Ar remote-repository
338 The remote repository's URL is obtained from the corresponding entry in
342 file of the local repository, as created by
345 New changes will be stored in a separate pack file downloaded from the server.
346 Optionally, separate pack files stored in the repository can be combined with
349 By default, branch references in the
351 reference namespace will be updated to point at the newly fetched commits.
354 command can then be used to make new changes visible on branches in the
356 namespace, merging incoming changes with the changes on those branches
359 If the repository was created as a mirror with
361 then all branches in the
363 namespace will be updated directly to match the corresponding branches in
364 the remote repository.
365 If those branches contained local commits, these commits will no longer be
366 reachable via a reference and will therefore be at risk of being discarded
367 by Git's garbage collector or
368 .Cm gotadmin cleanup .
369 Maintaining custom changes in a mirror repository is therefore discouraged.
371 In any case, references in the
373 namespace will always be fetched and mapped directly to local references
374 in the same namespace.
381 Fetch all branches from the remote repository's
384 This option can be enabled by default for specific repositories in
386 If this option is not specified, a branch resolved via the remote
387 repository's HEAD reference will be fetched.
388 Cannot be used together with the
394 from the remote repository's
397 This option may be specified multiple times to build a list of branches
399 If this option is not specified, a branch resolved via the remote
400 repository's HEAD reference will be fetched.
401 Cannot be used together with the
405 Delete branches and tags from the local repository which are no longer
406 present in the remote repository.
407 Only references are deleted.
408 Any commit, tree, tag, and blob objects belonging to deleted branches or
409 tags remain in the repository and may be removed separately with
410 Git's garbage collector or
411 .Cm gotadmin cleanup .
413 List branches and tags available for fetching from the remote repository
414 and exit immediately.
415 Cannot be used together with any of the other options except
421 Suppress progress reporting output.
422 The same option will be passed to
425 .It Fl R Ar reference
426 In addition to the branches and tags that will be fetched, fetch an arbitrary
428 from the remote repository's
431 This option may be specified multiple times to build a list of additional
435 may either be a path to a specific reference, or a reference namespace
436 which will cause all references in this namespace to be fetched.
438 Each reference will be mapped into the local repository's
440 namespace, unless the local repository was created as a mirror with
442 in which case references will be mapped directly into the local repository's
446 Once a reference has been fetched, a branch based on it can be created with
451 will refuse to fetch references from the remote repository's
456 .It Fl r Ar repository-path
457 Use the repository at the specified path.
458 If not specified, assume the repository is located at or above the current
460 If this directory is a
462 work tree, use the repository path associated with this work tree.
464 Allow existing references in the
466 namespace to be updated if they have changed on the server.
467 If not specified, only new tag references will be created.
472 to print debugging messages to standard error output.
473 The same option will be passed to
476 Multiple -v options increase the verbosity.
479 Delete all references which correspond to a particular
480 .Ar remote-repository
481 instead of fetching new changes.
482 This can be useful when a remote repository is being removed from
488 .Ar remote-repository
489 argument is mandatory and no other options except
496 Only references are deleted.
497 Any commit, tree, tag, and blob objects fetched from a remote repository
498 will generally be stored in pack files and may be removed separately with
500 and Git's garbage collector.
508 .Op Fl p Ar path-prefix
510 .Op Ar work-tree-path
513 Copy files from a repository into a new work tree.
514 Show the status of each affected file, using the following status codes:
515 .Bl -column YXZ description
516 .It A Ta new file was added
517 .It E Ta file already exists in work tree's meta-data
522 is not specified, either use the last component of
523 .Ar repository path ,
526 was specified use the last component of
534 Check out files from a commit on the specified
536 If this option is not specified, a branch resolved via the repository's HEAD
537 reference will be used.
539 Check out files from the specified
541 on the selected branch.
542 The expected argument is a commit ID SHA1 hash or an existing reference
543 or tag name which will be resolved to a commit ID.
544 An abbreviated hash argument will be expanded to a full SHA1 hash
545 automatically, provided the abbreviation is unique.
546 If this option is not specified, the most recent commit on the selected
551 is not contained in the selected branch, a different branch which contains
552 this commit must be specified with the
555 If no such branch is known, a new branch must be created for this
561 Checking out work trees with an unknown branch is intentionally not supported.
563 Proceed with the checkout operation even if the directory at
566 Existing files will be left intact.
567 .It Fl p Ar path-prefix
568 Restrict the work tree to a subset of the repository's tree hierarchy.
569 Only files beneath the specified
573 Silence progress output.
584 Update an existing work tree to a different
586 Change existing files in the work tree as necessary to match file contents
588 Preserve any local changes in the work tree and merge them with the
591 Files which already contain merge conflicts will not be updated to avoid
592 further complications.
593 Such files will be updated when
595 is run again after merge conflicts have been resolved.
596 If the conflicting changes are no longer needed, affected files can be
603 Show the status of each affected file, using the following status codes:
604 .Bl -column YXZ description
605 .It U Ta file was updated and contained no local changes
606 .It G Ta file was updated and local changes were merged cleanly
607 .It C Ta file was updated and conflicts occurred during merge
608 .It D Ta file was deleted
609 .It A Ta new file was added
610 .It \(a~ Ta versioned file is obstructed by a non-regular file
611 .It ! Ta a missing versioned file was restored
612 .It # Ta file was not updated because it contains merge conflicts
613 .It ? Ta changes destined for an unversioned file were not merged
618 is specified, update the entire work tree.
619 Otherwise, restrict the update operation to files at or within the
621 Each path is required to exist in the update operation's target commit.
622 Files in the work tree outside specified paths will remain unchanged and
623 will retain their previously recorded base commit.
626 commands may refuse to run while the work tree contains files from
627 multiple base commits.
628 The base commit of such a work tree can be made consistent by running
630 across the entire work tree.
633 is incompatible with the
638 cannot update paths with staged changes.
639 If changes have been staged with
641 these changes must first be committed with
651 Switch the work tree's branch reference to the specified
653 before updating the work tree.
654 This option requires that all paths in the work tree are updated.
656 As usual, any local changes in the work tree will be preserved.
657 This can be useful when switching to a newly created branch in order
658 to commit existing local changes to this branch.
660 Any local changes must be dealt with separately in order to obtain a
661 work tree with pristine file contents corresponding exactly to the specified
663 Such changes could first be committed to a different branch with
665 or could be discarded with
668 Update the work tree to the specified
670 The expected argument is a commit ID SHA1 hash or an existing reference
671 or tag name which will be resolved to a commit ID.
672 An abbreviated hash argument will be expanded to a full SHA1 hash
673 automatically, provided the abbreviation is unique.
674 If this option is not specified, the most recent commit on the work tree's
677 Silence progress output.
683 .Op Fl S Ar status-codes
684 .Op Fl s Ar status-codes
688 Show the current modification status of files in a work tree,
689 using the following status codes:
690 .Bl -column YXZ description
691 .It M Ta modified file
692 .It A Ta file scheduled for addition in next commit
693 .It D Ta file scheduled for deletion in next commit
694 .It C Ta modified or added file which contains merge conflicts
695 .It ! Ta versioned file was expected on disk but is missing
696 .It \(a~ Ta versioned file is obstructed by a non-regular file
697 .It ? Ta unversioned item not tracked by
699 .It m Ta modified file modes (executable bit only)
700 .It N Ta non-existent
702 specified on the command line
707 is specified, show modifications in the entire work tree.
708 Otherwise, show modifications at or within the specified paths.
710 If changes have been staged with
712 staged changes are shown in the second output column, using the following
714 .Bl -column YXZ description
715 .It M Ta file modification is staged
716 .It A Ta file addition is staged
717 .It D Ta file deletion is staged
720 Changes created on top of staged changes are indicated in the first column:
721 .Bl -column YXZ description
722 .It MM Ta file was modified after earlier changes have been staged
723 .It MA Ta file was modified after having been staged for addition
731 Show unversioned files even if they match an ignore pattern.
732 .It Fl S Ar status-codes
733 Suppress the output of files with a modification status matching any of the
734 single-character status codes contained in the
737 Any combination of codes from the above list of possible status codes
739 For staged files, status codes displayed in either column will be matched.
740 Cannot be used together with the
743 .It Fl s Ar status-codes
744 Only show files with a modification status matching any of the
745 single-character status codes contained in the
748 Any combination of codes from the above list of possible status codes
750 For staged files, status codes displayed in either column will be matched.
751 Cannot be used together with the
756 For compatibility with
767 files in each traversed directory and will not display unversioned files
768 which match these patterns.
773 supports consecutive asterisks,
775 which will match an arbitrary amount of directories.
779 only supports a single ignore pattern per line.
783 does not support negated ignore patterns prefixed with
785 and gives no special significance to the location of path component separators,
794 .Op Fl r Ar repository-path
795 .Op Fl S Ar search-pattern
799 Display history of a repository.
802 is specified, show only commits which modified this path.
803 If invoked in a work tree, the
805 is interpreted relative to the current working directory,
806 and the work tree's path prefix is implicitly prepended.
807 Otherwise, the path is interpreted relative to the repository root.
814 Display individual commits which were merged into the current branch
818 shows the linear history of the current branch only.
820 Set the number of context lines shown in diffs with
822 By default, 3 lines of context are shown.
824 Start traversing history at the specified
826 The expected argument is a commit ID SHA1 hash or an existing reference
827 or tag name which will be resolved to a commit ID.
828 An abbreviated hash argument will be expanded to a full SHA1 hash
829 automatically, provided the abbreviation is unique.
830 If this option is not specified, default to the work tree's current branch
831 if invoked in a work tree, or to the repository's HEAD reference.
833 Display diffstat of changes introduced in the commit.
834 Cannot be used with the
838 Limit history traversal to a given number of commits.
839 If this option is not specified, a default limit value of zero is used,
840 which is treated as an unbounded limit.
842 .Ev GOT_LOG_DEFAULT_LIMIT
843 environment variable may be set to change this default value.
845 Display the list of file paths changed in each commit, using the following
847 .Bl -column YXZ description
848 .It M Ta modified file
849 .It D Ta file was deleted
850 .It A Ta new file was added
851 .It m Ta modified file modes (executable bit only)
854 Cannot be used with the
858 Display the patch of modifications made in each commit.
861 is specified, only show the patch of modifications at or within this path.
862 Cannot be used with the
866 Determine a set of commits to display as usual, but display these commits
868 .It Fl r Ar repository-path
869 Use the repository at the specified path.
870 If not specified, assume the repository is located at or above the current
872 If this directory is a
874 work tree, use the repository path associated with this work tree.
875 .It Fl S Ar search-pattern
876 If specified, show only commits with a log message, author name,
877 committer name, or ID SHA1 hash matched by the extended regular
880 Lines in committed patches will be matched if
883 File paths changed by a commit will be matched if
886 Regular expression syntax is documented in
889 Display a short one-line summary of each commit, instead of the default
891 Cannot be used together with the
897 Stop traversing commit history immediately after the specified
900 This option has no effect if the specified
910 .Op Fl r Ar repository-path
911 .Op Ar object1 Ar object2 | Ar path ...
914 When invoked within a work tree without any arguments, display all
915 local changes in the work tree.
918 arguments are specified, only show changes within the specified paths.
920 If two arguments are provided, treat each argument as a reference, a tag
921 name, or an object ID SHA1 hash, and display differences between the
922 corresponding objects.
923 Both objects must be of the same type (blobs, trees, or commits).
924 An abbreviated hash argument will be expanded to a full SHA1 hash
925 automatically, provided the abbreviation is unique.
926 If none of these interpretations produce a valid result or if the
931 is running in a work tree, attempt to interpret the two arguments as paths.
938 Treat file contents as ASCII text even if binary data is detected.
940 Set the number of context lines shown in the diff.
941 By default, 3 lines of context are shown.
943 Show differences between commits in the repository.
944 This option may be used up to two times.
945 When used only once, show differences between the specified
947 and its first parent commit.
948 When used twice, show differences between the two specified commits.
950 The expected argument is a commit ID SHA1 hash or an existing reference
951 or tag name which will be resolved to a commit ID.
952 An abbreviated hash argument will be expanded to a full SHA1 hash
953 automatically, provided the abbreviation is unique.
957 option is used, all non-option arguments will be interpreted as paths.
960 arguments are provided, only show differences for the specified paths.
962 Cannot be used together with the
966 Interpret all arguments as paths only.
967 This option can be used to resolve ambiguity in cases where paths
968 look like tag names, reference names, or object IDs.
969 This option is only valid when
971 is invoked in a work tree.
972 .It Fl r Ar repository-path
973 Use the repository at the specified path.
974 If not specified, assume the repository is located at or above the current
976 If this directory is a
978 work tree, use the repository path associated with this work tree.
980 Show changes staged with
982 instead of showing local changes in the work tree.
983 This option is only valid when
985 is invoked in a work tree.
987 Ignore whitespace-only changes.
993 .Op Fl r Ar repository-path
997 Display line-by-line history of a file at the specified path.
1004 Start traversing history at the specified
1006 The expected argument is a commit ID SHA1 hash or an existing reference
1007 or tag name which will be resolved to a commit ID.
1008 An abbreviated hash argument will be expanded to a full SHA1 hash
1009 automatically, provided the abbreviation is unique.
1010 .It Fl r Ar repository-path
1011 Use the repository at the specified path.
1012 If not specified, assume the repository is located at or above the current
1014 If this directory is a
1016 work tree, use the repository path associated with this work tree.
1023 .Op Fl r Ar repository-path
1027 Display a listing of files and directories at the specified
1028 directory path in the repository.
1029 Entries shown in this listing may carry one of the following trailing
1031 .Bl -column YXZ description
1032 .It @ Ta entry is a symbolic link
1033 .It / Ta entry is a directory
1034 .It * Ta entry is an executable file
1035 .It $ Ta entry is a Git submodule
1038 Symbolic link entries are also annotated with the target path of the link.
1042 is specified, list the repository path corresponding to the current
1043 directory of the work tree, or the root directory of the repository
1044 if there is no work tree.
1051 List files and directories as they appear in the specified
1053 The expected argument is a commit ID SHA1 hash or an existing reference
1054 or tag name which will be resolved to a commit ID.
1055 An abbreviated hash argument will be expanded to a full SHA1 hash
1056 automatically, provided the abbreviation is unique.
1058 Show object IDs of files (blob objects) and directories (tree objects).
1060 Recurse into sub-directories in the repository.
1061 .It Fl r Ar repository-path
1062 Use the repository at the specified path.
1063 If not specified, assume the repository is located at or above the current
1065 If this directory is a
1067 work tree, use the repository path associated with this work tree.
1073 .Op Fl r Ar repository-path
1074 .Op Fl s Ar reference
1077 Manage references in a repository.
1079 References may be listed, created, deleted, and changed.
1080 When creating, deleting, or changing a reference the specified
1082 must be an absolute reference name, i.e. it must begin with
1090 Create a reference or change an existing reference.
1091 The reference with the specified
1093 will point at the specified
1097 argument is a ID SHA1 hash or an existing reference or tag name which will
1098 be resolved to the ID of a corresponding commit, tree, tag, or blob object.
1099 Cannot be used together with any other options except
1102 Delete the reference with the specified
1104 from the repository.
1105 Any commit, tree, tag, and blob objects belonging to deleted references
1106 remain in the repository and may be removed separately with
1107 Git's garbage collector or
1108 .Cm gotadmin cleanup .
1109 Cannot be used together with any other options except
1112 List references in the repository.
1115 is specified, list all existing references in the repository.
1118 is a reference namespace, list all references in this namespace.
1119 Otherwise, show only the reference with the given
1121 Cannot be used together with any other options except
1125 .It Fl r Ar repository-path
1126 Use the repository at the specified path.
1127 If not specified, assume the repository is located at or above the current
1129 If this directory is a
1131 work tree, use the repository path associated with this work tree.
1132 .It Fl s Ar reference
1133 Create a symbolic reference, or change an existing symbolic reference.
1134 The symbolic reference with the specified
1136 will point at the specified
1138 which must already exist in the repository.
1139 Care should be taken not to create loops between references when
1140 this option is used.
1141 Cannot be used together with any other options except
1144 Sort listed references by modification time (most recently modified first)
1145 instead of sorting by lexicographical order.
1146 Use of this option requires the
1148 option to be used as well.
1156 .Op Fl r Ar repository-path
1160 Create, list, or delete branches.
1162 Local branches are managed via references which live in the
1164 reference namespace.
1167 command creates references in this namespace only.
1169 When deleting branches, the specified
1173 reference namespace first.
1174 If no corresponding branch is found, the
1176 namespace will be searched next.
1178 If invoked in a work tree without any arguments, print the name of the
1179 work tree's current branch.
1183 argument is passed, attempt to create a branch reference with the given name.
1184 By default the new branch reference will point at the latest commit on the
1185 work tree's current branch if invoked in a work tree, and otherwise to a commit
1186 resolved via the repository's HEAD reference.
1188 If invoked in a work tree, once the branch was created successfully
1189 switch the work tree's head reference to the newly created branch and
1190 update files across the entire work tree, just like
1191 .Cm got update -b Ar name
1193 Show the status of each affected file, using the following status codes:
1194 .Bl -column YXZ description
1195 .It U Ta file was updated and contained no local changes
1196 .It G Ta file was updated and local changes were merged cleanly
1197 .It C Ta file was updated and conflicts occurred during merge
1198 .It D Ta file was deleted
1199 .It A Ta new file was added
1200 .It \(a~ Ta versioned file is obstructed by a non-regular file
1201 .It ! Ta a missing versioned file was restored
1209 Make a newly created branch reference point at the specified
1213 argument is a commit ID SHA1 hash or an existing reference
1214 or tag name which will be resolved to a commit ID.
1216 Delete the branch with the specified
1222 reference namespace.
1224 Only the branch reference is deleted.
1225 Any commit, tree, and blob objects belonging to the branch
1226 remain in the repository and may be removed separately with
1227 Git's garbage collector or
1228 .Cm gotadmin cleanup .
1230 List all existing branches in the repository, including copies of remote
1231 repositories' branches in the
1233 reference namespace.
1235 If invoked in a work tree, the work tree's current branch is shown
1236 with one the following annotations:
1237 .Bl -column YXZ description
1238 .It * Ta work tree's base commit matches the branch tip
1239 .It \(a~ Ta work tree's base commit is out-of-date
1242 Do not switch and update the work tree after creating a new branch.
1243 .It Fl r Ar repository-path
1244 Use the repository at the specified path.
1245 If not specified, assume the repository is located at or above the current
1247 If this directory is a
1249 work tree, use the repository path associated with this work tree.
1251 Sort listed branches by modification time (most recently modified first)
1252 instead of sorting by lexicographical order.
1255 reference namespace are listed before branches in
1258 Use of this option requires the
1260 option to be used as well.
1267 .Op Fl r Ar repository-path
1268 .Op Fl s Ar signer-id
1271 Manage tags in a repository.
1273 Tags are managed via references which live in the
1275 reference namespace.
1278 command operates on references in this namespace only.
1279 References in this namespace point at tag objects which contain a pointer
1280 to another object, a tag message, as well as author and timestamp information.
1282 Attempt to create a tag with the given
1284 and make this tag point at the given
1286 If no commit is specified, default to the latest commit on the work tree's
1287 current branch if invoked in a work tree, and to a commit resolved via
1288 the repository's HEAD reference otherwise.
1295 Make the newly created tag reference point at the specified
1299 argument is a commit ID SHA1 hash or an existing reference or tag name which
1300 will be resolved to a commit ID.
1301 An abbreviated hash argument will be expanded to a full SHA1 hash
1302 automatically, provided the abbreviation is unique.
1304 List all existing tags in the repository instead of creating a new tag.
1307 argument is passed, show only the tag with the given
1310 Use the specified tag message when creating the new tag.
1315 opens a temporary file in an editor where a tag message can be written.
1316 .It Fl r Ar repository-path
1317 Use the repository at the specified path.
1318 If not specified, assume the repository is located at or above the current
1320 If this directory is a
1322 work tree, use the repository path associated with this work tree.
1323 .It Fl s Ar signer-id
1324 While creating a new tag, sign this tag with the identity given in
1327 For SSH-based signatures,
1329 is the path to a file which may refer to either a private SSH key,
1330 or a public SSH key with the private half available via
1333 will sign the tag object by invoking
1337 command, using the signature namespace
1339 for compatibility with
1342 Verify tag object signatures.
1345 is specified, show and verify the tag object with the provided name.
1346 Otherwise, list all tag objects and verify signatures where present.
1349 verifies SSH-based signatures by invoking
1352 .Fl Y Cm verify Fl f Ar allowed_signers .
1357 otherwise verification is impossible.
1360 During SSH signature creation and verification this option will be passed to
1362 Multiple -v options increase the verbosity.
1368 command will not delete tags or change existing tags.
1369 If a tag must be deleted, the
1371 command may be used to delete a tag's reference.
1372 This should only be done if the tag has not already been copied to
1379 Schedule unversioned files in a work tree for addition to the
1380 repository in the next commit.
1381 By default, files which match a
1383 ignore pattern will not be added.
1390 Add files even if they match a
1394 Permit recursion into directories.
1395 If this option is not specified,
1397 will refuse to run if a specified
1405 .Op Fl s Ar status-codes
1409 Remove versioned files from a work tree and schedule them for deletion
1410 from the repository in the next commit.
1417 Perform the operation even if a file contains local modifications,
1418 and do not raise an error if a specified
1420 does not exist on disk.
1422 Keep affected files on disk.
1424 Permit recursion into directories.
1425 If this option is not specified,
1427 will refuse to run if a specified
1430 .It Fl s Ar status-codes
1431 Only delete files with a modification status matching one of the
1432 single-character status codes contained in the
1435 The following status codes may be specified:
1436 .Bl -column YXZ description
1437 .It M Ta modified file (this implies the
1440 .It ! Ta versioned file expected on disk but missing
1448 .Op Fl p Ar strip-count
1454 to files in a work tree.
1455 Files added or removed by a patch will be scheduled for addition or removal in
1458 The patch must be in the unified diff format as produced by
1465 diff when invoked with their
1470 argument is provided, read unified diff data from standard input instead.
1474 contains multiple patches, then attempt to apply each of them in sequence.
1476 Show the status of each affected file, using the following status codes:
1477 .Bl -column XYZ description
1478 .It M Ta file was modified
1479 .It G Ta file was merged using a merge-base found in the repository
1480 .It C Ta file was merged and conflicts occurred during merge
1481 .It D Ta file was deleted
1482 .It A Ta file was added
1483 .It # Ta failed to patch the file
1486 If a change does not match at its exact line number, attempt to
1487 apply it somewhere else in the file if a good spot can be found.
1488 Otherwise, the patch will fail to apply.
1492 will refuse to apply a patch if certain preconditions are not met.
1493 Files to be deleted must already be under version control, and must
1494 not have been scheduled for deletion already.
1495 Files to be added must not yet be under version control and must not
1496 already be present on disk.
1497 Files to be modified must already be under version control and may not
1498 contain conflict markers.
1500 If an error occurs, the
1502 operation will be aborted.
1503 Any changes made to the work tree up to this point will be left behind.
1504 Such changes can be viewed with
1506 and can be reverted with
1515 Attempt to locate files within the specified
1517 for use as a merge-base for 3-way merges.
1518 Ideally, the specified
1520 should contain versions of files which the changes contained in the
1523 Files will be located by path, relative to the repository root.
1526 option is used then leading path components will be stripped
1527 before paths are looked up in the repository.
1531 option is not used then
1533 will attempt to locate merge-bases via object IDs found in
1535 meta-data, such as produced by
1541 option is only recommended in the absence of such meta-data.
1543 In case no merge-base is available for a file, changes will be applied
1544 without doing a 3-way merge.
1545 Changes which do not apply cleanly may then be rejected entirely, rather
1546 than producing merge conflicts in the patched target file.
1548 Do not make any modifications to the work tree.
1549 This can be used to check whether a patch would apply without issues.
1552 contains diffs that affect the same file multiple times, the results
1553 displayed may be incorrect.
1554 .It Fl p Ar strip-count
1555 Specify the number of leading path components to strip from paths
1564 path prefixes generated by
1566 will be recognized and stripped automatically.
1568 Reverse the patch before applying it.
1574 .Op Fl F Ar response-script
1578 Revert any local changes in files at the specified paths in a work tree.
1579 File contents will be overwritten with those contained in the
1580 work tree's base commit.
1581 There is no way to bring discarded changes back after
1584 If a file was added with
1586 it will become an unversioned file again.
1587 If a file was deleted with
1589 it will be restored.
1595 .It Fl F Ar response-script
1603 responses line-by-line from the specified
1605 file instead of prompting interactively.
1607 Instead of reverting all changes in files, interactively select or reject
1608 changes to revert based on
1614 (quit reverting this file) responses.
1615 If a file is in modified status, individual patches derived from the
1616 modified file content can be reverted.
1617 Files in added or deleted status may only be reverted in their entirety.
1619 Permit recursion into directories.
1620 If this option is not specified,
1622 will refuse to run if a specified
1636 Create a new commit in the repository from changes in a work tree
1637 and use this commit as the new base commit for the work tree.
1640 is specified, commit all changes in the work tree.
1641 Otherwise, commit changes at or within the specified paths.
1643 If changes have been explicitly staged for commit with
1645 only commit staged changes and reject any specified paths which
1646 have not been staged.
1649 opens a temporary file in an editor where a log message can be written
1657 options are used together.
1659 Show the status of each affected file, using the following status codes:
1660 .Bl -column YXZ description
1661 .It M Ta modified file
1662 .It D Ta file was deleted
1663 .It A Ta new file was added
1664 .It m Ta modified file modes (executable bit only)
1667 Files which are not part of the new commit will retain their previously
1668 recorded base commit.
1671 commands may refuse to run while the work tree contains files from
1672 multiple base commits.
1673 The base commit of such a work tree can be made consistent by running
1675 across the entire work tree.
1679 command requires the
1681 environment variable to be set,
1682 unless an author has been configured in
1688 configuration settings can be
1689 obtained from the repository's
1691 file or from Git's global
1700 Set author information in the newly created commit to
1702 This is useful when committing changes which were written by someone
1706 argument must use the same format as the
1708 environment variable.
1710 In addition to storing author information, the newly created commit
1713 information which is obtained, as usual, from the
1715 environment variable, or
1717 or Git configuration settings.
1719 Use the prepared log message stored in the file found at
1721 when creating the new commit.
1723 opens a temporary file in an editor where the prepared log message can be
1724 reviewed and edited further if needed.
1725 Cannot be used together with the
1729 Use the specified log message when creating the new commit.
1730 Cannot be used together with the
1734 This option prevents
1736 from opening the commit message in an editor.
1737 It has no effect unless it is used together with the
1739 option and is intended for non-interactive use such as scripting.
1741 This option prevents
1743 from generating a diff of the to-be-committed changes in a temporary file
1744 which can be viewed while editing a commit message.
1746 Allow the addition of symbolic links which point outside of the path space
1747 that is under version control.
1750 will reject such symbolic links due to safety concerns.
1753 may decide to represent such a symbolic link as a regular file which contains
1754 the link's target path, rather than creating an actual symbolic link which
1755 points outside of the work tree.
1756 Use of this option is discouraged because external mechanisms such as
1758 are better suited for managing symbolic links to paths not under
1763 will refuse to run if certain preconditions are not met.
1764 If the work tree's current branch is not in the
1766 reference namespace, new commits may not be created on this branch.
1767 Local changes may only be committed if they are based on file content
1768 found in the most recent commit on the work tree's branch.
1769 If a path is found to be out of date,
1771 must be used first in order to merge local changes with changes made
1779 .Op Fl r Ar repository-path
1781 .Op Ar remote-repository
1784 Send new changes to a remote repository.
1786 .Ar remote-repository
1790 The remote repository's URL is obtained from the corresponding entry in
1794 file of the local repository, as created by
1797 All objects corresponding to new changes will be written to a temporary
1798 pack file which is then uploaded to the server.
1799 Upon success, references in the
1801 reference namespace of the local repository will be updated to point at
1802 the commits which have been sent.
1804 By default, changes will only be sent if they are based on up-to-date
1805 copies of relevant branches in the remote repository.
1806 If any changes to be sent are based on out-of-date copies or would
1807 otherwise break linear history of existing branches, new changes must
1808 be fetched from the server with
1810 and local branches must be rebased with
1817 option can be used to make exceptions to these requirements.
1824 Send all branches from the local repository's
1826 reference namespace.
1829 option is equivalent to listing all branches with multiple
1832 Cannot be used together with the
1838 from the local repository's
1840 reference namespace.
1841 This option may be specified multiple times to build a list of branches
1843 If this option is not specified, default to the work tree's current branch
1844 if invoked in a work tree, or to the repository's HEAD reference.
1845 Cannot be used together with the
1849 Delete the specified
1851 from the remote repository's
1853 reference namespace.
1854 This option may be specified multiple times to build a list of branches
1857 Only references are deleted.
1858 Any commit, tree, tag, and blob objects belonging to deleted branches
1859 may become subject to deletion by Git's garbage collector running on
1862 Requesting deletion of branches results in an error if the server
1863 does not support this feature or disallows the deletion of branches
1864 based on its configuration.
1866 Attempt to force the server to overwrite existing branches or tags
1867 in the remote repository, even when
1871 would usually be required before changes can be sent.
1872 The server may reject forced requests regardless, depending on its
1875 Any commit, tree, tag, and blob objects belonging to overwritten branches
1876 or tags may become subject to deletion by Git's garbage collector running
1881 reference namespace is globally shared between all repositories.
1884 option to overwrite tags is discouraged because it can lead to
1885 inconsistencies between the tags present in different repositories.
1886 In general, creating a new tag with a different name is recommended
1887 instead of overwriting an existing tag.
1891 option is particularly discouraged if changes being sent are based
1892 on an out-of-date copy of a branch in the remote repository.
1893 Instead of using the
1895 option, new changes should
1898 and local branches should be rebased with
1900 followed by another attempt to send the changes.
1904 option should only be needed in situations where the remote repository's
1905 copy of a branch or tag is known to be out-of-date and is considered
1907 The risks of creating inconsistencies between different repositories
1908 should also be taken into account.
1910 Suppress progress reporting output.
1911 The same option will be passed to
1914 .It Fl r Ar repository-path
1915 Use the repository at the specified path.
1916 If not specified, assume the repository is located at or above the current
1918 If this directory is a
1920 work tree, use the repository path associated with this work tree.
1922 Attempt to send all tags from the local repository's
1924 reference namespace.
1927 option is equivalent to listing all tags with multiple
1930 Cannot be used together with the
1936 from the local repository's
1938 reference namespace, in addition to any branches that are being sent.
1941 option may be specified multiple times to build a list of tags to send.
1942 No tags will be sent if the
1946 Raise an error if the specified
1948 already exists in the remote repository, unless the
1950 option is used to overwrite the server's copy of the tag.
1951 In general, creating a new tag with a different name is recommended
1952 instead of overwriting an existing tag.
1954 Cannot be used together with the
1961 to print debugging messages to standard error output.
1962 The same option will be passed to
1965 Multiple -v options increase the verbosity.
1969 .It Cm cherrypick Ar commit
1971 Merge changes from a single
1976 should be on a different branch than the work tree's base commit.
1977 The expected argument is a reference or a commit ID SHA1 hash.
1978 An abbreviated hash argument will be expanded to a full SHA1 hash
1979 automatically, provided the abbreviation is unique.
1981 Show the status of each affected file, using the following status codes:
1982 .Bl -column YXZ description
1983 .It G Ta file was merged
1984 .It C Ta file was merged and conflicts occurred during merge
1985 .It ! Ta changes destined for a missing file were not merged
1986 .It D Ta file was deleted
1987 .It d Ta file's deletion was prevented by local modifications
1988 .It A Ta new file was added
1989 .It \(a~ Ta changes destined for a non-regular file were not merged
1990 .It ? Ta changes destined for an unversioned file were not merged
1993 The merged changes will appear as local changes in the work tree, which
1996 amended manually or with further
2001 or discarded again with
2005 will refuse to run if certain preconditions are not met.
2006 If the work tree contains multiple base commits, it must first be updated
2007 to a single base commit with
2009 If any relevant files already contain merge conflicts, these
2010 conflicts must be resolved first.
2012 .It Cm backout Ar commit
2014 Reverse-merge changes from a single
2019 should be on the same branch as the work tree's base commit.
2020 The expected argument is a reference or a commit ID SHA1 hash.
2021 An abbreviated hash argument will be expanded to a full SHA1 hash
2022 automatically, provided the abbreviation is unique.
2024 Show the status of each affected file, using the following status codes:
2025 .Bl -column YXZ description
2026 .It G Ta file was merged
2027 .It C Ta file was merged and conflicts occurred during merge
2028 .It ! Ta changes destined for a missing file were not merged
2029 .It D Ta file was deleted
2030 .It d Ta file's deletion was prevented by local modifications
2031 .It A Ta new file was added
2032 .It \(a~ Ta changes destined for a non-regular file were not merged
2033 .It ? Ta changes destined for an unversioned file were not merged
2036 The reverse-merged changes will appear as local changes in the work tree,
2037 which may be viewed with
2039 amended manually or with further
2044 or discarded again with
2048 will refuse to run if certain preconditions are not met.
2049 If the work tree contains multiple base commits, it must first be updated
2050 to a single base commit with
2052 If any relevant files already contain merge conflicts, these
2053 conflicts must be resolved first.
2061 Rebase commits on the specified
2063 onto the tip of the current branch of the work tree.
2066 must share common ancestry with the work tree's current branch.
2067 Rebasing begins with the first descendant commit of the youngest
2068 common ancestor commit shared by the specified
2070 and the work tree's current branch, and stops once the tip commit
2077 is used as intended, the specified
2079 represents a local commit history and may already contain changes
2080 that are not yet visible in any other repositories.
2081 The work tree's current branch, which must be set with
2085 operation, represents a branch from a remote repository which shares
2086 a common history with the specified
2088 but has progressed, and perhaps diverged, due to commits added to the
2091 Rebased commits are accumulated on a temporary branch which the work tree
2092 will remain switched to throughout the entire rebase operation.
2093 Commits on this branch represent the same changes with the same log
2094 messages as their counterparts on the original
2096 but with different commit IDs.
2097 Once rebasing has completed successfully, the temporary branch becomes
2098 the new version of the specified
2100 and the work tree is automatically switched to it.
2101 If author information is available via the
2103 environment variable,
2109 configuration settings, this author information will be used to identify
2114 Old commits in their pre-rebase state are automatically backed up in the
2115 .Dq refs/got/backup/rebase
2116 reference namespace.
2117 As long as these references are not removed older versions of rebased
2118 commits will remain in the repository and can be viewed with the
2121 Removal of these references makes objects which become unreachable via
2122 any reference subject to removal by Git's garbage collector or
2123 .Cm gotadmin cleanup .
2125 While rebasing commits, show the status of each affected file,
2126 using the following status codes:
2127 .Bl -column YXZ description
2128 .It G Ta file was merged
2129 .It C Ta file was merged and conflicts occurred during merge
2130 .It ! Ta changes destined for a missing file were not merged
2131 .It D Ta file was deleted
2132 .It d Ta file's deletion was prevented by local modifications
2133 .It A Ta new file was added
2134 .It \(a~ Ta changes destined for a non-regular file were not merged
2135 .It ? Ta changes destined for an unversioned file were not merged
2138 If merge conflicts occur, the rebase operation is interrupted and may
2139 be continued once conflicts have been resolved.
2140 If any files with destined changes are found to be missing or unversioned,
2141 or if files could not be deleted due to differences in deleted content,
2142 the rebase operation will be interrupted to prevent potentially incomplete
2143 changes from being committed to the repository without user intervention.
2144 The work tree may be modified as desired and the rebase operation can be
2145 continued once the changes present in the work tree are considered complete.
2146 Alternatively, the rebase operation may be aborted which will leave
2148 unmodified and the work tree switched back to its original branch.
2150 If a merge conflict is resolved in a way which renders the merged
2151 change into a no-op change, the corresponding commit will be elided
2152 when the rebase operation continues.
2155 will refuse to run if certain preconditions are not met.
2160 reference namespace, the branch may not be rebased.
2161 If the work tree is not yet fully updated to the tip commit of its
2162 branch, then the work tree must first be updated with
2164 If changes have been staged with
2166 these changes must first be committed with
2170 If the work tree contains local changes, these changes must first be
2177 contains changes to files outside of the work tree's path prefix,
2178 the work tree cannot be used to rebase this branch.
2184 commands will refuse to run while a rebase operation is in progress.
2185 Other commands which manipulate the work tree may be used for
2186 conflict resolution purposes.
2190 is already based on the work tree's current branch, then no commits
2191 need to be rebased and
2193 will simply switch the work tree to the specified
2195 and update files in the work tree accordingly.
2202 Abort an interrupted rebase operation.
2203 If this option is used, no other command-line arguments are allowed.
2205 Continue an interrupted rebase operation.
2206 If this option is used, no other command-line arguments are allowed.
2208 Show a list of past rebase operations, represented by references in the
2209 .Dq refs/got/backup/rebase
2210 reference namespace.
2212 Display the author, date, and log message of each backed up commit,
2213 the object ID of the corresponding post-rebase commit, and
2214 the object ID of their common ancestor commit.
2215 Given these object IDs,
2222 options can be used to examine the history of either version of the branch,
2227 option can be used to create a new branch from a pre-rebase state if desired.
2231 is specified, only show commits which at some point in time represented this
2233 Otherwise, list all backed up commits for any branches.
2235 If this option is used,
2237 does not require a work tree.
2238 None of the other options can be used together with
2241 Delete backups created by past rebase operations, represented by references
2243 .Dq refs/got/backup/rebase
2244 reference namespace.
2248 is specified, only delete backups which at some point in time represented
2250 Otherwise, delete all references found within
2251 .Dq refs/got/backup/rebase .
2253 Any commit, tree, tag, and blob objects belonging to deleted backups
2254 remain in the repository and may be removed separately with
2255 Git's garbage collector or
2256 .Cm gotadmin cleanup .
2258 If this option is used,
2260 does not require a work tree.
2261 None of the other options can be used together with
2268 .Op Fl F Ar histedit-script
2272 Edit commit history between the work tree's current base commit and
2273 the tip commit of the work tree's current branch.
2277 command requires the
2279 environment variable to be set,
2280 unless an author has been configured in
2286 configuration settings can be obtained from the repository's
2288 file or from Git's global
2294 operation, the work tree's current branch must be set with
2296 to the branch which should be edited, unless this branch is already the
2297 current branch of the work tree.
2298 The tip of this branch represents the upper bound (inclusive) of commits
2303 Furthermore, the work tree's base commit
2306 to a point in this branch's commit history where editing should begin.
2307 This commit represents the lower bound (non-inclusive) of commits touched
2312 Editing of commit history is controlled via a
2314 which can be written in an editor based on a template, passed on the
2315 command line, or generated with the
2321 The format of the histedit script is line-based.
2322 Each line in the script begins with a command name, followed by
2323 whitespace and an argument.
2324 For most commands, the expected argument is a commit ID SHA1 hash.
2325 Any remaining text on the line is ignored.
2326 Lines which begin with the
2328 character are ignored entirely.
2330 The available histedit script commands are as follows:
2331 .Bl -column YXZ pick-commit
2332 .It Cm pick Ar commit Ta Use the specified commit as it is.
2333 .It Cm edit Ar commit Ta Use the specified commit but once changes have been
2334 merged into the work tree interrupt the histedit operation for amending.
2335 .It Cm fold Ar commit Ta Combine the specified commit with the next commit
2336 listed further below that will be used.
2337 .It Cm drop Ar commit Ta Remove this commit from the edited history.
2338 .It Cm mesg Oo Ar log-message Oc Ta Create a new log message for the commit of
2343 command on the previous line of the histedit script.
2346 argument provides a new single-line log message to use.
2349 argument is omitted, open an editor where a new log message can be written.
2352 Every commit in the history being edited must be mentioned in the script.
2353 Lines may be re-ordered to change the order of commits in the edited history.
2354 No commit may be listed more than once.
2356 Edited commits are accumulated on a temporary branch which the work tree
2357 will remain switched to throughout the entire histedit operation.
2358 Once history editing has completed successfully, the temporary branch becomes
2359 the new version of the work tree's branch and the work tree is automatically
2362 Old commits in their pre-histedit state are automatically backed up in the
2363 .Dq refs/got/backup/histedit
2364 reference namespace.
2365 As long as these references are not removed older versions of edited
2366 commits will remain in the repository and can be viewed with the
2369 Removal of these references makes objects which become unreachable via
2370 any reference subject to removal by Git's garbage collector or
2371 .Cm gotadmin cleanup .
2373 While merging commits, show the status of each affected file,
2374 using the following status codes:
2375 .Bl -column YXZ description
2376 .It G Ta file was merged
2377 .It C Ta file was merged and conflicts occurred during merge
2378 .It ! Ta changes destined for a missing file were not merged
2379 .It D Ta file was deleted
2380 .It d Ta file's deletion was prevented by local modifications
2381 .It A Ta new file was added
2382 .It \(a~ Ta changes destined for a non-regular file were not merged
2383 .It ? Ta changes destined for an unversioned file were not merged
2386 If merge conflicts occur, the histedit operation is interrupted and may
2387 be continued once conflicts have been resolved.
2388 If any files with destined changes are found to be missing or unversioned,
2389 or if files could not be deleted due to differences in deleted content,
2390 the histedit operation will be interrupted to prevent potentially incomplete
2391 changes from being committed to the repository without user intervention.
2392 The work tree may be modified as desired and the histedit operation can be
2393 continued once the changes present in the work tree are considered complete.
2394 Alternatively, the histedit operation may be aborted which will leave
2395 the work tree switched back to its original branch.
2397 If a merge conflict is resolved in a way which renders the merged
2398 change into a no-op change, the corresponding commit will be elided
2399 when the histedit operation continues.
2402 will refuse to run if certain preconditions are not met.
2403 If the work tree's current branch is not in the
2405 reference namespace, the history of the branch may not be edited.
2406 If the work tree contains multiple base commits, it must first be updated
2407 to a single base commit with
2409 If changes have been staged with
2411 these changes must first be committed with
2415 If the work tree contains local changes, these changes must first be
2420 If the edited history contains changes to files outside of the work tree's
2421 path prefix, the work tree cannot be used to edit the history of this branch.
2428 commands will refuse to run while a histedit operation is in progress.
2429 Other commands which manipulate the work tree may be used, and the
2431 command may be used to commit arbitrary changes to the temporary branch
2432 while the histedit operation is interrupted.
2439 Abort an interrupted histedit operation.
2440 If this option is used, no other command-line arguments are allowed.
2442 Continue an interrupted histedit operation.
2443 If this option is used, no other command-line arguments are allowed.
2445 Interrupt the histedit operation for editing after merging each commit.
2446 This option is a quick equivalent to a histedit script which uses the
2448 command for all commits.
2451 option can only be used when starting a new histedit operation.
2452 If this option is used, no other command-line arguments are allowed.
2453 .It Fl F Ar histedit-script
2456 instead of opening a temporary file in an editor where a histedit script
2459 Fold all commits into a single commit.
2460 This option is a quick equivalent to a histedit script which folds all
2461 commits, combining them all into one commit.
2464 option can only be used when starting a new histedit operation.
2465 If this option is used, no other command-line arguments are allowed.
2467 Show a list of past histedit operations, represented by references in the
2468 .Dq refs/got/backup/histedit
2469 reference namespace.
2471 Display the author, date, and log message of each backed up commit,
2472 the object ID of the corresponding post-histedit commit, and
2473 the object ID of their common ancestor commit.
2474 Given these object IDs,
2481 options can be used to examine the history of either version of the branch,
2486 option can be used to create a new branch from a pre-histedit state if desired.
2490 is specified, only show commits which at some point in time represented this
2492 Otherwise, list all backed up commits for any branches.
2494 If this option is used,
2496 does not require a work tree.
2497 None of the other options can be used together with
2500 Edit log messages only.
2501 This option is a quick equivalent to a histedit script which edits
2502 only log messages but otherwise leaves every picked commit as-is.
2505 option can only be used when starting a new histedit operation.
2506 If this option is used, no other command-line arguments are allowed.
2508 Delete backups created by past histedit operations, represented by references
2510 .Dq refs/got/backup/histedit
2511 reference namespace.
2515 is specified, only delete backups which at some point in time represented
2517 Otherwise, delete all references found within
2518 .Dq refs/got/backup/histedit .
2520 Any commit, tree, tag, and blob objects belonging to deleted backups
2521 remain in the repository and may be removed separately with
2522 Git's garbage collector or
2523 .Cm gotadmin cleanup .
2525 If this option is used,
2527 does not require a work tree.
2528 None of the other options can be used together with
2532 .It Cm integrate Ar branch
2534 Integrate the specified
2536 into the work tree's current branch.
2537 Files in the work tree are updated to match the contents on the integrated
2539 and the reference of the work tree's branch is changed to point at the
2540 head commit of the integrated
2543 Both branches can be considered equivalent after integration since they
2544 will be pointing at the same commit.
2545 Both branches remain available for future work, if desired.
2546 In case the integrated
2548 is no longer needed it may be deleted with
2551 Show the status of each affected file, using the following status codes:
2552 .Bl -column YXZ description
2553 .It U Ta file was updated
2554 .It D Ta file was deleted
2555 .It A Ta new file was added
2556 .It \(a~ Ta versioned file is obstructed by a non-regular file
2557 .It ! Ta a missing versioned file was restored
2561 will refuse to run if certain preconditions are not met.
2562 Most importantly, the
2564 must have been rebased onto the work tree's current branch with
2566 before it can be integrated, in order to linearize commit history and
2567 resolve merge conflicts.
2568 If the work tree contains multiple base commits, it must first be updated
2569 to a single base commit with
2571 If changes have been staged with
2573 these changes must first be committed with
2577 If the work tree contains local changes, these changes must first be
2589 Create a merge commit based on the current branch of the work tree and
2592 If a linear project history is desired, then use of
2594 should be preferred over
2596 However, even strictly linear projects may require merge commits in order
2597 to merge in new versions of third-party code stored on vendor branches
2601 Merge commits are commits based on multiple parent commits.
2602 The tip commit of the work tree's current branch, which must be set with
2606 operation, will be used as the first parent.
2607 The tip commit of the specified
2609 will be used as the second parent.
2611 No ancestral relationship between the two branches is required.
2612 If the two branches have already been merged previously, only new changes
2615 It is not possible to create merge commits with more than two parents.
2616 If more than one branch needs to be merged, then multiple merge commits
2617 with two parents each can be created in sequence.
2619 While merging changes found on the
2621 into the work tree, show the status of each affected file,
2622 using the following status codes:
2623 .Bl -column YXZ description
2624 .It G Ta file was merged
2625 .It C Ta file was merged and conflicts occurred during merge
2626 .It ! Ta changes destined for a missing file were not merged
2627 .It D Ta file was deleted
2628 .It d Ta file's deletion was prevented by local modifications
2629 .It A Ta new file was added
2630 .It \(a~ Ta changes destined for a non-regular file were not merged
2631 .It ? Ta changes destined for an unversioned file were not merged
2634 If merge conflicts occur, the merge operation is interrupted and conflicts
2635 must be resolved before the merge operation can continue.
2636 If any files with destined changes are found to be missing or unversioned,
2637 or if files could not be deleted due to differences in deleted content,
2638 the merge operation will be interrupted to prevent potentially incomplete
2639 changes from being committed to the repository without user intervention.
2640 The work tree may be modified as desired and the merge can be continued
2641 once the changes present in the work tree are considered complete.
2642 Alternatively, the merge operation may be aborted which will leave
2643 the work tree's current branch unmodified.
2645 If a merge conflict is resolved in a way which renders all merged
2646 changes into no-op changes, the merge operation cannot continue
2647 and must be aborted.
2650 will refuse to run if certain preconditions are not met.
2653 is based on the work tree's current branch, then no merge commit can
2656 may be used to integrate the
2659 If the work tree is not yet fully updated to the tip commit of its
2660 branch, then the work tree must first be updated with
2662 If the work tree contains multiple base commits, it must first be updated
2663 to a single base commit with
2665 If changes have been staged with
2667 these changes must first be committed with
2671 If the work tree contains local changes, these changes must first be
2678 contains changes to files outside of the work tree's path prefix,
2679 the work tree cannot be used to merge this branch.
2689 commands will refuse to run while a merge operation is in progress.
2690 Other commands which manipulate the work tree may be used for
2691 conflict resolution purposes.
2698 Abort an interrupted merge operation.
2699 If this option is used, no other command-line arguments are allowed.
2701 Continue an interrupted merge operation.
2702 If this option is used, no other command-line arguments are allowed.
2704 Merge changes into the work tree as usual but do not create a merge
2706 The merge result can be adjusted as desired before a merge commit is
2709 Alternatively, the merge may be aborted with
2716 .Op Fl F Ar response-script
2720 Stage local changes for inclusion in the next commit.
2723 is specified, stage all changes in the work tree.
2724 Otherwise, stage changes at or within the specified paths.
2725 Paths may be staged if they are added, modified, or deleted according to
2728 Show the status of each affected file, using the following status codes:
2729 .Bl -column YXZ description
2730 .It A Ta file addition has been staged
2731 .It M Ta file modification has been staged
2732 .It D Ta file deletion has been staged
2735 Staged file contents are saved in newly created blob objects in the repository.
2736 These blobs will be referred to by tree objects once staged changes have been
2739 Staged changes affect the behaviour of
2744 While paths with staged changes exist, the
2746 command will refuse to commit any paths which do not have staged changes.
2747 Local changes created on top of staged changes can only be committed if
2748 the path is staged again, or if the staged changes are committed first.
2751 command will show both local changes and staged changes.
2754 command is able to display local changes relative to staged changes,
2755 and to display staged changes relative to the repository.
2758 command cannot revert staged changes but may be used to revert
2759 local changes created on top of staged changes.
2765 .It Fl F Ar response-script
2773 responses line-by-line from the specified
2775 file instead of prompting interactively.
2777 Instead of staging new changes, list paths which are already staged,
2778 along with the IDs of staged blob objects and stage status codes.
2779 If paths were provided on the command line, show the staged paths
2780 among the specified paths.
2781 Otherwise, show all staged paths.
2783 Instead of staging the entire content of a changed file, interactively
2784 select or reject changes for staging based on
2788 (reject change), and
2790 (quit staging this file) responses.
2791 If a file is in modified status, individual patches derived from the
2792 modified file content can be staged.
2793 Files in added or deleted status may only be staged or rejected in
2796 Allow staging of symbolic links which point outside of the path space
2797 that is under version control.
2800 will reject such symbolic links due to safety concerns.
2803 may decide to represent such a symbolic link as a regular file which contains
2804 the link's target path, rather than creating an actual symbolic link which
2805 points outside of the work tree.
2806 Use of this option is discouraged because external mechanisms such as
2808 are better suited for managing symbolic links to paths not under
2813 will refuse to run if certain preconditions are not met.
2814 If a file contains merge conflicts, these conflicts must be resolved first.
2815 If a file is found to be out of date relative to the head commit on the
2816 work tree's current branch, the file must be updated with
2818 before it can be staged (however, this does not prevent the file from
2819 becoming out-of-date at some point after having been staged).
2826 commands will refuse to run while staged changes exist.
2827 If staged changes cannot be committed because a staged path
2828 is out of date, the path must be unstaged with
2830 before it can be updated with
2832 and may then be staged again if necessary.
2837 .Op Fl F Ar response-script
2841 Merge staged changes back into the work tree and put affected paths
2842 back into non-staged status.
2845 is specified, unstage all staged changes across the entire work tree.
2846 Otherwise, unstage changes at or within the specified paths.
2848 Show the status of each affected file, using the following status codes:
2849 .Bl -column YXZ description
2850 .It G Ta file was unstaged
2851 .It C Ta file was unstaged and conflicts occurred during merge
2852 .It ! Ta changes destined for a missing file were not merged
2853 .It D Ta file was staged as deleted and still is deleted
2854 .It d Ta file's deletion was prevented by local modifications
2855 .It \(a~ Ta changes destined for a non-regular file were not merged
2862 .It Fl F Ar response-script
2870 responses line-by-line from the specified
2872 file instead of prompting interactively.
2874 Instead of unstaging the entire content of a changed file, interactively
2875 select or reject changes for unstaging based on
2879 (keep change staged), and
2881 (quit unstaging this file) responses.
2882 If a file is staged in modified status, individual patches derived from the
2883 staged file content can be unstaged.
2884 Files staged in added or deleted status may only be unstaged in their entirety.
2890 .Op Fl r Ar repository-path
2893 Parse and print contents of objects to standard output in a line-based
2895 Content of commit, tree, and tag objects is printed in a way similar
2896 to the actual content stored in such objects.
2897 Blob object contents are printed as they would appear in files on disk.
2899 Attempt to interpret each argument as a reference, a tag name, or
2900 an object ID SHA1 hash.
2901 References will be resolved to an object ID.
2902 Tag names will resolved to a tag object.
2903 An abbreviated hash argument will be expanded to a full SHA1 hash
2904 automatically, provided the abbreviation is unique.
2906 If none of the above interpretations produce a valid result, or if the
2908 option is used, attempt to interpret the argument as a path which will
2909 be resolved to the ID of an object found at this path in the repository.
2916 Look up paths in the specified
2918 If this option is not used, paths are looked up in the commit resolved
2919 via the repository's HEAD reference.
2920 The expected argument is a commit ID SHA1 hash or an existing reference
2921 or tag name which will be resolved to a commit ID.
2922 An abbreviated hash argument will be expanded to a full SHA1 hash
2923 automatically, provided the abbreviation is unique.
2925 Interpret all arguments as paths only.
2926 This option can be used to resolve ambiguity in cases where paths
2927 look like tag names, reference names, or object IDs.
2928 .It Fl r Ar repository-path
2929 Use the repository at the specified path.
2930 If not specified, assume the repository is located at or above the current
2932 If this directory is a
2934 work tree, use the repository path associated with this work tree.
2936 .It Cm info Op Ar path ...
2937 Display meta-data stored in a work tree.
2942 The work tree to use is resolved implicitly by walking upwards from the
2943 current working directory.
2947 arguments are specified, show additional per-file information for tracked
2948 files located at or within these paths.
2951 argument corresponds to the work tree's root directory, display information
2952 for all tracked files.
2955 .Bl -tag -width GOT_IGNORE_GITCONFIG
2957 The author's name and email address, such as
2958 .Dq An Flan Hacker Aq Mt flan_hacker@openbsd.org .
2968 may fail to parse commits without an email address in author data,
2972 environment variables with a missing email address.
2974 .Ev GOT_AUTHOR will be overridden by configuration settings in
2980 configuration settings in the repository's
2987 configuration settings contained in Git's global
2989 configuration file will only be used if neither
2993 environment variable provide author information.
2994 .It Ev VISUAL , EDITOR
2995 The editor spawned by
3003 text editor will be spawned in order to give
3005 the attention it deserves.
3006 .It Ev GOT_LOG_DEFAULT_LIMIT
3007 The default limit on the number of commits traversed by
3009 If set to zero, the limit is unbounded.
3010 This variable will be silently ignored if it is set to a non-numeric value.
3011 .It Ev GOT_IGNORE_GITCONFIG
3012 If this variable is set then any remote repository definitions or author
3013 information found in Git configuration files will be ignored.
3016 .Bl -tag -width packed-refs -compact
3018 Repository-wide configuration settings for
3022 configuration file located in the root directory of a Git repository
3023 supersedes any relevant settings in Git's
3027 .It Pa .got/got.conf
3028 Worktree-specific configuration settings for
3032 configuration file in the
3034 meta-data directory of a work tree supersedes any relevant settings in
3037 configuration file and Git's
3044 Enable tab-completion of
3049 .Dl $ set -A complete_got_1 -- $(got -h 2>&1 | sed -n s/commands://p)
3051 Clone an existing Git repository for use with
3055 .Dl $ got clone ssh://git@github.com/openbsd/src.git
3057 Use of HTTP URLs currently requires
3061 .Dl $ git clone --bare https://github.com/openbsd/src.git
3063 Alternatively, for quick and dirty local testing of
3065 a new Git repository could be created and populated with files,
3066 e.g. from a temporary CVS checkout located at
3069 .Dl $ gotadmin init /var/git/src.git
3070 .Dl $ got import -r /var/git/src.git -I CVS -I obj /tmp/src
3072 Check out a work tree from the Git repository to /usr/src:
3074 .Dl $ got checkout /var/git/src.git /usr/src
3076 View local changes in a work tree directory:
3078 .Dl $ got diff | less
3080 In a work tree, display files in a potentially problematic state:
3082 .Dl $ got status -s 'C!~?'
3084 Interactively revert selected local changes in a work tree directory:
3086 .Dl $ got revert -p -R\ .
3088 In a work tree or a git repository directory, list all branch references:
3092 In a work tree or a git repository directory, create a new branch called
3093 .Dq unified-buffer-cache
3094 which is forked off the
3098 .Dl $ got branch -c master unified-buffer-cache
3100 Switch an existing work tree to the branch
3101 .Dq unified-buffer-cache .
3102 Local changes in the work tree will be preserved and merged if necessary:
3104 .Dl $ got update -b unified-buffer-cache
3106 Create a new commit from local changes in a work tree directory.
3107 This new commit will become the head commit of the work tree's current branch:
3111 In a work tree or a git repository directory, view changes committed in
3112 the 3 most recent commits to the work tree's branch, or the branch resolved
3113 via the repository's HEAD reference, respectively:
3115 .Dl $ got log -p -l 3
3117 As above, but display changes in the order in which
3119 could apply them in sequence:
3121 .Dl $ got log -p -l 3 -R
3123 In a work tree or a git repository directory, log the history of a subdirectory:
3125 .Dl $ got log sys/uvm
3127 While operating inside a work tree, paths are specified relative to the current
3128 working directory, so this command will log the subdirectory
3131 .Dl $ cd sys/uvm && got log\ .
3133 And this command has the same effect:
3135 .Dl $ cd sys/dev/usb && got log ../../uvm
3137 And this command displays work tree meta-data about all tracked files:
3140 .Dl $ got info\ . | less
3142 Add new files and remove obsolete files in a work tree directory:
3144 .Dl $ got add sys/uvm/uvm_ubc.c
3145 .Dl $ got remove sys/uvm/uvm_vnode.c
3147 Create a new commit from local changes in a work tree directory
3148 with a pre-defined log message.
3150 .Dl $ got commit -m 'unify the buffer cache'
3152 Alternatively, create a new commit from local changes in a work tree
3153 directory with a log message that has been prepared in the file
3156 .Dl $ got commit -F /tmp/msg
3158 Update any work tree checked out from the
3159 .Dq unified-buffer-cache
3160 branch to the latest commit on this branch:
3164 Roll file content on the unified-buffer-cache branch back by one commit,
3165 and then fetch the rolled-back change into the work tree as a local change
3166 to be amended and perhaps committed again:
3168 .Dl $ got backout unified-buffer-cache
3169 .Dl $ got commit -m 'roll back previous'
3170 .Dl $ # now back out the previous backout :-)
3171 .Dl $ got backout unified-buffer-cache
3173 Fetch new changes on the remote repository's
3175 branch, making them visible on the local repository's
3182 In a repository created with a HTTP URL and
3183 .Cm git clone --bare
3186 command must be used instead:
3188 .Dl $ cd /var/git/src.git
3189 .Dl $ git fetch origin master:refs/remotes/origin/master
3193 branch to merge the new changes that are now visible on the
3198 .Dl $ got update -b origin/master
3199 .Dl $ got rebase master
3202 .Dq unified-buffer-cache
3203 branch on top of the new head commit of the
3207 .Dl $ got update -b master
3208 .Dl $ got rebase unified-buffer-cache
3210 Create a patch from all changes on the unified-buffer-cache branch.
3211 The patch can be mailed out for review and applied to
3215 .Dl $ got diff master unified-buffer-cache > /tmp/ubc.diff
3217 Edit the entire commit history of the
3218 .Dq unified-buffer-cache
3221 .Dl $ got update -b unified-buffer-cache
3222 .Dl $ got update -c master
3225 Before working against existing branches in a repository cloned with
3226 .Cm git clone --bare
3231 must be configured to map all references in the remote repository
3234 namespace of the local repository.
3235 This can be achieved by setting Git's
3236 .Pa remote.origin.fetch
3237 configuration variable to the value
3238 .Dq +refs/heads/*:refs/remotes/origin/*
3243 .Dl $ cd /var/git/repo
3244 .Dl $ git config remote.origin.fetch '+refs/heads/*:refs/remotes/origin/*'
3248 option must be disabled:
3250 .Dl $ cd /var/git/repo
3251 .Dl $ git config remote.origin.mirror false
3253 Alternatively, the following
3255 configuration item can be added manually to the Git repository's
3259 .Dl [remote \&"origin\&"]
3261 .Dl fetch = +refs/heads/*:refs/remotes/origin/*
3264 This configuration leaves the local repository's
3266 namespace free for use by local branches checked out with
3268 and, if needed, created with
3271 .Dq refs/remotes/origin
3272 namespace can now be updated with incoming changes from the remote
3277 without extra command line arguments.
3278 Newly fetched changes can be examined with
3281 Display changes on the remote repository's version of the
3283 branch, as of the last time
3287 .Dl $ got log -c origin/master | less
3289 As shown here, most commands accept abbreviated reference names such as
3292 .Dq refs/remotes/origin/master .
3293 The latter is only needed in case of ambiguity.
3296 must be used to merge changes which are visible on the
3301 This will also merge local changes, if any, with the incoming changes:
3303 .Dl $ got update -b origin/master
3304 .Dl $ got rebase master
3306 In order to make changes committed to the
3307 .Dq unified-buffer-cache
3311 .Dq unified-buffer-cache
3312 branch must first be rebased onto the
3316 .Dl $ got update -b master
3317 .Dl $ got rebase unified-buffer-cache
3320 .Dq unified-buffer-cache
3321 branch can now be made visible on the
3325 Because the rebase operation switched the work tree to the
3326 .Dq unified-buffer-cache
3327 branch, the work tree must be switched back to the
3331 .Dl $ got update -b master
3332 .Dl $ got integrate unified-buffer-cache
3336 branch, log messages for local changes can now be amended with
3338 by other developers and any other important new information:
3340 .Dl $ got update -c origin/master
3341 .Dl $ got histedit -m
3343 If the remote repository offers write access, local changes on the
3345 branch can be sent to the remote repository with
3349 can be run without further arguments.
3350 The arguments shown here match defaults, provided the work tree's
3351 current branch is the
3355 .Dl $ got send -b master origin
3357 If the remote repository requires the HTTPS protocol, the
3359 command must be used instead:
3361 .Dl $ cd /var/git/src.git
3362 .Dl $ git push origin master
3364 When making contributions to projects which use the
3366 workflow, SSH protocol repository access needs to be set up first.
3367 Once an account has been created on a Git hosting site it should
3368 be possible to upload a public SSH key for repository access
3373 workflow will usually involve two remote repositories.
3374 In the real-life example below, the
3376 repository was forked from the
3378 repository by using the Git hosting site's web interface.
3381 file in the local repository describes both remote repositories:
3382 .Bd -literal -offset indent
3383 # Jelmers's repository, which accepts pull requests
3385 server git@github.com
3387 repository "/jelmer/dulwich"
3391 # Stefan's fork, used as the default remote repository
3393 server git@github.com
3395 repository "/stspdotname/dulwich"
3400 With this configuration, Stefan can create commits on
3401 .Dq refs/heads/master
3402 and send them to the
3404 repository by running:
3406 .Dl $ got send -b master origin
3408 The changes can now be proposed to Jelmer by opening a pull request
3409 via the Git hosting site's web interface.
3410 If Jelmer requests further changes to be made, additional commits
3411 can be created on the
3413 branch and be added to the pull request by running
3417 If Jelmer prefers additional commits to be
3419 then the following commands can be used to achieve this:
3421 .Dl $ got update -b master
3422 .Dl $ got update -c origin/master
3423 .Dl $ got histedit -f
3424 .Dl $ got send -f -b master origin
3426 Once Jelmer has accepted the pull request, Stefan can fetch the
3427 merged changes, and possibly several other new changes, by running:
3429 .Dl $ got fetch upstream
3431 The merged changes will now be visible under the reference
3432 .Dq refs/remotes/upstream/master .
3435 branch can now be rebased on top of the latest changes
3438 .Dl $ got update -b upstream/master
3439 .Dl $ got rebase master
3441 As a final step, the forked repository's copy of the master branch needs
3442 to be kept in sync by sending the new changes there:
3444 .Dl $ got send -f -b master origin
3446 If multiple pull requests need to be managed in parallel, a separate branch
3447 must be created for each pull request with
3449 Each such branch can then be used as above, in place of
3450 .Dq refs/heads/master .
3451 Changes for any accepted pull requests will still appear under
3452 .Dq refs/remotes/upstream/master,
3453 regardless of which branch was used in the forked repository to
3454 create a pull request.
3458 .Xr git-repository 5 ,
3459 .Xr got-worktree 5 ,
3463 .An Anthony J. Bentley Aq Mt bentley@openbsd.org
3464 .An Christian Weisgerber Aq Mt naddy@openbsd.org
3465 .An Hiltjo Posthuma Aq Mt hiltjo@codemadness.org
3466 .An Josh Rickmar Aq Mt jrick@zettaport.com
3467 .An Joshua Stein Aq Mt jcs@openbsd.org
3468 .An Klemens Nanni Aq Mt kn@openbsd.org
3469 .An Martin Pieuchot Aq Mt mpi@openbsd.org
3470 .An Neels Hofmeyr Aq Mt neels@hofmeyr.de
3471 .An Omar Polo Aq Mt op@openbsd.org
3472 .An Ori Bernstein Aq Mt ori@openbsd.org
3473 .An Sebastien Marie Aq Mt semarie@openbsd.org
3474 .An Stefan Sperling Aq Mt stsp@openbsd.org
3475 .An Steven McDonald Aq Mt steven@steven-mcdonald.id.au
3476 .An Theo Buehler Aq Mt tb@openbsd.org
3477 .An Thomas Adam Aq Mt thomas@xteddy.org
3478 .An Tracey Emery Aq Mt tracey@traceyemery.net
3479 .An Yang Zhong Aq Mt yzhong@freebsdfoundation.org
3486 were derived from code under copyright by:
3488 .An Caldera International
3489 .An Daniel Hartmeier
3494 .An Jean-Francois Brousseau
3500 .An Niklas Hallqvist
3505 .An Xavier Santolaria
3508 contains code contributed to the public domain by
3509 .An Austin Appleby .
3512 is a work-in-progress and some features remain to be implemented.
3514 At present, the user has to fall back on
3516 to perform some tasks.
3520 Reading from remote repositories over HTTP or HTTPS protocols requires
3525 Writing to remote repositories over HTTP or HTTPS protocols requires
3528 The creation of merge commits with more than two parent commits requires
3531 In situations where files or directories were moved around
3533 will not automatically merge changes to new locations and
3535 will usually produce better results.
