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
79 .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
80 Create an initial commit in a repository from the file hierarchy
83 The created commit will not have any parent commits, i.e. it will be a
85 Also create a new reference which provides a branch name for the newly
87 Show the path of each imported file to indicate progress.
93 environment variable to be set,
98 configuration settings can be obtained from the repository's
100 file or from Git's global
111 instead of creating the default branch
113 Use of this option is required if the
115 branch already exists.
117 Use the specified log message when creating the new commit.
122 opens a temporary file in an editor where a log message can be written.
123 .It Fl r Ar repository-path
124 Use the repository at the specified path.
125 If not specified, assume the repository is located at or above the current
128 Ignore files or directories with a name which matches the specified
130 This option may be specified multiple times to build a list of ignore patterns.
133 follows the globbing rules documented in
139 .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
140 Copy files from a repository into a new work tree.
141 Show the status of each affected file, using the following status codes:
142 .Bl -column YXZ description
143 .It A Ta new file was added
144 .It E Ta file already exists in work tree's meta-data
149 is not specified, either use the last component of
150 .Ar repository path ,
153 was specified use the last component of
161 Proceed with the checkout operation even if the directory at
164 Existing files will be left intact.
166 Check out files from a commit on the specified
168 If this option is not specified, a branch resolved via the repository's HEAD
169 reference will be used.
171 Check out files from the specified
173 on the selected branch.
174 The expected argument is a commit ID SHA1 hash or an existing reference
175 or tag name which will be resolved to a commit ID.
176 An abbreviated hash argument will be expanded to a full SHA1 hash
177 automatically, provided the abbreviation is unique.
178 If this option is not specified, the most recent commit on the selected
180 .It Fl p Ar path-prefix
181 Restrict the work tree to a subset of the repository's tree hierarchy.
182 Only files beneath the specified
189 .It Cm update Oo Fl b Ar branch Oc Oo Fl c Ar commit Oc Op Ar path ...
190 Update an existing work tree to a different commit.
191 Show the status of each affected file, using the following status codes:
192 .Bl -column YXZ description
193 .It U Ta file was updated and contained no local changes
194 .It G Ta file was updated and local changes were merged cleanly
195 .It C Ta file was updated and conflicts occurred during merge
196 .It D Ta file was deleted
197 .It A Ta new file was added
198 .It \(a~ Ta versioned file is obstructed by a non-regular file
199 .It ! Ta a missing versioned file was restored
204 is specified, update the entire work tree.
205 Otherwise, restrict the update operation to files at or within the
207 Each path is required to exist in the update operation's target commit.
208 Files in the work tree outside specified paths will remain unchanged and
209 will retain their previously recorded base commit.
212 commands may refuse to run while the work tree contains files from
213 multiple base commits.
214 The base commit of such a work tree can be made consistent by running
216 across the entire work tree.
219 is incompatible with the
224 cannot update paths with staged changes.
225 If changes have been staged with
227 these changes must first be committed with
237 Switch the work tree's branch reference to the specified
239 before updating the work tree.
240 This option requires that all paths in the work tree are updated.
242 Update the work tree to the specified
244 The expected argument is a commit ID SHA1 hash or an existing reference
245 or tag name which will be resolved to a commit ID.
246 An abbreviated hash argument will be expanded to a full SHA1 hash
247 automatically, provided the abbreviation is unique.
248 If this option is not specified, the most recent commit on the work tree's
254 .It Cm status Op Ar path ...
255 Show the current modification status of files in a work tree,
256 using the following status codes:
257 .Bl -column YXZ description
258 .It M Ta modified file
259 .It A Ta file scheduled for addition in next commit
260 .It D Ta file scheduled for deletion in next commit
261 .It C Ta modified or added file which contains merge conflicts
262 .It ! Ta versioned file was expected on disk but is missing
263 .It \(a~ Ta versioned file is obstructed by a non-regular file
264 .It ? Ta unversioned item not tracked by
266 .It m Ta modified file modes (executable bit only)
267 .It N Ta non-existent
269 specified on the command line
274 is specified, show modifications in the entire work tree.
275 Otherwise, show modifications at or within the specified paths.
277 If changes have been staged with
279 staged changes are shown in the second output column, using the following
281 .Bl -column YXZ description
282 .It M Ta file modification is staged
283 .It A Ta file addition is staged
284 .It D Ta file deletion is staged
287 Changes created on top of staged changes are indicated in the first column:
288 .Bl -column YXZ description
289 .It MM Ta file was modified after earlier changes have been staged
290 .It MA Ta file was modified after having been staged for addition
293 For compatibility with
304 files in each traversed directory and will not display unversioned files
305 which match these patterns.
310 supports consecutive asterisks,
312 which will match an arbitrary amount of directories.
316 only supports a single ignore pattern per line.
320 does not support negated ignore patterns prefixed with
322 and gives no special significance to the location of path component separators,
328 .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 s Ar search-pattern Oc Oo Fl r Ar repository-path Oc Op Ar path
329 Display history of a repository.
332 is specified, show only commits which modified this path.
333 If invoked in a work tree, the
335 is interpreted relative to the current working directory,
336 and the work tree's path prefix is implicitly prepended.
337 Otherwise, the path is interpreted relative to the repository root.
344 Display individual commits which were merged into the current branch
348 shows the linear history of the current branch only.
350 Start traversing history at the specified
352 The expected argument is a commit ID SHA1 hash or an existing reference
353 or tag name which will be resolved to a commit ID.
354 An abbreviated hash argument will be expanded to a full SHA1 hash
355 automatically, provided the abbreviation is unique.
356 If this option is not specified, default to the work tree's current branch
357 if invoked in a work tree, or to the repository's HEAD reference.
359 Set the number of context lines shown in diffs with
361 By default, 3 lines of context are shown.
363 Limit history traversal to a given number of commits.
364 If this option is not specified, a default limit value of zero is used,
365 which is treated as an unbounded limit.
367 .Ev GOT_LOG_DEFAULT_LIMIT
368 environment variable may be set to change this default value.
370 Display the patch of modifications made in each commit.
373 is specified, only show the patch of modifications at or within this path.
374 .It Fl s Ar search-pattern
375 If specified, show only commits with a log message matched by the extended
378 Regular expression syntax is documented in
380 .It Fl r Ar repository-path
381 Use the repository at the specified path.
382 If not specified, assume the repository is located at or above the current
384 If this directory is a
386 work tree, use the repository path associated with this work tree.
388 .It Cm diff 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
389 When invoked within a work tree with less than two arguments, display
390 uncommitted changes in the work tree.
393 is specified, only show changes within this path.
395 If two arguments are provided, treat each argument as a reference, a tag
396 name, or an object ID SHA1 hash, and display differences between the
397 corresponding objects.
398 Both objects must be of the same type (blobs, trees, or commits).
399 An abbreviated hash argument will be expanded to a full SHA1 hash
400 automatically, provided the abbreviation is unique.
407 Set the number of context lines shown in the diff.
408 By default, 3 lines of context are shown.
409 .It Fl r Ar repository-path
410 Use the repository at the specified path.
411 If not specified, assume the repository is located at or above the current
413 If this directory is a
415 work tree, use the repository path associated with this work tree.
417 Show changes staged with
419 instead of showing local changes.
420 This option is only valid when
422 is invoked in a work tree.
424 Ignore whitespace-only changes.
429 .It Cm blame Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Ar path
430 Display line-by-line history of a file at the specified path.
437 Start traversing history at the specified
439 The expected argument is a commit ID SHA1 hash or an existing reference
440 or tag name which will be resolved to a commit ID.
441 An abbreviated hash argument will be expanded to a full SHA1 hash
442 automatically, provided the abbreviation is unique.
443 .It Fl r Ar repository-path
444 Use the repository at the specified path.
445 If not specified, assume the repository is located at or above the current
447 If this directory is a
449 work tree, use the repository path associated with this work tree.
454 .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
455 Display a listing of files and directories at the specified
456 directory path in the repository.
457 Entries shown in this listing may carry one of the following trailing
459 .Bl -column YXZ description
460 .It @ Ta entry is a symbolic link
461 .It / Ta entry is a directory
462 .It * Ta entry is an executable file
463 .It $ Ta entry is a Git submodule
468 is specified, list the repository path corresponding to the current
469 directory of the work tree, or the root directory of the repository
470 if there is no work tree.
477 List files and directories as they appear in the specified
479 The expected argument is a commit ID SHA1 hash or an existing reference
480 or tag name which will be resolved to a commit ID.
481 An abbreviated hash argument will be expanded to a full SHA1 hash
482 automatically, provided the abbreviation is unique.
483 .It Fl r Ar repository-path
484 Use the repository at the specified path.
485 If not specified, assume the repository is located at or above the current
487 If this directory is a
489 work tree, use the repository path associated with this work tree.
491 Show object IDs of files (blob objects) and directories (tree objects).
493 Recurse into sub-directories in the repository.
498 .It Cm ref Oo Fl r Ar repository-path Oc Oo Fl l Oc Oo Fl d Ar name Oc Oo Fl s Oc Op Ar name Ar target
499 Manage references in a repository.
501 If no options are passed, expect two arguments and attempt to create,
502 or update, the reference with the given
504 and make it point at the given
506 The name must be an absolute reference name, i.e. it must begin with
508 The target may be an object ID SHA1 hash or an existing reference which
509 will be resolved to an object ID.
510 An abbreviated hash argument will be expanded to a full SHA1 hash
511 automatically, provided the abbreviation is unique.
517 .It Fl r Ar repository-path
518 Use the repository at the specified path.
519 If not specified, assume the repository is located at or above the current
521 If this directory is a
523 work tree, use the repository path associated with this work tree.
525 List all existing references in the repository.
527 Delete the reference with the specified name from the repository.
529 Create a symbolic reference pointing at the specified
531 which must be an existing reference.
532 Care should be taken not to create loops between references when
535 .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
536 Create, list, or delete branches.
538 Branches are managed via references which live in the
543 command operates on references in this namespace only.
545 If invoked in a work tree without any arguments, print the name of the
546 work tree's current branch.
550 argument is passed, attempt to create a branch reference with the given name.
551 By default the new branch reference will point at the latest commit on the
552 work tree's current branch if invoked in a work tree, and otherwise to a commit
553 resolved via the repository's HEAD reference.
555 If invoked in a work tree, once the branch was created successfully
556 switch the work tree's head reference to the newly created branch and
557 update files across the entire work tree, just like
558 .Cm got update -b Ar name
560 Show the status of each affected file, using the following status codes:
561 .Bl -column YXZ description
562 .It U Ta file was updated and contained no local changes
563 .It G Ta file was updated and local changes were merged cleanly
564 .It C Ta file was updated and conflicts occurred during merge
565 .It D Ta file was deleted
566 .It A Ta new file was added
567 .It \(a~ Ta versioned file is obstructed by a non-regular file
568 .It ! Ta a missing versioned file was restored
576 Make a newly created branch reference point at the specified
580 argument is a commit ID SHA1 hash or an existing reference
581 or tag name which will be resolved to a commit ID.
582 .It Fl r Ar repository-path
583 Use the repository at the specified path.
584 If not specified, assume the repository is located at or above the current
586 If this directory is a
588 work tree, use the repository path associated with this work tree.
590 List all existing branches in the repository.
591 If invoked in a work tree, the work tree's current branch is shown
592 with one the following annotations:
593 .Bl -column YXZ description
594 .It * Ta work tree's base commit matches the branch tip
595 .It \(a~ Ta work tree's base commit is out-of-date
598 Delete the branch with the specified name from the repository.
599 Only the branch reference is deleted.
600 Any commit, tree, and blob objects belonging to the branch
601 remain in the repository and may be removed separately with
602 Git's garbage collector.
604 Do not switch and update the work tree after creating a new branch.
609 .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
610 Manage tags in a repository.
612 Tags are managed via references which live in the
617 command operates on references in this namespace only.
618 References in this namespace point at tag objects which contain a pointer
619 to another object, a tag message, as well as author and timestamp information.
621 Attempt to create a tag with the given
623 and make this tag point at the given
625 If no commit is specified, default to the latest commit on the work tree's
626 current branch if invoked in a work tree, and to a commit resolved via
627 the repository's HEAD reference otherwise.
634 Make the newly created tag reference point at the specified
638 argument is a commit ID SHA1 hash or an existing reference or tag name which
639 will be resolved to a commit ID.
640 An abbreviated hash argument will be expanded to a full SHA1 hash
641 automatically, provided the abbreviation is unique.
643 Use the specified tag message when creating the new tag.
648 opens a temporary file in an editor where a tag message can be written.
649 .It Fl r Ar repository-path
650 Use the repository at the specified path.
651 If not specified, assume the repository is located at or above the current
653 If this directory is a
655 work tree, use the repository path associated with this work tree.
657 List all existing tags in the repository instead of creating a new tag.
658 If this option is used, no other command-line arguments are allowed.
663 command will not delete tags or change existing tags.
664 If a tag must be deleted, the
666 command may be used to delete a tag's reference.
667 This should only be done if the tag has not already been copied to
669 .It Cm add Oo Fl R Oc Oo Fl I Oc Ar path ...
670 Schedule unversioned files in a work tree for addition to the
671 repository in the next commit.
678 Permit recursion into directories.
679 If this option is not specified,
681 will refuse to run if a specified
685 With -R, add files even if they match a
689 .It Cm remove Oo Fl f Oc Oo Fl k Oc Oo Fl R Oc Ar path ...
690 Remove versioned files from a work tree and schedule them for deletion
691 from the repository in the next commit.
698 Perform the operation even if a file contains uncommitted modifications.
700 Keep affected files on disk.
702 Permit recursion into directories.
703 If this option is not specified,
705 will refuse to run if a specified
712 .It Cm revert Oo Fl p Oc Oo Fl F Ar response-script Oc Oo Fl R Oc Ar path ...
713 Revert any uncommitted changes in files at the specified paths.
714 File contents will be overwritten with those contained in the
715 work tree's base commit.
716 There is no way to bring discarded changes back after
719 If a file was added with
721 it will become an unversioned file again.
722 If a file was deleted with
731 Instead of reverting all changes in files, interactively select or reject
732 changes to revert based on
738 (quit reverting this file) responses.
739 If a file is in modified status, individual patches derived from the
740 modified file content can be reverted.
741 Files in added or deleted status may only be reverted in their entirety.
742 .It Fl F Ar response-script
750 responses line-by-line from the specified
752 file instead of prompting interactively.
754 Permit recursion into directories.
755 If this option is not specified,
757 will refuse to run if a specified
764 .It Cm commit Oo Fl m Ar message Oc Op Ar path ...
765 Create a new commit in the repository from changes in a work tree
766 and use this commit as the new base commit for the work tree.
769 is specified, commit all changes in the work tree.
770 Otherwise, commit changes at or within the specified paths.
772 If changes have been explicitly staged for commit with
774 only commit staged changes and reject any specified paths which
775 have not been staged.
777 Show the status of each affected file, using the following status codes:
778 .Bl -column YXZ description
779 .It M Ta modified file
780 .It D Ta file was deleted
781 .It A Ta new file was added
782 .It m Ta modified file modes (executable bit only)
785 Files which are not part of the new commit will retain their previously
786 recorded base commit.
789 commands may refuse to run while the work tree contains files from
790 multiple base commits.
791 The base commit of such a work tree can be made consistent by running
793 across the entire work tree.
799 environment variable to be set,
804 configuration settings can be
805 obtained from the repository's
807 file or from Git's global
816 Use the specified log message when creating the new commit.
821 opens a temporary file in an editor where a log message can be written.
825 will refuse to run if certain preconditions are not met.
826 If the work tree's current branch is not in the
828 reference namespace, new commits may not be created on this branch.
829 Local changes may only be committed if they are based on file content
830 found in the most recent commit on the work tree's branch.
831 If a path is found to be out of date,
833 must be used first in order to merge local changes with changes made
838 .It Cm cherrypick Ar commit
839 Merge changes from a single
844 must be on a different branch than the work tree's base commit.
845 The expected argument is a reference or a commit ID SHA1 hash.
846 An abbreviated hash argument will be expanded to a full SHA1 hash
847 automatically, provided the abbreviation is unique.
849 Show the status of each affected file, using the following status codes:
850 .Bl -column YXZ description
851 .It G Ta file was merged
852 .It C Ta file was merged and conflicts occurred during merge
853 .It ! Ta changes destined for a missing file were not merged
854 .It D Ta file was deleted
855 .It d Ta file's deletion was obstructed by local modifications
856 .It A Ta new file was added
857 .It \(a~ Ta changes destined for a non-regular file were not merged
860 The merged changes will appear as local changes in the work tree, which
863 amended manually or with further
868 or discarded again with
872 will refuse to run if certain preconditions are not met.
873 If the work tree contains multiple base commits it must first be updated
874 to a single base commit with
876 If the work tree already contains files with merge conflicts, these
877 conflicts must be resolved first.
881 .It Cm backout Ar commit
882 Reverse-merge changes from a single
887 must be on the same branch as the work tree's base commit.
888 The expected argument is a reference or a commit ID SHA1 hash.
889 An abbreviated hash argument will be expanded to a full SHA1 hash
890 automatically, provided the abbreviation is unique.
892 Show the status of each affected file, using the following status codes:
893 .Bl -column YXZ description
894 .It G Ta file was merged
895 .It C Ta file was merged and conflicts occurred during merge
896 .It ! Ta changes destined for a missing file were not merged
897 .It D Ta file was deleted
898 .It d Ta file's deletion was obstructed by local modifications
899 .It A Ta new file was added
900 .It \(a~ Ta changes destined for a non-regular file were not merged
903 The reverse-merged changes will appear as local changes in the work tree,
904 which may be viewed with
906 amended manually or with further
911 or discarded again with
915 will refuse to run if certain preconditions are not met.
916 If the work tree contains multiple base commits it must first be updated
917 to a single base commit with
919 If the work tree already contains files with merge conflicts, these
920 conflicts must be resolved first.
924 .It Cm rebase Oo Fl a Oc Oo Fl c Oc Op Ar branch
925 Rebase commits on the specified
927 onto the tip of the current branch of the work tree.
930 must share common ancestry with the work tree's current branch.
931 Rebasing begins with the first descendant commit of the youngest
932 common ancestor commit shared by the specified
934 and the work tree's current branch, and stops once the tip commit
941 is used as intended, the specified
943 contains changes made in local commits that are not yet visible in any
945 The work tree's current branch, which must be set with
949 operation, represents a branch from a remote repository which shares
950 a common history with the specified
952 but has at some point diverged due to commits added to the remote repository.
954 Rebased commits are accumulated on a temporary branch which the work tree
955 will remain switched to throughout the entire rebase operation.
956 Commits on this branch represent the same changes with the same log
957 messages as their counterparts on the original
959 but with different commit IDs.
960 Once rebasing has completed successfully, the temporary branch becomes
961 the new version of the specified
963 and the work tree is automatically switched to it.
965 While rebasing commits, show the status of each affected file,
966 using the following status codes:
967 .Bl -column YXZ description
968 .It G Ta file was merged
969 .It C Ta file was merged and conflicts occurred during merge
970 .It ! Ta changes destined for a missing file were not merged
971 .It D Ta file was deleted
972 .It d Ta file's deletion was obstructed by local modifications
973 .It A Ta new file was added
974 .It \(a~ Ta changes destined for a non-regular file were not merged
977 If merge conflicts occur the rebase operation is interrupted and may
978 be continued once conflicts have been resolved.
979 Alternatively, the rebase operation may be aborted which will leave
981 unmodified and the work tree switched back to its original branch.
983 If a merge conflict is resolved in a way which renders the merged
984 change into a no-op change, the corresponding commit will be elided
985 when the rebase operation continues.
988 will refuse to run if certain preconditions are not met.
989 If the work tree is not yet fully updated to the tip commit of its
990 branch then the work tree must first be updated with
992 If changes have been staged with
994 these changes must first be committed with
998 If the work tree contains local changes, these changes must first be
1005 contains changes to files outside of the work tree's path prefix,
1006 the work tree cannot be used to rebase this branch.
1012 commands will refuse to run while a rebase operation is in progress.
1013 Other commands which manipulate the work tree may be used for
1014 conflict resolution purposes.
1021 Abort an interrupted rebase operation.
1022 If this option is used, no other command-line arguments are allowed.
1024 Continue an interrupted rebase operation.
1025 If this option is used, no other command-line arguments are allowed.
1030 .It Cm histedit Oo Fl a Oc Oo Fl c Oc Oo Fl F Ar histedit-script Oc Oo Fl m Oc
1031 Edit commit history between the work tree's current base commit and
1032 the tip commit of the work tree's current branch.
1036 operation the work tree's current branch must be set with
1038 to the branch which should be edited, unless this branch is already the
1039 current branch of the work tree.
1040 The tip of this branch represents the upper bound (inclusive) of commits
1045 Furthermore, the work tree's base commit
1048 to a point in this branch's commit history where editing should begin.
1049 This commit represents the lower bound (non-inclusive) of commits touched
1054 Editing of commit history is controlled via a
1056 which can be written in an editor based on a template, passed on the
1057 command line, or generated with the
1059 option if only log messages need to be edited.
1061 The format of the histedit script is line-based.
1062 Each line in the script begins with a command name, followed by
1063 whitespace and an argument.
1064 For most commands, the expected argument is a commit ID SHA1 hash.
1065 Any remaining text on the line is ignored.
1066 Lines which begin with the
1068 character are ignored entirely.
1070 The available commands are as follows:
1071 .Bl -column YXZ pick-commit
1072 .It pick Ar commit Ta Use the specified commit as it is.
1073 .It edit Ar commit Ta Use the specified commit but once changes have been
1074 merged into the work tree interrupt the histedit operation for amending.
1075 .It fold Ar commit Ta Combine the specified commit with the next commit
1076 listed further below that will be used.
1077 .It drop Ar commit Ta Remove this commit from the edited history.
1078 .It mesg Ar log-message Ta Use the specified single-line log message for
1079 the commit on the previous line.
1080 If the log message argument is left empty, open an editor where a new
1081 log message can be written.
1084 Every commit in the history being edited must be mentioned in the script.
1085 Lines may be re-ordered to change the order of commits in the edited history.
1087 Edited commits are accumulated on a temporary branch which the work tree
1088 will remain switched to throughout the entire histedit operation.
1089 Once history editing has completed successfully, the temporary branch becomes
1090 the new version of the work tree's branch and the work tree is automatically
1093 While merging commits, show the status of each affected file,
1094 using the following status codes:
1095 .Bl -column YXZ description
1096 .It G Ta file was merged
1097 .It C Ta file was merged and conflicts occurred during merge
1098 .It ! Ta changes destined for a missing file were not merged
1099 .It D Ta file was deleted
1100 .It d Ta file's deletion was obstructed by local modifications
1101 .It A Ta new file was added
1102 .It \(a~ Ta changes destined for a non-regular file were not merged
1105 If merge conflicts occur the histedit operation is interrupted and may
1106 be continued once conflicts have been resolved.
1107 Alternatively, the histedit operation may be aborted which will leave
1108 the work tree switched back to its original branch.
1110 If a merge conflict is resolved in a way which renders the merged
1111 change into a no-op change, the corresponding commit will be elided
1112 when the histedit operation continues.
1115 will refuse to run if certain preconditions are not met.
1116 If the work tree's current branch is not in the
1118 reference namespace, the history of the branch may not be edited.
1119 If the work tree contains multiple base commits it must first be updated
1120 to a single base commit with
1122 If changes have been staged with
1124 these changes must first be committed with
1128 If the work tree contains local changes, these changes must first be
1133 If the edited history contains changes to files outside of the work tree's
1134 path prefix, the work tree cannot be used to edit the history of this branch.
1141 commands will refuse to run while a histedit operation is in progress.
1142 Other commands which manipulate the work tree may be used, and the
1144 command may be used to commit arbitrary changes to the temporary branch
1145 while the histedit operation is interrupted.
1152 Abort an interrupted histedit operation.
1153 If this option is used, no other command-line arguments are allowed.
1155 Continue an interrupted histedit operation.
1156 If this option is used, no other command-line arguments are allowed.
1157 .It Fl F Ar histedit-script
1160 instead of opening a temporary file in an editor where a histedit script
1163 Edit log messages only.
1164 This option is a quick equivalent to a histedit script which edits
1165 only log messages but otherwise leaves every picked commit as-is.
1168 option can only be used when starting a new histedit operation.
1169 If this option is used, no other command-line arguments are allowed.
1174 .It Cm integrate Ar branch
1175 Integrate the specified
1177 into the work tree's current branch.
1178 Files in the work tree are updated to match the contents on the integrated
1180 and the reference of the work tree's branch is changed to point at the
1181 head commit of the integrated
1184 Both branches can be considered equivalent after integration since they
1185 will be pointing at the same commit.
1186 Both branches remain available for future work, if desired.
1187 In case the integrated
1189 is no longer needed it may be deleted with
1192 Show the status of each affected file, using the following status codes:
1193 .Bl -column YXZ description
1194 .It U Ta file was updated
1195 .It D Ta file was deleted
1196 .It A Ta new file was added
1197 .It \(a~ Ta versioned file is obstructed by a non-regular file
1198 .It ! Ta a missing versioned file was restored
1202 will refuse to run if certain preconditions are not met.
1203 Most importantly, the
1205 must have been rebased onto the work tree's current branch with
1207 before it can be integrated, in order to linearize commit history and
1208 resolve merge conflicts.
1209 If the work tree contains multiple base commits it must first be updated
1210 to a single base commit with
1212 If changes have been staged with
1214 these changes must first be committed with
1218 If the work tree contains local changes, these changes must first be
1226 .It Cm stage Oo Fl l Oc Oo Fl p Oc Oo Fl F Ar response-script Oc Op Ar path ...
1227 Stage local changes for inclusion in the next commit.
1230 is specified, stage all changes in the work tree.
1231 Otherwise, stage changes at or within the specified paths.
1232 Paths may be staged if they are added, modified, or deleted according to
1235 Show the status of each affected file, using the following status codes:
1236 .Bl -column YXZ description
1237 .It A Ta file addition has been staged
1238 .It M Ta file modification has been staged
1239 .It D Ta file deletion has been staged
1242 Staged file contents are saved in newly created blob objects in the repository.
1243 These blobs will be referred to by tree objects once staged changes have been
1246 Staged changes affect the behaviour of
1251 While paths with staged changes exist, the
1253 command will refuse to commit any paths which do not have staged changes.
1254 Local changes created on top of staged changes can only be committed if
1255 the path is staged again, or if the staged changes are committed first.
1258 command will show both local changes and staged changes.
1261 command is able to display local changes relative to staged changes,
1262 and to display staged changes relative to the repository.
1265 command cannot revert staged changes but may be used to revert
1266 local changes created on top of staged changes.
1273 Instead of staging new changes, list paths which are already staged,
1274 along with the IDs of staged blob objects and stage status codes.
1275 If paths were provided in the command line show the staged paths
1276 among the specified paths.
1277 Otherwise, show all staged paths.
1279 Instead of staging the entire content of a changed file, interactively
1280 select or reject changes for staging based on
1284 (reject change), and
1286 (quit staging this file) responses.
1287 If a file is in modified status, individual patches derived from the
1288 modified file content can be staged.
1289 Files in added or deleted status may only be staged or rejected in
1291 .It Fl F Ar response-script
1299 responses line-by-line from the specified
1301 file instead of prompting interactively.
1305 will refuse to run if certain preconditions are not met.
1306 If a file contains merge conflicts, these conflicts must be resolved first.
1307 If a file is found to be out of date relative to the head commit on the
1308 work tree's current branch, the file must be updated with
1310 before it can be staged (however, this does not prevent the file from
1311 becoming out-of-date at some point after having been staged).
1318 commands will refuse to run while staged changes exist.
1319 If staged changes cannot be committed because a staged path
1320 is out of date, the path must be unstaged with
1322 before it can be updated with
1324 and may then be staged again if necessary.
1328 .It Cm unstage Oo Fl p Oc Oo Fl F Ar response-script Oc Op Ar path ...
1329 Merge staged changes back into the work tree and put affected paths
1330 back into non-staged status.
1333 is specified, unstage all staged changes across the entire work tree.
1334 Otherwise, unstage changes at or within the specified paths.
1336 Show the status of each affected file, using the following status codes:
1337 .Bl -column YXZ description
1338 .It G Ta file was unstaged
1339 .It C Ta file was unstaged and conflicts occurred during merge
1340 .It ! Ta changes destined for a missing file were not merged
1341 .It D Ta file was staged as deleted and still is deleted
1342 .It d Ta file's deletion was obstructed by local modifications
1343 .It \(a~ Ta changes destined for a non-regular file were not merged
1351 Instead of unstaging the entire content of a changed file, interactively
1352 select or reject changes for unstaging based on
1356 (keep change staged), and
1358 (quit unstaging this file) responses.
1359 If a file is staged in modified status, individual patches derived from the
1360 staged file content can be unstaged.
1361 Files staged in added or deleted status may only be unstaged in their entirety.
1362 .It Fl F Ar response-script
1370 responses line-by-line from the specified
1372 file instead of prompting interactively.
1377 .It Cm cat Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Oo Fl P Oc Ar arg ...
1378 Parse and print contents of objects to standard output in a line-based
1380 Content of commit, tree, and tag objects is printed in a way similar
1381 to the actual content stored in such objects.
1382 Blob object contents are printed as they would appear in files on disk.
1384 Attempt to interpret each argument as a reference, a tag name, or
1385 an object ID SHA1 hash.
1386 References will be resolved to an object ID.
1387 Tag names will resolved to a tag object.
1388 An abbreviated hash argument will be expanded to a full SHA1 hash
1389 automatically, provided the abbreviation is unique.
1391 If none of the above interpretations produce a valid result, or if the
1393 option is used, attempt to interpret the argument as a path which will
1394 be resolved to the ID of an object found at this path in the repository.
1401 Look up paths in the specified
1403 If this option is not used, paths are looked up in the commit resolved
1404 via the repository's HEAD reference.
1405 The expected argument is a commit ID SHA1 hash or an existing reference
1406 or tag name which will be resolved to a commit ID.
1407 An abbreviated hash argument will be expanded to a full SHA1 hash
1408 automatically, provided the abbreviation is unique.
1409 .It Fl r Ar repository-path
1410 Use the repository at the specified path.
1411 If not specified, assume the repository is located at or above the current
1413 If this directory is a
1415 work tree, use the repository path associated with this work tree.
1417 Interpret all arguments as paths only.
1418 This option can be used to resolve ambiguity in cases where paths
1419 look like tag names, reference names, or object IDs.
1423 .Bl -tag -width GOT_AUTHOR
1425 The author's name and email address for
1430 .Dq An Flan Hacker Aq Mt flan_hacker@openbsd.org .
1433 may fail to parse commits without an email address in author data,
1437 environment variables with a missing email address.
1443 configuration settings in the repository's
1445 file will override the value of
1451 configuration settings contained in Git's global
1453 configuration file will be used only if the
1455 environment variable is
1458 .It Ev VISUAL , EDITOR
1459 The editor spawned by
1464 .It Ev GOT_LOG_DEFAULT_LIMIT
1465 The default limit on the number of commits traversed by
1467 If set to zero, the limit is unbounded.
1468 This variable will be silently ignored if it is set to a non-numeric value.
1473 Clone an existing Git repository for use with
1475 This step currently requires
1479 .Dl $ git clone --bare https://github.com/openbsd/src.git
1481 Alternatively, for quick and dirty local testing of
1483 a new Git repository could be created and populated with files,
1484 e.g. from a temporary CVS checkout located at
1487 .Dl $ got init /var/git/src.git
1488 .Dl $ got import -r /var/git/src.git -I CVS -I obj /tmp/src
1490 Check out a work tree from the Git repository to /usr/src:
1492 .Dl $ got checkout /var/git/src.git /usr/src
1494 View local changes in a work tree directory:
1497 .Dl $ got diff | less
1499 Interactively revert selected local changes in a work tree directory:
1501 .Dl $ got revert -p -R\ .
1503 In a work tree or a git repository directory, list all branch references:
1507 In a work tree or a git repository directory, create a new branch called
1508 .Dq unified-buffer-cache
1509 which is forked off the
1513 .Dl $ got branch unified-buffer-cache master
1515 Switch an existing work tree to the branch
1516 .Dq unified-buffer-cache .
1517 Local changes in the work tree will be preserved and merged if necessary:
1519 .Dl $ got update -b unified-buffer-cache
1521 Create a new commit from local changes in a work tree directory.
1522 This new commit will become the head commit of the work tree's current branch:
1526 In a work tree or a git repository directory, view changes committed in
1527 the 3 most recent commits to the work tree's branch, or the branch resolved
1528 via the repository's HEAD reference, respectively:
1530 .Dl $ got log -p -l 3
1532 In a work tree or a git repository directory, log the history of a subdirectory:
1534 .Dl $ got log sys/uvm
1536 While operating inside a work tree, paths are specified relative to the current
1537 working directory, so this command will log the subdirectory
1540 .Dl $ cd sys/uvm && got log '.'
1542 And this command has the same effect:
1544 .Dl $ cd sys/dev/usb && got log ../../uvm
1546 Add new files and remove obsolete files in a work tree directory:
1548 .Dl $ got add sys/uvm/uvm_ubc.c
1549 .Dl $ got remove sys/uvm/uvm_vnode.c
1551 Create a new commit from local changes in a work tree directory
1552 with a pre-defined log message.
1554 .Dl $ got commit -m 'unify the buffer cache'
1556 Update any work tree checked out from the
1557 .Dq unified-buffer-cache
1558 branch to the latest commit on this branch:
1562 Roll file content on the unified-buffer-cache branch back by one commit,
1563 and then fetch the rolled-back change into the work tree as a local change
1564 to be amended and perhaps committed again:
1566 .Dl $ got backout unified-buffer-cache
1567 .Dl $ got commit -m 'roll back previous'
1568 .Dl $ # now back out the previous backout :-)
1569 .Dl $ got backout unified-buffer-cache
1571 Fetch new upstream commits into the local repository's master branch.
1572 This step currently requires
1575 .Dl $ cd /var/git/src.git
1576 .Dl $ git fetch origin master:master
1579 .Dq unified-buffer-cache
1580 branch on top of the new head commit of the
1584 .Dl $ got update -b master
1585 .Dl $ got rebase unified-buffer-cache
1587 Create a patch from all changes on the unified-buffer-cache branch.
1588 The patch can be mailed out for review and applied to
1592 .Dl $ got diff master unified-buffer-cache > /tmp/ubc.diff
1594 Edit the entire commit history of the
1595 .Dq unified-buffer-cache
1598 .Dl $ got update -b unified-buffer-cache
1599 .Dl $ got update -c master
1602 Additional steps are necessary if local changes need to be pushed back
1603 to the remote repository, which currently requires
1607 Before working against existing branches in a repository cloned with
1608 .Dq git clone --bare ,
1611 must be configured to map all references in the remote repository
1614 namespace of the local repository.
1615 This can achieved by setting Git's
1616 .Pa remote.origin.fetch
1617 configuration variable to the value
1618 .Dq +refs/heads/*:refs/remotes/origin/*
1623 .Dl $ cd /var/git/repo
1624 .Dl $ git config remote.origin.fetch '+refs/heads/*:refs/remotes/origin/*'
1626 Alternatively, the following
1628 configuration item can be added manually to the Git repository's
1632 .Dl [remote "origin"]
1634 .Dl fetch = +refs/heads/*:refs/remotes/origin/*
1636 This configuration leaves the local repository's
1638 namespace free for use by local branches checked out with
1640 and, if needed, created with
1645 namespace can be updated with incoming changes from the remote
1649 .Dl $ cd /var/git/repo
1652 To make changes fetched from the remote repository appear on the
1656 branch must be rebased onto the
1659 This will also merge local changes, if any, with the incoming changes:
1661 .Dl $ got update -b origin/master
1662 .Dl $ got rebase master
1666 branch, log messages for local changes can now be amended with
1668 by other developers and any other important new information:
1670 .Dl $ got update -c origin/master
1671 .Dl $ got histedit -m
1673 Local changes on the
1675 branch can then be pushed to the remote
1679 .Dl $ cd /var/git/repo
1680 .Dl $ git push origin master
1682 In order to merge changes committed to the
1683 .Dq unified-buffer-cache
1684 branch back into the
1687 .Dq unified-buffer-cache
1688 branch must first be rebased onto the
1692 .Dl $ got update -b master
1693 .Dl $ got rebase unified-buffer-cache
1696 .Dq unified-buffer-cache
1697 branch can now be made visible on the
1701 Because the rebase operation switched the work tree to the
1702 .Dq unified-buffer-cache
1703 branch, the work tree must be switched back to the
1706 .Dq unified-buffer-cache
1707 branch can be integrated into
1710 .Dl $ got update -b master
1711 .Dl $ got integrate unified-buffer-cache
1714 .Xr git-repository 5 ,
1717 .An Stefan Sperling Aq Mt stsp@openbsd.org
1718 .An Martin Pieuchot Aq Mt mpi@openbsd.org
1719 .An Joshua Stein Aq Mt jcs@openbsd.org
1722 is a work-in-progress and many commands remain to be implemented.
1723 At present, the user has to fall back on
1725 to perform many tasks, in particular tasks related to repository
1726 administration and tasks which require a network connection.
