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 or deletes references in this namespace only.
1019 If invoked in a work tree without any arguments, print the name of the
1020 work tree's current branch.
1024 argument is passed, attempt to create a branch reference with the given name.
1025 By default the new branch reference will point at the latest commit on the
1026 work tree's current branch if invoked in a work tree, and otherwise to a commit
1027 resolved via the repository's HEAD reference.
1029 If invoked in a work tree, once the branch was created successfully
1030 switch the work tree's head reference to the newly created branch and
1031 update files across the entire work tree, just like
1032 .Cm got update -b Ar name
1034 Show the status of each affected file, using the following status codes:
1035 .Bl -column YXZ description
1036 .It U Ta file was updated and contained no local changes
1037 .It G Ta file was updated and local changes were merged cleanly
1038 .It C Ta file was updated and conflicts occurred during merge
1039 .It D Ta file was deleted
1040 .It A Ta new file was added
1041 .It \(a~ Ta versioned file is obstructed by a non-regular file
1042 .It ! Ta a missing versioned file was restored
1050 Make a newly created branch reference point at the specified
1054 argument is a commit ID SHA1 hash or an existing reference
1055 or tag name which will be resolved to a commit ID.
1056 .It Fl r Ar repository-path
1057 Use the repository at the specified path.
1058 If not specified, assume the repository is located at or above the current
1060 If this directory is a
1062 work tree, use the repository path associated with this work tree.
1064 List all existing branches in the repository, including copies of remote
1065 repositories' branches in the
1067 reference namespace.
1069 If invoked in a work tree, the work tree's current branch is shown
1070 with one the following annotations:
1071 .Bl -column YXZ description
1072 .It * Ta work tree's base commit matches the branch tip
1073 .It \(a~ Ta work tree's base commit is out-of-date
1076 Delete the branch with the specified name from the repository.
1077 Only the branch reference is deleted.
1078 Any commit, tree, and blob objects belonging to the branch
1079 remain in the repository and may be removed separately with
1080 Git's garbage collector or
1081 .Cm gotadmin cleanup .
1083 Do not switch and update the work tree after creating a new branch.
1088 .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
1089 Manage tags in a repository.
1091 Tags are managed via references which live in the
1093 reference namespace.
1096 command operates on references in this namespace only.
1097 References in this namespace point at tag objects which contain a pointer
1098 to another object, a tag message, as well as author and timestamp information.
1100 Attempt to create a tag with the given
1102 and make this tag point at the given
1104 If no commit is specified, default to the latest commit on the work tree's
1105 current branch if invoked in a work tree, and to a commit resolved via
1106 the repository's HEAD reference otherwise.
1113 Make the newly created tag reference point at the specified
1117 argument is a commit ID SHA1 hash or an existing reference or tag name which
1118 will be resolved to a commit ID.
1119 An abbreviated hash argument will be expanded to a full SHA1 hash
1120 automatically, provided the abbreviation is unique.
1122 Use the specified tag message when creating the new tag.
1127 opens a temporary file in an editor where a tag message can be written.
1128 .It Fl r Ar repository-path
1129 Use the repository at the specified path.
1130 If not specified, assume the repository is located at or above the current
1132 If this directory is a
1134 work tree, use the repository path associated with this work tree.
1136 List all existing tags in the repository instead of creating a new tag.
1137 If this option is used, no other command-line arguments are allowed.
1142 command will not delete tags or change existing tags.
1143 If a tag must be deleted, the
1145 command may be used to delete a tag's reference.
1146 This should only be done if the tag has not already been copied to
1148 .It Cm add Oo Fl R Oc Oo Fl I Oc Ar path ...
1149 Schedule unversioned files in a work tree for addition to the
1150 repository in the next commit.
1151 By default, files which match a
1153 ignore pattern will not be added.
1160 Permit recursion into directories.
1161 If this option is not specified,
1163 will refuse to run if a specified
1167 Add files even if they match a
1171 .It Cm remove Oo Fl f Oc Oo Fl k Oc Oo Fl R Oc Oo Fl s Ar status-codes Oc Ar path ...
1172 Remove versioned files from a work tree and schedule them for deletion
1173 from the repository in the next commit.
1180 Perform the operation even if a file contains local modifications.
1182 Keep affected files on disk.
1184 Permit recursion into directories.
1185 If this option is not specified,
1187 will refuse to run if a specified
1190 .It Fl s Ar status-codes
1191 Only delete files with a modification status matching one of the
1192 single-character status codes contained in the
1195 The following status codes may be specified:
1196 .Bl -column YXZ description
1197 .It M Ta modified file (this implies the
1200 .It ! Ta versioned file expected on disk but missing
1206 .It Cm revert Oo Fl p Oc Oo Fl F Ar response-script Oc Oo Fl R Oc Ar path ...
1207 Revert any local changes in files at the specified paths in a work tree.
1208 File contents will be overwritten with those contained in the
1209 work tree's base commit.
1210 There is no way to bring discarded changes back after
1213 If a file was added with
1215 it will become an unversioned file again.
1216 If a file was deleted with
1218 it will be restored.
1225 Instead of reverting all changes in files, interactively select or reject
1226 changes to revert based on
1232 (quit reverting this file) responses.
1233 If a file is in modified status, individual patches derived from the
1234 modified file content can be reverted.
1235 Files in added or deleted status may only be reverted in their entirety.
1236 .It Fl F Ar response-script
1244 responses line-by-line from the specified
1246 file instead of prompting interactively.
1248 Permit recursion into directories.
1249 If this option is not specified,
1251 will refuse to run if a specified
1258 .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 ...
1259 Create a new commit in the repository from changes in a work tree
1260 and use this commit as the new base commit for the work tree.
1263 is specified, commit all changes in the work tree.
1264 Otherwise, commit changes at or within the specified paths.
1266 If changes have been explicitly staged for commit with
1268 only commit staged changes and reject any specified paths which
1269 have not been staged.
1272 opens a temporary file in an editor where a log message can be written
1280 options are used together.
1282 Show the status of each affected file, using the following status codes:
1283 .Bl -column YXZ description
1284 .It M Ta modified file
1285 .It D Ta file was deleted
1286 .It A Ta new file was added
1287 .It m Ta modified file modes (executable bit only)
1290 Files which are not part of the new commit will retain their previously
1291 recorded base commit.
1294 commands may refuse to run while the work tree contains files from
1295 multiple base commits.
1296 The base commit of such a work tree can be made consistent by running
1298 across the entire work tree.
1302 command requires the
1304 environment variable to be set,
1305 unless an author has been configured in
1311 configuration settings can be
1312 obtained from the repository's
1314 file or from Git's global
1323 Use the prepared log message stored in the file found at
1325 when creating the new commit.
1327 opens a temporary file in an editor where the prepared log message can be
1328 reviewed and edited further if needed.
1329 Cannot be used together with the
1333 Use the specified log message when creating the new commit.
1334 Cannot be used together with the
1338 This option prevents
1340 from opening the commit message in an editor.
1341 It has no effect unless it is used together with the
1343 option and is intended for non-interactive use such as scripting.
1345 Allow the addition of symbolic links which point outside of the path space
1346 that is under version control.
1349 will reject such symbolic links due to safety concerns.
1352 may decide to represent such a symbolic link as a regular file which contains
1353 the link's target path, rather than creating an actual symbolic link which
1354 points outside of the work tree.
1355 Use of this option is discouraged because external mechanisms such as
1357 are better suited for managing symbolic links to paths not under
1362 will refuse to run if certain preconditions are not met.
1363 If the work tree's current branch is not in the
1365 reference namespace, new commits may not be created on this branch.
1366 Local changes may only be committed if they are based on file content
1367 found in the most recent commit on the work tree's branch.
1368 If a path is found to be out of date,
1370 must be used first in order to merge local changes with changes made
1375 .It Cm cherrypick Ar commit
1376 Merge changes from a single
1381 must be on a different branch than the work tree's base commit.
1382 The expected argument is a reference or a commit ID SHA1 hash.
1383 An abbreviated hash argument will be expanded to a full SHA1 hash
1384 automatically, provided the abbreviation is unique.
1386 Show the status of each affected file, using the following status codes:
1387 .Bl -column YXZ description
1388 .It G Ta file was merged
1389 .It C Ta file was merged and conflicts occurred during merge
1390 .It ! Ta changes destined for a missing file were not merged
1391 .It D Ta file was deleted
1392 .It d Ta file's deletion was obstructed by local modifications
1393 .It A Ta new file was added
1394 .It \(a~ Ta changes destined for a non-regular file were not merged
1395 .It ? Ta changes destined for an unversioned file were not merged
1398 The merged changes will appear as local changes in the work tree, which
1401 amended manually or with further
1406 or discarded again with
1410 will refuse to run if certain preconditions are not met.
1411 If the work tree contains multiple base commits it must first be updated
1412 to a single base commit with
1414 If the work tree already contains files with merge conflicts, these
1415 conflicts must be resolved first.
1419 .It Cm backout Ar commit
1420 Reverse-merge changes from a single
1425 must be on the same branch as the work tree's base commit.
1426 The expected argument is a reference or a commit ID SHA1 hash.
1427 An abbreviated hash argument will be expanded to a full SHA1 hash
1428 automatically, provided the abbreviation is unique.
1430 Show the status of each affected file, using the following status codes:
1431 .Bl -column YXZ description
1432 .It G Ta file was merged
1433 .It C Ta file was merged and conflicts occurred during merge
1434 .It ! Ta changes destined for a missing file were not merged
1435 .It D Ta file was deleted
1436 .It d Ta file's deletion was obstructed by local modifications
1437 .It A Ta new file was added
1438 .It \(a~ Ta changes destined for a non-regular file were not merged
1439 .It ? Ta changes destined for an unversioned file were not merged
1442 The reverse-merged changes will appear as local changes in the work tree,
1443 which may be viewed with
1445 amended manually or with further
1450 or discarded again with
1454 will refuse to run if certain preconditions are not met.
1455 If the work tree contains multiple base commits it must first be updated
1456 to a single base commit with
1458 If the work tree already contains files with merge conflicts, these
1459 conflicts must be resolved first.
1463 .It Cm rebase Oo Fl a Oc Oo Fl c Oc Oo Fl l Oc Oo Fl X Oc Op Ar branch
1464 Rebase commits on the specified
1466 onto the tip of the current branch of the work tree.
1469 must share common ancestry with the work tree's current branch.
1470 Rebasing begins with the first descendant commit of the youngest
1471 common ancestor commit shared by the specified
1473 and the work tree's current branch, and stops once the tip commit
1480 is used as intended, the specified
1482 represents a local commit history and may already contain changes
1483 that are not yet visible in any other repositories.
1484 The work tree's current branch, which must be set with
1488 operation, represents a branch from a remote repository which shares
1489 a common history with the specified
1491 but has progressed, and perhaps diverged, due to commits added to the
1494 Rebased commits are accumulated on a temporary branch which the work tree
1495 will remain switched to throughout the entire rebase operation.
1496 Commits on this branch represent the same changes with the same log
1497 messages as their counterparts on the original
1499 but with different commit IDs.
1500 Once rebasing has completed successfully, the temporary branch becomes
1501 the new version of the specified
1503 and the work tree is automatically switched to it.
1505 Old commits in their pre-rebase state are automatically backed up in the
1506 .Dq refs/got/backup/rebase
1507 reference namespace.
1508 As long as these references are not removed older versions of rebased
1509 commits will remain in the repository and can be viewed with the
1512 Removal of these references makes objects which become unreachable via
1513 any reference subject to removal by Git's garbage collector or
1514 .Cm gotadmin cleanup .
1516 While rebasing commits, show the status of each affected file,
1517 using the following status codes:
1518 .Bl -column YXZ description
1519 .It G Ta file was merged
1520 .It C Ta file was merged and conflicts occurred during merge
1521 .It ! Ta changes destined for a missing file were not merged
1522 .It D Ta file was deleted
1523 .It d Ta file's deletion was obstructed by local modifications
1524 .It A Ta new file was added
1525 .It \(a~ Ta changes destined for a non-regular file were not merged
1526 .It ? Ta changes destined for an unversioned file were not merged
1529 If merge conflicts occur the rebase operation is interrupted and may
1530 be continued once conflicts have been resolved.
1531 Alternatively, the rebase operation may be aborted which will leave
1533 unmodified and the work tree switched back to its original branch.
1535 If a merge conflict is resolved in a way which renders the merged
1536 change into a no-op change, the corresponding commit will be elided
1537 when the rebase operation continues.
1540 will refuse to run if certain preconditions are not met.
1541 If the work tree is not yet fully updated to the tip commit of its
1542 branch then the work tree must first be updated with
1544 If changes have been staged with
1546 these changes must first be committed with
1550 If the work tree contains local changes, these changes must first be
1557 contains changes to files outside of the work tree's path prefix,
1558 the work tree cannot be used to rebase this branch.
1564 commands will refuse to run while a rebase operation is in progress.
1565 Other commands which manipulate the work tree may be used for
1566 conflict resolution purposes.
1573 Abort an interrupted rebase operation.
1574 If this option is used, no other command-line arguments are allowed.
1576 Continue an interrupted rebase operation.
1577 If this option is used, no other command-line arguments are allowed.
1579 Show a list of past rebase operations, represented by references in the
1580 .Dq refs/got/backup/rebase
1581 reference namespace.
1583 Display the author, date, and log message of each backed up commit,
1584 the object ID of the corresponding post-rebase commit, and
1585 the object ID of their common ancestor commit.
1586 Given these object IDs,
1593 options can be used to examine the history of either version of the branch,
1598 option can be used to create a new branch from a pre-rebase state if desired.
1602 is specified, only show commits which at some point in time represented this
1604 Otherwise, list all backed up commits for any branches.
1606 If this option is used,
1608 does not require a work tree.
1609 None of the other options can be used together with
1612 Delete backups created by past rebase operations, represented by references
1614 .Dq refs/got/backup/rebase
1615 reference namespace.
1619 is specified, only delete backups which at some point in time represented
1621 Otherwise, delete all references found within
1622 .Dq refs/got/backup/rebase .
1624 Any commit, tree, tag, and blob objects belonging to deleted backups
1625 remain in the repository and may be removed separately with
1626 Git's garbage collector or
1627 .Cm gotadmin cleanup .
1629 If this option is used,
1631 does not require a work tree.
1632 None of the other options can be used together with
1638 .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
1639 Edit commit history between the work tree's current base commit and
1640 the tip commit of the work tree's current branch.
1644 operation the work tree's current branch must be set with
1646 to the branch which should be edited, unless this branch is already the
1647 current branch of the work tree.
1648 The tip of this branch represents the upper bound (inclusive) of commits
1653 Furthermore, the work tree's base commit
1656 to a point in this branch's commit history where editing should begin.
1657 This commit represents the lower bound (non-inclusive) of commits touched
1662 Editing of commit history is controlled via a
1664 which can be written in an editor based on a template, passed on the
1665 command line, or generated with the
1671 The format of the histedit script is line-based.
1672 Each line in the script begins with a command name, followed by
1673 whitespace and an argument.
1674 For most commands, the expected argument is a commit ID SHA1 hash.
1675 Any remaining text on the line is ignored.
1676 Lines which begin with the
1678 character are ignored entirely.
1680 The available commands are as follows:
1681 .Bl -column YXZ pick-commit
1682 .It pick Ar commit Ta Use the specified commit as it is.
1683 .It edit Ar commit Ta Use the specified commit but once changes have been
1684 merged into the work tree interrupt the histedit operation for amending.
1685 .It fold Ar commit Ta Combine the specified commit with the next commit
1686 listed further below that will be used.
1687 .It drop Ar commit Ta Remove this commit from the edited history.
1688 .It mesg Ar log-message Ta Use the specified single-line log message for
1689 the commit on the previous line.
1690 If the log message argument is left empty, open an editor where a new
1691 log message can be written.
1694 Every commit in the history being edited must be mentioned in the script.
1695 Lines may be re-ordered to change the order of commits in the edited history.
1696 No commit may be listed more than once.
1698 Edited commits are accumulated on a temporary branch which the work tree
1699 will remain switched to throughout the entire histedit operation.
1700 Once history editing has completed successfully, the temporary branch becomes
1701 the new version of the work tree's branch and the work tree is automatically
1704 Old commits in their pre-histedit state are automatically backed up in the
1705 .Dq refs/got/backup/histedit
1706 reference namespace.
1707 As long as these references are not removed older versions of edited
1708 commits will remain in the repository and can be viewed with the
1711 Removal of these references makes objects which become unreachable via
1712 any reference subject to removal by Git's garbage collector or
1713 .Cm gotadmin cleanup .
1715 While merging commits, show the status of each affected file,
1716 using the following status codes:
1717 .Bl -column YXZ description
1718 .It G Ta file was merged
1719 .It C Ta file was merged and conflicts occurred during merge
1720 .It ! Ta changes destined for a missing file were not merged
1721 .It D Ta file was deleted
1722 .It d Ta file's deletion was obstructed by local modifications
1723 .It A Ta new file was added
1724 .It \(a~ Ta changes destined for a non-regular file were not merged
1725 .It ? Ta changes destined for an unversioned file were not merged
1728 If merge conflicts occur the histedit operation is interrupted and may
1729 be continued once conflicts have been resolved.
1730 Alternatively, the histedit operation may be aborted which will leave
1731 the work tree switched back to its original branch.
1733 If a merge conflict is resolved in a way which renders the merged
1734 change into a no-op change, the corresponding commit will be elided
1735 when the histedit operation continues.
1738 will refuse to run if certain preconditions are not met.
1739 If the work tree's current branch is not in the
1741 reference namespace, the history of the branch may not be edited.
1742 If the work tree contains multiple base commits it must first be updated
1743 to a single base commit with
1745 If changes have been staged with
1747 these changes must first be committed with
1751 If the work tree contains local changes, these changes must first be
1756 If the edited history contains changes to files outside of the work tree's
1757 path prefix, the work tree cannot be used to edit the history of this branch.
1764 commands will refuse to run while a histedit operation is in progress.
1765 Other commands which manipulate the work tree may be used, and the
1767 command may be used to commit arbitrary changes to the temporary branch
1768 while the histedit operation is interrupted.
1775 Abort an interrupted histedit operation.
1776 If this option is used, no other command-line arguments are allowed.
1778 Continue an interrupted histedit operation.
1779 If this option is used, no other command-line arguments are allowed.
1781 Fold all commits into a single commit.
1782 This option is a quick equivalent to a histedit script which folds all
1783 commits, combining them all into one commit.
1786 option can only be used when starting a new histedit operation.
1787 If this option is used, no other command-line arguments are allowed.
1788 .It Fl F Ar histedit-script
1791 instead of opening a temporary file in an editor where a histedit script
1794 Edit log messages only.
1795 This option is a quick equivalent to a histedit script which edits
1796 only log messages but otherwise leaves every picked commit as-is.
1799 option can only be used when starting a new histedit operation.
1800 If this option is used, no other command-line arguments are allowed.
1802 Show a list of past histedit operations, represented by references in the
1803 .Dq refs/got/backup/histedit
1804 reference namespace.
1806 Display the author, date, and log message of each backed up commit,
1807 the object ID of the corresponding post-histedit commit, and
1808 the object ID of their common ancestor commit.
1809 Given these object IDs,
1816 options can be used to examine the history of either version of the branch,
1821 option can be used to create a new branch from a pre-histedit state if desired.
1825 is specified, only show commits which at some point in time represented this
1827 Otherwise, list all backed up commits for any branches.
1829 If this option is used,
1831 does not require a work tree.
1832 None of the other options can be used together with
1835 Delete backups created by past histedit operations, represented by references
1837 .Dq refs/got/backup/histedit
1838 reference namespace.
1842 is specified, only delete backups which at some point in time represented
1844 Otherwise, delete all references found within
1845 .Dq refs/got/backup/histedit .
1847 Any commit, tree, tag, and blob objects belonging to deleted backups
1848 remain in the repository and may be removed separately with
1849 Git's garbage collector or
1850 .Cm gotadmin cleanup .
1852 If this option is used,
1854 does not require a work tree.
1855 None of the other options can be used together with
1861 .It Cm integrate Ar branch
1862 Integrate the specified
1864 into the work tree's current branch.
1865 Files in the work tree are updated to match the contents on the integrated
1867 and the reference of the work tree's branch is changed to point at the
1868 head commit of the integrated
1871 Both branches can be considered equivalent after integration since they
1872 will be pointing at the same commit.
1873 Both branches remain available for future work, if desired.
1874 In case the integrated
1876 is no longer needed it may be deleted with
1879 Show the status of each affected file, using the following status codes:
1880 .Bl -column YXZ description
1881 .It U Ta file was updated
1882 .It D Ta file was deleted
1883 .It A Ta new file was added
1884 .It \(a~ Ta versioned file is obstructed by a non-regular file
1885 .It ! Ta a missing versioned file was restored
1889 will refuse to run if certain preconditions are not met.
1890 Most importantly, the
1892 must have been rebased onto the work tree's current branch with
1894 before it can be integrated, in order to linearize commit history and
1895 resolve merge conflicts.
1896 If the work tree contains multiple base commits it must first be updated
1897 to a single base commit with
1899 If changes have been staged with
1901 these changes must first be committed with
1905 If the work tree contains local changes, these changes must first be
1913 .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 ...
1914 Stage local changes for inclusion in the next commit.
1917 is specified, stage all changes in the work tree.
1918 Otherwise, stage changes at or within the specified paths.
1919 Paths may be staged if they are added, modified, or deleted according to
1922 Show the status of each affected file, using the following status codes:
1923 .Bl -column YXZ description
1924 .It A Ta file addition has been staged
1925 .It M Ta file modification has been staged
1926 .It D Ta file deletion has been staged
1929 Staged file contents are saved in newly created blob objects in the repository.
1930 These blobs will be referred to by tree objects once staged changes have been
1933 Staged changes affect the behaviour of
1938 While paths with staged changes exist, the
1940 command will refuse to commit any paths which do not have staged changes.
1941 Local changes created on top of staged changes can only be committed if
1942 the path is staged again, or if the staged changes are committed first.
1945 command will show both local changes and staged changes.
1948 command is able to display local changes relative to staged changes,
1949 and to display staged changes relative to the repository.
1952 command cannot revert staged changes but may be used to revert
1953 local changes created on top of staged changes.
1960 Instead of staging new changes, list paths which are already staged,
1961 along with the IDs of staged blob objects and stage status codes.
1962 If paths were provided in the command line show the staged paths
1963 among the specified paths.
1964 Otherwise, show all staged paths.
1966 Instead of staging the entire content of a changed file, interactively
1967 select or reject changes for staging based on
1971 (reject change), and
1973 (quit staging this file) responses.
1974 If a file is in modified status, individual patches derived from the
1975 modified file content can be staged.
1976 Files in added or deleted status may only be staged or rejected in
1978 .It Fl F Ar response-script
1986 responses line-by-line from the specified
1988 file instead of prompting interactively.
1990 Allow staging of symbolic links which point outside of the path space
1991 that is under version control.
1994 will reject such symbolic links due to safety concerns.
1997 may decide to represent such a symbolic link as a regular file which contains
1998 the link's target path, rather than creating an actual symbolic link which
1999 points outside of the work tree.
2000 Use of this option is discouraged because external mechanisms such as
2002 are better suited for managing symbolic links to paths not under
2007 will refuse to run if certain preconditions are not met.
2008 If a file contains merge conflicts, these conflicts must be resolved first.
2009 If a file is found to be out of date relative to the head commit on the
2010 work tree's current branch, the file must be updated with
2012 before it can be staged (however, this does not prevent the file from
2013 becoming out-of-date at some point after having been staged).
2020 commands will refuse to run while staged changes exist.
2021 If staged changes cannot be committed because a staged path
2022 is out of date, the path must be unstaged with
2024 before it can be updated with
2026 and may then be staged again if necessary.
2030 .It Cm unstage Oo Fl p Oc Oo Fl F Ar response-script Oc Op Ar path ...
2031 Merge staged changes back into the work tree and put affected paths
2032 back into non-staged status.
2035 is specified, unstage all staged changes across the entire work tree.
2036 Otherwise, unstage changes at or within the specified paths.
2038 Show the status of each affected file, using the following status codes:
2039 .Bl -column YXZ description
2040 .It G Ta file was unstaged
2041 .It C Ta file was unstaged and conflicts occurred during merge
2042 .It ! Ta changes destined for a missing file were not merged
2043 .It D Ta file was staged as deleted and still is deleted
2044 .It d Ta file's deletion was obstructed by local modifications
2045 .It \(a~ Ta changes destined for a non-regular file were not merged
2053 Instead of unstaging the entire content of a changed file, interactively
2054 select or reject changes for unstaging based on
2058 (keep change staged), and
2060 (quit unstaging this file) responses.
2061 If a file is staged in modified status, individual patches derived from the
2062 staged file content can be unstaged.
2063 Files staged in added or deleted status may only be unstaged in their entirety.
2064 .It Fl F Ar response-script
2072 responses line-by-line from the specified
2074 file instead of prompting interactively.
2079 .It Cm cat Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Oo Fl P Oc Ar arg ...
2080 Parse and print contents of objects to standard output in a line-based
2082 Content of commit, tree, and tag objects is printed in a way similar
2083 to the actual content stored in such objects.
2084 Blob object contents are printed as they would appear in files on disk.
2086 Attempt to interpret each argument as a reference, a tag name, or
2087 an object ID SHA1 hash.
2088 References will be resolved to an object ID.
2089 Tag names will resolved to a tag object.
2090 An abbreviated hash argument will be expanded to a full SHA1 hash
2091 automatically, provided the abbreviation is unique.
2093 If none of the above interpretations produce a valid result, or if the
2095 option is used, attempt to interpret the argument as a path which will
2096 be resolved to the ID of an object found at this path in the repository.
2103 Look up paths in the specified
2105 If this option is not used, paths are looked up in the commit resolved
2106 via the repository's HEAD reference.
2107 The expected argument is a commit ID SHA1 hash or an existing reference
2108 or tag name which will be resolved to a commit ID.
2109 An abbreviated hash argument will be expanded to a full SHA1 hash
2110 automatically, provided the abbreviation is unique.
2111 .It Fl r Ar repository-path
2112 Use the repository at the specified path.
2113 If not specified, assume the repository is located at or above the current
2115 If this directory is a
2117 work tree, use the repository path associated with this work tree.
2119 Interpret all arguments as paths only.
2120 This option can be used to resolve ambiguity in cases where paths
2121 look like tag names, reference names, or object IDs.
2123 .It Cm info Op Ar path ...
2124 Display meta-data stored in a work tree.
2129 The work tree to use is resolved implicitly by walking upwards from the
2130 current working directory.
2134 arguments are specified, show additional per-file information for tracked
2135 files located at or within these paths.
2138 argument corresponds to the work tree's root directory, display information
2139 for all tracked files.
2142 .Bl -tag -width GOT_AUTHOR
2144 The author's name and email address for
2149 .Dq An Flan Hacker Aq Mt flan_hacker@openbsd.org .
2152 may fail to parse commits without an email address in author data,
2156 environment variables with a missing email address.
2158 .Ev GOT_AUTHOR will be overriden by configuration settings in
2164 configuration settings in the repository's
2171 configuration settings contained in Git's global
2173 configuration file will only be used if neither
2177 environment variable provide author information.
2178 .It Ev VISUAL , EDITOR
2179 The editor spawned by
2187 text editor will be spawned in order to give
2189 the attention it deserves.
2190 .It Ev GOT_LOG_DEFAULT_LIMIT
2191 The default limit on the number of commits traversed by
2193 If set to zero, the limit is unbounded.
2194 This variable will be silently ignored if it is set to a non-numeric value.
2197 .Bl -tag -width packed-refs -compact
2199 Repository-wide configuration settings for
2203 configuration file located in the root directory of a Git repository
2204 supersedes any relevant settings in Git's
2208 .It Pa .got/got.conf
2209 Worktree-specific configuration settings for
2213 configuration file in the
2215 meta-data directory of a work tree supersedes any relevant settings in
2218 configuration file and Git's
2225 Clone an existing Git repository for use with
2229 .Dl $ got clone ssh://git@github.com/openbsd/src.git
2231 Use of HTTP URLs currently requires
2235 .Dl $ git clone --bare https://github.com/openbsd/src.git
2237 Alternatively, for quick and dirty local testing of
2239 a new Git repository could be created and populated with files,
2240 e.g. from a temporary CVS checkout located at
2243 .Dl $ got init /var/git/src.git
2244 .Dl $ got import -r /var/git/src.git -I CVS -I obj /tmp/src
2246 Check out a work tree from the Git repository to /usr/src:
2248 .Dl $ got checkout /var/git/src.git /usr/src
2250 View local changes in a work tree directory:
2252 .Dl $ got diff | less
2254 In a work tree, display files in a potentially problematic state:
2256 .Dl $ got status -s 'C!~?'
2258 Interactively revert selected local changes in a work tree directory:
2260 .Dl $ got revert -p -R\ .
2262 In a work tree or a git repository directory, list all branch references:
2266 In a work tree or a git repository directory, create a new branch called
2267 .Dq unified-buffer-cache
2268 which is forked off the
2272 .Dl $ got branch -c master unified-buffer-cache
2274 Switch an existing work tree to the branch
2275 .Dq unified-buffer-cache .
2276 Local changes in the work tree will be preserved and merged if necessary:
2278 .Dl $ got update -b unified-buffer-cache
2280 Create a new commit from local changes in a work tree directory.
2281 This new commit will become the head commit of the work tree's current branch:
2285 In a work tree or a git repository directory, view changes committed in
2286 the 3 most recent commits to the work tree's branch, or the branch resolved
2287 via the repository's HEAD reference, respectively:
2289 .Dl $ got log -p -l 3
2291 As above, but display changes in the order in which
2293 could apply them in sequence:
2295 .Dl $ got log -p -l 3 -R
2297 In a work tree or a git repository directory, log the history of a subdirectory:
2299 .Dl $ got log sys/uvm
2301 While operating inside a work tree, paths are specified relative to the current
2302 working directory, so this command will log the subdirectory
2305 .Dl $ cd sys/uvm && got log\ .
2307 And this command has the same effect:
2309 .Dl $ cd sys/dev/usb && got log ../../uvm
2311 And this command displays work tree meta-data about all tracked files:
2314 .Dl $ got info\ . | less
2316 Add new files and remove obsolete files in a work tree directory:
2318 .Dl $ got add sys/uvm/uvm_ubc.c
2319 .Dl $ got remove sys/uvm/uvm_vnode.c
2321 Create a new commit from local changes in a work tree directory
2322 with a pre-defined log message.
2324 .Dl $ got commit -m 'unify the buffer cache'
2326 Alternatively, create a new commit from local changes in a work tree
2327 directory with a log message that has been prepared in the file
2330 .Dl $ got commit -F /tmp/msg
2332 Update any work tree checked out from the
2333 .Dq unified-buffer-cache
2334 branch to the latest commit on this branch:
2338 Roll file content on the unified-buffer-cache branch back by one commit,
2339 and then fetch the rolled-back change into the work tree as a local change
2340 to be amended and perhaps committed again:
2342 .Dl $ got backout unified-buffer-cache
2343 .Dl $ got commit -m 'roll back previous'
2344 .Dl $ # now back out the previous backout :-)
2345 .Dl $ got backout unified-buffer-cache
2347 Fetch new upstream commits into the local repository's
2354 In a repository created with a HTTP URL and
2355 .Cm git clone --bare
2358 command must be used instead:
2360 .Dl $ cd /var/git/src.git
2361 .Dl $ git fetch origin master:refs/remotes/origin/master
2365 branch to merge the new changes that are now visible on the
2370 .Dl $ got update -b origin/master
2371 .Dl $ got rebase master
2374 .Dq unified-buffer-cache
2375 branch on top of the new head commit of the
2379 .Dl $ got update -b master
2380 .Dl $ got rebase unified-buffer-cache
2382 Create a patch from all changes on the unified-buffer-cache branch.
2383 The patch can be mailed out for review and applied to
2387 .Dl $ got diff master unified-buffer-cache > /tmp/ubc.diff
2389 Edit the entire commit history of the
2390 .Dq unified-buffer-cache
2393 .Dl $ got update -b unified-buffer-cache
2394 .Dl $ got update -c master
2397 In order to merge changes committed to the
2398 .Dq unified-buffer-cache
2399 branch back into the
2402 .Dq unified-buffer-cache
2403 branch must first be rebased onto the
2407 .Dl $ got update -b master
2408 .Dl $ got rebase unified-buffer-cache
2411 .Dq unified-buffer-cache
2412 branch can now be made visible on the
2416 Because the rebase operation switched the work tree to the
2417 .Dq unified-buffer-cache
2418 branch, the work tree must be switched back to the
2421 .Dq unified-buffer-cache
2422 branch can be integrated into
2425 .Dl $ got update -b master
2426 .Dl $ got integrate unified-buffer-cache
2428 Additional steps may be necessary if local changes need to be pushed back
2429 to the remote repository, which currently requires
2431 Before working against existing branches in a repository cloned with
2432 .Cm git clone --bare
2437 must be configured to map all references in the remote repository
2440 namespace of the local repository.
2441 This can be achieved by setting Git's
2442 .Pa remote.origin.fetch
2443 configuration variable to the value
2444 .Dq +refs/heads/*:refs/remotes/origin/*
2449 .Dl $ cd /var/git/repo
2450 .Dl $ git config remote.origin.fetch '+refs/heads/*:refs/remotes/origin/*'
2454 option must be disabled:
2456 .Dl $ cd /var/git/repo
2457 .Dl $ git config remote.origin.mirror false
2459 Alternatively, the following
2461 configuration item can be added manually to the Git repository's
2465 .Dl [remote \&"origin\&"]
2467 .Dl fetch = +refs/heads/*:refs/remotes/origin/*
2470 This configuration leaves the local repository's
2472 namespace free for use by local branches checked out with
2474 and, if needed, created with
2479 namespace can now be updated with incoming changes from the remote
2484 without extra command line arguments:
2486 .Dl $ cd /var/git/repo
2489 To make changes fetched from the remote repository appear on the
2493 branch must be rebased onto the
2496 This will also merge local changes, if any, with the incoming changes:
2498 .Dl $ got update -b origin/master
2499 .Dl $ got rebase master
2503 branch, log messages for local changes can now be amended with
2505 by other developers and any other important new information:
2507 .Dl $ got update -c origin/master
2508 .Dl $ got histedit -m
2510 Local changes on the
2512 branch can then be pushed to the remote
2516 .Dl $ cd /var/git/repo
2517 .Dl $ git push origin master
2521 .Xr git-repository 5 ,
2522 .Xr got-worktree 5 ,
2525 .An Stefan Sperling Aq Mt stsp@openbsd.org
2526 .An Martin Pieuchot Aq Mt mpi@openbsd.org
2527 .An Joshua Stein Aq Mt jcs@openbsd.org
2528 .An Ori Bernstein Aq Mt ori@openbsd.org
2531 is a work-in-progress and some features remain to be implemented.
2533 At present, the user has to fall back on
2535 to perform some tasks.
2539 Reading from remote repositories over HTTP or HTTPS protocols requires
2544 Writing to remote repositories, over any protocol, requires
2547 The creation of merge commits, i.e. commits with two or more parent commits,
2551 In situations where files or directories were moved around
2553 will not automatically merge changes to new locations and
2555 will usually produce better results.
