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
65 .It Cm init Ar repository-path
66 Create a new empty repository at the specified
73 command must be used to populate the empty repository before
76 .It Cm import Oo Fl b Ar branch Oc Oo Fl m Ar message Oc Oo Fl r Ar repository-path Oc Oo Fl I Ar pattern Oc Ar directory
77 Create an initial commit in a repository from the file hierarchy
80 The created commit will not have any parent commits, i.e. it will be a
82 Also create a new reference which provides a branch name for the newly
84 Show the path of each imported file to indicate progress.
90 environment variable to be set,
91 unless an author has been configured in
97 configuration settings can be obtained from the repository's
99 file or from Git's global
110 instead of creating the default branch
112 Use of this option is required if the
114 branch already exists.
116 Use the specified log message when creating the new commit.
121 opens a temporary file in an editor where a log message can be written.
122 .It Fl r Ar repository-path
123 Use the repository at the specified path.
124 If not specified, assume the repository is located at or above the current
127 Ignore files or directories with a name which matches the specified
129 This option may be specified multiple times to build a list of ignore patterns.
132 follows the globbing rules documented in
138 .It Cm clone Oo Fl a Oc Oo Fl b Ar branch Oc Oo Fl l Oc Oo Fl m Oc Oo Fl q Oc Oo Fl v Oc Oo Fl R Ar reference Oc Ar repository-URL Op Ar directory
139 Clone a Git repository at the specified
145 is specified the directory name will be derived from the name of the
148 will refuse to run if the
154 specifies a protocol scheme, a server hostname, an optional port number
155 separated from the hostname by a colon, and a path to the repository on
157 .Lk scheme://hostname:port/path/to/repository
159 The following protocol schemes are supported:
160 .Bl -tag -width git+ssh
162 The Git protocol as implemented by the
165 Use of this protocol is discouraged since it supports neither authentication
168 The Git protocol wrapped in an authenticated and encrypted
171 With this protocol the hostname may contain an embedded username for
176 Short alias for git+ssh.
179 Objects in the cloned repository are stored in a pack file which is downloaded
181 This pack file will then be indexed to facilitate access to the objects stored
183 If any objects in the pack file are stored in deltified form, all deltas will
184 be fully resolved in order to compute the ID of such objects.
185 This can take some time.
186 More details about the pack file format are documented in
187 .Xr git-repository 5 .
190 creates a remote repository entry in the
194 files of the cloned repository to store the
200 arguments for future use by
210 Fetch all branches from the remote repository's
212 reference namespace and set
213 .Cm fetch-all-branches
214 in the cloned repository's
216 file for future use by
218 If this option is not specified, a branch resolved via the remote
219 repository's HEAD reference will be fetched.
220 Cannot be used together with the
226 from the remote repository's
229 This option may be specified multiple times to build a list of branches
231 If the branch corresponding to the remote repository's HEAD reference is not
232 in this list, the cloned repository's HEAD reference will be set to the first
233 branch which was fetched.
234 If this option is not specified, a branch resolved via the remote
235 repository's HEAD reference will be fetched.
236 Cannot be used together with the
240 List branches and tags available for fetching from the remote repository
241 and exit immediately.
242 Cannot be used together with any of the other options except
247 Create the cloned repository as a mirror of the original repository.
248 This is useful if the cloned repository will not be used to store
249 locally created commits.
255 files will be set up with the
257 option enabled, such that
261 will write incoming changes directly to branches in the
263 reference namespace, rather than to branches in the
266 This avoids the usual requirement of having to run
270 in order to make incoming changes appear on branches in the
273 But maintaining custom changes in the cloned repository becomes difficult
274 since such changes will be at risk of being discarded whenever incoming
277 Suppress progress reporting output.
278 The same option will be passed to
285 to print debugging messages to standard error output.
286 This option will be passed to
289 Multiple -v options increase the verbosity.
291 .It Fl R Ar reference
292 In addition to the branches and tags that will be fetched, fetch an arbitrary
294 from the remote repository's
297 This option may be specified multiple times to build a list of additional
301 may either be a path to a specific reference, or a reference namespace
302 which will cause all references in this namespace to be fetched.
304 Each reference will be mapped into the cloned repository's
306 namespace, unless the
308 option is used to mirror references directly into the cloned repository's
313 will refuse to fetch references from the remote repository's
322 .It Cm fetch Oo Fl a Oc Oo Fl b Ar branch Oc Oo Fl d Oc Oo Fl l Oc Oo Fl r Ar repository-path Oc Oo Fl t Oc Oo Fl q Oc Oo Fl v Oc Oo Fl R Ar reference Oc Oo Fl X Oc Op Ar remote-repository
323 Fetch new changes from a remote repository.
325 .Ar remote-repository
329 The remote repository's URL is obtained from the corresponding entry in
333 file of the local repository, as created by
336 New changes will be stored in a separate pack file downloaded from the server.
337 Optionally, separate pack files stored in the repository can be combined with
340 By default, branch references in the
342 reference namespace will be updated to point at the newly fetched commits.
345 command can then be used to make new changes visible on branches in the
347 namespace, merging incoming changes with the changes on those branches
350 If the repository was created as a mirror with
352 then all branches in the
354 namespace will be updated directly to match the corresponding branches in
355 the remote repository.
356 If those branches contained local commits, these commits will no longer be
357 reachable via a reference and will therefore be at risk of being discarded
358 by Git's garbage collector or
359 .Cm gotadmin cleanup .
360 Maintaining custom changes in a mirror repository is therefore discouraged.
362 In any case, references in the
364 namespace will always be fetched and mapped directly to local references
365 in the same namespace.
372 Fetch all branches from the remote repository's
375 This option can be enabled by default for specific repositories in
377 If this option is not specified, a branch resolved via the remote
378 repository's HEAD reference will be fetched.
379 Cannot be used together with the
385 from the remote repository's
388 This option may be specified multiple times to build a list of branches
390 If this option is not specified, a branch resolved via the remote
391 repository's HEAD reference will be fetched.
392 Cannot be used together with the
396 Delete branches and tags from the local repository which are no longer
397 present in the remote repository.
398 Only references are deleted.
399 Any commit, tree, tag, and blob objects belonging to deleted branches or
400 tags remain in the repository and may be removed separately with
401 Git's garbage collector or
402 .Cm gotadmin cleanup .
404 List branches and tags available for fetching from the remote repository
405 and exit immediately.
406 Cannot be used together with any of the other options except
412 Allow existing references in the
414 namespace to be updated if they have changed on the server.
415 If not specified, only new tag references will be created.
416 .It Fl r Ar repository-path
417 Use the repository at the specified path.
418 If not specified, assume the repository is located at or above the current
420 If this directory is a
422 work tree, use the repository path associated with this work tree.
424 Suppress progress reporting output.
425 The same option will be passed to
432 to print debugging messages to standard error output.
433 The same option will be passed to
436 Multiple -v options increase the verbosity.
438 .It Fl R Ar reference
439 In addition to the branches and tags that will be fetched, fetch an arbitrary
441 from the remote repository's
444 This option may be specified multiple times to build a list of additional
448 may either be a path to a specific reference, or a reference namespace
449 which will cause all references in this namespace to be fetched.
451 Each reference will be mapped into the local repository's
453 namespace, unless the local repository was created as a mirror with
455 in which case references will be mapped directly into the local repository's
459 Once a reference has been fetched, a branch based on it can be created with
464 will refuse to fetch references from the remote repository's
470 Delete all references which correspond to a particular
471 .Ar remote-repository
472 instead of fetching new changes.
473 This can be useful when a remote repository is being removed from
479 .Ar remote-repository
480 argument is mandatory and no other options except
487 Only references are deleted.
488 Any commit, tree, tag, and blob objects fetched from a remote repository
489 will generally be stored in pack files and may be removed separately with
491 and Git's garbage collector.
496 .It Cm checkout Oo Fl E Oc Oo Fl b Ar branch Oc Oo Fl c Ar commit Oc Oo Fl p Ar path-prefix Oc Ar repository-path Op Ar work-tree-path
497 Copy files from a repository into a new work tree.
498 Show the status of each affected file, using the following status codes:
499 .Bl -column YXZ description
500 .It A Ta new file was added
501 .It E Ta file already exists in work tree's meta-data
506 is not specified, either use the last component of
507 .Ar repository path ,
510 was specified use the last component of
518 Proceed with the checkout operation even if the directory at
521 Existing files will be left intact.
523 Check out files from a commit on the specified
525 If this option is not specified, a branch resolved via the repository's HEAD
526 reference will be used.
528 Check out files from the specified
530 on the selected branch.
531 The expected argument is a commit ID SHA1 hash or an existing reference
532 or tag name which will be resolved to a commit ID.
533 An abbreviated hash argument will be expanded to a full SHA1 hash
534 automatically, provided the abbreviation is unique.
535 If this option is not specified, the most recent commit on the selected
540 is not contained in the selected branch, a different branch which contains
541 this commit must be specified with the
544 If no such branch is known a new branch must be created for this
550 Checking out work trees with an unknown branch is intentionally not supported.
551 .It Fl p Ar path-prefix
552 Restrict the work tree to a subset of the repository's tree hierarchy.
553 Only files beneath the specified
560 .It Cm update Oo Fl b Ar branch Oc Oo Fl c Ar commit Oc Op Ar path ...
561 Update an existing work tree to a different
563 Change existing files in the work tree as necessary to match file contents
565 Preserve any local changes in the work tree and merge them with the
568 Files which already contain merge conflicts will not be updated to avoid
569 further complications.
570 Such files will be updated when
572 is run again after merge conflicts have been resolved.
573 If the conflicting changes are no longer needed affected files can be
580 Show the status of each affected file, using the following status codes:
581 .Bl -column YXZ description
582 .It U Ta file was updated and contained no local changes
583 .It G Ta file was updated and local changes were merged cleanly
584 .It C Ta file was updated and conflicts occurred during merge
585 .It D Ta file was deleted
586 .It A Ta new file was added
587 .It \(a~ Ta versioned file is obstructed by a non-regular file
588 .It ! Ta a missing versioned file was restored
589 .It # Ta file was not updated because it contains merge conflicts
590 .It ? Ta changes destined for an unversioned file were not merged
595 is specified, update the entire work tree.
596 Otherwise, restrict the update operation to files at or within the
598 Each path is required to exist in the update operation's target commit.
599 Files in the work tree outside specified paths will remain unchanged and
600 will retain their previously recorded base commit.
603 commands may refuse to run while the work tree contains files from
604 multiple base commits.
605 The base commit of such a work tree can be made consistent by running
607 across the entire work tree.
610 is incompatible with the
615 cannot update paths with staged changes.
616 If changes have been staged with
618 these changes must first be committed with
628 Switch the work tree's branch reference to the specified
630 before updating the work tree.
631 This option requires that all paths in the work tree are updated.
633 As usual, any local changes in the work tree will be preserved.
634 This can be useful when switching to a newly created branch in order
635 to commit existing local changes to this branch.
637 Any local changes must be dealt with separately in order to obtain a
638 work tree with pristine file contents corresponding exactly to the specified
640 Such changes could first be committed to a different branch with
642 or could be discarded with
645 Update the work tree to the specified
647 The expected argument is a commit ID SHA1 hash or an existing reference
648 or tag name which will be resolved to a commit ID.
649 An abbreviated hash argument will be expanded to a full SHA1 hash
650 automatically, provided the abbreviation is unique.
651 If this option is not specified, the most recent commit on the work tree's
657 .It Cm status Oo Fl I Oc Oo Fl s Ar status-codes Oc Op Ar path ...
658 Show the current modification status of files in a work tree,
659 using the following status codes:
660 .Bl -column YXZ description
661 .It M Ta modified file
662 .It A Ta file scheduled for addition in next commit
663 .It D Ta file scheduled for deletion in next commit
664 .It C Ta modified or added file which contains merge conflicts
665 .It ! Ta versioned file was expected on disk but is missing
666 .It \(a~ Ta versioned file is obstructed by a non-regular file
667 .It ? Ta unversioned item not tracked by
669 .It m Ta modified file modes (executable bit only)
670 .It N Ta non-existent
672 specified on the command line
677 is specified, show modifications in the entire work tree.
678 Otherwise, show modifications at or within the specified paths.
680 If changes have been staged with
682 staged changes are shown in the second output column, using the following
684 .Bl -column YXZ description
685 .It M Ta file modification is staged
686 .It A Ta file addition is staged
687 .It D Ta file deletion is staged
690 Changes created on top of staged changes are indicated in the first column:
691 .Bl -column YXZ description
692 .It MM Ta file was modified after earlier changes have been staged
693 .It MA Ta file was modified after having been staged for addition
701 Show unversioned files even if they match an ignore pattern.
702 .It Fl s Ar status-codes
703 Only show files with a modification status matching any of the
704 single-character status codes contained in the
707 Any combination of codes from the above list of possible status codes
709 For staged files, status codes displayed in either column will be matched.
712 For compatibility with
723 files in each traversed directory and will not display unversioned files
724 which match these patterns.
729 supports consecutive asterisks,
731 which will match an arbitrary amount of directories.
735 only supports a single ignore pattern per line.
739 does not support negated ignore patterns prefixed with
741 and gives no special significance to the location of path component separators,
747 .It Cm log Oo Fl b Oc Oo Fl c Ar commit Oc Oo Fl C Ar number Oc Oo Fl l Ar N Oc Oo Fl p Oc Oo Fl P Oc Oo Fl s Ar search-pattern Oc Oo Fl r Ar repository-path Oc Oo Fl R Oc Oo Fl x Ar commit Oc Op Ar path
748 Display history of a repository.
751 is specified, show only commits which modified this path.
752 If invoked in a work tree, the
754 is interpreted relative to the current working directory,
755 and the work tree's path prefix is implicitly prepended.
756 Otherwise, the path is interpreted relative to the repository root.
763 Display individual commits which were merged into the current branch
767 shows the linear history of the current branch only.
769 Start traversing history at the specified
771 The expected argument is a commit ID SHA1 hash or an existing reference
772 or tag name which will be resolved to a commit ID.
773 An abbreviated hash argument will be expanded to a full SHA1 hash
774 automatically, provided the abbreviation is unique.
775 If this option is not specified, default to the work tree's current branch
776 if invoked in a work tree, or to the repository's HEAD reference.
778 Set the number of context lines shown in diffs with
780 By default, 3 lines of context are shown.
782 Limit history traversal to a given number of commits.
783 If this option is not specified, a default limit value of zero is used,
784 which is treated as an unbounded limit.
786 .Ev GOT_LOG_DEFAULT_LIMIT
787 environment variable may be set to change this default value.
789 Display the patch of modifications made in each commit.
792 is specified, only show the patch of modifications at or within this path.
794 Display the list of file paths changed in each commit, using the following
796 .Bl -column YXZ description
797 .It M Ta modified file
798 .It D Ta file was deleted
799 .It A Ta new file was added
800 .It m Ta modified file modes (executable bit only)
802 .It Fl s Ar search-pattern
803 If specified, show only commits with a log message matched by the extended
806 When used together with
808 then the file paths changed by a commit can be matched as well.
809 Regular expression syntax is documented in
811 .It Fl r Ar repository-path
812 Use the repository at the specified path.
813 If not specified, assume the repository is located at or above the current
815 If this directory is a
817 work tree, use the repository path associated with this work tree.
819 Determine a set of commits to display as usual, but display these commits
822 Stop traversing commit history immediately after the specified
825 This option has no effect if the specified
829 .It Cm diff Oo Fl a Oc Oo Fl C Ar number Oc Oo Fl r Ar repository-path Oc Oo Fl s Oc Oo Fl w Oc Op Ar object1 Ar object2 | Ar path
830 When invoked within a work tree with less than two arguments, display
831 local changes in the work tree.
834 is specified, only show changes within this path.
836 If two arguments are provided, treat each argument as a reference, a tag
837 name, or an object ID SHA1 hash, and display differences between the
838 corresponding objects.
839 Both objects must be of the same type (blobs, trees, or commits).
840 An abbreviated hash argument will be expanded to a full SHA1 hash
841 automatically, provided the abbreviation is unique.
848 Treat file contents as ASCII text even if binary data is detected.
850 Set the number of context lines shown in the diff.
851 By default, 3 lines of context are shown.
852 .It Fl r Ar repository-path
853 Use the repository at the specified path.
854 If not specified, assume the repository is located at or above the current
856 If this directory is a
858 work tree, use the repository path associated with this work tree.
860 Show changes staged with
862 instead of showing local changes in the work tree.
863 This option is only valid when
865 is invoked in a work tree.
867 Ignore whitespace-only changes.
872 .It Cm blame Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Ar path
873 Display line-by-line history of a file at the specified path.
880 Start traversing history at the specified
882 The expected argument is a commit ID SHA1 hash or an existing reference
883 or tag name which will be resolved to a commit ID.
884 An abbreviated hash argument will be expanded to a full SHA1 hash
885 automatically, provided the abbreviation is unique.
886 .It Fl r Ar repository-path
887 Use the repository at the specified path.
888 If not specified, assume the repository is located at or above the current
890 If this directory is a
892 work tree, use the repository path associated with this work tree.
897 .It Cm tree Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Oo Fl i Oc Oo Fl R Oc Op Ar path
898 Display a listing of files and directories at the specified
899 directory path in the repository.
900 Entries shown in this listing may carry one of the following trailing
902 .Bl -column YXZ description
903 .It @ Ta entry is a symbolic link
904 .It / Ta entry is a directory
905 .It * Ta entry is an executable file
906 .It $ Ta entry is a Git submodule
909 Symbolic link entries are also annotated with the target path of the link.
913 is specified, list the repository path corresponding to the current
914 directory of the work tree, or the root directory of the repository
915 if there is no work tree.
922 List files and directories as they appear in the specified
924 The expected argument is a commit ID SHA1 hash or an existing reference
925 or tag name which will be resolved to a commit ID.
926 An abbreviated hash argument will be expanded to a full SHA1 hash
927 automatically, provided the abbreviation is unique.
928 .It Fl r Ar repository-path
929 Use the repository at the specified path.
930 If not specified, assume the repository is located at or above the current
932 If this directory is a
934 work tree, use the repository path associated with this work tree.
936 Show object IDs of files (blob objects) and directories (tree objects).
938 Recurse into sub-directories in the repository.
943 .It Cm ref Oo Fl r Ar repository-path Oc Oo Fl l Oc Oo Fl c Ar object Oc Oo Fl s Ar reference Oc Oo Fl d Oc Op Ar name
944 Manage references in a repository.
946 References may be listed, created, deleted, and changed.
947 When creating, deleting, or changing a reference the specified
949 must be an absolute reference name, i.e. it must begin with
956 .It Fl r Ar repository-path
957 Use the repository at the specified path.
958 If not specified, assume the repository is located at or above the current
960 If this directory is a
962 work tree, use the repository path associated with this work tree.
964 List references in the repository.
967 is specified, list all existing references in the repository.
970 is a reference namespace, list all references in this namespace.
971 Otherwise, show only the reference with the given
973 Cannot be used together with any other options except
976 Create a reference or change an existing reference.
977 The reference with the specified
979 will point at the specified
983 argument is a ID SHA1 hash or an existing reference or tag name which will
984 be resolved to the ID of a corresponding commit, tree, tag, or blob object.
985 Cannot be used together with any other options except
987 .It Fl s Ar reference
988 Create a symbolic reference, or change an existing symbolic reference.
989 The symbolic reference with the specified
991 will point at the specified
993 which must already exist in the repository.
994 Care should be taken not to create loops between references when
996 Cannot be used together with any other options except
999 Delete the reference with the specified
1001 from the repository.
1002 Any commit, tree, tag, and blob objects belonging to deleted references
1003 remain in the repository and may be removed separately with
1004 Git's garbage collector or
1005 .Cm gotadmin cleanup .
1006 Cannot be used together with any other options except
1009 .It Cm branch Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Oo Fl l Oc Oo Fl d Ar name Oc Oo Fl n Oc Op Ar name
1010 Create, list, or delete branches.
1012 Local branches are managed via references which live in the
1014 reference namespace.
1017 command creates references in this namespace only.
1019 When deleting branches the specified
1023 reference namespace first.
1024 If no corresponding branch is found the
1026 namespace will be searched next.
1028 If invoked in a work tree without any arguments, print the name of the
1029 work tree's current branch.
1033 argument is passed, attempt to create a branch reference with the given name.
1034 By default the new branch reference will point at the latest commit on the
1035 work tree's current branch if invoked in a work tree, and otherwise to a commit
1036 resolved via the repository's HEAD reference.
1038 If invoked in a work tree, once the branch was created successfully
1039 switch the work tree's head reference to the newly created branch and
1040 update files across the entire work tree, just like
1041 .Cm got update -b Ar name
1043 Show the status of each affected file, using the following status codes:
1044 .Bl -column YXZ description
1045 .It U Ta file was updated and contained no local changes
1046 .It G Ta file was updated and local changes were merged cleanly
1047 .It C Ta file was updated and conflicts occurred during merge
1048 .It D Ta file was deleted
1049 .It A Ta new file was added
1050 .It \(a~ Ta versioned file is obstructed by a non-regular file
1051 .It ! Ta a missing versioned file was restored
1059 Make a newly created branch reference point at the specified
1063 argument is a commit ID SHA1 hash or an existing reference
1064 or tag name which will be resolved to a commit ID.
1065 .It Fl r Ar repository-path
1066 Use the repository at the specified path.
1067 If not specified, assume the repository is located at or above the current
1069 If this directory is a
1071 work tree, use the repository path associated with this work tree.
1073 List all existing branches in the repository, including copies of remote
1074 repositories' branches in the
1076 reference namespace.
1078 If invoked in a work tree, the work tree's current branch is shown
1079 with one the following annotations:
1080 .Bl -column YXZ description
1081 .It * Ta work tree's base commit matches the branch tip
1082 .It \(a~ Ta work tree's base commit is out-of-date
1085 Delete the branch with the specified
1091 reference namespace.
1093 Only the branch reference is deleted.
1094 Any commit, tree, and blob objects belonging to the branch
1095 remain in the repository and may be removed separately with
1096 Git's garbage collector or
1097 .Cm gotadmin cleanup .
1099 Do not switch and update the work tree after creating a new branch.
1104 .It Cm tag Oo Fl c Ar commit Oc Oo Fl m Ar message Oc Oo Fl r Ar repository-path Oc Oo Fl l Oc Ar name
1105 Manage tags in a repository.
1107 Tags are managed via references which live in the
1109 reference namespace.
1112 command operates on references in this namespace only.
1113 References in this namespace point at tag objects which contain a pointer
1114 to another object, a tag message, as well as author and timestamp information.
1116 Attempt to create a tag with the given
1118 and make this tag point at the given
1120 If no commit is specified, default to the latest commit on the work tree's
1121 current branch if invoked in a work tree, and to a commit resolved via
1122 the repository's HEAD reference otherwise.
1129 Make the newly created tag reference point at the specified
1133 argument is a commit ID SHA1 hash or an existing reference or tag name which
1134 will be resolved to a commit ID.
1135 An abbreviated hash argument will be expanded to a full SHA1 hash
1136 automatically, provided the abbreviation is unique.
1138 Use the specified tag message when creating the new tag.
1143 opens a temporary file in an editor where a tag message can be written.
1144 .It Fl r Ar repository-path
1145 Use the repository at the specified path.
1146 If not specified, assume the repository is located at or above the current
1148 If this directory is a
1150 work tree, use the repository path associated with this work tree.
1152 List all existing tags in the repository instead of creating a new tag.
1153 If this option is used, no other command-line arguments are allowed.
1158 command will not delete tags or change existing tags.
1159 If a tag must be deleted, the
1161 command may be used to delete a tag's reference.
1162 This should only be done if the tag has not already been copied to
1164 .It Cm add Oo Fl R Oc Oo Fl I Oc Ar path ...
1165 Schedule unversioned files in a work tree for addition to the
1166 repository in the next commit.
1167 By default, files which match a
1169 ignore pattern will not be added.
1176 Permit recursion into directories.
1177 If this option is not specified,
1179 will refuse to run if a specified
1183 Add files even if they match a
1187 .It Cm remove Oo Fl f Oc Oo Fl k Oc Oo Fl R Oc Oo Fl s Ar status-codes Oc Ar path ...
1188 Remove versioned files from a work tree and schedule them for deletion
1189 from the repository in the next commit.
1196 Perform the operation even if a file contains local modifications.
1198 Keep affected files on disk.
1200 Permit recursion into directories.
1201 If this option is not specified,
1203 will refuse to run if a specified
1206 .It Fl s Ar status-codes
1207 Only delete files with a modification status matching one of the
1208 single-character status codes contained in the
1211 The following status codes may be specified:
1212 .Bl -column YXZ description
1213 .It M Ta modified file (this implies the
1216 .It ! Ta versioned file expected on disk but missing
1222 .It Cm revert Oo Fl p Oc Oo Fl F Ar response-script Oc Oo Fl R Oc Ar path ...
1223 Revert any local changes in files at the specified paths in a work tree.
1224 File contents will be overwritten with those contained in the
1225 work tree's base commit.
1226 There is no way to bring discarded changes back after
1229 If a file was added with
1231 it will become an unversioned file again.
1232 If a file was deleted with
1234 it will be restored.
1241 Instead of reverting all changes in files, interactively select or reject
1242 changes to revert based on
1248 (quit reverting this file) responses.
1249 If a file is in modified status, individual patches derived from the
1250 modified file content can be reverted.
1251 Files in added or deleted status may only be reverted in their entirety.
1252 .It Fl F Ar response-script
1260 responses line-by-line from the specified
1262 file instead of prompting interactively.
1264 Permit recursion into directories.
1265 If this option is not specified,
1267 will refuse to run if a specified
1274 .It Cm commit Oo Fl F Ar path Oc Oo Fl m Ar message Oc Oo Fl N Oc Oo Fl S Oc Op Ar path ...
1275 Create a new commit in the repository from changes in a work tree
1276 and use this commit as the new base commit for the work tree.
1279 is specified, commit all changes in the work tree.
1280 Otherwise, commit changes at or within the specified paths.
1282 If changes have been explicitly staged for commit with
1284 only commit staged changes and reject any specified paths which
1285 have not been staged.
1288 opens a temporary file in an editor where a log message can be written
1296 options are used together.
1298 Show the status of each affected file, using the following status codes:
1299 .Bl -column YXZ description
1300 .It M Ta modified file
1301 .It D Ta file was deleted
1302 .It A Ta new file was added
1303 .It m Ta modified file modes (executable bit only)
1306 Files which are not part of the new commit will retain their previously
1307 recorded base commit.
1310 commands may refuse to run while the work tree contains files from
1311 multiple base commits.
1312 The base commit of such a work tree can be made consistent by running
1314 across the entire work tree.
1318 command requires the
1320 environment variable to be set,
1321 unless an author has been configured in
1327 configuration settings can be
1328 obtained from the repository's
1330 file or from Git's global
1339 Use the prepared log message stored in the file found at
1341 when creating the new commit.
1343 opens a temporary file in an editor where the prepared log message can be
1344 reviewed and edited further if needed.
1345 Cannot be used together with the
1349 Use the specified log message when creating the new commit.
1350 Cannot be used together with the
1354 This option prevents
1356 from opening the commit message in an editor.
1357 It has no effect unless it is used together with the
1359 option and is intended for non-interactive use such as scripting.
1361 Allow the addition of symbolic links which point outside of the path space
1362 that is under version control.
1365 will reject such symbolic links due to safety concerns.
1368 may decide to represent such a symbolic link as a regular file which contains
1369 the link's target path, rather than creating an actual symbolic link which
1370 points outside of the work tree.
1371 Use of this option is discouraged because external mechanisms such as
1373 are better suited for managing symbolic links to paths not under
1378 will refuse to run if certain preconditions are not met.
1379 If the work tree's current branch is not in the
1381 reference namespace, new commits may not be created on this branch.
1382 Local changes may only be committed if they are based on file content
1383 found in the most recent commit on the work tree's branch.
1384 If a path is found to be out of date,
1386 must be used first in order to merge local changes with changes made
1391 .It Cm send Oo Fl a Oc Oo Fl b Ar branch Oc Oo Fl d Ar branch Oc Oo Fl f Oc Oo Fl r Ar repository-path Oc Oo Fl t Ar tag Oc Oo Fl T Oc Oo Fl q Oc Oo Fl v Oc Op Ar remote-repository
1392 Send new changes to a remote repository.
1394 .Ar remote-repository
1398 The remote repository's URL is obtained from the corresponding entry in
1402 file of the local repository, as created by
1405 All objects corresponding to new changes will be written to a temporary
1406 pack file which is then uploaded to the server.
1407 Upon success, references in the
1409 reference namespace of the local repository will be updated to point at
1410 the commits which have been sent.
1412 By default, changes will only be sent if they are based on up-to-date
1413 copies of relevant branches in the remote repository.
1414 If any changes to be sent are based on out-of-date copies or would
1415 otherwise break linear history of existing branches, new changes must
1416 be fetched from the server with
1418 and local branches must be rebased with
1425 option can be used to make exceptions to these requirements.
1432 Send all branches from the local repository's
1434 reference namespace.
1437 option is equivalent to listing all branches with multiple
1440 Cannot be used together with the
1446 from the local repository's
1448 reference namespace.
1449 This option may be specified multiple times to build a list of branches
1451 If this option is not specified, default to the work tree's current branch
1452 if invoked in a work tree, or to the repository's HEAD reference.
1453 Cannot be used together with the
1457 Delete the specified
1459 from the remote repository's
1461 reference namespace.
1462 This option may be specified multiple times to build a list of branches
1465 Only references are deleted.
1466 Any commit, tree, tag, and blob objects belonging to deleted branches
1467 may become subject to deletion by Git's garbage collector running on
1470 Requesting deletion of branches results in an error if the server
1471 does not support this feature or disallows the deletion of branches
1472 based on its configuration.
1474 Attempt to force the server to overwrite existing branches or tags
1475 in the remote repository, even when
1479 would usually be required before changes can be sent.
1480 The server may reject forced requests regardless, depending on its
1483 Any commit, tree, tag, and blob objects belonging to overwritten branches
1484 or tags may become subject to deletion by Git's garbage collector running
1489 reference namespace is globally shared between all repositories.
1492 option to overwrite tags is discouraged because it can lead to
1493 inconsistencies between the tags present in different repositories.
1494 In general, creating a new tag with a different name is recommended
1495 instead of overwriting an existing tag.
1499 option is particularly discouraged if changes being sent are based
1500 on an out-of-date copy of a branch in the remote repository.
1501 Instead of using the
1503 option, new changes should
1506 and local branches should be rebased with
1508 followed by another attempt to send the changes.
1512 option should only be needed in situations where the remote repository's
1513 copy of a branch or tag is known to be out-of-date and is considered
1515 The risks of creating inconsistencies between different repositories
1516 should also be taken into account.
1517 .It Fl r Ar repository-path
1518 Use the repository at the specified path.
1519 If not specified, assume the repository is located at or above the current
1521 If this directory is a
1523 work tree, use the repository path associated with this work tree.
1527 from the local repository's
1529 reference namespace, in addition to any branches that are being sent.
1532 option may be specified multiple times to build a list of tags to send.
1533 No tags will be sent if the
1537 Raise an error if the specified
1539 already exists in the remote repository, unless the
1541 option is used to overwrite the server's copy of the tag.
1542 In general, creating a new tag with a different name is recommended
1543 instead of overwriting an existing tag.
1545 Cannot be used together with the
1549 Attempt to send all tags from the local repository's
1551 reference namespace.
1554 option is equivalent to listing all tags with multiple
1557 Cannot be used together with the
1561 Suppress progress reporting output.
1562 The same option will be passed to
1569 to print debugging messages to standard error output.
1570 The same option will be passed to
1573 Multiple -v options increase the verbosity.
1579 .It Cm cherrypick Ar commit
1580 Merge changes from a single
1585 must be on a different branch than the work tree's base commit.
1586 The expected argument is a reference or a commit ID SHA1 hash.
1587 An abbreviated hash argument will be expanded to a full SHA1 hash
1588 automatically, provided the abbreviation is unique.
1590 Show the status of each affected file, using the following status codes:
1591 .Bl -column YXZ description
1592 .It G Ta file was merged
1593 .It C Ta file was merged and conflicts occurred during merge
1594 .It ! Ta changes destined for a missing file were not merged
1595 .It D Ta file was deleted
1596 .It d Ta file's deletion was obstructed by local modifications
1597 .It A Ta new file was added
1598 .It \(a~ Ta changes destined for a non-regular file were not merged
1599 .It ? Ta changes destined for an unversioned file were not merged
1602 The merged changes will appear as local changes in the work tree, which
1605 amended manually or with further
1610 or discarded again with
1614 will refuse to run if certain preconditions are not met.
1615 If the work tree contains multiple base commits it must first be updated
1616 to a single base commit with
1618 If the work tree already contains files with merge conflicts, these
1619 conflicts must be resolved first.
1623 .It Cm backout Ar commit
1624 Reverse-merge changes from a single
1629 must be on the same branch as the work tree's base commit.
1630 The expected argument is a reference or a commit ID SHA1 hash.
1631 An abbreviated hash argument will be expanded to a full SHA1 hash
1632 automatically, provided the abbreviation is unique.
1634 Show the status of each affected file, using the following status codes:
1635 .Bl -column YXZ description
1636 .It G Ta file was merged
1637 .It C Ta file was merged and conflicts occurred during merge
1638 .It ! Ta changes destined for a missing file were not merged
1639 .It D Ta file was deleted
1640 .It d Ta file's deletion was obstructed by local modifications
1641 .It A Ta new file was added
1642 .It \(a~ Ta changes destined for a non-regular file were not merged
1643 .It ? Ta changes destined for an unversioned file were not merged
1646 The reverse-merged changes will appear as local changes in the work tree,
1647 which may be viewed with
1649 amended manually or with further
1654 or discarded again with
1658 will refuse to run if certain preconditions are not met.
1659 If the work tree contains multiple base commits it must first be updated
1660 to a single base commit with
1662 If the work tree already contains files with merge conflicts, these
1663 conflicts must be resolved first.
1667 .It Cm rebase Oo Fl a Oc Oo Fl c Oc Oo Fl l Oc Oo Fl X Oc Op Ar branch
1668 Rebase commits on the specified
1670 onto the tip of the current branch of the work tree.
1673 must share common ancestry with the work tree's current branch.
1674 Rebasing begins with the first descendant commit of the youngest
1675 common ancestor commit shared by the specified
1677 and the work tree's current branch, and stops once the tip commit
1684 is used as intended, the specified
1686 represents a local commit history and may already contain changes
1687 that are not yet visible in any other repositories.
1688 The work tree's current branch, which must be set with
1692 operation, represents a branch from a remote repository which shares
1693 a common history with the specified
1695 but has progressed, and perhaps diverged, due to commits added to the
1698 Rebased commits are accumulated on a temporary branch which the work tree
1699 will remain switched to throughout the entire rebase operation.
1700 Commits on this branch represent the same changes with the same log
1701 messages as their counterparts on the original
1703 but with different commit IDs.
1704 Once rebasing has completed successfully, the temporary branch becomes
1705 the new version of the specified
1707 and the work tree is automatically switched to it.
1709 Old commits in their pre-rebase state are automatically backed up in the
1710 .Dq refs/got/backup/rebase
1711 reference namespace.
1712 As long as these references are not removed older versions of rebased
1713 commits will remain in the repository and can be viewed with the
1716 Removal of these references makes objects which become unreachable via
1717 any reference subject to removal by Git's garbage collector or
1718 .Cm gotadmin cleanup .
1720 While rebasing commits, show the status of each affected file,
1721 using the following status codes:
1722 .Bl -column YXZ description
1723 .It G Ta file was merged
1724 .It C Ta file was merged and conflicts occurred during merge
1725 .It ! Ta changes destined for a missing file were not merged
1726 .It D Ta file was deleted
1727 .It d Ta file's deletion was obstructed by local modifications
1728 .It A Ta new file was added
1729 .It \(a~ Ta changes destined for a non-regular file were not merged
1730 .It ? Ta changes destined for an unversioned file were not merged
1733 If merge conflicts occur the rebase operation is interrupted and may
1734 be continued once conflicts have been resolved.
1735 Alternatively, the rebase operation may be aborted which will leave
1737 unmodified and the work tree switched back to its original branch.
1739 If a merge conflict is resolved in a way which renders the merged
1740 change into a no-op change, the corresponding commit will be elided
1741 when the rebase operation continues.
1744 will refuse to run if certain preconditions are not met.
1745 If the work tree is not yet fully updated to the tip commit of its
1746 branch then the work tree must first be updated with
1748 If changes have been staged with
1750 these changes must first be committed with
1754 If the work tree contains local changes, these changes must first be
1761 contains changes to files outside of the work tree's path prefix,
1762 the work tree cannot be used to rebase this branch.
1768 commands will refuse to run while a rebase operation is in progress.
1769 Other commands which manipulate the work tree may be used for
1770 conflict resolution purposes.
1777 Abort an interrupted rebase operation.
1778 If this option is used, no other command-line arguments are allowed.
1780 Continue an interrupted rebase operation.
1781 If this option is used, no other command-line arguments are allowed.
1783 Show a list of past rebase operations, represented by references in the
1784 .Dq refs/got/backup/rebase
1785 reference namespace.
1787 Display the author, date, and log message of each backed up commit,
1788 the object ID of the corresponding post-rebase commit, and
1789 the object ID of their common ancestor commit.
1790 Given these object IDs,
1797 options can be used to examine the history of either version of the branch,
1802 option can be used to create a new branch from a pre-rebase state if desired.
1806 is specified, only show commits which at some point in time represented this
1808 Otherwise, list all backed up commits for any branches.
1810 If this option is used,
1812 does not require a work tree.
1813 None of the other options can be used together with
1816 Delete backups created by past rebase operations, represented by references
1818 .Dq refs/got/backup/rebase
1819 reference namespace.
1823 is specified, only delete backups which at some point in time represented
1825 Otherwise, delete all references found within
1826 .Dq refs/got/backup/rebase .
1828 Any commit, tree, tag, and blob objects belonging to deleted backups
1829 remain in the repository and may be removed separately with
1830 Git's garbage collector or
1831 .Cm gotadmin cleanup .
1833 If this option is used,
1835 does not require a work tree.
1836 None of the other options can be used together with
1842 .It Cm histedit Oo Fl a Oc Oo Fl c Oc Oo Fl f Oc Oo Fl F Ar histedit-script Oc Oo Fl m Oc Oo Fl l Oc Oo Fl X Oc Op Ar branch
1843 Edit commit history between the work tree's current base commit and
1844 the tip commit of the work tree's current branch.
1848 operation the work tree's current branch must be set with
1850 to the branch which should be edited, unless this branch is already the
1851 current branch of the work tree.
1852 The tip of this branch represents the upper bound (inclusive) of commits
1857 Furthermore, the work tree's base commit
1860 to a point in this branch's commit history where editing should begin.
1861 This commit represents the lower bound (non-inclusive) of commits touched
1866 Editing of commit history is controlled via a
1868 which can be written in an editor based on a template, passed on the
1869 command line, or generated with the
1875 The format of the histedit script is line-based.
1876 Each line in the script begins with a command name, followed by
1877 whitespace and an argument.
1878 For most commands, the expected argument is a commit ID SHA1 hash.
1879 Any remaining text on the line is ignored.
1880 Lines which begin with the
1882 character are ignored entirely.
1884 The available commands are as follows:
1885 .Bl -column YXZ pick-commit
1886 .It pick Ar commit Ta Use the specified commit as it is.
1887 .It edit Ar commit Ta Use the specified commit but once changes have been
1888 merged into the work tree interrupt the histedit operation for amending.
1889 .It fold Ar commit Ta Combine the specified commit with the next commit
1890 listed further below that will be used.
1891 .It drop Ar commit Ta Remove this commit from the edited history.
1892 .It mesg Ar log-message Ta Use the specified single-line log message for
1893 the commit on the previous line.
1894 If the log message argument is left empty, open an editor where a new
1895 log message can be written.
1898 Every commit in the history being edited must be mentioned in the script.
1899 Lines may be re-ordered to change the order of commits in the edited history.
1900 No commit may be listed more than once.
1902 Edited commits are accumulated on a temporary branch which the work tree
1903 will remain switched to throughout the entire histedit operation.
1904 Once history editing has completed successfully, the temporary branch becomes
1905 the new version of the work tree's branch and the work tree is automatically
1908 Old commits in their pre-histedit state are automatically backed up in the
1909 .Dq refs/got/backup/histedit
1910 reference namespace.
1911 As long as these references are not removed older versions of edited
1912 commits will remain in the repository and can be viewed with the
1915 Removal of these references makes objects which become unreachable via
1916 any reference subject to removal by Git's garbage collector or
1917 .Cm gotadmin cleanup .
1919 While merging commits, show the status of each affected file,
1920 using the following status codes:
1921 .Bl -column YXZ description
1922 .It G Ta file was merged
1923 .It C Ta file was merged and conflicts occurred during merge
1924 .It ! Ta changes destined for a missing file were not merged
1925 .It D Ta file was deleted
1926 .It d Ta file's deletion was obstructed by local modifications
1927 .It A Ta new file was added
1928 .It \(a~ Ta changes destined for a non-regular file were not merged
1929 .It ? Ta changes destined for an unversioned file were not merged
1932 If merge conflicts occur the histedit operation is interrupted and may
1933 be continued once conflicts have been resolved.
1934 Alternatively, the histedit operation may be aborted which will leave
1935 the work tree switched back to its original branch.
1937 If a merge conflict is resolved in a way which renders the merged
1938 change into a no-op change, the corresponding commit will be elided
1939 when the histedit operation continues.
1942 will refuse to run if certain preconditions are not met.
1943 If the work tree's current branch is not in the
1945 reference namespace, the history of the branch may not be edited.
1946 If the work tree contains multiple base commits it must first be updated
1947 to a single base commit with
1949 If changes have been staged with
1951 these changes must first be committed with
1955 If the work tree contains local changes, these changes must first be
1960 If the edited history contains changes to files outside of the work tree's
1961 path prefix, the work tree cannot be used to edit the history of this branch.
1968 commands will refuse to run while a histedit operation is in progress.
1969 Other commands which manipulate the work tree may be used, and the
1971 command may be used to commit arbitrary changes to the temporary branch
1972 while the histedit operation is interrupted.
1979 Abort an interrupted histedit operation.
1980 If this option is used, no other command-line arguments are allowed.
1982 Continue an interrupted histedit operation.
1983 If this option is used, no other command-line arguments are allowed.
1985 Fold all commits into a single commit.
1986 This option is a quick equivalent to a histedit script which folds all
1987 commits, combining them all into one commit.
1990 option can only be used when starting a new histedit operation.
1991 If this option is used, no other command-line arguments are allowed.
1992 .It Fl F Ar histedit-script
1995 instead of opening a temporary file in an editor where a histedit script
1998 Edit log messages only.
1999 This option is a quick equivalent to a histedit script which edits
2000 only log messages but otherwise leaves every picked commit as-is.
2003 option can only be used when starting a new histedit operation.
2004 If this option is used, no other command-line arguments are allowed.
2006 Show a list of past histedit operations, represented by references in the
2007 .Dq refs/got/backup/histedit
2008 reference namespace.
2010 Display the author, date, and log message of each backed up commit,
2011 the object ID of the corresponding post-histedit commit, and
2012 the object ID of their common ancestor commit.
2013 Given these object IDs,
2020 options can be used to examine the history of either version of the branch,
2025 option can be used to create a new branch from a pre-histedit state if desired.
2029 is specified, only show commits which at some point in time represented this
2031 Otherwise, list all backed up commits for any branches.
2033 If this option is used,
2035 does not require a work tree.
2036 None of the other options can be used together with
2039 Delete backups created by past histedit operations, represented by references
2041 .Dq refs/got/backup/histedit
2042 reference namespace.
2046 is specified, only delete backups which at some point in time represented
2048 Otherwise, delete all references found within
2049 .Dq refs/got/backup/histedit .
2051 Any commit, tree, tag, and blob objects belonging to deleted backups
2052 remain in the repository and may be removed separately with
2053 Git's garbage collector or
2054 .Cm gotadmin cleanup .
2056 If this option is used,
2058 does not require a work tree.
2059 None of the other options can be used together with
2065 .It Cm integrate Ar branch
2066 Integrate the specified
2068 into the work tree's current branch.
2069 Files in the work tree are updated to match the contents on the integrated
2071 and the reference of the work tree's branch is changed to point at the
2072 head commit of the integrated
2075 Both branches can be considered equivalent after integration since they
2076 will be pointing at the same commit.
2077 Both branches remain available for future work, if desired.
2078 In case the integrated
2080 is no longer needed it may be deleted with
2083 Show the status of each affected file, using the following status codes:
2084 .Bl -column YXZ description
2085 .It U Ta file was updated
2086 .It D Ta file was deleted
2087 .It A Ta new file was added
2088 .It \(a~ Ta versioned file is obstructed by a non-regular file
2089 .It ! Ta a missing versioned file was restored
2093 will refuse to run if certain preconditions are not met.
2094 Most importantly, the
2096 must have been rebased onto the work tree's current branch with
2098 before it can be integrated, in order to linearize commit history and
2099 resolve merge conflicts.
2100 If the work tree contains multiple base commits it must first be updated
2101 to a single base commit with
2103 If changes have been staged with
2105 these changes must first be committed with
2109 If the work tree contains local changes, these changes must first be
2117 .It Cm stage Oo Fl l Oc Oo Fl p Oc Oo Fl F Ar response-script Oc Oo Fl S Oc Op Ar path ...
2118 Stage local changes for inclusion in the next commit.
2121 is specified, stage all changes in the work tree.
2122 Otherwise, stage changes at or within the specified paths.
2123 Paths may be staged if they are added, modified, or deleted according to
2126 Show the status of each affected file, using the following status codes:
2127 .Bl -column YXZ description
2128 .It A Ta file addition has been staged
2129 .It M Ta file modification has been staged
2130 .It D Ta file deletion has been staged
2133 Staged file contents are saved in newly created blob objects in the repository.
2134 These blobs will be referred to by tree objects once staged changes have been
2137 Staged changes affect the behaviour of
2142 While paths with staged changes exist, the
2144 command will refuse to commit any paths which do not have staged changes.
2145 Local changes created on top of staged changes can only be committed if
2146 the path is staged again, or if the staged changes are committed first.
2149 command will show both local changes and staged changes.
2152 command is able to display local changes relative to staged changes,
2153 and to display staged changes relative to the repository.
2156 command cannot revert staged changes but may be used to revert
2157 local changes created on top of staged changes.
2164 Instead of staging new changes, list paths which are already staged,
2165 along with the IDs of staged blob objects and stage status codes.
2166 If paths were provided in the command line show the staged paths
2167 among the specified paths.
2168 Otherwise, show all staged paths.
2170 Instead of staging the entire content of a changed file, interactively
2171 select or reject changes for staging based on
2175 (reject change), and
2177 (quit staging this file) responses.
2178 If a file is in modified status, individual patches derived from the
2179 modified file content can be staged.
2180 Files in added or deleted status may only be staged or rejected in
2182 .It Fl F Ar response-script
2190 responses line-by-line from the specified
2192 file instead of prompting interactively.
2194 Allow staging of symbolic links which point outside of the path space
2195 that is under version control.
2198 will reject such symbolic links due to safety concerns.
2201 may decide to represent such a symbolic link as a regular file which contains
2202 the link's target path, rather than creating an actual symbolic link which
2203 points outside of the work tree.
2204 Use of this option is discouraged because external mechanisms such as
2206 are better suited for managing symbolic links to paths not under
2211 will refuse to run if certain preconditions are not met.
2212 If a file contains merge conflicts, these conflicts must be resolved first.
2213 If a file is found to be out of date relative to the head commit on the
2214 work tree's current branch, the file must be updated with
2216 before it can be staged (however, this does not prevent the file from
2217 becoming out-of-date at some point after having been staged).
2224 commands will refuse to run while staged changes exist.
2225 If staged changes cannot be committed because a staged path
2226 is out of date, the path must be unstaged with
2228 before it can be updated with
2230 and may then be staged again if necessary.
2234 .It Cm unstage Oo Fl p Oc Oo Fl F Ar response-script Oc Op Ar path ...
2235 Merge staged changes back into the work tree and put affected paths
2236 back into non-staged status.
2239 is specified, unstage all staged changes across the entire work tree.
2240 Otherwise, unstage changes at or within the specified paths.
2242 Show the status of each affected file, using the following status codes:
2243 .Bl -column YXZ description
2244 .It G Ta file was unstaged
2245 .It C Ta file was unstaged and conflicts occurred during merge
2246 .It ! Ta changes destined for a missing file were not merged
2247 .It D Ta file was staged as deleted and still is deleted
2248 .It d Ta file's deletion was obstructed by local modifications
2249 .It \(a~ Ta changes destined for a non-regular file were not merged
2257 Instead of unstaging the entire content of a changed file, interactively
2258 select or reject changes for unstaging based on
2262 (keep change staged), and
2264 (quit unstaging this file) responses.
2265 If a file is staged in modified status, individual patches derived from the
2266 staged file content can be unstaged.
2267 Files staged in added or deleted status may only be unstaged in their entirety.
2268 .It Fl F Ar response-script
2276 responses line-by-line from the specified
2278 file instead of prompting interactively.
2283 .It Cm cat Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Oo Fl P Oc Ar arg ...
2284 Parse and print contents of objects to standard output in a line-based
2286 Content of commit, tree, and tag objects is printed in a way similar
2287 to the actual content stored in such objects.
2288 Blob object contents are printed as they would appear in files on disk.
2290 Attempt to interpret each argument as a reference, a tag name, or
2291 an object ID SHA1 hash.
2292 References will be resolved to an object ID.
2293 Tag names will resolved to a tag object.
2294 An abbreviated hash argument will be expanded to a full SHA1 hash
2295 automatically, provided the abbreviation is unique.
2297 If none of the above interpretations produce a valid result, or if the
2299 option is used, attempt to interpret the argument as a path which will
2300 be resolved to the ID of an object found at this path in the repository.
2307 Look up paths in the specified
2309 If this option is not used, paths are looked up in the commit resolved
2310 via the repository's HEAD reference.
2311 The expected argument is a commit ID SHA1 hash or an existing reference
2312 or tag name which will be resolved to a commit ID.
2313 An abbreviated hash argument will be expanded to a full SHA1 hash
2314 automatically, provided the abbreviation is unique.
2315 .It Fl r Ar repository-path
2316 Use the repository at the specified path.
2317 If not specified, assume the repository is located at or above the current
2319 If this directory is a
2321 work tree, use the repository path associated with this work tree.
2323 Interpret all arguments as paths only.
2324 This option can be used to resolve ambiguity in cases where paths
2325 look like tag names, reference names, or object IDs.
2327 .It Cm info Op Ar path ...
2328 Display meta-data stored in a work tree.
2333 The work tree to use is resolved implicitly by walking upwards from the
2334 current working directory.
2338 arguments are specified, show additional per-file information for tracked
2339 files located at or within these paths.
2342 argument corresponds to the work tree's root directory, display information
2343 for all tracked files.
2346 .Bl -tag -width GOT_AUTHOR
2348 The author's name and email address for
2353 .Dq An Flan Hacker Aq Mt flan_hacker@openbsd.org .
2356 may fail to parse commits without an email address in author data,
2360 environment variables with a missing email address.
2362 .Ev GOT_AUTHOR will be overridden by configuration settings in
2368 configuration settings in the repository's
2375 configuration settings contained in Git's global
2377 configuration file will only be used if neither
2381 environment variable provide author information.
2382 .It Ev VISUAL , EDITOR
2383 The editor spawned by
2391 text editor will be spawned in order to give
2393 the attention it deserves.
2394 .It Ev GOT_LOG_DEFAULT_LIMIT
2395 The default limit on the number of commits traversed by
2397 If set to zero, the limit is unbounded.
2398 This variable will be silently ignored if it is set to a non-numeric value.
2401 .Bl -tag -width packed-refs -compact
2403 Repository-wide configuration settings for
2407 configuration file located in the root directory of a Git repository
2408 supersedes any relevant settings in Git's
2412 .It Pa .got/got.conf
2413 Worktree-specific configuration settings for
2417 configuration file in the
2419 meta-data directory of a work tree supersedes any relevant settings in
2422 configuration file and Git's
2429 Enable tab-completion of
2434 .Dl $ set -A complete_got_1 -- $(got -h 2>&1 | sed -n s/commands://p)
2436 Clone an existing Git repository for use with
2440 .Dl $ got clone ssh://git@github.com/openbsd/src.git
2442 Use of HTTP URLs currently requires
2446 .Dl $ git clone --bare https://github.com/openbsd/src.git
2448 Alternatively, for quick and dirty local testing of
2450 a new Git repository could be created and populated with files,
2451 e.g. from a temporary CVS checkout located at
2454 .Dl $ got init /var/git/src.git
2455 .Dl $ got import -r /var/git/src.git -I CVS -I obj /tmp/src
2457 Check out a work tree from the Git repository to /usr/src:
2459 .Dl $ got checkout /var/git/src.git /usr/src
2461 View local changes in a work tree directory:
2463 .Dl $ got diff | less
2465 In a work tree, display files in a potentially problematic state:
2467 .Dl $ got status -s 'C!~?'
2469 Interactively revert selected local changes in a work tree directory:
2471 .Dl $ got revert -p -R\ .
2473 In a work tree or a git repository directory, list all branch references:
2477 In a work tree or a git repository directory, create a new branch called
2478 .Dq unified-buffer-cache
2479 which is forked off the
2483 .Dl $ got branch -c master unified-buffer-cache
2485 Switch an existing work tree to the branch
2486 .Dq unified-buffer-cache .
2487 Local changes in the work tree will be preserved and merged if necessary:
2489 .Dl $ got update -b unified-buffer-cache
2491 Create a new commit from local changes in a work tree directory.
2492 This new commit will become the head commit of the work tree's current branch:
2496 In a work tree or a git repository directory, view changes committed in
2497 the 3 most recent commits to the work tree's branch, or the branch resolved
2498 via the repository's HEAD reference, respectively:
2500 .Dl $ got log -p -l 3
2502 As above, but display changes in the order in which
2504 could apply them in sequence:
2506 .Dl $ got log -p -l 3 -R
2508 In a work tree or a git repository directory, log the history of a subdirectory:
2510 .Dl $ got log sys/uvm
2512 While operating inside a work tree, paths are specified relative to the current
2513 working directory, so this command will log the subdirectory
2516 .Dl $ cd sys/uvm && got log\ .
2518 And this command has the same effect:
2520 .Dl $ cd sys/dev/usb && got log ../../uvm
2522 And this command displays work tree meta-data about all tracked files:
2525 .Dl $ got info\ . | less
2527 Add new files and remove obsolete files in a work tree directory:
2529 .Dl $ got add sys/uvm/uvm_ubc.c
2530 .Dl $ got remove sys/uvm/uvm_vnode.c
2532 Create a new commit from local changes in a work tree directory
2533 with a pre-defined log message.
2535 .Dl $ got commit -m 'unify the buffer cache'
2537 Alternatively, create a new commit from local changes in a work tree
2538 directory with a log message that has been prepared in the file
2541 .Dl $ got commit -F /tmp/msg
2543 Update any work tree checked out from the
2544 .Dq unified-buffer-cache
2545 branch to the latest commit on this branch:
2549 Roll file content on the unified-buffer-cache branch back by one commit,
2550 and then fetch the rolled-back change into the work tree as a local change
2551 to be amended and perhaps committed again:
2553 .Dl $ got backout unified-buffer-cache
2554 .Dl $ got commit -m 'roll back previous'
2555 .Dl $ # now back out the previous backout :-)
2556 .Dl $ got backout unified-buffer-cache
2558 Fetch new changes on the remote repository's
2560 branch, making them visible on the local repository's
2567 In a repository created with a HTTP URL and
2568 .Cm git clone --bare
2571 command must be used instead:
2573 .Dl $ cd /var/git/src.git
2574 .Dl $ git fetch origin master:refs/remotes/origin/master
2578 branch to merge the new changes that are now visible on the
2583 .Dl $ got update -b origin/master
2584 .Dl $ got rebase master
2587 .Dq unified-buffer-cache
2588 branch on top of the new head commit of the
2592 .Dl $ got update -b master
2593 .Dl $ got rebase unified-buffer-cache
2595 Create a patch from all changes on the unified-buffer-cache branch.
2596 The patch can be mailed out for review and applied to
2600 .Dl $ got diff master unified-buffer-cache > /tmp/ubc.diff
2602 Edit the entire commit history of the
2603 .Dq unified-buffer-cache
2606 .Dl $ got update -b unified-buffer-cache
2607 .Dl $ got update -c master
2610 Before working against existing branches in a repository cloned with
2611 .Cm git clone --bare
2616 must be configured to map all references in the remote repository
2619 namespace of the local repository.
2620 This can be achieved by setting Git's
2621 .Pa remote.origin.fetch
2622 configuration variable to the value
2623 .Dq +refs/heads/*:refs/remotes/origin/*
2628 .Dl $ cd /var/git/repo
2629 .Dl $ git config remote.origin.fetch '+refs/heads/*:refs/remotes/origin/*'
2633 option must be disabled:
2635 .Dl $ cd /var/git/repo
2636 .Dl $ git config remote.origin.mirror false
2638 Alternatively, the following
2640 configuration item can be added manually to the Git repository's
2644 .Dl [remote \&"origin\&"]
2646 .Dl fetch = +refs/heads/*:refs/remotes/origin/*
2649 This configuration leaves the local repository's
2651 namespace free for use by local branches checked out with
2653 and, if needed, created with
2656 .Dq refs/remotes/origin
2657 namespace can now be updated with incoming changes from the remote
2662 without extra command line arguments.
2663 Newly fetched changes can be examined with
2666 Display changes on the remote repository's version of the
2668 branch, as of the last time
2672 .Dl $ got log -c origin/master | less
2674 As shown here, most commands accept abbreviated reference names such as
2677 .Dq refs/remotes/origin/master .
2678 The latter is only needed in case of ambiguity.
2681 must be used to merge changes which are visible on the
2686 This will also merge local changes, if any, with the incoming changes:
2688 .Dl $ got update -b origin/master
2689 .Dl $ got rebase master
2691 In order to make changes committed to the
2692 .Dq unified-buffer-cache
2696 .Dq unified-buffer-cache
2697 branch must first be rebased onto the
2701 .Dl $ got update -b master
2702 .Dl $ got rebase unified-buffer-cache
2705 .Dq unified-buffer-cache
2706 branch can now be made visible on the
2710 Because the rebase operation switched the work tree to the
2711 .Dq unified-buffer-cache
2712 branch the work tree must be switched back to the
2716 .Dl $ got update -b master
2717 .Dl $ got integrate unified-buffer-cache
2721 branch, log messages for local changes can now be amended with
2723 by other developers and any other important new information:
2725 .Dl $ got update -c origin/master
2726 .Dl $ got histedit -m
2728 If the remote repository offers write access local changes on the
2730 branch can be sent to the remote repository with
2734 can be run without further arguments.
2735 The arguments shown here match defaults, provided the work tree's
2736 current branch is the
2740 .Dl $ got send -b master origin
2742 If the remote repository requires the HTTPS protocol the
2744 command must be used instead:
2746 .Dl $ cd /var/git/src.git
2747 .Dl $ git push origin master
2751 .Xr git-repository 5 ,
2752 .Xr got-worktree 5 ,
2755 .An Stefan Sperling Aq Mt stsp@openbsd.org
2756 .An Martin Pieuchot Aq Mt mpi@openbsd.org
2757 .An Joshua Stein Aq Mt jcs@openbsd.org
2758 .An Ori Bernstein Aq Mt ori@openbsd.org
2761 is a work-in-progress and some features remain to be implemented.
2763 At present, the user has to fall back on
2765 to perform some tasks.
2769 Reading from remote repositories over HTTP or HTTPS protocols requires
2774 Writing to remote repositories over HTTP or HTTPS protocols requires
2777 The creation of merge commits, i.e. commits with two or more parent commits,
2781 In situations where files or directories were moved around
2783 will not automatically merge changes to new locations and
2785 will usually produce better results.
