2 .\" Copyright (c) 2017 Martin Pieuchot
3 .\" Copyright (c) 2018, 2019, 2020 Stefan Sperling
5 .\" Permission to use, copy, modify, and distribute this software for any
6 .\" purpose with or without fee is hereby granted, provided that the above
7 .\" copyright notice and this permission notice appear in all copies.
9 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
30 is a version control system which stores the history of tracked files
31 in a Git repository, as used by the Git version control system.
32 This repository format is described in
33 .Xr git-repository 5 .
38 version control system because every copy of a repository is writeable.
39 Modifications made to files can be synchronized between repositories
44 must be checked out from the repository for modification.
45 Checked out files are stored in a
47 which can be placed at an arbitrary directory in the filesystem hierarchy.
48 The on-disk format of this work tree is described in
52 provides global and command-specific options.
53 Global options must precede the command name, and are as follows:
54 .Bl -tag -width tenletters
56 Display usage information and exit immediately.
58 Display program version and exit immediately.
64 .Bl -tag -width checkout
71 .Op Fl r Ar repository-path
75 Create an initial commit in a repository from the file hierarchy
78 The created commit will not have any parent commits, i.e. it will be a
80 Also create a new reference which provides a branch name for the newly
82 Show the path of each imported file to indicate progress.
88 environment variable to be set,
89 unless an author has been configured in
95 configuration settings can be obtained from the repository's
97 file or from Git's global
108 If this option is not specified, a branch corresponding to the repository's
109 HEAD reference will be used.
110 Use of this option is required if the branch resolved via the repository's
111 HEAD reference already exists.
113 Ignore files or directories with a name which matches the specified
115 This option may be specified multiple times to build a list of ignore patterns.
118 follows the globbing rules documented in
120 Ignore patterns which end with a slash,
122 will only match directories.
124 Use the specified log message when creating the new commit.
129 opens a temporary file in an editor where a log message can be written.
130 Quitting the editor without saving the file will abort the import operation.
131 .It Fl r Ar repository-path
132 Use the repository at the specified path.
133 If not specified, assume the repository is located at or above the current
141 .Op Fl R Ar reference
146 Clone a Git repository at the specified
152 is specified, the directory name will be derived from the name of the
155 will refuse to run if the
161 specifies a protocol scheme, a server hostname, an optional port number
162 separated from the hostname by a colon, and a path to the repository on
164 .Lk scheme://hostname:port/path/to/repository
166 The following protocol schemes are supported:
167 .Bl -tag -width git+ssh
169 The Git protocol as implemented by the
172 Use of this protocol is discouraged since it supports neither authentication
175 The Git protocol wrapped in an authenticated and encrypted
178 With this protocol the hostname may contain an embedded username for
183 Short alias for git+ssh.
186 Objects in the cloned repository are stored in a pack file which is downloaded
188 This pack file will then be indexed to facilitate access to the objects stored
190 If any objects in the pack file are stored in deltified form, all deltas will
191 be fully resolved in order to compute the ID of such objects.
192 This can take some time.
193 More details about the pack file format are documented in
194 .Xr git-repository 5 .
197 creates a remote repository entry in the
201 files of the cloned repository to store the
207 arguments for future use by
217 Fetch all branches from the remote repository's
219 reference namespace and set
220 .Cm fetch_all_branches
221 in the cloned repository's
223 file for future use by
225 If this option is not specified, a branch resolved via the remote
226 repository's HEAD reference will be fetched.
227 Cannot be used together with the
233 from the remote repository's
236 This option may be specified multiple times to build a list of branches
238 If the branch corresponding to the remote repository's HEAD reference is not
239 in this list, the cloned repository's HEAD reference will be set to the first
240 branch which was fetched.
241 If this option is not specified, a branch resolved via the remote
242 repository's HEAD reference will be fetched.
243 Cannot be used together with the
247 List branches and tags available for fetching from the remote repository
248 and exit immediately.
249 Cannot be used together with any of the other options except
254 Create the cloned repository as a mirror of the original repository.
255 This is useful if the cloned repository will not be used to store
256 locally created commits.
262 files will be set up with the
264 option enabled, such that
268 will write incoming changes directly to branches in the
270 reference namespace, rather than to branches in the
273 This avoids the usual requirement of having to run
279 in order to make incoming changes appear on branches in the
282 But maintaining custom changes in the cloned repository becomes difficult
283 since such changes will be at risk of being discarded whenever incoming
286 Suppress progress reporting output.
287 The same option will be passed to
290 .It Fl R Ar reference
291 In addition to the branches and tags that will be fetched, fetch an arbitrary
293 from the remote repository's
296 This option may be specified multiple times to build a list of additional
300 may either be a path to a specific reference, or a reference namespace
301 which will cause all references in this namespace to be fetched.
303 Each reference will be mapped into the cloned repository's
305 namespace, unless the
307 option is used to mirror references directly into the cloned repository's
312 will refuse to fetch references from the remote repository's
321 to print debugging messages to standard error output.
322 This option will be passed to
325 Multiple -v options increase the verbosity.
333 .Op Fl R Ar reference
334 .Op Fl r Ar repository-path
335 .Op Ar remote-repository
338 Fetch new changes from a remote repository.
340 .Ar remote-repository
344 The remote repository's URL is obtained from the corresponding entry in
348 file of the local repository, as created by
351 By default, any branches configured in
354 .Ar remote-repository
358 is invoked in a work tree then this work tree's current branch will be
359 fetched, too, provided it is present on the server.
360 If no branches to fetch can be found in
362 or via a work tree, or said branches are not found on the server, a branch
363 resolved via the remote repository's HEAD reference will be fetched.
364 Likewise, if a HEAD reference for the
365 .Ar remote-repository
366 exists but its target no longer matches the remote HEAD, then
367 the new target branch will be fetched.
368 This default behaviour can be overridden with the
374 New changes will be stored in a separate pack file downloaded from the server.
375 Optionally, separate pack files stored in the repository can be combined with
378 By default, branch references in the
380 reference namespace will be updated to point at the newly fetched commits.
385 command can then be used to make new changes visible on branches in the
387 namespace, merging incoming changes with the changes on those branches
390 If the repository was created as a mirror with
392 then all branches in the
394 namespace will be updated directly to match the corresponding branches in
395 the remote repository.
396 If those branches contained local commits, these commits will no longer be
397 reachable via a reference and will therefore be at risk of being discarded
398 by Git's garbage collector or
399 .Cm gotadmin cleanup .
400 Maintaining custom changes in a mirror repository is therefore discouraged.
402 In any case, references in the
404 namespace will always be fetched and mapped directly to local references
405 in the same namespace.
412 Fetch all branches from the remote repository's
415 This option can be enabled by default for specific repositories in
417 Cannot be used together with the
423 from the remote repository's
426 This option may be specified multiple times to build a list of branches
428 Cannot be used together with the
432 Delete branches and tags from the local repository which are no longer
433 present in the remote repository.
434 Only references are deleted.
435 Any commit, tree, tag, and blob objects belonging to deleted branches or
436 tags remain in the repository and may be removed separately with
437 Git's garbage collector or
438 .Cm gotadmin cleanup .
440 List branches and tags available for fetching from the remote repository
441 and exit immediately.
442 Cannot be used together with any of the other options except
448 Suppress progress reporting output.
449 The same option will be passed to
452 .It Fl R Ar reference
453 In addition to the branches and tags that will be fetched, fetch an arbitrary
455 from the remote repository's
458 This option may be specified multiple times to build a list of additional
462 may either be a path to a specific reference, or a reference namespace
463 which will cause all references in this namespace to be fetched.
465 Each reference will be mapped into the local repository's
467 namespace, unless the local repository was created as a mirror with
469 in which case references will be mapped directly into the local repository's
473 Once a reference has been fetched, a branch based on it can be created with
478 will refuse to fetch references from the remote repository's
483 .It Fl r Ar repository-path
484 Use the repository at the specified path.
485 If not specified, assume the repository is located at or above the current
487 If this directory is a
489 work tree, use the repository path associated with this work tree.
491 Allow existing references in the
493 namespace to be updated if they have changed on the server.
494 If not specified, only new tag references will be created.
499 to print debugging messages to standard error output.
500 The same option will be passed to
503 Multiple -v options increase the verbosity.
506 Delete all references which correspond to a particular
507 .Ar remote-repository
508 instead of fetching new changes.
509 This can be useful when a remote repository is being removed from
515 .Ar remote-repository
516 argument is mandatory and no other options except
523 Only references are deleted.
524 Any commit, tree, tag, and blob objects fetched from a remote repository
525 will generally be stored in pack files and may be removed separately with
527 and Git's garbage collector.
535 .Op Fl p Ar path-prefix
537 .Op Ar work-tree-path
540 Copy files from a repository into a new work tree.
541 Show the status of each affected file, using the following status codes:
542 .Bl -column YXZ description
543 .It A Ta new file was added
544 .It E Ta file already exists in work tree's meta-data
549 is not specified, either use the last component of
550 .Ar repository path ,
553 was specified use the last component of
561 Check out files from a commit on the specified
563 If this option is not specified, a branch resolved via the repository's HEAD
564 reference will be used.
566 Check out files from the specified
568 on the selected branch.
569 If this option is not specified, the most recent commit on the selected
574 argument is a commit ID SHA1 hash or an existing reference
575 or tag name which will be resolved to a commit ID.
576 An abbreviated hash argument will be expanded to a full SHA1 hash
577 automatically, provided the abbreviation is unique.
585 can also be used, with both resolving to the
586 repository's HEAD reference, or, if the
588 option is used, the head of the checked-out
590 Keywords and reference names may be appended with
594 modifiers and an optional integer N to denote the
595 Nth descendant or antecedent by first parent traversal, respectively;
598 denotes the work tree branch head's 2nd generation ancestor, and
600 will denote the 3rd generation ancestor of the commit resolved by the
603 If an integer does not follow the
609 is implicitly appended
618 is not contained in the selected branch, a different branch which contains
619 this commit must be specified with the
622 If no such branch is known, a new branch must be created for this
628 Checking out work trees with an unknown branch is intentionally not supported.
630 Proceed with the checkout operation even if the directory at
633 Existing files will be left intact.
634 .It Fl p Ar path-prefix
635 Restrict the work tree to a subset of the repository's tree hierarchy.
636 Only files beneath the specified
640 Silence progress output.
651 Update an existing work tree to a different
653 Change existing files in the work tree as necessary to match file contents
655 Preserve any local changes in the work tree and merge them with the
658 Files which already contain merge conflicts will not be updated to avoid
659 further complications.
660 Such files will be updated when
662 is run again after merge conflicts have been resolved.
663 If the conflicting changes are no longer needed, affected files can be
670 Show the status of each affected file, using the following status codes:
671 .Bl -column YXZ description
672 .It U Ta file was updated and contained no local changes
673 .It G Ta file was updated and local changes were merged cleanly
674 .It C Ta file was updated and conflicts occurred during merge
675 .It D Ta file was deleted
676 .It d Ta file's deletion was prevented by local modifications
677 .It A Ta new file was added
678 .It \(a~ Ta versioned file is obstructed by a non-regular file
679 .It ! Ta a missing versioned file was restored
680 .It # Ta file was not updated because it contains merge conflicts
681 .It ? Ta changes destined for an unversioned file were not merged
686 is specified, update the entire work tree.
687 Otherwise, restrict the update operation to files at or within the
689 Each path is required to exist in the update operation's target commit.
690 Files in the work tree outside specified paths will remain unchanged and
691 will retain their previously recorded base commit.
694 commands may refuse to run while the work tree contains files from
695 multiple base commits.
696 The base commit of such a work tree can be made consistent by running
698 across the entire work tree.
701 is incompatible with the
706 cannot update paths with staged changes.
707 If changes have been staged with
709 these changes must first be committed with
719 Switch the work tree's branch reference to the specified
721 before updating the work tree.
722 This option requires that all paths in the work tree are updated.
724 As usual, any local changes in the work tree will be preserved.
725 This can be useful when switching to a newly created branch in order
726 to commit existing local changes to this branch.
728 Any local changes must be dealt with separately in order to obtain a
729 work tree with pristine file contents corresponding exactly to the specified
731 Such changes could first be committed to a different branch with
733 or could be discarded with
736 Update the work tree to the specified
738 If this option is not specified, the most recent commit on the work tree's
743 argument is a commit ID SHA1 hash or an existing reference
744 or tag name which will be resolved to a commit ID.
745 An abbreviated hash argument will be expanded to a full SHA1 hash
746 automatically, provided the abbreviation is unique.
754 can also be used to represent the work tree's base commit
755 and branch head, respectively.
756 Keywords and reference names may be appended with
760 modifiers and an optional integer N to denote the
761 Nth descendant or antecedent, respectively, by first parent traversal;
764 denotes the work tree branch head's 2nd generation ancestor, and
766 denotes the 4th generation descendant of the work tree's base commit.
769 will denote the 3rd generation ancestor of the commit resolved by the
772 If an integer does not follow the
778 is implicitly appended
785 Silence progress output.
791 .Op Fl S Ar status-codes
792 .Op Fl s Ar status-codes
796 Show the current modification status of files in a work tree,
797 using the following status codes:
798 .Bl -column YXZ description
799 .It M Ta modified file
800 .It A Ta file scheduled for addition in next commit
801 .It D Ta file scheduled for deletion in next commit
802 .It C Ta modified or added file which contains merge conflicts
803 .It ! Ta versioned file was expected on disk but is missing
804 .It \(a~ Ta versioned file is obstructed by a non-regular file
805 .It ? Ta unversioned item not tracked by
807 .It m Ta modified file modes (executable bit only)
808 .It N Ta non-existent
810 specified on the command line
815 is specified, show modifications in the entire work tree.
816 Otherwise, show modifications at or within the specified paths.
818 If changes have been staged with
820 staged changes are shown in the second output column, using the following
822 .Bl -column YXZ description
823 .It M Ta file modification is staged
824 .It A Ta file addition is staged
825 .It D Ta file deletion is staged
828 Changes created on top of staged changes are indicated in the first column:
829 .Bl -column YXZ description
830 .It MM Ta file was modified after earlier changes have been staged
831 .It MA Ta file was modified after having been staged for addition
839 Show unversioned files even if they match an ignore pattern.
840 .It Fl S Ar status-codes
841 Suppress the output of files with a modification status matching any of the
842 single-character status codes contained in the
845 Any combination of codes from the above list of possible status codes
847 For staged files, status codes displayed in either column will be matched.
848 Cannot be used together with the
851 .It Fl s Ar status-codes
852 Only show files with a modification status matching any of the
853 single-character status codes contained in the
856 Any combination of codes from the above list of possible status codes
858 For staged files, status codes displayed in either column will be matched.
859 Cannot be used together with the
864 For compatibility with
875 files in each traversed directory and will not display unversioned files
876 which match these patterns.
877 Ignore patterns which end with a slash,
879 will only match directories.
884 supports consecutive asterisks,
886 which will match an arbitrary amount of directories.
890 only supports a single ignore pattern per line.
894 does not support negated ignore patterns prefixed with
896 and gives no special significance to the location of path component separators,
905 .Op Fl r Ar repository-path
906 .Op Fl S Ar search-pattern
910 Display history of a repository.
913 is specified, show only commits which modified this path.
914 If invoked in a work tree, the
916 is interpreted relative to the current working directory,
917 and the work tree's path prefix is implicitly prepended.
918 Otherwise, the path is interpreted relative to the repository root.
925 Display individual commits which were merged into the current branch
929 shows the linear history of the current branch only.
931 Set the number of context lines shown in diffs with
933 By default, 3 lines of context are shown.
935 Start traversing history at the specified
937 If this option is not specified, default to the work tree's current branch
938 if invoked in a work tree, or to the repository's HEAD reference.
942 argument is a commit ID SHA1 hash or an existing reference
943 or tag name which will be resolved to a commit ID.
944 An abbreviated hash argument will be expanded to a full SHA1 hash
945 automatically, provided the abbreviation is unique.
953 can also be used to represent the work tree's base commit
954 and branch head, respectively.
955 The former is only valid if invoked in a work tree, while the latter will
956 resolve to the tip of the work tree's current branch if invoked in a
957 work tree, otherwise it will resolve to the repository's HEAD reference.
958 Keywords and references may be appended with
962 modifiers and an optional integer N to denote the
963 Nth descendant or antecedent, respectively, by first parent traversal;
966 denotes the HEAD reference's 2nd generation ancestor, and
968 denotes the 4th generation descendant of the work tree's base commit.
971 will denote the 3rd generation descendant of the commit resolved by the
978 modifier without a trailing integer has an implicit
987 Display diffstat of changes introduced in each commit.
988 Cannot be used with the
992 Limit history traversal to a given number of commits.
993 If this option is not specified, a default limit value of zero is used,
994 which is treated as an unbounded limit.
996 .Ev GOT_LOG_DEFAULT_LIMIT
997 environment variable may be set to change this default value.
999 Display the list of file paths changed in each commit, using the following
1001 .Bl -column YXZ description
1002 .It M Ta modified file
1003 .It D Ta file was deleted
1004 .It A Ta new file was added
1005 .It m Ta modified file modes (executable bit only)
1008 Cannot be used with the
1012 Display the patch of modifications made in each commit.
1015 is specified, only show the patch of modifications at or within this path.
1016 Cannot be used with the
1020 Determine a set of commits to display as usual, but display these commits
1022 .It Fl r Ar repository-path
1023 Use the repository at the specified path.
1024 If not specified, assume the repository is located at or above the current
1026 If this directory is a
1028 work tree, use the repository path associated with this work tree.
1029 .It Fl S Ar search-pattern
1030 If specified, show only commits with a log message, author name,
1031 committer name, or ID SHA1 hash matched by the extended regular
1033 .Ar search-pattern .
1034 Lines in committed patches will be matched if
1037 File paths changed by a commit will be matched if
1040 Regular expression syntax is documented in
1043 Display a short one-line summary of each commit, instead of the default
1045 Cannot be used together with the
1051 Stop traversing commit history immediately after the specified
1054 This option has no effect if the specified
1064 .Op Fl r Ar repository-path
1065 .Op Ar object1 Ar object2 | Ar path ...
1068 When invoked within a work tree without any arguments, display all
1069 local changes in the work tree.
1072 arguments are specified, only show changes within the specified paths.
1074 If two arguments are provided, treat each argument as a reference, a tag
1075 name, or an object ID SHA1 hash, and display differences between the
1076 corresponding objects.
1077 Both objects must be of the same type (blobs, trees, or commits).
1078 An abbreviated hash argument will be expanded to a full SHA1 hash
1079 automatically, provided the abbreviation is unique.
1080 If none of these interpretations produce a valid result or if the
1085 is running in a work tree, attempt to interpret the two arguments as paths.
1092 Treat file contents as ASCII text even if binary data is detected.
1094 Set the number of context lines shown in the diff.
1095 By default, 3 lines of context are shown.
1097 Show differences between commits in the repository.
1098 This option may be used up to two times.
1099 When used only once, show differences between the specified
1101 and its first parent commit.
1102 When used twice, show differences between the two specified commits.
1106 option is used, all non-option arguments will be interpreted as paths.
1109 arguments are provided, only show differences for the specified paths.
1113 argument is a commit ID SHA1 hash or an existing reference
1114 or tag name which will be resolved to a commit ID.
1115 An abbreviated hash argument will be expanded to a full SHA1 hash
1116 automatically, provided the abbreviation is unique.
1124 can also be used to represent the work tree's base commit
1125 and branch head, respectively.
1126 The former is only valid if invoked in a work tree, while the latter will
1127 resolve to the tip of the work tree's current branch if invoked in a
1128 work tree, otherwise it will resolve to the repository's HEAD reference.
1129 Keywords and references may be appended with
1133 modifiers and an optional integer N to denote the
1134 Nth descendant or antecedent, respectively, by first parent traversal;
1137 denotes the HEAD reference's 2nd generation ancestor, and
1139 denotes the 4th generation descendant of the work tree's base commit.
1142 will denote the 8th generation descendant of the commit resolved by the
1145 If an integer does not follow the
1151 is implicitly appended
1158 Cannot be used together with the
1162 Display diffstat of changes before the actual diff by annotating each file path
1163 or blob hash being diffed with the total number of lines added and removed.
1164 A summary line will display the total number of changes across all files.
1166 Interpret all arguments as paths only.
1167 This option can be used to resolve ambiguity in cases where paths
1168 look like tag names, reference names, or object IDs.
1169 This option is only valid when
1171 is invoked in a work tree.
1172 .It Fl r Ar repository-path
1173 Use the repository at the specified path.
1174 If not specified, assume the repository is located at or above the current
1176 If this directory is a
1178 work tree, use the repository path associated with this work tree.
1180 Show changes staged with
1182 instead of showing local changes in the work tree.
1183 This option is only valid when
1185 is invoked in a work tree.
1187 Ignore whitespace-only changes.
1193 .Op Fl r Ar repository-path
1197 Display line-by-line history of a file at the specified path.
1204 Start traversing history at the specified
1206 The expected argument is a commit ID SHA1 hash or an existing reference
1207 or tag name which will be resolved to a commit ID.
1208 An abbreviated hash argument will be expanded to a full SHA1 hash
1209 automatically, provided the abbreviation is unique.
1210 .It Fl r Ar repository-path
1211 Use the repository at the specified path.
1212 If not specified, assume the repository is located at or above the current
1214 If this directory is a
1216 work tree, use the repository path associated with this work tree.
1223 .Op Fl r Ar repository-path
1227 Display a listing of files and directories at the specified
1228 directory path in the repository.
1229 Entries shown in this listing may carry one of the following trailing
1231 .Bl -column YXZ description
1232 .It @ Ta entry is a symbolic link
1233 .It / Ta entry is a directory
1234 .It * Ta entry is an executable file
1235 .It $ Ta entry is a Git submodule
1238 Symbolic link entries are also annotated with the target path of the link.
1242 is specified, list the repository path corresponding to the current
1243 directory of the work tree, or the root directory of the repository
1244 if there is no work tree.
1251 List files and directories as they appear in the specified
1253 The expected argument is a commit ID SHA1 hash or an existing reference
1254 or tag name which will be resolved to a commit ID.
1255 An abbreviated hash argument will be expanded to a full SHA1 hash
1256 automatically, provided the abbreviation is unique.
1258 Show object IDs of files (blob objects) and directories (tree objects).
1260 Recurse into sub-directories in the repository.
1261 .It Fl r Ar repository-path
1262 Use the repository at the specified path.
1263 If not specified, assume the repository is located at or above the current
1265 If this directory is a
1267 work tree, use the repository path associated with this work tree.
1273 .Op Fl r Ar repository-path
1274 .Op Fl s Ar reference
1277 Manage references in a repository.
1279 References may be listed, created, deleted, and changed.
1280 When creating, deleting, or changing a reference the specified
1282 must be an absolute reference name, i.e. it must begin with
1290 Create a reference or change an existing reference.
1291 The reference with the specified
1293 will point at the specified
1297 argument is a ID SHA1 hash or an existing reference or tag name which will
1298 be resolved to the ID of a corresponding commit, tree, tag, or blob object.
1299 Cannot be used together with any other options except
1302 Delete the reference with the specified
1304 from the repository.
1305 Any commit, tree, tag, and blob objects belonging to deleted references
1306 remain in the repository and may be removed separately with
1307 Git's garbage collector or
1308 .Cm gotadmin cleanup .
1309 Cannot be used together with any other options except
1312 List references in the repository.
1315 is specified, list all existing references in the repository.
1318 is a reference namespace, list all references in this namespace.
1319 Otherwise, show only the reference with the given
1321 Cannot be used together with any other options except
1325 .It Fl r Ar repository-path
1326 Use the repository at the specified path.
1327 If not specified, assume the repository is located at or above the current
1329 If this directory is a
1331 work tree, use the repository path associated with this work tree.
1332 .It Fl s Ar reference
1333 Create a symbolic reference, or change an existing symbolic reference.
1334 The symbolic reference with the specified
1336 will point at the specified
1338 which must already exist in the repository.
1339 Care should be taken not to create loops between references when
1340 this option is used.
1341 Cannot be used together with any other options except
1344 Sort listed references by modification time (most recently modified first)
1345 instead of sorting by lexicographical order.
1346 Use of this option requires the
1348 option to be used as well.
1356 .Op Fl r Ar repository-path
1360 Create, list, or delete branches.
1362 Local branches are managed via references which live in the
1364 reference namespace.
1367 command creates references in this namespace only.
1369 When deleting branches, the specified
1373 reference namespace first.
1374 If no corresponding branch is found, the
1376 namespace will be searched next.
1378 If invoked in a work tree without any arguments, print the name of the
1379 work tree's current branch.
1383 argument is passed, attempt to create a branch reference with the given name.
1384 By default the new branch reference will point at the latest commit on the
1385 work tree's current branch if invoked in a work tree, and otherwise to a commit
1386 resolved via the repository's HEAD reference.
1388 If invoked in a work tree, once the branch was created successfully
1389 switch the work tree's head reference to the newly created branch and
1390 update files across the entire work tree, just like
1391 .Cm got update -b Ar name
1393 Show the status of each affected file, using the following status codes:
1394 .Bl -column YXZ description
1395 .It U Ta file was updated and contained no local changes
1396 .It G Ta file was updated and local changes were merged cleanly
1397 .It C Ta file was updated and conflicts occurred during merge
1398 .It D Ta file was deleted
1399 .It A Ta new file was added
1400 .It \(a~ Ta versioned file is obstructed by a non-regular file
1401 .It ! Ta a missing versioned file was restored
1409 Make a newly created branch reference point at the specified
1411 The expected argument is a commit ID SHA1 hash or an existing reference
1412 or tag name which will be resolved to a commit ID.
1420 can also be used to represent the work tree's base commit
1421 and branch head, respectively.
1422 The former is only valid if invoked in a work tree, while the latter will
1423 resolve to the tip of the work tree's current branch if invoked in a
1424 work tree, otherwise it will resolve to the repository's HEAD reference.
1425 Keywords and references may be appended with
1429 modifiers and an optional integer N to denote the
1430 Nth descendant or antecedent by first parent traversal, respectively;
1433 denotes the work tree branch head's 2nd generation ancestor, and
1435 denotes the 4th generation descendant of the work tree's base commit.
1438 will denote the 3rd generation descendant of the commit resolved by the
1445 modifier without a trailing integer has an implicit
1454 Delete the branch with the specified
1460 reference namespace.
1462 Only the branch reference is deleted.
1463 Any commit, tree, and blob objects belonging to the branch
1464 remain in the repository and may be removed separately with
1465 Git's garbage collector or
1466 .Cm gotadmin cleanup .
1468 List all existing branches in the repository, including copies of remote
1469 repositories' branches in the
1471 reference namespace.
1473 If invoked in a work tree, the work tree's current branch is shown
1474 with one of the following annotations:
1475 .Bl -column YXZ description
1476 .It * Ta work tree's base commit matches the branch tip
1477 .It \(a~ Ta work tree's base commit is out-of-date
1480 Do not switch and update the work tree after creating a new branch.
1481 .It Fl r Ar repository-path
1482 Use the repository at the specified path.
1483 If not specified, assume the repository is located at or above the current
1485 If this directory is a
1487 work tree, use the repository path associated with this work tree.
1489 Sort listed branches by modification time (most recently modified first)
1490 instead of sorting by lexicographical order.
1493 reference namespace are listed before branches in
1496 Use of this option requires the
1498 option to be used as well.
1505 .Op Fl r Ar repository-path
1506 .Op Fl s Ar signer-id
1509 Manage tags in a repository.
1511 Tags are managed via references which live in the
1513 reference namespace.
1516 command operates on references in this namespace only.
1517 References in this namespace point at tag objects which contain a pointer
1518 to another object, a tag message, as well as author and timestamp information.
1520 Attempt to create a tag with the given
1522 and make this tag point at the given
1524 If no commit is specified, default to the latest commit on the work tree's
1525 current branch if invoked in a work tree, and to a commit resolved via
1526 the repository's HEAD reference otherwise.
1533 Make the newly created tag reference point at the specified
1537 argument is a commit ID SHA1 hash or an existing reference or tag name which
1538 will be resolved to a commit ID.
1539 An abbreviated hash argument will be expanded to a full SHA1 hash
1540 automatically, provided the abbreviation is unique.
1542 List all existing tags in the repository instead of creating a new tag.
1545 argument is passed, show only the tag with the given
1548 Use the specified tag message when creating the new tag.
1553 opens a temporary file in an editor where a tag message can be written.
1554 Quitting the editor without saving the file will abort the tag operation.
1555 .It Fl r Ar repository-path
1556 Use the repository at the specified path.
1557 If not specified, assume the repository is located at or above the current
1559 If this directory is a
1561 work tree, use the repository path associated with this work tree.
1562 .It Fl s Ar signer-id
1563 While creating a new tag, sign this tag with the identity given in
1566 For SSH-based signatures,
1568 is the path to a file which may refer to either a private SSH key,
1569 or a public SSH key with the private half available via
1572 will sign the tag object by invoking
1576 command, using the signature namespace
1578 for compatibility with
1581 Verify tag object signatures.
1584 is specified, show and verify the tag object with the provided name.
1585 Otherwise, list all tag objects and verify signatures where present.
1588 verifies SSH-based signatures by invoking
1591 .Fl Y Cm verify Fl f Ar allowed_signers .
1596 otherwise verification is impossible.
1599 During SSH signature creation and verification this option will be passed to
1601 Multiple -v options increase the verbosity.
1607 command will not delete tags or change existing tags.
1608 If a tag must be deleted, the
1610 command may be used to delete a tag's reference.
1611 This should only be done if the tag has not already been copied to
1618 Schedule unversioned files in a work tree for addition to the
1619 repository in the next commit.
1620 By default, files which match a
1622 ignore pattern will not be added.
1626 mentioned in the command line is not an unversioned file then
1629 To avoid unnecessary errors from paths picked up by file globbing patterns
1630 in the shell, paths in the argument list will be silently ignored if they
1633 at all, or if they are reported with one of the following status codes
1634 and do not have changes staged via
1636 .Bl -column YXZ description
1637 .It M Ta modified file
1638 .It A Ta file scheduled for addition in next commit
1639 .It C Ta modified or added file which contains merge conflicts
1640 .It m Ta modified file modes (executable bit only)
1648 Add files even if they match a
1652 Permit recursion into directories.
1653 If this option is not specified,
1655 will refuse to run if a specified
1663 .Op Fl s Ar status-codes
1667 Remove versioned files from a work tree and schedule them for deletion
1668 from the repository in the next commit.
1675 Perform the operation even if a file contains local modifications,
1676 and do not raise an error if a specified
1678 does not exist on disk.
1680 Keep affected files on disk.
1682 Permit recursion into directories.
1683 If this option is not specified,
1685 will refuse to run if a specified
1688 .It Fl s Ar status-codes
1689 Only delete files with a modification status matching one of the
1690 single-character status codes contained in the
1693 The following status codes may be specified:
1694 .Bl -column YXZ description
1695 .It M Ta modified file (this implies the
1698 .It ! Ta versioned file expected on disk but missing
1706 .Op Fl p Ar strip-count
1712 to files in a work tree.
1713 Files added or removed by a patch will be scheduled for addition or removal in
1716 The patch must be in the unified diff format as produced by
1723 diff when invoked with their
1728 argument is provided, read unified diff data from standard input instead.
1732 contains multiple patches, then attempt to apply each of them in sequence.
1734 Show the status of each affected file, using the following status codes:
1735 .Bl -column XYZ description
1736 .It M Ta file was modified
1737 .It G Ta file was merged using a merge-base found in the repository
1738 .It C Ta file was merged and conflicts occurred during merge
1739 .It D Ta file was deleted
1740 .It A Ta file was added
1741 .It # Ta failed to patch the file
1744 If a change does not match at its exact line number, attempt to
1745 apply it somewhere else in the file if a good spot can be found.
1746 Otherwise, the patch will fail to apply.
1750 will refuse to apply a patch if certain preconditions are not met.
1751 Files to be deleted must already be under version control, and must
1752 not have been scheduled for deletion already.
1753 Files to be added must not yet be under version control and must not
1754 already be present on disk.
1755 Files to be modified must already be under version control and may not
1756 contain conflict markers.
1758 If an error occurs, the
1760 operation will be aborted.
1761 Any changes made to the work tree up to this point will be left behind.
1762 Such changes can be viewed with
1764 and can be reverted with
1773 Attempt to locate files within the specified
1775 for use as a merge-base for 3-way merges.
1779 option is not used then
1781 will attempt to locate merge-bases via object IDs found in
1783 meta-data, such as produced by
1789 option is only recommended in the absence of such meta-data.
1791 Ideally, the specified
1793 should contain versions of files which the changes contained in the
1796 Files will be located by path, relative to the repository root.
1799 option is used then leading path components will be stripped
1800 before paths are looked up in the repository.
1802 In case no merge-base is available for a file, changes will be applied
1803 without doing a 3-way merge.
1804 Changes which do not apply cleanly may then be rejected entirely, rather
1805 than producing merge conflicts in the patched target file.
1809 argument is a commit ID SHA1 hash or an existing reference
1810 or tag name which will be resolved to a commit ID.
1811 An abbreviated hash argument will be expanded to a full SHA1 hash
1812 automatically, provided the abbreviation is unique.
1820 can also be used to represent the work tree's base commit
1821 and branch head, respectively.
1822 Keywords and references may be appended with
1826 modifiers and an optional integer N to denote the
1827 Nth descendant or antecedent by first parent traversal, respectively;
1830 denotes the work tree branch head's 2nd generation ancestor, and
1832 denotes the 4th generation descendant of the work tree's base commit.
1835 will denote the 3rd generation descendant of the commit resolved by the
1842 modifier without a trailing integer has an implicit
1851 Do not make any modifications to the work tree.
1852 This can be used to check whether a patch would apply without issues.
1855 contains diffs that affect the same file multiple times, the results
1856 displayed may be incorrect.
1857 .It Fl p Ar strip-count
1858 Specify the number of leading path components to strip from paths
1867 path prefixes generated by
1869 will be recognized and stripped automatically.
1871 Reverse the patch before applying it.
1877 .Op Fl F Ar response-script
1881 Revert any local changes in files at the specified paths in a work tree.
1882 File contents will be overwritten with those contained in the
1883 work tree's base commit.
1884 There is no way to bring discarded changes back after
1887 If a file was added with
1889 it will become an unversioned file again.
1890 If a file was deleted with
1892 it will be restored.
1898 .It Fl F Ar response-script
1906 responses line-by-line from the specified
1908 file instead of prompting interactively.
1910 Instead of reverting all changes in files, interactively select or reject
1911 changes to revert based on
1917 (quit reverting this file) responses.
1918 If a file is in modified status, individual patches derived from the
1919 modified file content can be reverted.
1920 Files in added or deleted status may only be reverted in their entirety.
1922 Permit recursion into directories.
1923 If this option is not specified,
1925 will refuse to run if a specified
1939 Create a new commit in the repository from changes in a work tree
1940 and use this commit as the new base commit for the work tree.
1943 is specified, commit all changes in the work tree.
1944 Otherwise, commit changes at or within the specified paths.
1946 If changes have been explicitly staged for commit with
1948 only commit staged changes and reject any specified paths which
1949 have not been staged.
1952 opens a temporary file in an editor where a log message can be written
1960 options are used together.
1961 Quitting the editor without saving the file will abort the commit operation.
1963 Show the status of each affected file, using the following status codes:
1964 .Bl -column YXZ description
1965 .It M Ta modified file
1966 .It D Ta file was deleted
1967 .It A Ta new file was added
1968 .It m Ta modified file modes (executable bit only)
1971 Files which are not part of the new commit will retain their previously
1972 recorded base commit.
1975 commands may refuse to run while the work tree contains files from
1976 multiple base commits.
1977 The base commit of such a work tree can be made consistent by running
1979 across the entire work tree.
1983 command requires the
1985 environment variable to be set,
1986 unless an author has been configured in
1992 configuration settings can be
1993 obtained from the repository's
1995 file or from Git's global
2004 Set author information in the newly created commit to
2006 This is useful when committing changes on behalf of someone else.
2009 argument must use the same format as the
2011 environment variable.
2013 In addition to storing author information, the newly created commit
2016 information which is obtained, as usual, from the
2018 environment variable, or
2020 or Git configuration settings.
2022 Allow committing files in conflicted status.
2024 Committing files with conflict markers should generally be avoided.
2025 Cases where conflict markers must be stored in the repository for
2026 some legitimate reason should be very rare.
2027 There are usually ways to avoid storing conflict markers verbatim by
2028 applying appropriate programming tricks.
2030 Use the prepared log message stored in the file found at
2032 when creating the new commit.
2034 opens a temporary file in an editor where the prepared log message can be
2035 reviewed and edited further if needed.
2036 Cannot be used together with the
2040 Use the specified log message when creating the new commit.
2041 Cannot be used together with the
2045 This option prevents
2047 from opening the commit message in an editor.
2048 It has no effect unless it is used together with the
2050 option and is intended for non-interactive use such as scripting.
2052 This option prevents
2054 from generating a diff of the to-be-committed changes in a temporary file
2055 which can be viewed while editing a commit message.
2057 Allow the addition of symbolic links which point outside of the path space
2058 that is under version control.
2061 will reject such symbolic links due to safety concerns.
2064 may decide to represent such a symbolic link as a regular file which contains
2065 the link's target path, rather than creating an actual symbolic link which
2066 points outside of the work tree.
2067 Use of this option is discouraged because external mechanisms such as
2069 are better suited for managing symbolic links to paths not under
2074 will refuse to run if certain preconditions are not met.
2075 If the work tree's current branch is not in the
2077 reference namespace, new commits may not be created on this branch.
2078 Local changes may only be committed if they are based on file content
2079 found in the most recent commit on the work tree's branch.
2080 If a path is found to be out of date,
2082 must be used first in order to merge local changes with changes made
2090 .Op Fl r Ar repository-path
2092 .Op Ar remote-repository
2095 Send new changes to a remote repository.
2097 .Ar remote-repository
2101 The remote repository's URL is obtained from the corresponding entry in
2105 file of the local repository, as created by
2108 All objects corresponding to new changes will be written to a temporary
2109 pack file which is then uploaded to the server.
2110 Upon success, references in the
2112 reference namespace of the local repository will be updated to point at
2113 the commits which have been sent.
2115 By default, changes will only be sent if they are based on up-to-date
2116 copies of relevant branches in the remote repository.
2117 If any changes to be sent are based on out-of-date copies or would
2118 otherwise break linear history of existing branches, new changes must
2119 be fetched from the server with
2121 and local branches must be rebased with
2128 option can be used to make exceptions to these requirements.
2135 Send all branches from the local repository's
2137 reference namespace.
2140 option is equivalent to listing all branches with multiple
2143 Cannot be used together with the
2149 from the local repository's
2151 reference namespace.
2152 This option may be specified multiple times to build a list of branches
2154 If this option is not specified, default to the work tree's current branch
2155 if invoked in a work tree, or to the repository's HEAD reference.
2156 Cannot be used together with the
2160 Delete the specified
2162 from the remote repository's
2164 reference namespace.
2165 This option may be specified multiple times to build a list of branches
2168 Only references are deleted.
2169 Any commit, tree, tag, and blob objects belonging to deleted branches
2170 may become subject to deletion by Git's garbage collector running on
2173 Requesting deletion of branches results in an error if the server
2174 does not support this feature or disallows the deletion of branches
2175 based on its configuration.
2177 Attempt to force the server to overwrite existing branches or tags
2178 in the remote repository, even when
2184 would usually be required before changes can be sent.
2185 The server may reject forced requests regardless, depending on its
2188 Any commit, tree, tag, and blob objects belonging to overwritten branches
2189 or tags may become subject to deletion by Git's garbage collector running
2194 reference namespace is globally shared between all repositories.
2197 option to overwrite tags is discouraged because it can lead to
2198 inconsistencies between the tags present in different repositories.
2199 In general, creating a new tag with a different name is recommended
2200 instead of overwriting an existing tag.
2204 option is particularly discouraged if changes being sent are based
2205 on an out-of-date copy of a branch in the remote repository.
2206 Instead of using the
2208 option, new changes should
2211 and local branches should be rebased with
2215 followed by another attempt to send the changes.
2219 option should only be needed in situations where the remote repository's
2220 copy of a branch or tag is known to be out-of-date and is considered
2222 The risks of creating inconsistencies between different repositories
2223 should also be taken into account.
2225 Suppress progress reporting output.
2226 The same option will be passed to
2229 .It Fl r Ar repository-path
2230 Use the repository at the specified path.
2231 If not specified, assume the repository is located at or above the current
2233 If this directory is a
2235 work tree, use the repository path associated with this work tree.
2237 Attempt to send all tags from the local repository's
2239 reference namespace.
2242 option is equivalent to listing all tags with multiple
2245 Cannot be used together with the
2251 from the local repository's
2253 reference namespace, in addition to any branches that are being sent.
2256 option may be specified multiple times to build a list of tags to send.
2257 No tags will be sent if the
2261 Raise an error if the specified
2263 already exists in the remote repository, unless the
2265 option is used to overwrite the server's copy of the tag.
2266 In general, creating a new tag with a different name is recommended
2267 instead of overwriting an existing tag.
2269 Cannot be used together with the
2276 to print debugging messages to standard error output.
2277 The same option will be passed to
2280 Multiple -v options increase the verbosity.
2290 Merge changes from a single
2295 should be on a different branch than the work tree's base commit.
2296 The expected argument is a reference or a commit ID SHA1 hash.
2297 An abbreviated hash argument will be expanded to a full SHA1 hash
2298 automatically, provided the abbreviation is unique.
2306 can also be used to represent the work tree's base commit
2307 and branch head, respectively.
2308 Keywords and references may be appended with
2312 modifiers and an optional integer N to denote the
2313 Nth descendant or antecedent by first parent traversal, respectively;
2316 denotes the work tree branch head's 2nd generation ancestor, and
2318 denotes the 4th generation descendant of the work tree's base commit.
2321 will denote the 3rd generation descendant of the commit resolved by the
2328 modifier without a trailing integer has an implicit
2337 Show the status of each affected file, using the following status codes:
2338 .Bl -column YXZ description
2339 .It G Ta file was merged
2340 .It C Ta file was merged and conflicts occurred during merge
2341 .It ! Ta changes destined for a missing file were not merged
2342 .It D Ta file was deleted
2343 .It d Ta file's deletion was prevented by local modifications
2344 .It A Ta new file was added
2345 .It \(a~ Ta changes destined for a non-regular file were not merged
2346 .It ? Ta changes destined for an unversioned file were not merged
2349 The merged changes will appear as local changes in the work tree, which
2352 amended manually or with further
2358 If invoked in a work tree where no
2363 operation is taking place,
2365 creates a record of commits which have been merged into the work tree.
2366 When a file changed by
2370 the log messages of relevant merged commits will then appear in the editor,
2371 where the messages should be further adjusted to convey the reasons for
2372 cherrypicking the changes.
2373 Upon exiting the editor, if the time stamp of the log message file
2374 is unchanged or the log message is empty,
2376 will fail with an unmodified or empty log message error.
2378 If all the changes in all files touched by a given commit are discarded,
2381 this commit's log message record will also disappear.
2384 will refuse to run if certain preconditions are not met.
2385 If the work tree contains multiple base commits, it must first be updated
2386 to a single base commit with
2388 If any relevant files already contain merge conflicts, these
2389 conflicts must be resolved first.
2397 Display a list of commit log messages recorded by cherrypick operations,
2398 represented by references in the
2399 .Dq refs/got/worktree
2400 reference namespace.
2403 is specified, only show the log message of the specified commit.
2405 If invoked in a work tree, only log messages recorded by cherrypick operations
2406 in the current work tree will be displayed.
2407 Otherwise, all commit log messages will be displayed irrespective of the
2408 work tree in which they were created.
2409 This option cannot be used with
2412 Delete log messages created by previous cherrypick operations, represented by
2414 .Dq refs/got/worktree
2415 reference namespace.
2418 is specified, only delete the log message of the specified commit.
2420 If invoked in a work tree, only log messages recorded by cherrypick operations
2421 in the current work tree will be deleted.
2422 Otherwise, all commit log messages will be deleted irrespective of the
2423 work tree in which they were created.
2424 This option cannot be used with
2435 Reverse-merge changes from a single
2440 should be on the same branch as the work tree's base commit.
2441 The expected argument is a reference or a commit ID SHA1 hash.
2442 An abbreviated hash argument will be expanded to a full SHA1 hash
2443 automatically, provided the abbreviation is unique.
2451 can also be used to represent the work tree's base commit
2452 and branch head, respectively.
2453 Keywords and references may be appended with
2457 modifiers and an optional integer N to denote the
2458 Nth descendant or antecedent by first parent traversal, respectively;
2461 denotes the work tree branch head's 2nd generation ancestor, and
2463 denotes the 4th generation descendant of the work tree's base commit.
2466 will denote the 5th generation descendant of the commit resolved by the
2473 modifier without a trailing integer has an implicit
2482 Show the status of each affected file, using the following status codes:
2483 .Bl -column YXZ description
2484 .It G Ta file was merged
2485 .It C Ta file was merged and conflicts occurred during merge
2486 .It ! Ta changes destined for a missing file were not merged
2487 .It D Ta file was deleted
2488 .It d Ta file's deletion was prevented by local modifications
2489 .It A Ta new file was added
2490 .It \(a~ Ta changes destined for a non-regular file were not merged
2491 .It ? Ta changes destined for an unversioned file were not merged
2494 The reverse-merged changes will appear as local changes in the work tree,
2495 which may be viewed with
2497 amended manually or with further
2503 If invoked in a work tree where no
2508 operation is taking place,
2510 creates a record of commits which have been reverse-merged into the work tree.
2511 When a file changed by
2515 the log messages of relevant reverse-merged commits will then appear in
2516 the editor, where the messages should be further adjusted to convey the
2517 reasons for backing out the changes.
2518 Upon exiting the editor, if the time stamp of the log message file
2519 is unchanged or the log message is empty,
2521 will fail with an unmodified or empty log message error.
2523 If all the changes in all files touched by a given commit are discarded,
2526 this commit's log message record will also disappear.
2529 will refuse to run if certain preconditions are not met.
2530 If the work tree contains multiple base commits, it must first be updated
2531 to a single base commit with
2533 If any relevant files already contain merge conflicts, these
2534 conflicts must be resolved first.
2542 Display a list of commit log messages recorded by backout operations,
2543 represented by references in the
2544 .Dq refs/got/worktree
2545 reference namespace.
2548 is specified, only show the log message of the specified commit.
2550 If invoked in a work tree, only log messages recorded by backout operations
2551 in the current work tree will be displayed.
2552 Otherwise, all commit log messages will be displayed irrespective of the
2553 work tree in which they were created.
2554 This option cannot be used with
2557 Delete log messages created by previous backout operations, represented by
2559 .Dq refs/got/worktree
2560 reference namespace.
2563 is specified, only delete the log message of the specified commit.
2565 If invoked in a work tree, only log messages recorded by backout operations
2566 in the current work tree will be deleted.
2567 Otherwise, all commit log messages will be deleted irrespective of the
2568 work tree in which they were created.
2569 This option cannot be used with
2580 Rebase commits on the specified
2582 onto the tip of the current branch of the work tree.
2585 must share common ancestry with the work tree's current branch.
2586 Rebasing begins with the first descendant commit of the youngest
2587 common ancestor commit shared by the specified
2589 and the work tree's current branch, and stops once the tip commit
2596 is used as intended, the specified
2598 represents a local commit history and may already contain changes
2599 that are not yet visible in any other repositories.
2600 The work tree's current branch, which must be set with
2604 operation, represents a branch from a remote repository which shares
2605 a common history with the specified
2607 but has progressed, and perhaps diverged, due to commits added to the
2610 Rebased commits are accumulated on a temporary branch which the work tree
2611 will remain switched to throughout the entire rebase operation.
2612 Commits on this branch represent the same changes with the same log
2613 messages as their counterparts on the original
2615 but with different commit IDs.
2616 Once rebasing has completed successfully, the temporary branch becomes
2617 the new version of the specified
2619 and the work tree is automatically switched to it.
2620 If author information is available via the
2622 environment variable,
2628 configuration settings, this author information will be used to identify
2633 Old commits in their pre-rebase state are automatically backed up in the
2634 .Dq refs/got/backup/rebase
2635 reference namespace.
2636 As long as these references are not removed older versions of rebased
2637 commits will remain in the repository and can be viewed with the
2640 Removal of these references makes objects which become unreachable via
2641 any reference subject to removal by Git's garbage collector or
2642 .Cm gotadmin cleanup .
2644 While rebasing commits, show the status of each affected file,
2645 using the following status codes:
2646 .Bl -column YXZ description
2647 .It G Ta file was merged
2648 .It C Ta file was merged and conflicts occurred during merge
2649 .It ! Ta changes destined for a missing file were not merged
2650 .It D Ta file was deleted
2651 .It d Ta file's deletion was prevented by local modifications
2652 .It A Ta new file was added
2653 .It \(a~ Ta changes destined for a non-regular file were not merged
2654 .It ? Ta changes destined for an unversioned file were not merged
2657 If merge conflicts occur, the rebase operation is interrupted and may
2658 be continued once conflicts have been resolved.
2659 If any files with destined changes are found to be missing or unversioned,
2660 or if files could not be deleted due to differences in deleted content,
2661 the rebase operation will be interrupted to prevent potentially incomplete
2662 changes from being committed to the repository without user intervention.
2663 The work tree may be modified as desired and the rebase operation can be
2664 continued once the changes present in the work tree are considered complete.
2665 Alternatively, the rebase operation may be aborted which will leave
2667 unmodified and the work tree switched back to its original branch.
2669 If a merge conflict is resolved in a way which renders the merged
2670 change into a no-op change, the corresponding commit will be elided
2671 when the rebase operation continues.
2674 will refuse to run if certain preconditions are not met.
2679 reference namespace, the branch may not be rebased.
2680 If the work tree is not yet fully updated to the tip commit of its
2681 branch, then the work tree must first be updated with
2683 If changes have been staged with
2685 these changes must first be committed with
2689 If the work tree contains local changes, these changes must first be
2696 contains changes to files outside of the work tree's path prefix,
2697 the work tree cannot be used to rebase this branch.
2706 commands will refuse to run while a rebase operation is in progress.
2707 Other commands which manipulate the work tree may be used for
2708 conflict resolution purposes.
2712 is already based on the work tree's current branch, then no commits
2713 need to be rebased and
2715 will simply switch the work tree to the specified
2717 and update files in the work tree accordingly.
2724 Abort an interrupted rebase operation.
2725 If this option is used, no other command-line arguments are allowed.
2727 Allow a rebase operation to continue with files in conflicted status.
2728 This option should generally be avoided, and can only be used with the
2732 Continue an interrupted rebase operation.
2733 If this option is used, no other command-line arguments are allowed except
2736 Show a list of past rebase operations, represented by references in the
2737 .Dq refs/got/backup/rebase
2738 reference namespace.
2740 Display the author, date, and log message of each backed up commit,
2741 the object ID of the corresponding post-rebase commit, and
2742 the object ID of their common ancestor commit.
2743 Given these object IDs,
2750 options can be used to examine the history of either version of the branch,
2755 option can be used to create a new branch from a pre-rebase state if desired.
2759 is specified, only show commits which at some point in time represented this
2761 Otherwise, list all backed up commits for any branches.
2763 If this option is used,
2765 does not require a work tree.
2766 None of the other options can be used together with
2769 Delete backups created by past rebase operations, represented by references
2771 .Dq refs/got/backup/rebase
2772 reference namespace.
2776 is specified, only delete backups which at some point in time represented
2778 Otherwise, delete all references found within
2779 .Dq refs/got/backup/rebase .
2781 Any commit, tree, tag, and blob objects belonging to deleted backups
2782 remain in the repository and may be removed separately with
2783 Git's garbage collector or
2784 .Cm gotadmin cleanup .
2786 If this option is used,
2788 does not require a work tree.
2789 None of the other options can be used together with
2796 .Op Fl F Ar histedit-script
2800 Edit commit history between the work tree's current base commit and
2801 the tip commit of the work tree's current branch.
2805 command requires the
2807 environment variable to be set,
2808 unless an author has been configured in
2814 configuration settings can be obtained from the repository's
2816 file or from Git's global
2822 operation, the work tree's current branch must be set with
2824 to the branch which should be edited, unless this branch is already the
2825 current branch of the work tree.
2826 The tip of this branch represents the upper bound (inclusive) of commits
2831 Furthermore, the work tree's base commit
2834 to a point in this branch's commit history where editing should begin.
2835 This commit represents the lower bound (non-inclusive) of commits touched
2840 Editing of commit history is controlled via a
2842 which can be written in an editor based on a template, passed on the
2843 command line, or generated with the
2850 Quitting the editor without saving the file will abort the histedit operation.
2852 The format of the histedit script is line-based.
2853 Each line in the script begins with a command name, followed by
2854 whitespace and an argument.
2855 For most commands, the expected argument is a commit ID SHA1 hash.
2856 Any remaining text on the line is ignored.
2857 Lines which begin with the
2859 character are ignored entirely.
2861 The available histedit script commands are as follows:
2862 .Bl -column YXZ pick-commit
2863 .It Cm pick Ar commit Ta Use the specified commit as it is.
2864 .It Cm edit Ar commit Ta Apply the changes from the specified commit, but
2865 then interrupt the histedit operation for amending, without creating a commit.
2866 While the histedit operation is interrupted arbitrary files may be edited,
2867 and commands which manipulate the work tree can be used freely.
2872 commands can be used to add new files or remove existing ones.
2875 command can be used to eliminate arbitrary changes from files in the work tree.
2878 command may be used to prepare a subset of changes for inclusion in the
2882 command can be used to insert arbitrary commits into the edited history.
2883 Regular editing of history must eventually be resumed by running
2884 .Cm got histedit -c .
2885 .It Cm fold Ar commit Ta Combine the specified commit with the next commit
2886 listed further below that will be used.
2887 .It Cm drop Ar commit Ta Remove this commit from the edited history.
2888 .It Cm mesg Oo Ar log-message Oc Ta Create a new log message for the commit of
2893 command on the previous line of the histedit script.
2896 argument provides a new single-line log message to use.
2899 argument is omitted, open an editor where a new log message can be written.
2902 Every commit in the history being edited must be mentioned in the script.
2903 Lines may be re-ordered to change the order of commits in the edited history.
2904 No commit may be listed more than once.
2906 Edited commits are accumulated on a temporary branch which the work tree
2907 will remain switched to throughout the entire histedit operation.
2908 Once history editing has completed successfully, the temporary branch becomes
2909 the new version of the work tree's branch and the work tree is automatically
2912 Old commits in their pre-histedit state are automatically backed up in the
2913 .Dq refs/got/backup/histedit
2914 reference namespace.
2915 As long as these references are not removed older versions of edited
2916 commits will remain in the repository and can be viewed with the
2919 Removal of these references makes objects which become unreachable via
2920 any reference subject to removal by Git's garbage collector or
2921 .Cm gotadmin cleanup .
2923 While merging commits, show the status of each affected file,
2924 using the following status codes:
2925 .Bl -column YXZ description
2926 .It G Ta file was merged
2927 .It C Ta file was merged and conflicts occurred during merge
2928 .It ! Ta changes destined for a missing file were not merged
2929 .It D Ta file was deleted
2930 .It d Ta file's deletion was prevented by local modifications
2931 .It A Ta new file was added
2932 .It \(a~ Ta changes destined for a non-regular file were not merged
2933 .It ? Ta changes destined for an unversioned file were not merged
2936 If merge conflicts occur, the histedit operation is interrupted and may
2937 be continued once conflicts have been resolved.
2938 If any files with destined changes are found to be missing or unversioned,
2939 or if files could not be deleted due to differences in deleted content,
2940 the histedit operation will be interrupted to prevent potentially incomplete
2941 changes from being committed to the repository without user intervention.
2942 The work tree may be modified as desired and the histedit operation can be
2943 continued once the changes present in the work tree are considered complete.
2944 Alternatively, the histedit operation may be aborted which will leave
2945 the work tree switched back to its original branch.
2947 If a merge conflict is resolved in a way which renders the merged
2948 change into a no-op change, the corresponding commit will be elided
2949 when the histedit operation continues.
2952 will refuse to run if certain preconditions are not met.
2953 If the work tree's current branch is not in the
2955 reference namespace, the history of the branch may not be edited.
2956 If the work tree contains multiple base commits, it must first be updated
2957 to a single base commit with
2959 If changes have been staged with
2961 these changes must first be committed with
2965 If the work tree contains local changes, these changes must first be
2970 If the edited history contains changes to files outside of the work tree's
2971 path prefix, the work tree cannot be used to edit the history of this branch.
2979 commands will refuse to run while a histedit operation is in progress.
2980 Other commands which manipulate the work tree may be used, and the
2982 command may be used to commit arbitrary changes to the temporary branch
2983 while the histedit operation is interrupted.
2990 Abort an interrupted histedit operation.
2991 If this option is used, no other command-line arguments are allowed.
2993 Allow a histedit operation to continue with files in conflicted status.
2994 This option should generally be avoided, and can only be used with the
2998 Continue an interrupted histedit operation.
2999 If this option is used, no other command-line arguments are allowed except
3003 This option is a quick equivalent to a histedit script which drops all
3007 option can only be used when starting a new histedit operation.
3008 If this option is used, no other command-line arguments are allowed.
3010 Interrupt the histedit operation for editing after merging each commit.
3011 This option is a quick equivalent to a histedit script which uses the
3013 command for all commits.
3016 option can only be used when starting a new histedit operation.
3017 If this option is used, no other command-line arguments are allowed.
3018 .It Fl F Ar histedit-script
3021 instead of opening a temporary file in an editor where a histedit script
3024 Fold all commits into a single commit.
3025 This option is a quick equivalent to a histedit script which folds all
3026 commits, combining them all into one commit.
3029 option can only be used when starting a new histedit operation.
3030 If this option is used, no other command-line arguments are allowed.
3032 Show a list of past histedit operations, represented by references in the
3033 .Dq refs/got/backup/histedit
3034 reference namespace.
3036 Display the author, date, and log message of each backed up commit,
3037 the object ID of the corresponding post-histedit commit, and
3038 the object ID of their common ancestor commit.
3039 Given these object IDs,
3046 options can be used to examine the history of either version of the branch,
3051 option can be used to create a new branch from a pre-histedit state if desired.
3055 is specified, only show commits which at some point in time represented this
3057 Otherwise, list all backed up commits for any branches.
3059 If this option is used,
3061 does not require a work tree.
3062 None of the other options can be used together with
3065 Edit log messages only.
3066 This option is a quick equivalent to a histedit script which edits
3067 only log messages but otherwise leaves every picked commit as-is.
3070 option can only be used when starting a new histedit operation.
3071 If this option is used, no other command-line arguments are allowed.
3073 Delete backups created by past histedit operations, represented by references
3075 .Dq refs/got/backup/histedit
3076 reference namespace.
3080 is specified, only delete backups which at some point in time represented
3082 Otherwise, delete all references found within
3083 .Dq refs/got/backup/histedit .
3085 Any commit, tree, tag, and blob objects belonging to deleted backups
3086 remain in the repository and may be removed separately with
3087 Git's garbage collector or
3088 .Cm gotadmin cleanup .
3090 If this option is used,
3092 does not require a work tree.
3093 None of the other options can be used together with
3097 .It Cm integrate Ar branch
3099 Integrate the specified
3101 into the work tree's current branch.
3102 Files in the work tree are updated to match the contents on the integrated
3104 and the reference of the work tree's branch is changed to point at the
3105 head commit of the integrated
3108 Both branches can be considered equivalent after integration since they
3109 will be pointing at the same commit.
3110 Both branches remain available for future work, if desired.
3111 In case the integrated
3113 is no longer needed it may be deleted with
3116 Show the status of each affected file, using the following status codes:
3117 .Bl -column YXZ description
3118 .It U Ta file was updated
3119 .It D Ta file was deleted
3120 .It A Ta new file was added
3121 .It \(a~ Ta versioned file is obstructed by a non-regular file
3122 .It ! Ta a missing versioned file was restored
3126 will refuse to run if certain preconditions are not met.
3127 Most importantly, the
3129 must have been rebased onto the work tree's current branch with
3131 before it can be integrated, in order to linearize commit history and
3132 resolve merge conflicts.
3133 If the work tree contains multiple base commits, it must first be updated
3134 to a single base commit with
3136 If changes have been staged with
3138 these changes must first be committed with
3142 If the work tree contains local changes, these changes must first be
3156 into the current branch of the work tree.
3157 If the branches have diverged, creates a merge commit.
3160 already includes all commits from the work tree's branch, updates the work
3161 tree's branch to be the same as
3163 without creating a commit, and updates the work tree to the most recent commit
3166 If a linear project history is desired, then use of
3168 should be preferred over
3170 However, even strictly linear projects may require merge commits in order
3171 to merge in new versions of third-party code stored on vendor branches
3175 Merge commits are commits based on multiple parent commits.
3176 The tip commit of the work tree's current branch, which must be in the
3178 reference namespace and must be set with
3182 operation, will be used as the first parent.
3183 The tip commit of the specified
3185 will be used as the second parent.
3187 No ancestral relationship between the two branches is required.
3188 If the two branches have already been merged previously, only new changes
3191 It is not possible to create merge commits with more than two parents.
3192 If more than one branch needs to be merged, then multiple merge commits
3193 with two parents each can be created in sequence.
3195 While merging changes found on the
3197 into the work tree, show the status of each affected file,
3198 using the following status codes:
3199 .Bl -column YXZ description
3200 .It G Ta file was merged
3201 .It C Ta file was merged and conflicts occurred during merge
3202 .It ! Ta changes destined for a missing file were not merged
3203 .It D Ta file was deleted
3204 .It d Ta file's deletion was prevented by local modifications
3205 .It A Ta new file was added
3206 .It \(a~ Ta changes destined for a non-regular file were not merged
3207 .It ? Ta changes destined for an unversioned file were not merged
3210 If merge conflicts occur, the merge operation is interrupted and conflicts
3211 must be resolved before the merge operation can continue.
3212 If any files with destined changes are found to be missing or unversioned,
3213 or if files could not be deleted due to differences in deleted content,
3214 the merge operation will be interrupted to prevent potentially incomplete
3215 changes from being committed to the repository without user intervention.
3216 The work tree may be modified as desired and the merge can be continued
3217 once the changes present in the work tree are considered complete.
3218 Alternatively, the merge operation may be aborted which will leave
3219 the work tree's current branch unmodified.
3222 will refuse to run if certain preconditions are not met.
3223 If the work tree's current branch is not in the
3225 reference namespace then the work tree must first be switched to a
3230 If the work tree is not yet fully updated to the tip commit of its
3231 branch, then the work tree must first be updated with
3233 If the work tree contains multiple base commits, it must first be updated
3234 to a single base commit with
3236 If changes have been staged with
3238 these changes must first be committed with
3242 If the work tree contains local changes, these changes must first be
3249 contains changes to files outside of the work tree's path prefix,
3250 the work tree cannot be used to merge this branch.
3260 commands will refuse to run while a merge operation is in progress.
3261 Other commands which manipulate the work tree may be used for
3262 conflict resolution purposes.
3269 Abort an interrupted merge operation.
3270 If this option is used, no other command-line arguments are allowed.
3272 Allow a merge operation to continue with files in conflicted status.
3273 This option should generally be avoided, and can only be used with the
3277 Continue an interrupted merge operation.
3278 If this option is used, no other command-line arguments are allowed except
3281 Create a merge commit even if the branches have not diverged.
3283 Merge changes into the work tree as usual but do not create a merge
3285 The merge result can be adjusted as desired before a merge commit is
3288 Alternatively, the merge may be aborted with
3295 .Op Fl F Ar response-script
3299 Stage local changes for inclusion in the next commit.
3302 is specified, stage all changes in the work tree.
3303 Otherwise, stage changes at or within the specified paths.
3304 Paths may be staged if they are added, modified, or deleted according to
3307 Show the status of each affected file, using the following status codes:
3308 .Bl -column YXZ description
3309 .It A Ta file addition has been staged
3310 .It M Ta file modification has been staged
3311 .It D Ta file deletion has been staged
3314 Staged file contents are saved in newly created blob objects in the repository.
3315 These blobs will be referred to by tree objects once staged changes have been
3318 Staged changes affect the behaviour of
3323 While paths with staged changes exist, the
3325 command will refuse to commit any paths which do not have staged changes.
3326 Local changes created on top of staged changes can only be committed if
3327 the path is staged again, or if the staged changes are committed first.
3330 command will show both local changes and staged changes.
3333 command is able to display local changes relative to staged changes,
3334 and to display staged changes relative to the repository.
3337 command cannot revert staged changes but may be used to revert
3338 local changes created on top of staged changes.
3344 .It Fl F Ar response-script
3352 responses line-by-line from the specified
3354 file instead of prompting interactively.
3356 Instead of staging new changes, list paths which are already staged,
3357 along with the IDs of staged blob objects and stage status codes.
3358 If paths were provided on the command line, show the staged paths
3359 among the specified paths.
3360 Otherwise, show all staged paths.
3362 Instead of staging the entire content of a changed file, interactively
3363 select or reject changes for staging based on
3367 (reject change), and
3369 (quit staging this file) responses.
3370 If a file is in modified status, individual patches derived from the
3371 modified file content can be staged.
3372 Files in added or deleted status may only be staged or rejected in
3375 Allow staging of symbolic links which point outside of the path space
3376 that is under version control.
3379 will reject such symbolic links due to safety concerns.
3382 may decide to represent such a symbolic link as a regular file which contains
3383 the link's target path, rather than creating an actual symbolic link which
3384 points outside of the work tree.
3385 Use of this option is discouraged because external mechanisms such as
3387 are better suited for managing symbolic links to paths not under
3392 will refuse to run if certain preconditions are not met.
3393 If a file contains merge conflicts, these conflicts must be resolved first.
3394 If a file is found to be out of date relative to the head commit on the
3395 work tree's current branch, the file must be updated with
3397 before it can be staged (however, this does not prevent the file from
3398 becoming out-of-date at some point after having been staged).
3406 commands will refuse to run while staged changes exist.
3407 If staged changes cannot be committed because a staged path
3408 is out of date, the path must be unstaged with
3410 before it can be updated with
3412 and may then be staged again if necessary.
3417 .Op Fl F Ar response-script
3421 Merge staged changes back into the work tree and put affected paths
3422 back into non-staged status.
3425 is specified, unstage all staged changes across the entire work tree.
3426 Otherwise, unstage changes at or within the specified paths.
3428 Show the status of each affected file, using the following status codes:
3429 .Bl -column YXZ description
3430 .It G Ta file was unstaged
3431 .It C Ta file was unstaged and conflicts occurred during merge
3432 .It ! Ta changes destined for a missing file were not merged
3433 .It D Ta file was staged as deleted and still is deleted
3434 .It d Ta file's deletion was prevented by local modifications
3435 .It \(a~ Ta changes destined for a non-regular file were not merged
3442 .It Fl F Ar response-script
3450 responses line-by-line from the specified
3452 file instead of prompting interactively.
3454 Instead of unstaging the entire content of a changed file, interactively
3455 select or reject changes for unstaging based on
3459 (keep change staged), and
3461 (quit unstaging this file) responses.
3462 If a file is staged in modified status, individual patches derived from the
3463 staged file content can be unstaged.
3464 Files staged in added or deleted status may only be unstaged in their entirety.
3470 .Op Fl r Ar repository-path
3473 Parse and print contents of objects to standard output in a line-based
3475 Content of commit, tree, and tag objects is printed in a way similar
3476 to the actual content stored in such objects.
3477 Blob object contents are printed as they would appear in files on disk.
3479 Attempt to interpret each argument as a reference, a tag name, or
3480 an object ID SHA1 hash.
3481 References will be resolved to an object ID.
3482 Tag names will resolved to a tag object.
3483 An abbreviated hash argument will be expanded to a full SHA1 hash
3484 automatically, provided the abbreviation is unique.
3486 If none of the above interpretations produce a valid result, or if the
3488 option is used, attempt to interpret the argument as a path which will
3489 be resolved to the ID of an object found at this path in the repository.
3496 Look up paths in the specified
3498 If this option is not used, paths are looked up in the commit resolved
3499 via the repository's HEAD reference.
3500 The expected argument is a commit ID SHA1 hash or an existing reference
3501 or tag name which will be resolved to a commit ID.
3502 An abbreviated hash argument will be expanded to a full SHA1 hash
3503 automatically, provided the abbreviation is unique.
3505 Interpret all arguments as paths only.
3506 This option can be used to resolve ambiguity in cases where paths
3507 look like tag names, reference names, or object IDs.
3508 .It Fl r Ar repository-path
3509 Use the repository at the specified path.
3510 If not specified, assume the repository is located at or above the current
3512 If this directory is a
3514 work tree, use the repository path associated with this work tree.
3516 .It Cm info Op Ar path ...
3517 Display meta-data stored in a work tree.
3522 The work tree to use is resolved implicitly by walking upwards from the
3523 current working directory.
3527 arguments are specified, show additional per-file information for tracked
3528 files located at or within these paths.
3531 argument corresponds to the work tree's root directory, display information
3532 for all tracked files.
3535 .Bl -tag -width GOT_IGNORE_GITCONFIG
3537 The author's name and email address, such as
3538 .Dq An Flan Hacker Aq Mt flan_hacker@openbsd.org .
3549 may fail to parse commits without an email address in author data,
3553 environment variables with a missing email address.
3555 .Ev GOT_AUTHOR will be overridden by configuration settings in
3561 configuration settings in the repository's
3568 configuration settings contained in Git's global
3570 configuration file will only be used if neither
3574 environment variable provide author information.
3575 .It Ev GOT_IGNORE_GITCONFIG
3576 If this variable is set then any remote repository definitions or author
3577 information found in Git configuration files will be ignored.
3578 .It Ev GOT_LOG_DEFAULT_LIMIT
3579 The default limit on the number of commits traversed by
3581 If set to zero, the limit is unbounded.
3582 This variable will be silently ignored if it is set to a non-numeric value.
3583 .It Ev VISUAL , EDITOR
3584 The editor spawned by
3592 text editor will be spawned.
3595 .Bl -tag -width packed-refs -compact
3597 Repository-wide configuration settings for
3601 configuration file located in the root directory of a Git repository
3602 supersedes any relevant settings in Git's
3606 .It Pa .got/got.conf
3607 Worktree-specific configuration settings for
3611 configuration file in the
3613 meta-data directory of a work tree supersedes any relevant settings in
3616 configuration file and Git's
3623 Enable tab-completion of
3628 .Dl $ set -A complete_got_1 -- $(got -h 2>&1 | sed -n s/commands://p)
3630 Clone an existing Git repository for use with
3634 .Dl $ got clone ssh://git@github.com/openbsd/src.git
3636 Unfortunately, many of the popular Git hosting sites do not offer anonymous
3638 Such sites will require an account to be created, and a public SSH key to be
3639 uploaded to this account, before repository access via ssh:// URLs will work.
3641 Use of HTTP URLs currently requires
3645 .Dl $ git clone --bare https://github.com/openbsd/src.git
3647 Alternatively, for quick and dirty local testing of
3649 a new Git repository could be created and populated with files,
3650 e.g. from a temporary CVS checkout located at
3653 .Dl $ gotadmin init /var/git/src.git
3654 .Dl $ got import -r /var/git/src.git -I CVS -I obj /tmp/src
3656 Check out a work tree from the Git repository to /usr/src:
3658 .Dl $ got checkout /var/git/src.git /usr/src
3660 View local changes in a work tree directory:
3662 .Dl $ got diff | less
3664 In a work tree, display files in a potentially problematic state:
3666 .Dl $ got status -s 'C!~?'
3668 Interactively revert selected local changes in a work tree directory:
3670 .Dl $ got revert -p -R\ .
3672 In a work tree or a git repository directory, list all branch references:
3676 As above, but list the most recently modified branches only:
3678 .Dl $ got branch -lt | head
3680 In a work tree or a git repository directory, create a new branch called
3681 .Dq unified-buffer-cache
3682 which is forked off the
3686 .Dl $ got branch -c master unified-buffer-cache
3688 Switch an existing work tree to the branch
3689 .Dq unified-buffer-cache .
3690 Local changes in the work tree will be preserved and merged if necessary:
3692 .Dl $ got update -b unified-buffer-cache
3694 Create a new commit from local changes in a work tree directory.
3695 This new commit will become the head commit of the work tree's current branch:
3699 In a work tree or a git repository directory, view changes committed in
3700 the 3 most recent commits to the work tree's branch, or the branch resolved
3701 via the repository's HEAD reference, respectively:
3703 .Dl $ got log -p -l 3
3705 As above, but display changes in the order in which
3707 could apply them in sequence:
3709 .Dl $ got log -p -l 3 -R
3711 In a work tree or a git repository directory, log the history of a subdirectory:
3713 .Dl $ got log sys/uvm
3715 While operating inside a work tree, paths are specified relative to the current
3716 working directory, so this command will log the subdirectory
3719 .Dl $ cd sys/uvm && got log\ .
3721 And this command has the same effect:
3723 .Dl $ cd sys/dev/usb && got log ../../uvm
3725 And this command displays work tree meta-data about all tracked files:
3728 .Dl $ got info\ . | less
3730 Add new files and remove obsolete files in a work tree directory:
3732 .Dl $ got add sys/uvm/uvm_ubc.c
3733 .Dl $ got remove sys/uvm/uvm_vnode.c
3735 Create a new commit from local changes in a work tree directory
3736 with a pre-defined log message.
3738 .Dl $ got commit -m 'unify the buffer cache'
3740 Alternatively, create a new commit from local changes in a work tree
3741 directory with a log message that has been prepared in the file
3744 .Dl $ got commit -F /tmp/msg
3746 Update any work tree checked out from the
3747 .Dq unified-buffer-cache
3748 branch to the latest commit on this branch:
3752 Roll file content on the unified-buffer-cache branch back by one commit,
3753 and then fetch the rolled-back change into the work tree as a local change
3754 to be amended and perhaps committed again:
3756 .Dl $ got backout unified-buffer-cache
3757 .Dl $ got commit -m 'roll back previous'
3758 .Dl $ # now back out the previous backout :-)
3759 .Dl $ got backout unified-buffer-cache
3761 Fetch new changes on the remote repository's
3763 branch, making them visible on the local repository's
3770 In a repository created with a HTTP URL and
3771 .Cm git clone --bare
3774 command must be used instead:
3776 .Dl $ cd /var/git/src.git
3777 .Dl $ git fetch origin master:refs/remotes/origin/master
3781 branch to merge the new changes that are now visible on the
3786 .Dl $ got update -b origin/master
3787 .Dl $ got rebase master
3790 .Dq unified-buffer-cache
3791 branch on top of the new head commit of the
3795 .Dl $ got update -b master
3796 .Dl $ got rebase unified-buffer-cache
3798 Create a patch from all changes on the unified-buffer-cache branch.
3799 The patch can be mailed out for review and applied to
3803 .Dl $ got diff master unified-buffer-cache > /tmp/ubc.diff
3805 Edit the entire commit history of the
3806 .Dq unified-buffer-cache
3809 .Dl $ got update -b unified-buffer-cache
3810 .Dl $ got update -c master
3813 Before working against existing branches in a repository cloned with
3814 .Cm git clone --bare
3819 must be configured to map all references in the remote repository
3822 namespace of the local repository.
3823 This can be achieved by setting Git's
3824 .Pa remote.origin.fetch
3825 configuration variable to the value
3826 .Dq +refs/heads/*:refs/remotes/origin/*
3831 .Dl $ cd /var/git/repo
3832 .Dl $ git config remote.origin.fetch '+refs/heads/*:refs/remotes/origin/*'
3836 option must be disabled:
3838 .Dl $ cd /var/git/repo
3839 .Dl $ git config remote.origin.mirror false
3841 Alternatively, the following
3843 configuration item can be added manually to the Git repository's
3847 .Dl [remote \&"origin\&"]
3849 .Dl fetch = +refs/heads/*:refs/remotes/origin/*
3852 This configuration leaves the local repository's
3854 namespace free for use by local branches checked out with
3856 and, if needed, created with
3859 .Dq refs/remotes/origin
3860 namespace can now be updated with incoming changes from the remote
3865 without extra command line arguments.
3866 Newly fetched changes can be examined with
3869 Display changes on the remote repository's version of the
3871 branch, as of the last time
3875 .Dl $ got log -c origin/master | less
3877 As shown here, most commands accept abbreviated reference names such as
3880 .Dq refs/remotes/origin/master .
3881 The latter is only needed in case of ambiguity.
3884 can be used to merge changes which are visible on the
3889 This will also merge local changes, if any, with the incoming changes:
3891 .Dl $ got update -b origin/master
3892 .Dl $ got rebase master
3894 In order to make changes committed to the
3895 .Dq unified-buffer-cache
3899 .Dq unified-buffer-cache
3900 branch can be rebased onto the
3904 .Dl $ got update -b master
3905 .Dl $ got rebase unified-buffer-cache
3908 .Dq unified-buffer-cache
3909 branch can now be made visible on the
3913 Because the rebase operation switched the work tree to the
3914 .Dq unified-buffer-cache
3915 branch, the work tree must be switched back to the
3919 .Dl $ got update -b master
3920 .Dl $ got integrate unified-buffer-cache
3924 branch, log messages for local changes can now be amended with
3926 by other developers and any other important new information:
3928 .Dl $ got update -c origin/master
3929 .Dl $ got histedit -m
3931 If the remote repository offers write access, local changes on the
3933 branch can be sent to the remote repository with
3937 can be run without further arguments.
3938 The arguments shown here match defaults, provided the work tree's
3939 current branch is the
3943 .Dl $ got send -b master origin
3945 If the remote repository requires the HTTPS protocol, the
3947 command must be used instead:
3949 .Dl $ cd /var/git/src.git
3950 .Dl $ git push origin master
3952 When making contributions to projects which use the
3954 workflow, SSH protocol repository access needs to be set up first.
3955 Once an account has been created on a Git hosting site it should
3956 be possible to upload a public SSH key for repository access
3961 workflow will usually involve two remote repositories.
3962 In the real-life example below, the
3964 repository was forked from the
3966 repository by using the Git hosting site's web interface.
3969 file in the local repository describes both remote repositories:
3970 .Bd -literal -offset indent
3971 # Jelmers's repository, which accepts pull requests
3973 server git@github.com
3975 repository "/jelmer/dulwich"
3979 # Stefan's fork, used as the default remote repository
3981 server git@github.com
3983 repository "/stspdotname/dulwich"
3988 With this configuration, Stefan can create commits on
3989 .Dq refs/heads/master
3990 and send them to the
3992 repository by running:
3994 .Dl $ got send -b master origin
3996 The changes can now be proposed to Jelmer by opening a pull request
3997 via the Git hosting site's web interface.
3998 If Jelmer requests further changes to be made, additional commits
3999 can be created on the
4001 branch and be added to the pull request by running
4005 If Jelmer prefers additional commits to be
4007 then the following commands can be used to achieve this:
4009 .Dl $ got update -b master
4010 .Dl $ got update -c origin/master
4011 .Dl $ got histedit -f
4012 .Dl $ got send -f -b master origin
4014 In addition to reviewing the pull request in the web user interface,
4015 Jelmer can fetch the pull request's branch into his local repository
4016 and create a local branch which contains the proposed changes:
4018 .Dl $ got fetch -R refs/pull/1046/head origin
4019 .Dl $ got branch -c refs/remotes/origin/pull/1046/head pr1046
4021 Once Jelmer has accepted the pull request, Stefan can fetch the
4022 merged changes, and possibly several other new changes, by running:
4024 .Dl $ got fetch upstream
4026 The merged changes will now be visible under the reference
4027 .Dq refs/remotes/upstream/master .
4030 branch can now be rebased on top of the latest changes
4033 .Dl $ got update -b upstream/master
4034 .Dl $ got rebase master
4036 As an alternative to
4038 branches can be merged with
4041 .Dl $ got update -b master
4042 .Dl $ got merge upstream/master
4044 The question of whether to rebase or merge branches is philosophical.
4045 When in doubt, refer to the software project's policies set by project
4048 As a final step, the forked repository's copy of the master branch needs
4049 to be kept in sync by sending the new changes there:
4051 .Dl $ got send -f -b master origin
4053 If multiple pull requests need to be managed in parallel, a separate branch
4054 must be created for each pull request with
4056 Each such branch can then be used as above, in place of
4057 .Dq refs/heads/master .
4058 Changes for any accepted pull requests will still appear under
4059 .Dq refs/remotes/upstream/master,
4060 regardless of which branch was used in the forked repository to
4061 create a pull request.
4065 .Xr git-repository 5 ,
4066 .Xr got-worktree 5 ,
4070 .An Anthony J. Bentley Aq Mt bentley@openbsd.org
4071 .An Christian Weisgerber Aq Mt naddy@openbsd.org
4072 .An Hiltjo Posthuma Aq Mt hiltjo@codemadness.org
4073 .An Josh Rickmar Aq Mt jrick@zettaport.com
4074 .An Joshua Stein Aq Mt jcs@openbsd.org
4075 .An Klemens Nanni Aq Mt kn@openbsd.org
4076 .An Martin Pieuchot Aq Mt mpi@openbsd.org
4077 .An Neels Hofmeyr Aq Mt neels@hofmeyr.de
4078 .An Omar Polo Aq Mt op@openbsd.org
4079 .An Ori Bernstein Aq Mt ori@openbsd.org
4080 .An Sebastien Marie Aq Mt semarie@openbsd.org
4081 .An Stefan Sperling Aq Mt stsp@openbsd.org
4082 .An Steven McDonald Aq Mt steven@steven-mcdonald.id.au
4083 .An Theo Buehler Aq Mt tb@openbsd.org
4084 .An Thomas Adam Aq Mt thomas@xteddy.org
4085 .An Tracey Emery Aq Mt tracey@traceyemery.net
4086 .An Yang Zhong Aq Mt yzhong@freebsdfoundation.org
4093 were derived from code under copyright by:
4095 .An Caldera International
4096 .An Daniel Hartmeier
4101 .An Jean-Francois Brousseau
4107 .An Niklas Hallqvist
4112 .An Xavier Santolaria
4115 contains code contributed to the public domain by
4116 .An Austin Appleby .
4119 is a work-in-progress and some features remain to be implemented.
4121 At present, the user has to fall back on
4123 to perform some tasks.
4127 Reading from remote repositories over HTTP or HTTPS protocols requires
4132 Writing to remote repositories over HTTP or HTTPS protocols requires
4135 The creation of merge commits with more than two parent commits requires
4138 In situations where files or directories were moved around
4140 will not automatically merge changes to new locations and
4142 will usually produce better results.
