2 .\" Copyright (c) 2017 Martin Pieuchot
3 .\" Copyright (c) 2018, 2019 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 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.
143 is not specified, either use the last component of
144 .Ar repository path ,
147 was specified use the last component of
155 Check out files from a commit on the specified
157 If this option is not specified, a branch resolved via the repository's HEAD
158 reference will be used.
160 Check out files from the specified
162 on the selected branch.
163 The expected argument is a commit ID SHA1 hash or an existing reference
164 or tag name which will be resolved to a commit ID.
165 An abbreviated hash argument will be expanded to a full SHA1 hash
166 automatically, provided the abbreviation is unique.
167 If this option is not specified, the most recent commit on the selected
169 .It Fl p Ar path-prefix
170 Restrict the work tree to a subset of the repository's tree hierarchy.
171 Only files beneath the specified
178 .It Cm update Oo Fl b Ar branch Oc Oo Fl c Ar commit Oc Op Ar path ...
179 Update an existing work tree to a different commit.
180 Show the status of each affected file, using the following status codes:
181 .Bl -column YXZ description
182 .It U Ta file was updated and contained no local changes
183 .It G Ta file was updated and local changes were merged cleanly
184 .It C Ta file was updated and conflicts occurred during merge
185 .It D Ta file was deleted
186 .It A Ta new file was added
187 .It \(a~ Ta versioned file is obstructed by a non-regular file
188 .It ! Ta a missing versioned file was restored
193 is specified, update the entire work tree.
194 Otherwise, restrict the update operation to files at or within the
196 Each path is required to exist in the update operation's target commit.
197 Files in the work tree outside specified paths will remain unchanged and
198 will retain their previously recorded base commit.
201 commands may refuse to run while the work tree contains files from
202 multiple base commits.
203 The base commit of such a work tree can be made consistent by running
205 across the entire work tree.
208 is incompatible with the
213 cannot update paths with staged changes.
214 If changes have been staged with
216 these changes must first be committed with
226 Switch the work tree's branch reference to the specified
228 before updating the work tree.
229 This option requires that all paths in the work tree are updated.
231 Update the work tree to the specified
233 The expected argument is a commit ID SHA1 hash or an existing reference
234 or tag name which will be resolved to a commit ID.
235 An abbreviated hash argument will be expanded to a full SHA1 hash
236 automatically, provided the abbreviation is unique.
237 If this option is not specified, the most recent commit on the work tree's
243 .It Cm status Op Ar path ...
244 Show the current modification status of files in a work tree,
245 using the following status codes:
246 .Bl -column YXZ description
247 .It M Ta modified file
248 .It A Ta file scheduled for addition in next commit
249 .It D Ta file scheduled for deletion in next commit
250 .It C Ta modified or added file which contains merge conflicts
251 .It ! Ta versioned file was expected on disk but is missing
252 .It \(a~ Ta versioned file is obstructed by a non-regular file
253 .It ? Ta unversioned item not tracked by
255 .It m Ta modified file modes (executable bit only)
256 .It N Ta non-existent
258 specified on the command line
263 is specified, show modifications in the entire work tree.
264 Otherwise, show modifications at or within the specified paths.
266 If changes have been staged with
268 staged changes are shown in the second output column, using the following
270 .Bl -column YXZ description
271 .It M Ta file modification is staged
272 .It A Ta file addition is staged
273 .It D Ta file deletion is staged
276 Changes created on top of staged changes are indicated in the first column:
277 .Bl -column YXZ description
278 .It MM Ta file was modified after earlier changes have been staged
279 .It MA Ta file was modified after having been staged for addition
282 For compatibility with
293 files in each traversed directory and will not display unversioned files
294 which match these patterns.
299 supports consecutive asterisks,
301 which will match an arbitrary amount of directories.
305 only supports a single ignore pattern per line.
309 does not support negated ignore patterns prefixed with
311 and gives no special significance to the location of path component separators,
317 .It Cm log Oo Fl c Ar commit Oc Oo Fl C Ar number Oc Oo Fl f Oc Oo Fl l Ar N Oc Oo Fl p Oc Oo Fl r Ar repository-path Oc Op Ar path
318 Display history of a repository.
321 is specified, show only commits which modified this path.
328 Start traversing history at the specified
330 The expected argument is a commit ID SHA1 hash or an existing reference
331 or tag name which will be resolved to a commit ID.
332 An abbreviated hash argument will be expanded to a full SHA1 hash
333 automatically, provided the abbreviation is unique.
334 If this option is not specified, default to the work tree's current branch
335 if invoked in a work tree, or to the repository's HEAD reference.
337 Set the number of context lines shown in diffs with
339 By default, 3 lines of context are shown.
341 Restrict history traversal to the first parent of each commit.
342 This shows the linear history of the current branch only.
343 Merge commits which affected the current branch will be shown but
344 individual commits which originated on other branches will be omitted.
346 Limit history traversal to a given number of commits.
347 If this option is not specified, a default limit value of zero is used,
348 which is treated as an unbounded limit.
350 .Ev GOT_LOG_DEFAULT_LIMIT
351 environment variable may be set to change this default value.
353 Display the patch of modifications made in each commit.
356 is specified, only show the patch of modifications at or within this path.
357 .It Fl r Ar repository-path
358 Use the repository at the specified path.
359 If not specified, assume the repository is located at or above the current
361 If this directory is a
363 work tree, use the repository path associated with this work tree.
365 .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
366 When invoked within a work tree with less than two arguments, display
367 uncommitted changes in the work tree.
370 is specified, only show changes within this path.
372 If two arguments are provided, treat each argument as a reference, a tag
373 name, or an object ID SHA1 hash, and display differences between the
374 corresponding objects.
375 Both objects must be of the same type (blobs, trees, or commits).
376 An abbreviated hash argument will be expanded to a full SHA1 hash
377 automatically, provided the abbreviation is unique.
384 Set the number of context lines shown in the diff.
385 By default, 3 lines of context are shown.
386 .It Fl r Ar repository-path
387 Use the repository at the specified path.
388 If not specified, assume the repository is located at or above the current
390 If this directory is a
392 work tree, use the repository path associated with this work tree.
394 Show changes staged with
396 instead of showing local changes.
397 This option is only valid when
399 is invoked in a work tree.
401 Ignore whitespace-only changes.
406 .It Cm blame Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Ar path
407 Display line-by-line history of a file at the specified path.
414 Start traversing history at the specified
416 The expected argument is a commit ID SHA1 hash or an existing reference
417 or tag name which will be resolved to a commit ID.
418 An abbreviated hash argument will be expanded to a full SHA1 hash
419 automatically, provided the abbreviation is unique.
420 .It Fl r Ar repository-path
421 Use the repository at the specified path.
422 If not specified, assume the repository is located at or above the current
424 If this directory is a
426 work tree, use the repository path associated with this work tree.
431 .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
432 Display a listing of files and directories at the specified
433 directory path in the repository.
434 Entries shown in this listing may carry one of the following trailing
436 .Bl -column YXZ description
437 .It @ Ta entry is a symbolic link
438 .It / Ta entry is a directory
439 .It * Ta entry is an executable file
440 .It $ Ta entry is a Git submodule
445 is specified, list the repository path corresponding to the current
446 directory of the work tree, or the root directory of the repository
447 if there is no work tree.
454 List files and directories as they appear in the specified
456 The expected argument is a commit ID SHA1 hash or an existing reference
457 or tag name which will be resolved to a commit ID.
458 An abbreviated hash argument will be expanded to a full SHA1 hash
459 automatically, provided the abbreviation is unique.
460 .It Fl r Ar repository-path
461 Use the repository at the specified path.
462 If not specified, assume the repository is located at or above the current
464 If this directory is a
466 work tree, use the repository path associated with this work tree.
468 Show object IDs of files (blob objects) and directories (tree objects).
470 Recurse into sub-directories in the repository.
475 .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
476 Manage references in a repository.
478 If no options are passed, expect two arguments and attempt to create,
479 or update, the reference with the given
481 and make it point at the given
483 The name must be an absolute reference name, i.e. it must begin with
485 The target may be an object ID SHA1 hash or an existing reference which
486 will be resolved to an object ID.
487 An abbreviated hash argument will be expanded to a full SHA1 hash
488 automatically, provided the abbreviation is unique.
494 .It Fl r Ar repository-path
495 Use the repository at the specified path.
496 If not specified, assume the repository is located at or above the current
498 If this directory is a
500 work tree, use the repository path associated with this work tree.
502 List all existing references in the repository.
504 Delete the reference with the specified name from the repository.
506 Create a symbolic reference pointing at the specified
508 which must be an existing reference.
509 Care should be taken not to create loops between references when
512 .It Cm branch Oo Fl r Ar repository-path Oc Oo Fl l Oc Oo Fl d Ar name Oc Op Ar name Op Ar commit
513 Manage branches in a repository.
515 Branches are managed via references which live in the
520 command operates on references in this namespace only.
522 If invoked in a work tree without any arguments, print the name of the
523 work tree's current branch.
524 If one or two arguments are passed, attempt to create a branch reference
527 and make it point at the given
531 argument is a commit ID SHA1 hash or an existing reference
532 or tag name which will be resolved to a commit ID.
535 is specified, default to the latest commit on the work tree's current
536 branch if invoked in a work tree, or to a commit resolved via the
537 repository's HEAD reference.
543 .It Fl r Ar repository-path
544 Use the repository at the specified path.
545 If not specified, assume the repository is located at or above the current
547 If this directory is a
549 work tree, use the repository path associated with this work tree.
551 List all existing branches in the repository.
552 If invoked in a work tree, the work tree's current branch is shown
553 with one the following annotations:
554 .Bl -column YXZ description
555 .It * Ta work tree's base commit matches the branch tip
556 .It \(a~ Ta work tree's base commit is out-of-date
559 Delete the branch with the specified name from the repository.
560 Only the branch reference is deleted.
561 Any commit, tree, and blob objects belonging to the branch
562 remain in the repository and may be removed separately with
563 Git's garbage collector.
568 .It Cm tag Oo Fl m Ar message Oc Oo Fl r Ar repository-path Oc Oo Fl l Oc Ar name Op Ar commit Oc
569 Manage tags in a repository.
571 Tags are managed via references which live in the
576 command operates on references in this namespace only.
577 References in this namespace point at tag objects which contain a pointer
578 to another object, a tag message, as well as author and timestamp information.
580 Expect one or two arguments and attempt to create a tag with the given
582 and make this tag point at the given
584 If no commit is specified, default to the latest commit on the work tree's
585 current branch if invoked in a work tree, and to a commit resolved via
586 the repository's HEAD reference otherwise.
587 Otherwise, the expected argument is a commit ID SHA1 hash or an existing
588 reference or tag name which will be resolved to a commit ID.
589 An abbreviated hash argument will be expanded to a full SHA1 hash
590 automatically, provided the abbreviation is unique.
597 Use the specified tag message when creating the new tag
602 opens a temporary file in an editor where a tag message can be written.
603 .It Fl r Ar repository-path
604 Use the repository at the specified path.
605 If not specified, assume the repository is located at or above the current
607 If this directory is a
609 work tree, use the repository path associated with this work tree.
611 List all existing tags in the repository instead of creating a new tag.
612 If this option is used, no other command-line arguments are allowed.
617 command will not delete tags or change existing tags.
618 If a tag must be deleted, the
620 command may be used to delete a tag's reference.
621 This should only be done if the tag has not already been copied to
623 .It Cm add Ar file-path ...
624 Schedule unversioned files in a work tree for addition to the
625 repository in the next commit.
626 .It Cm remove Ar file-path ...
627 Remove versioned files from a work tree and schedule them for deletion
628 from the repository in the next commit.
635 Perform the operation even if a file contains uncommitted modifications.
640 .It Cm revert Oo Fl p Oc Oo Fl F Ar response-script Oc Oo Fl R Oc Ar path ...
641 Revert any uncommitted changes in files at the specified paths.
642 File contents will be overwritten with those contained in the
643 work tree's base commit.
644 There is no way to bring discarded changes back after
647 If a file was added with
649 it will become an unversioned file again.
650 If a file was deleted with
659 Instead of reverting all changes in files, interactively select or reject
660 changes to revert based on
666 (quit reverting this file) responses.
667 If a file is in modified status, individual patches derived from the
668 modified file content can be reverted.
669 Files in added or deleted status may only be reverted in their entirety.
670 .It Fl F Ar response-script
678 responses line-by-line from the specified
680 file instead of prompting interactively.
682 Permit recursion into directories.
683 If this option is not specified,
685 will refuse to run if a specified
692 .It Cm commit Oo Fl m Ar message Oc Op Ar path ...
693 Create a new commit in the repository from changes in a work tree
694 and use this commit as the new base commit for the work tree.
697 is specified, commit all changes in the work tree.
698 Otherwise, commit changes at or within the specified paths.
700 If changes have been explicitly staged for commit with
702 only commit staged changes and reject any specified paths which
703 have not been staged.
705 Show the status of each affected file, using the following status codes:
706 .Bl -column YXZ description
707 .It M Ta modified file
708 .It D Ta file was deleted
709 .It A Ta new file was added
710 .It m Ta modified file modes (executable bit only)
713 Files which are not part of the new commit will retain their previously
714 recorded base commit.
717 commands may refuse to run while the work tree contains files from
718 multiple base commits.
719 The base commit of such a work tree can be made consistent by running
721 across the entire work tree.
727 environment variable to be set,
732 configuration settings can be
733 obtained from the repository's
735 file or from Git's global
744 Use the specified log message when creating the new commit.
749 opens a temporary file in an editor where a log message can be written.
753 will refuse to run if certain preconditions are not met.
754 If the work tree's current branch is not in the
756 reference namespace, new commits may not be created on this branch.
757 Local changes may only be committed if they are based on file content
758 found in the most recent commit on the work tree's branch.
759 If a path is found to be out of date,
761 must be used first in order to merge local changes with changes made
766 .It Cm cherrypick Ar commit
767 Merge changes from a single
772 must be on a different branch than the work tree's base commit.
773 The expected argument is a reference or a commit ID SHA1 hash.
774 An abbreviated hash argument will be expanded to a full SHA1 hash
775 automatically, provided the abbreviation is unique.
777 Show the status of each affected file, using the following status codes:
778 .Bl -column YXZ description
779 .It G Ta file was merged
780 .It C Ta file was merged and conflicts occurred during merge
781 .It ! Ta changes destined for a missing file were not merged
782 .It D Ta file was deleted
783 .It d Ta file's deletion was obstructed by local modifications
784 .It A Ta new file was added
785 .It \(a~ Ta changes destined for a non-regular file were not merged
788 The merged changes will appear as local changes in the work tree, which
791 amended manually or with further
796 or discarded again with
800 will refuse to run if certain preconditions are not met.
801 If the work tree contains multiple base commits it must first be updated
802 to a single base commit with
804 If the work tree already contains files with merge conflicts, these
805 conflicts must be resolved first.
809 .It Cm backout Ar commit
810 Reverse-merge changes from a single
815 must be on the same branch as the work tree's base commit.
816 The expected argument is a reference or a commit ID SHA1 hash.
817 An abbreviated hash argument will be expanded to a full SHA1 hash
818 automatically, provided the abbreviation is unique.
820 Show the status of each affected file, using the following status codes:
821 .Bl -column YXZ description
822 .It G Ta file was merged
823 .It C Ta file was merged and conflicts occurred during merge
824 .It ! Ta changes destined for a missing file were not merged
825 .It D Ta file was deleted
826 .It d Ta file's deletion was obstructed by local modifications
827 .It A Ta new file was added
828 .It \(a~ Ta changes destined for a non-regular file were not merged
831 The reverse-merged changes will appear as local changes in the work tree,
832 which may be viewed with
834 amended manually or with further
839 or discarded again with
843 will refuse to run if certain preconditions are not met.
844 If the work tree contains multiple base commits it must first be updated
845 to a single base commit with
847 If the work tree already contains files with merge conflicts, these
848 conflicts must be resolved first.
852 .It Cm rebase Oo Fl a Oc Oo Fl c Oc Op Ar branch
853 Rebase commits on the specified
855 onto the tip of the current branch of the work tree.
858 must share common ancestry with the work tree's current branch.
859 Rebasing begins with the first descendant commit of the youngest
860 common ancestor commit shared by the specified
862 and the work tree's current branch, and stops once the tip commit
867 Rebased commits are accumulated on a temporary branch which the work tree
868 will remain switched to throughout the entire rebase operation.
869 Commits on this branch represent the same changes with the same log
870 messages as their counterparts on the original
872 but with different commit IDs.
873 Once rebasing has completed successfully, the temporary branch becomes
874 the new version of the specified
876 and the work tree is automatically switched to it.
878 While rebasing commits, show the status of each affected file,
879 using the following status codes:
880 .Bl -column YXZ description
881 .It G Ta file was merged
882 .It C Ta file was merged and conflicts occurred during merge
883 .It ! Ta changes destined for a missing file were not merged
884 .It D Ta file was deleted
885 .It d Ta file's deletion was obstructed by local modifications
886 .It A Ta new file was added
887 .It \(a~ Ta changes destined for a non-regular file were not merged
890 If merge conflicts occur the rebase operation is interrupted and may
891 be continued once conflicts have been resolved.
892 Alternatively, the rebase operation may be aborted which will leave
894 unmodified and the work tree switched back to its original branch.
896 If a merge conflict is resolved in a way which renders the merged
897 change into a no-op change, the corresponding commit will be elided
898 when the rebase operation continues.
901 will refuse to run if certain preconditions are not met.
902 If the work tree contains multiple base commits it must first be updated
903 to a single base commit with
905 If changes have been staged with
907 these changes must first be committed with
911 If the work tree contains local changes, these changes must first be
918 contains changes to files outside of the work tree's path prefix,
919 the work tree cannot be used to rebase this branch.
925 commands will refuse to run while a rebase operation is in progress.
926 Other commands which manipulate the work tree may be used for
927 conflict resolution purposes.
934 Abort an interrupted rebase operation.
935 If this option is used, no other command-line arguments are allowed.
937 Continue an interrupted rebase operation.
938 If this option is used, no other command-line arguments are allowed.
943 .It Cm histedit Oo Fl a Oc Oo Fl c Oc Op Fl F Ar histedit-script
944 Edit commit history between the work tree's current base commit and
945 the tip commit of the work tree's current branch.
947 Editing of commit history is controlled via a
949 which can be edited interactively or passed on the command line.
950 The format of the histedit script is line-based.
951 Each line in the script begins with a command name, followed by
952 whitespace and an argument.
953 For most commands, the expected argument is a commit ID SHA1 hash.
954 Any remaining text on the line is ignored.
955 Lines which begin with the
957 character are ignored entirely.
959 The available commands are as follows:
960 .Bl -column YXZ pick-commit
961 .It pick Ar commit Ta Use the specified commit as it is.
962 .It edit Ar commit Ta Use the specified commit but once changes have been
963 merged into the work tree interrupt the histedit operation for amending.
964 .It fold Ar commit Ta Combine the specified commit with the next commit
965 listed further below that will be used.
966 .It drop Ar commit Ta Remove this commit from the edited history.
967 .It mesg Ar log-message Ta Use the specified single-line log message for
968 the commit on the previous line.
969 If the log message argument is left empty, open an editor where a new
970 log message can be written.
973 Every commit in the history being edited must be mentioned in the script.
974 Lines may be re-ordered to change the order of commits in the edited history.
976 Edited commits are accumulated on a temporary branch which the work tree
977 will remain switched to throughout the entire histedit operation.
978 Once history editing has completed successfully, the temporary branch becomes
979 the new version of the work tree's branch and the work tree is automatically
982 While merging commits, show the status of each affected file,
983 using the following status codes:
984 .Bl -column YXZ description
985 .It G Ta file was merged
986 .It C Ta file was merged and conflicts occurred during merge
987 .It ! Ta changes destined for a missing file were not merged
988 .It D Ta file was deleted
989 .It d Ta file's deletion was obstructed by local modifications
990 .It A Ta new file was added
991 .It \(a~ Ta changes destined for a non-regular file were not merged
994 If merge conflicts occur the histedit operation is interrupted and may
995 be continued once conflicts have been resolved.
996 Alternatively, the histedit operation may be aborted which will leave
997 the work tree switched back to its original branch.
999 If a merge conflict is resolved in a way which renders the merged
1000 change into a no-op change, the corresponding commit will be elided
1001 when the histedit operation continues.
1004 will refuse to run if certain preconditions are not met.
1005 If the work tree's current branch is not in the
1007 reference namespace, the history of the branch may not be edited.
1008 If the work tree contains multiple base commits it must first be updated
1009 to a single base commit with
1011 If changes have been staged with
1013 these changes must first be committed with
1017 If the work tree contains local changes, these changes must first be
1022 If the edited history contains changes to files outside of the work tree's
1023 path prefix, the work tree cannot be used to edit the history of this branch.
1027 command will refuse to run while a histedit operation is in progress.
1028 Other commands which manipulate the work tree may be used, and the
1030 command may be used to commit arbitrary changes to the temporary branch
1031 while the histedit operation is interrupted.
1038 Abort an interrupted histedit operation.
1039 If this option is used, no other command-line arguments are allowed.
1041 Continue an interrupted histedit operation.
1042 If this option is used, no other command-line arguments are allowed.
1047 .It Cm integrate Ar branch
1048 Integrate the specified
1050 into the work tree's current branch.
1051 Files in the work tree are updated to match the contents on the integrated
1053 and the reference of the work tree's branch is changed to point at the
1054 head commit of the integrated
1057 Both branches can be considered equivalent after integration since they
1058 will be pointing at the same commit.
1059 Both branches remain available for future work, if desired.
1060 In case the integrated
1062 is no longer needed it may be deleted with
1065 Show the status of each affected file, using the following status codes:
1066 .Bl -column YXZ description
1067 .It U Ta file was updated
1068 .It D Ta file was deleted
1069 .It A Ta new file was added
1070 .It \(a~ Ta versioned file is obstructed by a non-regular file
1071 .It ! Ta a missing versioned file was restored
1075 will refuse to run if certain preconditions are not met.
1076 Most importantly, the
1078 must have been rebased onto the work tree's current branch with
1080 before it can be integrated, in order to linearize commit history and
1081 resolve merge conflicts.
1082 If the work tree contains multiple base commits it must first be updated
1083 to a single base commit with
1085 If changes have been staged with
1087 these changes must first be committed with
1091 If the work tree contains local changes, these changes must first be
1099 .It Cm stage Oo Fl l Oc Oo Fl p Oc Oo Fl F Ar response-script Oc Op Ar path ...
1100 Stage local changes for inclusion in the next commit.
1103 is specified, stage all changes in the work tree.
1104 Otherwise, stage changes at or within the specified paths.
1105 Paths may be staged if they are added, modified, or deleted according to
1108 Show the status of each affected file, using the following status codes:
1109 .Bl -column YXZ description
1110 .It A Ta file addition has been staged
1111 .It M Ta file modification has been staged
1112 .It D Ta file deletion has been staged
1115 Staged file contents are saved in newly created blob objects in the repository.
1116 These blobs will be referred to by tree objects once staged changes have been
1119 Staged changes affect the behaviour of
1124 While paths with staged changes exist, the
1126 command will refuse to commit any paths which do not have staged changes.
1127 Local changes created on top of staged changes can only be committed if
1128 the path is staged again, or if the staged changes are committed first.
1131 command will show both local changes and staged changes.
1134 command is able to display local changes relative to staged changes,
1135 and to display staged changes relative to the repository.
1138 command cannot revert staged changes but may be used to revert
1139 local changes created on top of staged changes.
1146 Instead of staging new changes, list paths which are already staged,
1147 along with the IDs of staged blob objects and stage status codes.
1148 If paths were provided in the command line show the staged paths
1149 among the specified paths.
1150 Otherwise, show all staged paths.
1152 Instead of staging the entire content of a changed file, interactively
1153 select or reject changes for staging based on
1157 (reject change), and
1159 (quit staging this file) responses.
1160 If a file is in modified status, individual patches derived from the
1161 modified file content can be staged.
1162 Files in added or deleted status may only be staged or rejected in
1164 .It Fl F Ar response-script
1172 responses line-by-line from the specified
1174 file instead of prompting interactively.
1178 will refuse to run if certain preconditions are not met.
1179 If a file contains merge conflicts, these conflicts must be resolved first.
1180 If a file is found to be out of date relative to the head commit on the
1181 work tree's current branch, the file must be updated with
1183 before it can be staged (however, this does not prevent the file from
1184 becoming out-of-date at some point after having been staged).
1191 commands will refuse to run while staged changes exist.
1192 If staged changes cannot be committed because a staged path
1193 is out of date, the path must be unstaged with
1195 before it can be updated with
1197 and may then be staged again if necessary.
1201 .It Cm unstage Oo Fl p Oc Oo Fl F Ar response-script Oc Op Ar path ...
1202 Merge staged changes back into the work tree and put affected paths
1203 back into non-staged status.
1206 is specified, unstage all staged changes across the entire work tree.
1207 Otherwise, unstage changes at or within the specified paths.
1209 Show the status of each affected file, using the following status codes:
1210 .Bl -column YXZ description
1211 .It G Ta file was unstaged
1212 .It C Ta file was unstaged and conflicts occurred during merge
1213 .It ! Ta changes destined for a missing file were not merged
1214 .It D Ta file was staged as deleted and still is deleted
1215 .It d Ta file's deletion was obstructed by local modifications
1216 .It \(a~ Ta changes destined for a non-regular file were not merged
1224 Instead of unstaging the entire content of a changed file, interactively
1225 select or reject changes for unstaging based on
1229 (keep change staged), and
1231 (quit unstaging this file) responses.
1232 If a file is staged in modified status, individual patches derived from the
1233 staged file content can be unstaged.
1234 Files staged in added or deleted status may only be unstaged in their entirety.
1235 .It Fl F Ar response-script
1243 responses line-by-line from the specified
1245 file instead of prompting interactively.
1250 .It Cm cat Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Oo Fl P Oc Ar arg ...
1251 Parse and print contents of objects to standard output in a line-based
1253 Content of commit, tree, and tag objects is printed in a way similar
1254 to the actual content stored in such objects.
1255 Blob object contents are printed as they would appear in files on disk.
1257 Attempt to interpret each argument as a reference, a tag name, or
1258 an object ID SHA1 hash.
1259 References will be resolved to an object ID.
1260 Tag names will resolved to a tag object.
1261 An abbreviated hash argument will be expanded to a full SHA1 hash
1262 automatically, provided the abbreviation is unique.
1264 If none of the above interpretations produce a valid result, or if the
1266 option is used, attempt to interpret the argument as a path which will
1267 be resolved to the ID of an object found at this path in the repository.
1274 Look up paths in the specified
1276 If this option is not used, paths are looked up in the commit resolved
1277 via the repository's HEAD reference.
1278 The expected argument is a commit ID SHA1 hash or an existing reference
1279 or tag name which will be resolved to a commit ID.
1280 An abbreviated hash argument will be expanded to a full SHA1 hash
1281 automatically, provided the abbreviation is unique.
1282 .It Fl r Ar repository-path
1283 Use the repository at the specified path.
1284 If not specified, assume the repository is located at or above the current
1286 If this directory is a
1288 work tree, use the repository path associated with this work tree.
1290 Interpret all arguments as paths only.
1291 This option can be used to resolve ambiguity in cases where paths
1292 look like tag names, reference names, or object IDs.
1296 .Bl -tag -width GOT_AUTHOR
1298 The author's name and email address for
1303 .Dq An Flan Hacker Aq Mt flan_hacker@openbsd.org .
1306 may fail to parse commits without an email address in author data,
1310 environment variables with a missing email address.
1316 configuration settings in the repository's
1318 file will override the value of
1324 configuration settings contained in Git's global
1326 configuration file will be used only if the
1328 environment variable is
1331 .It Ev VISUAL , EDITOR
1332 The editor spawned by
1337 .It Ev GOT_LOG_DEFAULT_LIMIT
1338 The default limit on the number of commits traversed by
1340 If set to zero, the limit is unbounded.
1341 This variable will be silently ignored if it is set to a non-numeric value.
1346 Clone an existing Git repository for use with
1348 This step currently requires
1352 .Dl $ git clone --bare https://github.com/openbsd/src.git
1354 Alternatively, for quick and dirty local testing of
1356 a new Git repository could be created and populated with files,
1357 e.g. from a temporary CVS checkout located at
1360 .Dl $ got init /var/git/src.git
1361 .Dl $ got import -r /var/git/src.git -I CVS -I obj /tmp/src
1363 Check out a work tree from the Git repository to /usr/src:
1365 .Dl $ got checkout /var/git/src.git /usr/src
1367 View local changes in a work tree directory:
1370 .Dl $ got diff | less
1372 Interactively revert selected local changes in a work tree directory:
1374 .Dl $ got revert -p -R\ .
1376 In a work tree or a git repository directory, list all branch references:
1380 In a work tree or a git repository directory, create a new branch called
1381 .Dq unified-buffer-cache
1382 which is forked off the
1386 .Dl $ got branch unified-buffer-cache master
1388 Switch an existing work tree to the branch
1389 .Dq unified-buffer-cache .
1390 Local changes in the work tree will be preserved and merged if necessary:
1392 .Dl $ got update -b unified-buffer-cache
1394 Create a new commit from local changes in a work tree directory.
1395 This new commit will become the head commit of the work tree's current branch:
1399 In a work tree or a git repository directory, view changes committed in
1400 the 3 most recent commits to the work tree's branch, or the branch resolved
1401 via the repository's HEAD reference, respectively:
1403 .Dl $ got log -p -l 3 -f
1405 Add new files and remove obsolete files in a work tree directory:
1407 .Dl $ got add sys/uvm/uvm_ubc.c
1408 .Dl $ got remove sys/uvm/uvm_vnode.c
1410 Create a new commit from local changes in a work tree directory
1411 with a pre-defined log message.
1413 .Dl $ got commit -m 'unify the buffer cache'
1415 Update any work tree checked out from the
1416 .Dq unified-buffer-cache
1417 branch to the latest commit on this branch:
1421 Roll file content on the unified-buffer-cache branch back by one commit,
1422 and then fetch the rolled-back change into the work tree as a local change
1423 to be amended and perhaps committed again:
1425 .Dl $ got backout unified-buffer-cache
1426 .Dl $ got commit -m 'roll back previous'
1427 .Dl $ # now back out the previous backout :-)
1428 .Dl $ got backout unified-buffer-cache
1430 Fetch new upstream commits into the local repository's master branch.
1431 This step currently requires
1434 .Dl $ cd /var/git/src.git
1435 .Dl $ git fetch origin master:master
1438 .Dq unified-buffer-cache
1439 branch on top of the new head commit of the
1443 .Dl $ got update -b master
1444 .Dl $ got rebase unified-buffer-cache
1446 Create a patch from all changes on the unified-buffer-cache branch.
1447 The patch can be mailed out for review and applied to
1451 .Dl $ got diff master unified-buffer-cache > /tmp/ubc.diff
1453 Edit the entire commit history of the
1454 .Dq unified-buffer-cache
1457 .Dl $ got update -b unified-buffer-cache
1458 .Dl $ got update -c master
1461 Additional steps are necessary if local changes need to be pushed back
1462 to the remote repository, which currently requires
1466 Before working against existing branches in a repository cloned with
1467 .Dq git clone --bare ,
1470 must be configured to map all references in the remote repository
1473 namespace of the local repository.
1474 This can achieved by setting Git's
1475 .Pa remote.origin.fetch
1476 configuration variable to the value
1477 .Dq +refs/heads/*:refs/remotes/origin/*
1482 .Dl $ cd /var/git/repo
1483 .Dl $ git config remote.origin.fetch '+refs/heads/*:refs/remotes/origin/*'
1485 Alternatively, the following
1487 configuration item can be added manually to the Git repository's
1491 .Dl [remote "origin"]
1493 .Dl fetch = +refs/heads/*:refs/remotes/origin/*
1495 This configuration leaves the local repository's
1497 namespace free for use by local branches checked out with
1499 and, if needed, created with
1504 namespace can be updated with incoming changes from the remote
1508 .Dl $ cd /var/git/repo
1511 Before outgoing changes on the local
1513 branch can be pushed to the remote repository, the local
1515 branch must be rebased onto the
1519 .Dl $ got update -b origin/master
1520 .Dl $ got rebase master
1522 Changes on the local
1524 branch can then be pushed to the remote
1528 .Dl $ cd /var/git/repo
1529 .Dl $ git push origin master
1531 In order to merge changes committed to the
1532 .Dq unified-buffer-cache
1533 branch back into the
1536 .Dq unified-buffer-cache
1537 branch must first be rebased onto the
1541 .Dl $ got update -b master
1542 .Dl $ got rebase unified-buffer-cache
1545 .Dq unified-buffer-cache
1546 branch can now be made visible on the
1550 Because the rebase operation switched the work tree to the
1551 .Dq unified-buffer-cache
1552 branch, the work tree must be switched back to the
1555 .Dq unified-buffer-cache
1556 branch can be integrated into
1559 .Dl $ got update -b master
1560 .Dl $ got integrate unified-buffer-cache
1564 .Xr git-repository 5 ,
1567 .An Stefan Sperling Aq Mt stsp@openbsd.org
1568 .An Martin Pieuchot Aq Mt mpi@openbsd.org
1569 .An Joshua Stein Aq Mt jcs@openbsd.org
1572 is a work-in-progress and many commands remain to be implemented.
1573 At present, the user has to fall back on
1575 to perform many tasks, in particular tasks related to repository
1576 administration and tasks which require a network connection.
