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 each 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 Display diffstat of changes before the actual diff by annotating each file path
967 or blob hash being diffed with the total number of lines added and removed.
968 A summary line will display the total number of changes across all files.
970 Interpret all arguments as paths only.
971 This option can be used to resolve ambiguity in cases where paths
972 look like tag names, reference names, or object IDs.
973 This option is only valid when
975 is invoked in a work tree.
976 .It Fl r Ar repository-path
977 Use the repository at the specified path.
978 If not specified, assume the repository is located at or above the current
980 If this directory is a
982 work tree, use the repository path associated with this work tree.
984 Show changes staged with
986 instead of showing local changes in the work tree.
987 This option is only valid when
989 is invoked in a work tree.
991 Ignore whitespace-only changes.
997 .Op Fl r Ar repository-path
1001 Display line-by-line history of a file at the specified path.
1008 Start traversing history at the specified
1010 The expected argument is a commit ID SHA1 hash or an existing reference
1011 or tag name which will be resolved to a commit ID.
1012 An abbreviated hash argument will be expanded to a full SHA1 hash
1013 automatically, provided the abbreviation is unique.
1014 .It Fl r Ar repository-path
1015 Use the repository at the specified path.
1016 If not specified, assume the repository is located at or above the current
1018 If this directory is a
1020 work tree, use the repository path associated with this work tree.
1027 .Op Fl r Ar repository-path
1031 Display a listing of files and directories at the specified
1032 directory path in the repository.
1033 Entries shown in this listing may carry one of the following trailing
1035 .Bl -column YXZ description
1036 .It @ Ta entry is a symbolic link
1037 .It / Ta entry is a directory
1038 .It * Ta entry is an executable file
1039 .It $ Ta entry is a Git submodule
1042 Symbolic link entries are also annotated with the target path of the link.
1046 is specified, list the repository path corresponding to the current
1047 directory of the work tree, or the root directory of the repository
1048 if there is no work tree.
1055 List files and directories as they appear in the specified
1057 The expected argument is a commit ID SHA1 hash or an existing reference
1058 or tag name which will be resolved to a commit ID.
1059 An abbreviated hash argument will be expanded to a full SHA1 hash
1060 automatically, provided the abbreviation is unique.
1062 Show object IDs of files (blob objects) and directories (tree objects).
1064 Recurse into sub-directories in the repository.
1065 .It Fl r Ar repository-path
1066 Use the repository at the specified path.
1067 If not specified, assume the repository is located at or above the current
1069 If this directory is a
1071 work tree, use the repository path associated with this work tree.
1077 .Op Fl r Ar repository-path
1078 .Op Fl s Ar reference
1081 Manage references in a repository.
1083 References may be listed, created, deleted, and changed.
1084 When creating, deleting, or changing a reference the specified
1086 must be an absolute reference name, i.e. it must begin with
1094 Create a reference or change an existing reference.
1095 The reference with the specified
1097 will point at the specified
1101 argument is a ID SHA1 hash or an existing reference or tag name which will
1102 be resolved to the ID of a corresponding commit, tree, tag, or blob object.
1103 Cannot be used together with any other options except
1106 Delete the reference with the specified
1108 from the repository.
1109 Any commit, tree, tag, and blob objects belonging to deleted references
1110 remain in the repository and may be removed separately with
1111 Git's garbage collector or
1112 .Cm gotadmin cleanup .
1113 Cannot be used together with any other options except
1116 List references in the repository.
1119 is specified, list all existing references in the repository.
1122 is a reference namespace, list all references in this namespace.
1123 Otherwise, show only the reference with the given
1125 Cannot be used together with any other options except
1129 .It Fl r Ar repository-path
1130 Use the repository at the specified path.
1131 If not specified, assume the repository is located at or above the current
1133 If this directory is a
1135 work tree, use the repository path associated with this work tree.
1136 .It Fl s Ar reference
1137 Create a symbolic reference, or change an existing symbolic reference.
1138 The symbolic reference with the specified
1140 will point at the specified
1142 which must already exist in the repository.
1143 Care should be taken not to create loops between references when
1144 this option is used.
1145 Cannot be used together with any other options except
1148 Sort listed references by modification time (most recently modified first)
1149 instead of sorting by lexicographical order.
1150 Use of this option requires the
1152 option to be used as well.
1160 .Op Fl r Ar repository-path
1164 Create, list, or delete branches.
1166 Local branches are managed via references which live in the
1168 reference namespace.
1171 command creates references in this namespace only.
1173 When deleting branches, the specified
1177 reference namespace first.
1178 If no corresponding branch is found, the
1180 namespace will be searched next.
1182 If invoked in a work tree without any arguments, print the name of the
1183 work tree's current branch.
1187 argument is passed, attempt to create a branch reference with the given name.
1188 By default the new branch reference will point at the latest commit on the
1189 work tree's current branch if invoked in a work tree, and otherwise to a commit
1190 resolved via the repository's HEAD reference.
1192 If invoked in a work tree, once the branch was created successfully
1193 switch the work tree's head reference to the newly created branch and
1194 update files across the entire work tree, just like
1195 .Cm got update -b Ar name
1197 Show the status of each affected file, using the following status codes:
1198 .Bl -column YXZ description
1199 .It U Ta file was updated and contained no local changes
1200 .It G Ta file was updated and local changes were merged cleanly
1201 .It C Ta file was updated and conflicts occurred during merge
1202 .It D Ta file was deleted
1203 .It A Ta new file was added
1204 .It \(a~ Ta versioned file is obstructed by a non-regular file
1205 .It ! Ta a missing versioned file was restored
1213 Make a newly created branch reference point at the specified
1217 argument is a commit ID SHA1 hash or an existing reference
1218 or tag name which will be resolved to a commit ID.
1220 Delete the branch with the specified
1226 reference namespace.
1228 Only the branch reference is deleted.
1229 Any commit, tree, and blob objects belonging to the branch
1230 remain in the repository and may be removed separately with
1231 Git's garbage collector or
1232 .Cm gotadmin cleanup .
1234 List all existing branches in the repository, including copies of remote
1235 repositories' branches in the
1237 reference namespace.
1239 If invoked in a work tree, the work tree's current branch is shown
1240 with one the following annotations:
1241 .Bl -column YXZ description
1242 .It * Ta work tree's base commit matches the branch tip
1243 .It \(a~ Ta work tree's base commit is out-of-date
1246 Do not switch and update the work tree after creating a new branch.
1247 .It Fl r Ar repository-path
1248 Use the repository at the specified path.
1249 If not specified, assume the repository is located at or above the current
1251 If this directory is a
1253 work tree, use the repository path associated with this work tree.
1255 Sort listed branches by modification time (most recently modified first)
1256 instead of sorting by lexicographical order.
1259 reference namespace are listed before branches in
1262 Use of this option requires the
1264 option to be used as well.
1271 .Op Fl r Ar repository-path
1272 .Op Fl s Ar signer-id
1275 Manage tags in a repository.
1277 Tags are managed via references which live in the
1279 reference namespace.
1282 command operates on references in this namespace only.
1283 References in this namespace point at tag objects which contain a pointer
1284 to another object, a tag message, as well as author and timestamp information.
1286 Attempt to create a tag with the given
1288 and make this tag point at the given
1290 If no commit is specified, default to the latest commit on the work tree's
1291 current branch if invoked in a work tree, and to a commit resolved via
1292 the repository's HEAD reference otherwise.
1299 Make the newly created tag reference point at the specified
1303 argument is a commit ID SHA1 hash or an existing reference or tag name which
1304 will be resolved to a commit ID.
1305 An abbreviated hash argument will be expanded to a full SHA1 hash
1306 automatically, provided the abbreviation is unique.
1308 List all existing tags in the repository instead of creating a new tag.
1311 argument is passed, show only the tag with the given
1314 Use the specified tag message when creating the new tag.
1319 opens a temporary file in an editor where a tag message can be written.
1320 .It Fl r Ar repository-path
1321 Use the repository at the specified path.
1322 If not specified, assume the repository is located at or above the current
1324 If this directory is a
1326 work tree, use the repository path associated with this work tree.
1327 .It Fl s Ar signer-id
1328 While creating a new tag, sign this tag with the identity given in
1331 For SSH-based signatures,
1333 is the path to a file which may refer to either a private SSH key,
1334 or a public SSH key with the private half available via
1337 will sign the tag object by invoking
1341 command, using the signature namespace
1343 for compatibility with
1346 Verify tag object signatures.
1349 is specified, show and verify the tag object with the provided name.
1350 Otherwise, list all tag objects and verify signatures where present.
1353 verifies SSH-based signatures by invoking
1356 .Fl Y Cm verify Fl f Ar allowed_signers .
1361 otherwise verification is impossible.
1364 During SSH signature creation and verification this option will be passed to
1366 Multiple -v options increase the verbosity.
1372 command will not delete tags or change existing tags.
1373 If a tag must be deleted, the
1375 command may be used to delete a tag's reference.
1376 This should only be done if the tag has not already been copied to
1383 Schedule unversioned files in a work tree for addition to the
1384 repository in the next commit.
1385 By default, files which match a
1387 ignore pattern will not be added.
1394 Add files even if they match a
1398 Permit recursion into directories.
1399 If this option is not specified,
1401 will refuse to run if a specified
1409 .Op Fl s Ar status-codes
1413 Remove versioned files from a work tree and schedule them for deletion
1414 from the repository in the next commit.
1421 Perform the operation even if a file contains local modifications,
1422 and do not raise an error if a specified
1424 does not exist on disk.
1426 Keep affected files on disk.
1428 Permit recursion into directories.
1429 If this option is not specified,
1431 will refuse to run if a specified
1434 .It Fl s Ar status-codes
1435 Only delete files with a modification status matching one of the
1436 single-character status codes contained in the
1439 The following status codes may be specified:
1440 .Bl -column YXZ description
1441 .It M Ta modified file (this implies the
1444 .It ! Ta versioned file expected on disk but missing
1452 .Op Fl p Ar strip-count
1458 to files in a work tree.
1459 Files added or removed by a patch will be scheduled for addition or removal in
1462 The patch must be in the unified diff format as produced by
1469 diff when invoked with their
1474 argument is provided, read unified diff data from standard input instead.
1478 contains multiple patches, then attempt to apply each of them in sequence.
1480 Show the status of each affected file, using the following status codes:
1481 .Bl -column XYZ description
1482 .It M Ta file was modified
1483 .It G Ta file was merged using a merge-base found in the repository
1484 .It C Ta file was merged and conflicts occurred during merge
1485 .It D Ta file was deleted
1486 .It A Ta file was added
1487 .It # Ta failed to patch the file
1490 If a change does not match at its exact line number, attempt to
1491 apply it somewhere else in the file if a good spot can be found.
1492 Otherwise, the patch will fail to apply.
1496 will refuse to apply a patch if certain preconditions are not met.
1497 Files to be deleted must already be under version control, and must
1498 not have been scheduled for deletion already.
1499 Files to be added must not yet be under version control and must not
1500 already be present on disk.
1501 Files to be modified must already be under version control and may not
1502 contain conflict markers.
1504 If an error occurs, the
1506 operation will be aborted.
1507 Any changes made to the work tree up to this point will be left behind.
1508 Such changes can be viewed with
1510 and can be reverted with
1519 Attempt to locate files within the specified
1521 for use as a merge-base for 3-way merges.
1522 Ideally, the specified
1524 should contain versions of files which the changes contained in the
1527 Files will be located by path, relative to the repository root.
1530 option is used then leading path components will be stripped
1531 before paths are looked up in the repository.
1535 option is not used then
1537 will attempt to locate merge-bases via object IDs found in
1539 meta-data, such as produced by
1545 option is only recommended in the absence of such meta-data.
1547 In case no merge-base is available for a file, changes will be applied
1548 without doing a 3-way merge.
1549 Changes which do not apply cleanly may then be rejected entirely, rather
1550 than producing merge conflicts in the patched target file.
1552 Do not make any modifications to the work tree.
1553 This can be used to check whether a patch would apply without issues.
1556 contains diffs that affect the same file multiple times, the results
1557 displayed may be incorrect.
1558 .It Fl p Ar strip-count
1559 Specify the number of leading path components to strip from paths
1568 path prefixes generated by
1570 will be recognized and stripped automatically.
1572 Reverse the patch before applying it.
1578 .Op Fl F Ar response-script
1582 Revert any local changes in files at the specified paths in a work tree.
1583 File contents will be overwritten with those contained in the
1584 work tree's base commit.
1585 There is no way to bring discarded changes back after
1588 If a file was added with
1590 it will become an unversioned file again.
1591 If a file was deleted with
1593 it will be restored.
1599 .It Fl F Ar response-script
1607 responses line-by-line from the specified
1609 file instead of prompting interactively.
1611 Instead of reverting all changes in files, interactively select or reject
1612 changes to revert based on
1618 (quit reverting this file) responses.
1619 If a file is in modified status, individual patches derived from the
1620 modified file content can be reverted.
1621 Files in added or deleted status may only be reverted in their entirety.
1623 Permit recursion into directories.
1624 If this option is not specified,
1626 will refuse to run if a specified
1640 Create a new commit in the repository from changes in a work tree
1641 and use this commit as the new base commit for the work tree.
1644 is specified, commit all changes in the work tree.
1645 Otherwise, commit changes at or within the specified paths.
1647 If changes have been explicitly staged for commit with
1649 only commit staged changes and reject any specified paths which
1650 have not been staged.
1653 opens a temporary file in an editor where a log message can be written
1661 options are used together.
1663 Show the status of each affected file, using the following status codes:
1664 .Bl -column YXZ description
1665 .It M Ta modified file
1666 .It D Ta file was deleted
1667 .It A Ta new file was added
1668 .It m Ta modified file modes (executable bit only)
1671 Files which are not part of the new commit will retain their previously
1672 recorded base commit.
1675 commands may refuse to run while the work tree contains files from
1676 multiple base commits.
1677 The base commit of such a work tree can be made consistent by running
1679 across the entire work tree.
1683 command requires the
1685 environment variable to be set,
1686 unless an author has been configured in
1692 configuration settings can be
1693 obtained from the repository's
1695 file or from Git's global
1704 Set author information in the newly created commit to
1706 This is useful when committing changes which were written by someone
1710 argument must use the same format as the
1712 environment variable.
1714 In addition to storing author information, the newly created commit
1717 information which is obtained, as usual, from the
1719 environment variable, or
1721 or Git configuration settings.
1723 Use the prepared log message stored in the file found at
1725 when creating the new commit.
1727 opens a temporary file in an editor where the prepared log message can be
1728 reviewed and edited further if needed.
1729 Cannot be used together with the
1733 Use the specified log message when creating the new commit.
1734 Cannot be used together with the
1738 This option prevents
1740 from opening the commit message in an editor.
1741 It has no effect unless it is used together with the
1743 option and is intended for non-interactive use such as scripting.
1745 This option prevents
1747 from generating a diff of the to-be-committed changes in a temporary file
1748 which can be viewed while editing a commit message.
1750 Allow the addition of symbolic links which point outside of the path space
1751 that is under version control.
1754 will reject such symbolic links due to safety concerns.
1757 may decide to represent such a symbolic link as a regular file which contains
1758 the link's target path, rather than creating an actual symbolic link which
1759 points outside of the work tree.
1760 Use of this option is discouraged because external mechanisms such as
1762 are better suited for managing symbolic links to paths not under
1767 will refuse to run if certain preconditions are not met.
1768 If the work tree's current branch is not in the
1770 reference namespace, new commits may not be created on this branch.
1771 Local changes may only be committed if they are based on file content
1772 found in the most recent commit on the work tree's branch.
1773 If a path is found to be out of date,
1775 must be used first in order to merge local changes with changes made
1783 .Op Fl r Ar repository-path
1785 .Op Ar remote-repository
1788 Send new changes to a remote repository.
1790 .Ar remote-repository
1794 The remote repository's URL is obtained from the corresponding entry in
1798 file of the local repository, as created by
1801 All objects corresponding to new changes will be written to a temporary
1802 pack file which is then uploaded to the server.
1803 Upon success, references in the
1805 reference namespace of the local repository will be updated to point at
1806 the commits which have been sent.
1808 By default, changes will only be sent if they are based on up-to-date
1809 copies of relevant branches in the remote repository.
1810 If any changes to be sent are based on out-of-date copies or would
1811 otherwise break linear history of existing branches, new changes must
1812 be fetched from the server with
1814 and local branches must be rebased with
1821 option can be used to make exceptions to these requirements.
1828 Send all branches from the local repository's
1830 reference namespace.
1833 option is equivalent to listing all branches with multiple
1836 Cannot be used together with the
1842 from the local repository's
1844 reference namespace.
1845 This option may be specified multiple times to build a list of branches
1847 If this option is not specified, default to the work tree's current branch
1848 if invoked in a work tree, or to the repository's HEAD reference.
1849 Cannot be used together with the
1853 Delete the specified
1855 from the remote repository's
1857 reference namespace.
1858 This option may be specified multiple times to build a list of branches
1861 Only references are deleted.
1862 Any commit, tree, tag, and blob objects belonging to deleted branches
1863 may become subject to deletion by Git's garbage collector running on
1866 Requesting deletion of branches results in an error if the server
1867 does not support this feature or disallows the deletion of branches
1868 based on its configuration.
1870 Attempt to force the server to overwrite existing branches or tags
1871 in the remote repository, even when
1875 would usually be required before changes can be sent.
1876 The server may reject forced requests regardless, depending on its
1879 Any commit, tree, tag, and blob objects belonging to overwritten branches
1880 or tags may become subject to deletion by Git's garbage collector running
1885 reference namespace is globally shared between all repositories.
1888 option to overwrite tags is discouraged because it can lead to
1889 inconsistencies between the tags present in different repositories.
1890 In general, creating a new tag with a different name is recommended
1891 instead of overwriting an existing tag.
1895 option is particularly discouraged if changes being sent are based
1896 on an out-of-date copy of a branch in the remote repository.
1897 Instead of using the
1899 option, new changes should
1902 and local branches should be rebased with
1904 followed by another attempt to send the changes.
1908 option should only be needed in situations where the remote repository's
1909 copy of a branch or tag is known to be out-of-date and is considered
1911 The risks of creating inconsistencies between different repositories
1912 should also be taken into account.
1914 Suppress progress reporting output.
1915 The same option will be passed to
1918 .It Fl r Ar repository-path
1919 Use the repository at the specified path.
1920 If not specified, assume the repository is located at or above the current
1922 If this directory is a
1924 work tree, use the repository path associated with this work tree.
1926 Attempt to send all tags from the local repository's
1928 reference namespace.
1931 option is equivalent to listing all tags with multiple
1934 Cannot be used together with the
1940 from the local repository's
1942 reference namespace, in addition to any branches that are being sent.
1945 option may be specified multiple times to build a list of tags to send.
1946 No tags will be sent if the
1950 Raise an error if the specified
1952 already exists in the remote repository, unless the
1954 option is used to overwrite the server's copy of the tag.
1955 In general, creating a new tag with a different name is recommended
1956 instead of overwriting an existing tag.
1958 Cannot be used together with the
1965 to print debugging messages to standard error output.
1966 The same option will be passed to
1969 Multiple -v options increase the verbosity.
1973 .It Cm cherrypick Ar commit
1975 Merge changes from a single
1980 should be on a different branch than the work tree's base commit.
1981 The expected argument is a reference or a commit ID SHA1 hash.
1982 An abbreviated hash argument will be expanded to a full SHA1 hash
1983 automatically, provided the abbreviation is unique.
1985 Show the status of each affected file, using the following status codes:
1986 .Bl -column YXZ description
1987 .It G Ta file was merged
1988 .It C Ta file was merged and conflicts occurred during merge
1989 .It ! Ta changes destined for a missing file were not merged
1990 .It D Ta file was deleted
1991 .It d Ta file's deletion was prevented by local modifications
1992 .It A Ta new file was added
1993 .It \(a~ Ta changes destined for a non-regular file were not merged
1994 .It ? Ta changes destined for an unversioned file were not merged
1997 The merged changes will appear as local changes in the work tree, which
2000 amended manually or with further
2005 or discarded again with
2009 will refuse to run if certain preconditions are not met.
2010 If the work tree contains multiple base commits, it must first be updated
2011 to a single base commit with
2013 If any relevant files already contain merge conflicts, these
2014 conflicts must be resolved first.
2016 .It Cm backout Ar commit
2018 Reverse-merge changes from a single
2023 should be on the same branch as the work tree's base commit.
2024 The expected argument is a reference or a commit ID SHA1 hash.
2025 An abbreviated hash argument will be expanded to a full SHA1 hash
2026 automatically, provided the abbreviation is unique.
2028 Show the status of each affected file, using the following status codes:
2029 .Bl -column YXZ description
2030 .It G Ta file was merged
2031 .It C Ta file was merged and conflicts occurred during merge
2032 .It ! Ta changes destined for a missing file were not merged
2033 .It D Ta file was deleted
2034 .It d Ta file's deletion was prevented by local modifications
2035 .It A Ta new file was added
2036 .It \(a~ Ta changes destined for a non-regular file were not merged
2037 .It ? Ta changes destined for an unversioned file were not merged
2040 The reverse-merged changes will appear as local changes in the work tree,
2041 which may be viewed with
2043 amended manually or with further
2048 or discarded again with
2052 will refuse to run if certain preconditions are not met.
2053 If the work tree contains multiple base commits, it must first be updated
2054 to a single base commit with
2056 If any relevant files already contain merge conflicts, these
2057 conflicts must be resolved first.
2065 Rebase commits on the specified
2067 onto the tip of the current branch of the work tree.
2070 must share common ancestry with the work tree's current branch.
2071 Rebasing begins with the first descendant commit of the youngest
2072 common ancestor commit shared by the specified
2074 and the work tree's current branch, and stops once the tip commit
2081 is used as intended, the specified
2083 represents a local commit history and may already contain changes
2084 that are not yet visible in any other repositories.
2085 The work tree's current branch, which must be set with
2089 operation, represents a branch from a remote repository which shares
2090 a common history with the specified
2092 but has progressed, and perhaps diverged, due to commits added to the
2095 Rebased commits are accumulated on a temporary branch which the work tree
2096 will remain switched to throughout the entire rebase operation.
2097 Commits on this branch represent the same changes with the same log
2098 messages as their counterparts on the original
2100 but with different commit IDs.
2101 Once rebasing has completed successfully, the temporary branch becomes
2102 the new version of the specified
2104 and the work tree is automatically switched to it.
2105 If author information is available via the
2107 environment variable,
2113 configuration settings, this author information will be used to identify
2118 Old commits in their pre-rebase state are automatically backed up in the
2119 .Dq refs/got/backup/rebase
2120 reference namespace.
2121 As long as these references are not removed older versions of rebased
2122 commits will remain in the repository and can be viewed with the
2125 Removal of these references makes objects which become unreachable via
2126 any reference subject to removal by Git's garbage collector or
2127 .Cm gotadmin cleanup .
2129 While rebasing commits, show the status of each affected file,
2130 using the following status codes:
2131 .Bl -column YXZ description
2132 .It G Ta file was merged
2133 .It C Ta file was merged and conflicts occurred during merge
2134 .It ! Ta changes destined for a missing file were not merged
2135 .It D Ta file was deleted
2136 .It d Ta file's deletion was prevented by local modifications
2137 .It A Ta new file was added
2138 .It \(a~ Ta changes destined for a non-regular file were not merged
2139 .It ? Ta changes destined for an unversioned file were not merged
2142 If merge conflicts occur, the rebase operation is interrupted and may
2143 be continued once conflicts have been resolved.
2144 If any files with destined changes are found to be missing or unversioned,
2145 or if files could not be deleted due to differences in deleted content,
2146 the rebase operation will be interrupted to prevent potentially incomplete
2147 changes from being committed to the repository without user intervention.
2148 The work tree may be modified as desired and the rebase operation can be
2149 continued once the changes present in the work tree are considered complete.
2150 Alternatively, the rebase operation may be aborted which will leave
2152 unmodified and the work tree switched back to its original branch.
2154 If a merge conflict is resolved in a way which renders the merged
2155 change into a no-op change, the corresponding commit will be elided
2156 when the rebase operation continues.
2159 will refuse to run if certain preconditions are not met.
2164 reference namespace, the branch may not be rebased.
2165 If the work tree is not yet fully updated to the tip commit of its
2166 branch, then the work tree must first be updated with
2168 If changes have been staged with
2170 these changes must first be committed with
2174 If the work tree contains local changes, these changes must first be
2181 contains changes to files outside of the work tree's path prefix,
2182 the work tree cannot be used to rebase this branch.
2191 commands will refuse to run while a rebase operation is in progress.
2192 Other commands which manipulate the work tree may be used for
2193 conflict resolution purposes.
2197 is already based on the work tree's current branch, then no commits
2198 need to be rebased and
2200 will simply switch the work tree to the specified
2202 and update files in the work tree accordingly.
2209 Abort an interrupted rebase operation.
2210 If this option is used, no other command-line arguments are allowed.
2212 Continue an interrupted rebase operation.
2213 If this option is used, no other command-line arguments are allowed.
2215 Show a list of past rebase operations, represented by references in the
2216 .Dq refs/got/backup/rebase
2217 reference namespace.
2219 Display the author, date, and log message of each backed up commit,
2220 the object ID of the corresponding post-rebase commit, and
2221 the object ID of their common ancestor commit.
2222 Given these object IDs,
2229 options can be used to examine the history of either version of the branch,
2234 option can be used to create a new branch from a pre-rebase state if desired.
2238 is specified, only show commits which at some point in time represented this
2240 Otherwise, list all backed up commits for any branches.
2242 If this option is used,
2244 does not require a work tree.
2245 None of the other options can be used together with
2248 Delete backups created by past rebase operations, represented by references
2250 .Dq refs/got/backup/rebase
2251 reference namespace.
2255 is specified, only delete backups which at some point in time represented
2257 Otherwise, delete all references found within
2258 .Dq refs/got/backup/rebase .
2260 Any commit, tree, tag, and blob objects belonging to deleted backups
2261 remain in the repository and may be removed separately with
2262 Git's garbage collector or
2263 .Cm gotadmin cleanup .
2265 If this option is used,
2267 does not require a work tree.
2268 None of the other options can be used together with
2275 .Op Fl F Ar histedit-script
2279 Edit commit history between the work tree's current base commit and
2280 the tip commit of the work tree's current branch.
2284 command requires the
2286 environment variable to be set,
2287 unless an author has been configured in
2293 configuration settings can be obtained from the repository's
2295 file or from Git's global
2301 operation, the work tree's current branch must be set with
2303 to the branch which should be edited, unless this branch is already the
2304 current branch of the work tree.
2305 The tip of this branch represents the upper bound (inclusive) of commits
2310 Furthermore, the work tree's base commit
2313 to a point in this branch's commit history where editing should begin.
2314 This commit represents the lower bound (non-inclusive) of commits touched
2319 Editing of commit history is controlled via a
2321 which can be written in an editor based on a template, passed on the
2322 command line, or generated with the
2328 The format of the histedit script is line-based.
2329 Each line in the script begins with a command name, followed by
2330 whitespace and an argument.
2331 For most commands, the expected argument is a commit ID SHA1 hash.
2332 Any remaining text on the line is ignored.
2333 Lines which begin with the
2335 character are ignored entirely.
2337 The available histedit script commands are as follows:
2338 .Bl -column YXZ pick-commit
2339 .It Cm pick Ar commit Ta Use the specified commit as it is.
2340 .It Cm edit Ar commit Ta Use the specified commit but once changes have been
2341 merged into the work tree interrupt the histedit operation for amending.
2342 .It Cm fold Ar commit Ta Combine the specified commit with the next commit
2343 listed further below that will be used.
2344 .It Cm drop Ar commit Ta Remove this commit from the edited history.
2345 .It Cm mesg Oo Ar log-message Oc Ta Create a new log message for the commit of
2350 command on the previous line of the histedit script.
2353 argument provides a new single-line log message to use.
2356 argument is omitted, open an editor where a new log message can be written.
2359 Every commit in the history being edited must be mentioned in the script.
2360 Lines may be re-ordered to change the order of commits in the edited history.
2361 No commit may be listed more than once.
2363 Edited commits are accumulated on a temporary branch which the work tree
2364 will remain switched to throughout the entire histedit operation.
2365 Once history editing has completed successfully, the temporary branch becomes
2366 the new version of the work tree's branch and the work tree is automatically
2369 Old commits in their pre-histedit state are automatically backed up in the
2370 .Dq refs/got/backup/histedit
2371 reference namespace.
2372 As long as these references are not removed older versions of edited
2373 commits will remain in the repository and can be viewed with the
2376 Removal of these references makes objects which become unreachable via
2377 any reference subject to removal by Git's garbage collector or
2378 .Cm gotadmin cleanup .
2380 While merging commits, show the status of each affected file,
2381 using the following status codes:
2382 .Bl -column YXZ description
2383 .It G Ta file was merged
2384 .It C Ta file was merged and conflicts occurred during merge
2385 .It ! Ta changes destined for a missing file were not merged
2386 .It D Ta file was deleted
2387 .It d Ta file's deletion was prevented by local modifications
2388 .It A Ta new file was added
2389 .It \(a~ Ta changes destined for a non-regular file were not merged
2390 .It ? Ta changes destined for an unversioned file were not merged
2393 If merge conflicts occur, the histedit operation is interrupted and may
2394 be continued once conflicts have been resolved.
2395 If any files with destined changes are found to be missing or unversioned,
2396 or if files could not be deleted due to differences in deleted content,
2397 the histedit operation will be interrupted to prevent potentially incomplete
2398 changes from being committed to the repository without user intervention.
2399 The work tree may be modified as desired and the histedit operation can be
2400 continued once the changes present in the work tree are considered complete.
2401 Alternatively, the histedit operation may be aborted which will leave
2402 the work tree switched back to its original branch.
2404 If a merge conflict is resolved in a way which renders the merged
2405 change into a no-op change, the corresponding commit will be elided
2406 when the histedit operation continues.
2409 will refuse to run if certain preconditions are not met.
2410 If the work tree's current branch is not in the
2412 reference namespace, the history of the branch may not be edited.
2413 If the work tree contains multiple base commits, it must first be updated
2414 to a single base commit with
2416 If changes have been staged with
2418 these changes must first be committed with
2422 If the work tree contains local changes, these changes must first be
2427 If the edited history contains changes to files outside of the work tree's
2428 path prefix, the work tree cannot be used to edit the history of this branch.
2436 commands will refuse to run while a histedit operation is in progress.
2437 Other commands which manipulate the work tree may be used, and the
2439 command may be used to commit arbitrary changes to the temporary branch
2440 while the histedit operation is interrupted.
2447 Abort an interrupted histedit operation.
2448 If this option is used, no other command-line arguments are allowed.
2450 Continue an interrupted histedit operation.
2451 If this option is used, no other command-line arguments are allowed.
2453 Interrupt the histedit operation for editing after merging each commit.
2454 This option is a quick equivalent to a histedit script which uses the
2456 command for all commits.
2459 option can only be used when starting a new histedit operation.
2460 If this option is used, no other command-line arguments are allowed.
2461 .It Fl F Ar histedit-script
2464 instead of opening a temporary file in an editor where a histedit script
2467 Fold all commits into a single commit.
2468 This option is a quick equivalent to a histedit script which folds all
2469 commits, combining them all into one commit.
2472 option can only be used when starting a new histedit operation.
2473 If this option is used, no other command-line arguments are allowed.
2475 Show a list of past histedit operations, represented by references in the
2476 .Dq refs/got/backup/histedit
2477 reference namespace.
2479 Display the author, date, and log message of each backed up commit,
2480 the object ID of the corresponding post-histedit commit, and
2481 the object ID of their common ancestor commit.
2482 Given these object IDs,
2489 options can be used to examine the history of either version of the branch,
2494 option can be used to create a new branch from a pre-histedit state if desired.
2498 is specified, only show commits which at some point in time represented this
2500 Otherwise, list all backed up commits for any branches.
2502 If this option is used,
2504 does not require a work tree.
2505 None of the other options can be used together with
2508 Edit log messages only.
2509 This option is a quick equivalent to a histedit script which edits
2510 only log messages but otherwise leaves every picked commit as-is.
2513 option can only be used when starting a new histedit operation.
2514 If this option is used, no other command-line arguments are allowed.
2516 Delete backups created by past histedit operations, represented by references
2518 .Dq refs/got/backup/histedit
2519 reference namespace.
2523 is specified, only delete backups which at some point in time represented
2525 Otherwise, delete all references found within
2526 .Dq refs/got/backup/histedit .
2528 Any commit, tree, tag, and blob objects belonging to deleted backups
2529 remain in the repository and may be removed separately with
2530 Git's garbage collector or
2531 .Cm gotadmin cleanup .
2533 If this option is used,
2535 does not require a work tree.
2536 None of the other options can be used together with
2540 .It Cm integrate Ar branch
2542 Integrate the specified
2544 into the work tree's current branch.
2545 Files in the work tree are updated to match the contents on the integrated
2547 and the reference of the work tree's branch is changed to point at the
2548 head commit of the integrated
2551 Both branches can be considered equivalent after integration since they
2552 will be pointing at the same commit.
2553 Both branches remain available for future work, if desired.
2554 In case the integrated
2556 is no longer needed it may be deleted with
2559 Show the status of each affected file, using the following status codes:
2560 .Bl -column YXZ description
2561 .It U Ta file was updated
2562 .It D Ta file was deleted
2563 .It A Ta new file was added
2564 .It \(a~ Ta versioned file is obstructed by a non-regular file
2565 .It ! Ta a missing versioned file was restored
2569 will refuse to run if certain preconditions are not met.
2570 Most importantly, the
2572 must have been rebased onto the work tree's current branch with
2574 before it can be integrated, in order to linearize commit history and
2575 resolve merge conflicts.
2576 If the work tree contains multiple base commits, it must first be updated
2577 to a single base commit with
2579 If changes have been staged with
2581 these changes must first be committed with
2585 If the work tree contains local changes, these changes must first be
2597 Create a merge commit based on the current branch of the work tree and
2600 If a linear project history is desired, then use of
2602 should be preferred over
2604 However, even strictly linear projects may require merge commits in order
2605 to merge in new versions of third-party code stored on vendor branches
2609 Merge commits are commits based on multiple parent commits.
2610 The tip commit of the work tree's current branch, which must be set with
2614 operation, will be used as the first parent.
2615 The tip commit of the specified
2617 will be used as the second parent.
2619 No ancestral relationship between the two branches is required.
2620 If the two branches have already been merged previously, only new changes
2623 It is not possible to create merge commits with more than two parents.
2624 If more than one branch needs to be merged, then multiple merge commits
2625 with two parents each can be created in sequence.
2627 While merging changes found on the
2629 into the work tree, show the status of each affected file,
2630 using the following status codes:
2631 .Bl -column YXZ description
2632 .It G Ta file was merged
2633 .It C Ta file was merged and conflicts occurred during merge
2634 .It ! Ta changes destined for a missing file were not merged
2635 .It D Ta file was deleted
2636 .It d Ta file's deletion was prevented by local modifications
2637 .It A Ta new file was added
2638 .It \(a~ Ta changes destined for a non-regular file were not merged
2639 .It ? Ta changes destined for an unversioned file were not merged
2642 If merge conflicts occur, the merge operation is interrupted and conflicts
2643 must be resolved before the merge operation can continue.
2644 If any files with destined changes are found to be missing or unversioned,
2645 or if files could not be deleted due to differences in deleted content,
2646 the merge operation will be interrupted to prevent potentially incomplete
2647 changes from being committed to the repository without user intervention.
2648 The work tree may be modified as desired and the merge can be continued
2649 once the changes present in the work tree are considered complete.
2650 Alternatively, the merge operation may be aborted which will leave
2651 the work tree's current branch unmodified.
2653 If a merge conflict is resolved in a way which renders all merged
2654 changes into no-op changes, the merge operation cannot continue
2655 and must be aborted.
2658 will refuse to run if certain preconditions are not met.
2661 is based on the work tree's current branch, then no merge commit can
2664 may be used to integrate the
2667 If the work tree is not yet fully updated to the tip commit of its
2668 branch, then the work tree must first be updated with
2670 If the work tree contains multiple base commits, it must first be updated
2671 to a single base commit with
2673 If changes have been staged with
2675 these changes must first be committed with
2679 If the work tree contains local changes, these changes must first be
2686 contains changes to files outside of the work tree's path prefix,
2687 the work tree cannot be used to merge this branch.
2697 commands will refuse to run while a merge operation is in progress.
2698 Other commands which manipulate the work tree may be used for
2699 conflict resolution purposes.
2706 Abort an interrupted merge operation.
2707 If this option is used, no other command-line arguments are allowed.
2709 Continue an interrupted merge operation.
2710 If this option is used, no other command-line arguments are allowed.
2712 Merge changes into the work tree as usual but do not create a merge
2714 The merge result can be adjusted as desired before a merge commit is
2717 Alternatively, the merge may be aborted with
2724 .Op Fl F Ar response-script
2728 Stage local changes for inclusion in the next commit.
2731 is specified, stage all changes in the work tree.
2732 Otherwise, stage changes at or within the specified paths.
2733 Paths may be staged if they are added, modified, or deleted according to
2736 Show the status of each affected file, using the following status codes:
2737 .Bl -column YXZ description
2738 .It A Ta file addition has been staged
2739 .It M Ta file modification has been staged
2740 .It D Ta file deletion has been staged
2743 Staged file contents are saved in newly created blob objects in the repository.
2744 These blobs will be referred to by tree objects once staged changes have been
2747 Staged changes affect the behaviour of
2752 While paths with staged changes exist, the
2754 command will refuse to commit any paths which do not have staged changes.
2755 Local changes created on top of staged changes can only be committed if
2756 the path is staged again, or if the staged changes are committed first.
2759 command will show both local changes and staged changes.
2762 command is able to display local changes relative to staged changes,
2763 and to display staged changes relative to the repository.
2766 command cannot revert staged changes but may be used to revert
2767 local changes created on top of staged changes.
2773 .It Fl F Ar response-script
2781 responses line-by-line from the specified
2783 file instead of prompting interactively.
2785 Instead of staging new changes, list paths which are already staged,
2786 along with the IDs of staged blob objects and stage status codes.
2787 If paths were provided on the command line, show the staged paths
2788 among the specified paths.
2789 Otherwise, show all staged paths.
2791 Instead of staging the entire content of a changed file, interactively
2792 select or reject changes for staging based on
2796 (reject change), and
2798 (quit staging this file) responses.
2799 If a file is in modified status, individual patches derived from the
2800 modified file content can be staged.
2801 Files in added or deleted status may only be staged or rejected in
2804 Allow staging of symbolic links which point outside of the path space
2805 that is under version control.
2808 will reject such symbolic links due to safety concerns.
2811 may decide to represent such a symbolic link as a regular file which contains
2812 the link's target path, rather than creating an actual symbolic link which
2813 points outside of the work tree.
2814 Use of this option is discouraged because external mechanisms such as
2816 are better suited for managing symbolic links to paths not under
2821 will refuse to run if certain preconditions are not met.
2822 If a file contains merge conflicts, these conflicts must be resolved first.
2823 If a file is found to be out of date relative to the head commit on the
2824 work tree's current branch, the file must be updated with
2826 before it can be staged (however, this does not prevent the file from
2827 becoming out-of-date at some point after having been staged).
2834 commands will refuse to run while staged changes exist.
2835 If staged changes cannot be committed because a staged path
2836 is out of date, the path must be unstaged with
2838 before it can be updated with
2840 and may then be staged again if necessary.
2845 .Op Fl F Ar response-script
2849 Merge staged changes back into the work tree and put affected paths
2850 back into non-staged status.
2853 is specified, unstage all staged changes across the entire work tree.
2854 Otherwise, unstage changes at or within the specified paths.
2856 Show the status of each affected file, using the following status codes:
2857 .Bl -column YXZ description
2858 .It G Ta file was unstaged
2859 .It C Ta file was unstaged and conflicts occurred during merge
2860 .It ! Ta changes destined for a missing file were not merged
2861 .It D Ta file was staged as deleted and still is deleted
2862 .It d Ta file's deletion was prevented by local modifications
2863 .It \(a~ Ta changes destined for a non-regular file were not merged
2870 .It Fl F Ar response-script
2878 responses line-by-line from the specified
2880 file instead of prompting interactively.
2882 Instead of unstaging the entire content of a changed file, interactively
2883 select or reject changes for unstaging based on
2887 (keep change staged), and
2889 (quit unstaging this file) responses.
2890 If a file is staged in modified status, individual patches derived from the
2891 staged file content can be unstaged.
2892 Files staged in added or deleted status may only be unstaged in their entirety.
2898 .Op Fl r Ar repository-path
2901 Parse and print contents of objects to standard output in a line-based
2903 Content of commit, tree, and tag objects is printed in a way similar
2904 to the actual content stored in such objects.
2905 Blob object contents are printed as they would appear in files on disk.
2907 Attempt to interpret each argument as a reference, a tag name, or
2908 an object ID SHA1 hash.
2909 References will be resolved to an object ID.
2910 Tag names will resolved to a tag object.
2911 An abbreviated hash argument will be expanded to a full SHA1 hash
2912 automatically, provided the abbreviation is unique.
2914 If none of the above interpretations produce a valid result, or if the
2916 option is used, attempt to interpret the argument as a path which will
2917 be resolved to the ID of an object found at this path in the repository.
2924 Look up paths in the specified
2926 If this option is not used, paths are looked up in the commit resolved
2927 via the repository's HEAD reference.
2928 The expected argument is a commit ID SHA1 hash or an existing reference
2929 or tag name which will be resolved to a commit ID.
2930 An abbreviated hash argument will be expanded to a full SHA1 hash
2931 automatically, provided the abbreviation is unique.
2933 Interpret all arguments as paths only.
2934 This option can be used to resolve ambiguity in cases where paths
2935 look like tag names, reference names, or object IDs.
2936 .It Fl r Ar repository-path
2937 Use the repository at the specified path.
2938 If not specified, assume the repository is located at or above the current
2940 If this directory is a
2942 work tree, use the repository path associated with this work tree.
2944 .It Cm info Op Ar path ...
2945 Display meta-data stored in a work tree.
2950 The work tree to use is resolved implicitly by walking upwards from the
2951 current working directory.
2955 arguments are specified, show additional per-file information for tracked
2956 files located at or within these paths.
2959 argument corresponds to the work tree's root directory, display information
2960 for all tracked files.
2963 .Bl -tag -width GOT_IGNORE_GITCONFIG
2965 The author's name and email address, such as
2966 .Dq An Flan Hacker Aq Mt flan_hacker@openbsd.org .
2976 may fail to parse commits without an email address in author data,
2980 environment variables with a missing email address.
2982 .Ev GOT_AUTHOR will be overridden by configuration settings in
2988 configuration settings in the repository's
2995 configuration settings contained in Git's global
2997 configuration file will only be used if neither
3001 environment variable provide author information.
3002 .It Ev GOT_IGNORE_GITCONFIG
3003 If this variable is set then any remote repository definitions or author
3004 information found in Git configuration files will be ignored.
3005 .It Ev GOT_LOG_DEFAULT_LIMIT
3006 The default limit on the number of commits traversed by
3008 If set to zero, the limit is unbounded.
3009 This variable will be silently ignored if it is set to a non-numeric value.
3010 .It Ev VISUAL , EDITOR
3011 The editor spawned by
3019 text editor will be spawned in order to give
3021 the attention it deserves.
3024 .Bl -tag -width packed-refs -compact
3026 Repository-wide configuration settings for
3030 configuration file located in the root directory of a Git repository
3031 supersedes any relevant settings in Git's
3035 .It Pa .got/got.conf
3036 Worktree-specific configuration settings for
3040 configuration file in the
3042 meta-data directory of a work tree supersedes any relevant settings in
3045 configuration file and Git's
3052 Enable tab-completion of
3057 .Dl $ set -A complete_got_1 -- $(got -h 2>&1 | sed -n s/commands://p)
3059 Clone an existing Git repository for use with
3063 .Dl $ got clone ssh://git@github.com/openbsd/src.git
3065 Use of HTTP URLs currently requires
3069 .Dl $ git clone --bare https://github.com/openbsd/src.git
3071 Alternatively, for quick and dirty local testing of
3073 a new Git repository could be created and populated with files,
3074 e.g. from a temporary CVS checkout located at
3077 .Dl $ gotadmin init /var/git/src.git
3078 .Dl $ got import -r /var/git/src.git -I CVS -I obj /tmp/src
3080 Check out a work tree from the Git repository to /usr/src:
3082 .Dl $ got checkout /var/git/src.git /usr/src
3084 View local changes in a work tree directory:
3086 .Dl $ got diff | less
3088 In a work tree, display files in a potentially problematic state:
3090 .Dl $ got status -s 'C!~?'
3092 Interactively revert selected local changes in a work tree directory:
3094 .Dl $ got revert -p -R\ .
3096 In a work tree or a git repository directory, list all branch references:
3100 As above, but list the most recently modified branches only:
3102 .Dl $ got branch -lt | head
3104 In a work tree or a git repository directory, create a new branch called
3105 .Dq unified-buffer-cache
3106 which is forked off the
3110 .Dl $ got branch -c master unified-buffer-cache
3112 Switch an existing work tree to the branch
3113 .Dq unified-buffer-cache .
3114 Local changes in the work tree will be preserved and merged if necessary:
3116 .Dl $ got update -b unified-buffer-cache
3118 Create a new commit from local changes in a work tree directory.
3119 This new commit will become the head commit of the work tree's current branch:
3123 In a work tree or a git repository directory, view changes committed in
3124 the 3 most recent commits to the work tree's branch, or the branch resolved
3125 via the repository's HEAD reference, respectively:
3127 .Dl $ got log -p -l 3
3129 As above, but display changes in the order in which
3131 could apply them in sequence:
3133 .Dl $ got log -p -l 3 -R
3135 In a work tree or a git repository directory, log the history of a subdirectory:
3137 .Dl $ got log sys/uvm
3139 While operating inside a work tree, paths are specified relative to the current
3140 working directory, so this command will log the subdirectory
3143 .Dl $ cd sys/uvm && got log\ .
3145 And this command has the same effect:
3147 .Dl $ cd sys/dev/usb && got log ../../uvm
3149 And this command displays work tree meta-data about all tracked files:
3152 .Dl $ got info\ . | less
3154 Add new files and remove obsolete files in a work tree directory:
3156 .Dl $ got add sys/uvm/uvm_ubc.c
3157 .Dl $ got remove sys/uvm/uvm_vnode.c
3159 Create a new commit from local changes in a work tree directory
3160 with a pre-defined log message.
3162 .Dl $ got commit -m 'unify the buffer cache'
3164 Alternatively, create a new commit from local changes in a work tree
3165 directory with a log message that has been prepared in the file
3168 .Dl $ got commit -F /tmp/msg
3170 Update any work tree checked out from the
3171 .Dq unified-buffer-cache
3172 branch to the latest commit on this branch:
3176 Roll file content on the unified-buffer-cache branch back by one commit,
3177 and then fetch the rolled-back change into the work tree as a local change
3178 to be amended and perhaps committed again:
3180 .Dl $ got backout unified-buffer-cache
3181 .Dl $ got commit -m 'roll back previous'
3182 .Dl $ # now back out the previous backout :-)
3183 .Dl $ got backout unified-buffer-cache
3185 Fetch new changes on the remote repository's
3187 branch, making them visible on the local repository's
3194 In a repository created with a HTTP URL and
3195 .Cm git clone --bare
3198 command must be used instead:
3200 .Dl $ cd /var/git/src.git
3201 .Dl $ git fetch origin master:refs/remotes/origin/master
3205 branch to merge the new changes that are now visible on the
3210 .Dl $ got update -b origin/master
3211 .Dl $ got rebase master
3214 .Dq unified-buffer-cache
3215 branch on top of the new head commit of the
3219 .Dl $ got update -b master
3220 .Dl $ got rebase unified-buffer-cache
3222 Create a patch from all changes on the unified-buffer-cache branch.
3223 The patch can be mailed out for review and applied to
3227 .Dl $ got diff master unified-buffer-cache > /tmp/ubc.diff
3229 Edit the entire commit history of the
3230 .Dq unified-buffer-cache
3233 .Dl $ got update -b unified-buffer-cache
3234 .Dl $ got update -c master
3237 Before working against existing branches in a repository cloned with
3238 .Cm git clone --bare
3243 must be configured to map all references in the remote repository
3246 namespace of the local repository.
3247 This can be achieved by setting Git's
3248 .Pa remote.origin.fetch
3249 configuration variable to the value
3250 .Dq +refs/heads/*:refs/remotes/origin/*
3255 .Dl $ cd /var/git/repo
3256 .Dl $ git config remote.origin.fetch '+refs/heads/*:refs/remotes/origin/*'
3260 option must be disabled:
3262 .Dl $ cd /var/git/repo
3263 .Dl $ git config remote.origin.mirror false
3265 Alternatively, the following
3267 configuration item can be added manually to the Git repository's
3271 .Dl [remote \&"origin\&"]
3273 .Dl fetch = +refs/heads/*:refs/remotes/origin/*
3276 This configuration leaves the local repository's
3278 namespace free for use by local branches checked out with
3280 and, if needed, created with
3283 .Dq refs/remotes/origin
3284 namespace can now be updated with incoming changes from the remote
3289 without extra command line arguments.
3290 Newly fetched changes can be examined with
3293 Display changes on the remote repository's version of the
3295 branch, as of the last time
3299 .Dl $ got log -c origin/master | less
3301 As shown here, most commands accept abbreviated reference names such as
3304 .Dq refs/remotes/origin/master .
3305 The latter is only needed in case of ambiguity.
3308 must be used to merge changes which are visible on the
3313 This will also merge local changes, if any, with the incoming changes:
3315 .Dl $ got update -b origin/master
3316 .Dl $ got rebase master
3318 In order to make changes committed to the
3319 .Dq unified-buffer-cache
3323 .Dq unified-buffer-cache
3324 branch must first be rebased onto the
3328 .Dl $ got update -b master
3329 .Dl $ got rebase unified-buffer-cache
3332 .Dq unified-buffer-cache
3333 branch can now be made visible on the
3337 Because the rebase operation switched the work tree to the
3338 .Dq unified-buffer-cache
3339 branch, the work tree must be switched back to the
3343 .Dl $ got update -b master
3344 .Dl $ got integrate unified-buffer-cache
3348 branch, log messages for local changes can now be amended with
3350 by other developers and any other important new information:
3352 .Dl $ got update -c origin/master
3353 .Dl $ got histedit -m
3355 If the remote repository offers write access, local changes on the
3357 branch can be sent to the remote repository with
3361 can be run without further arguments.
3362 The arguments shown here match defaults, provided the work tree's
3363 current branch is the
3367 .Dl $ got send -b master origin
3369 If the remote repository requires the HTTPS protocol, the
3371 command must be used instead:
3373 .Dl $ cd /var/git/src.git
3374 .Dl $ git push origin master
3376 When making contributions to projects which use the
3378 workflow, SSH protocol repository access needs to be set up first.
3379 Once an account has been created on a Git hosting site it should
3380 be possible to upload a public SSH key for repository access
3385 workflow will usually involve two remote repositories.
3386 In the real-life example below, the
3388 repository was forked from the
3390 repository by using the Git hosting site's web interface.
3393 file in the local repository describes both remote repositories:
3394 .Bd -literal -offset indent
3395 # Jelmers's repository, which accepts pull requests
3397 server git@github.com
3399 repository "/jelmer/dulwich"
3403 # Stefan's fork, used as the default remote repository
3405 server git@github.com
3407 repository "/stspdotname/dulwich"
3412 With this configuration, Stefan can create commits on
3413 .Dq refs/heads/master
3414 and send them to the
3416 repository by running:
3418 .Dl $ got send -b master origin
3420 The changes can now be proposed to Jelmer by opening a pull request
3421 via the Git hosting site's web interface.
3422 If Jelmer requests further changes to be made, additional commits
3423 can be created on the
3425 branch and be added to the pull request by running
3429 If Jelmer prefers additional commits to be
3431 then the following commands can be used to achieve this:
3433 .Dl $ got update -b master
3434 .Dl $ got update -c origin/master
3435 .Dl $ got histedit -f
3436 .Dl $ got send -f -b master origin
3438 Once Jelmer has accepted the pull request, Stefan can fetch the
3439 merged changes, and possibly several other new changes, by running:
3441 .Dl $ got fetch upstream
3443 The merged changes will now be visible under the reference
3444 .Dq refs/remotes/upstream/master .
3447 branch can now be rebased on top of the latest changes
3450 .Dl $ got update -b upstream/master
3451 .Dl $ got rebase master
3453 As a final step, the forked repository's copy of the master branch needs
3454 to be kept in sync by sending the new changes there:
3456 .Dl $ got send -f -b master origin
3458 If multiple pull requests need to be managed in parallel, a separate branch
3459 must be created for each pull request with
3461 Each such branch can then be used as above, in place of
3462 .Dq refs/heads/master .
3463 Changes for any accepted pull requests will still appear under
3464 .Dq refs/remotes/upstream/master,
3465 regardless of which branch was used in the forked repository to
3466 create a pull request.
3470 .Xr git-repository 5 ,
3471 .Xr got-worktree 5 ,
3475 .An Anthony J. Bentley Aq Mt bentley@openbsd.org
3476 .An Christian Weisgerber Aq Mt naddy@openbsd.org
3477 .An Hiltjo Posthuma Aq Mt hiltjo@codemadness.org
3478 .An Josh Rickmar Aq Mt jrick@zettaport.com
3479 .An Joshua Stein Aq Mt jcs@openbsd.org
3480 .An Klemens Nanni Aq Mt kn@openbsd.org
3481 .An Martin Pieuchot Aq Mt mpi@openbsd.org
3482 .An Neels Hofmeyr Aq Mt neels@hofmeyr.de
3483 .An Omar Polo Aq Mt op@openbsd.org
3484 .An Ori Bernstein Aq Mt ori@openbsd.org
3485 .An Sebastien Marie Aq Mt semarie@openbsd.org
3486 .An Stefan Sperling Aq Mt stsp@openbsd.org
3487 .An Steven McDonald Aq Mt steven@steven-mcdonald.id.au
3488 .An Theo Buehler Aq Mt tb@openbsd.org
3489 .An Thomas Adam Aq Mt thomas@xteddy.org
3490 .An Tracey Emery Aq Mt tracey@traceyemery.net
3491 .An Yang Zhong Aq Mt yzhong@freebsdfoundation.org
3498 were derived from code under copyright by:
3500 .An Caldera International
3501 .An Daniel Hartmeier
3506 .An Jean-Francois Brousseau
3512 .An Niklas Hallqvist
3517 .An Xavier Santolaria
3520 contains code contributed to the public domain by
3521 .An Austin Appleby .
3524 is a work-in-progress and some features remain to be implemented.
3526 At present, the user has to fall back on
3528 to perform some tasks.
3532 Reading from remote repositories over HTTP or HTTPS protocols requires
3537 Writing to remote repositories over HTTP or HTTPS protocols requires
3540 The creation of merge commits with more than two parent commits requires
3543 In situations where files or directories were moved around
3545 will not automatically merge changes to new locations and
3547 will usually produce better results.
