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 preceed 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.
102 instead of creating the default branch
104 Use of this option is required if the
106 branch already exists.
108 Use the specified log message when creating the new commit.
113 opens a temporary file in an editor where a log message can be written.
114 .It Fl r Ar repository-path
115 Use the repository at the specified path.
116 If not specified, assume the repository is located at or above the current
119 Ignore files or directories with a name which matches the specified
121 This option may be specified multiple times to build a list of ignore patterns.
124 follows the globbing rules documented in
130 .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
131 Copy files from a repository into a new work tree.
134 is not specified, either use the last component of
135 .Ar repository path ,
138 was specified use the last component of
146 Check out files from a commit on the specified
148 If this option is not specified, a branch resolved via the repository's HEAD
149 reference will be used.
151 Check out files from the specified
153 on the selected branch.
154 The expected argument is a commit ID SHA1 hash or an existing reference
155 or tag name which will be resolved to a commit ID.
156 An abbreviated hash argument will be expanded to a full SHA1 hash
157 automatically, provided the abbreviation is unique.
158 If this option is not specified, the most recent commit on the selected
160 .It Fl p Ar path-prefix
161 Restrict the work tree to a subset of the repository's tree hierarchy.
162 Only files beneath the specified
169 .It Cm update Oo Fl b Ar branch Oc Oo Fl c Ar commit Oc Op Ar path ...
170 Update an existing work tree to a different commit.
171 Show the status of each affected file, using the following status codes:
172 .Bl -column YXZ description
173 .It U Ta file was updated and contained no local changes
174 .It G Ta file was updated and local changes were merged cleanly
175 .It C Ta file was updated and conflicts occurred during merge
176 .It D Ta file was deleted
177 .It A Ta new file was added
178 .It \(a~ Ta versioned file is obstructed by a non-regular file
179 .It ! Ta a missing versioned file was restored
184 is specified, update the entire work tree.
185 Otherwise, restrict the update operation to files at or within the
187 Each path is required to exist in the update operation's target commit.
188 Files in the work tree outside specified paths will remain unchanged and
189 will retain their previously recorded base commit.
192 commands may refuse to run while the work tree contains files from
193 multiple base commits.
194 The base commit of such a work tree can be made consistent by running
196 across the entire work tree.
199 is incompatible with the
204 cannot update paths with staged changes.
205 If changes have been staged with
207 these changes must first be comitted with
217 Switch the work tree's branch reference to the specified
219 before updating the work tree.
220 This option requires that all paths in the work tree are updated.
222 Update the work tree to the specified
224 The expected argument is a commit ID SHA1 hash or an existing reference
225 or tag name which will be resolved to a commit ID.
226 An abbreviated hash argument will be expanded to a full SHA1 hash
227 automatically, provided the abbreviation is unique.
228 If this option is not specified, the most recent commit on the work tree's
234 .It Cm status Op Ar path ...
235 Show the current modification status of files in a work tree,
236 using the following status codes:
237 .Bl -column YXZ description
238 .It M Ta modified file
239 .It A Ta file scheduled for addition in next commit
240 .It D Ta file scheduled for deletion in next commit
241 .It C Ta modified or added file which contains merge conflicts
242 .It ! Ta versioned file was expected on disk but is missing
243 .It \(a~ Ta versioned file is obstructed by a non-regular file
244 .It ? Ta unversioned item not tracked by
250 is specified, show modifications in the entire work tree.
251 Otherwise, show modifications at or within the specified paths.
253 If changes have been staged with
255 staged changes are shown in the second output column, using the following
257 .Bl -column YXZ description
258 .It M Ta file modification is staged
259 .It A Ta file addition is staged
260 .It D Ta file deletion is staged
263 Changes created on top of staged changes are indicated in the first column:
264 .Bl -column YXZ description
265 .It MM Ta file was modified after earlier changes have been staged
266 .It MA Ta file was modified after having been staged for addition
269 For compatibility with
274 files in each traversed directory and will not display unversioned files
277 ignore patterns contained in
283 only supports a single ignore pattern per line.
287 .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
288 Display history of a repository.
291 is specified, show only commits which modified this path.
298 Start traversing history at the specified
300 The expected argument is a commit ID SHA1 hash or an existing reference
301 or tag name which will be resolved to a commit ID.
302 An abbreviated hash argument will be expanded to a full SHA1 hash
303 automatically, provided the abbreviation is unique.
304 If this option is not specified, default to the work tree's current branch
305 if invoked in a work tree, or to the repository's HEAD reference.
307 Set the number of context lines shown in diffs with
309 By default, 3 lines of context are shown.
311 Restrict history traversal to the first parent of each commit.
312 This shows the linear history of the current branch only.
313 Merge commits which affected the current branch will be shown but
314 individual commits which originated on other branches will be omitted.
316 Limit history traversal to a given number of commits.
318 Display the patch of modifications made in each commit.
319 .It Fl r Ar repository-path
320 Use the repository at the specified path.
321 If not specified, assume the repository is located at or above the current
323 If this directory is a
325 work tree, use the repository path associated with this work tree.
327 .It Cm diff Oo Fl C Ar number Oc Oo Fl r Ar repository-path Oc Oo Fl s Oc Op Ar object1 Ar object2 | Ar path
328 When invoked within a work tree with less than two arguments, display
329 uncommitted changes in the work tree.
332 is specified, only show changes within this path.
334 If two arguments are provided, treat each argument as a reference, a tag
335 name, or an object ID SHA1 hash, and display differences between the
336 corresponding objects.
337 Both objects must be of the same type (blobs, trees, or commits).
338 An abbreviated hash argument will be expanded to a full SHA1 hash
339 automatically, provided the abbreviation is unique.
346 Set the number of context lines shown in the diff.
347 By default, 3 lines of context are shown.
348 .It Fl r Ar repository-path
349 Use the repository at the specified path.
350 If not specified, assume the repository is located at or above the current
352 If this directory is a
354 work tree, use the repository path associated with this work tree.
356 Show changes staged with
358 instead of showing local changes.
359 This option is only valid when
361 is invoked in a work tree.
366 .It Cm blame Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Ar path
367 Display line-by-line history of a file at the specified path.
374 Start traversing history at the specified
376 The expected argument is a commit ID SHA1 hash or an existing reference
377 or tag name which will be resolved to a commit ID.
378 An abbreviated hash argument will be expanded to a full SHA1 hash
379 automatically, provided the abbreviation is unique.
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.
391 .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
392 Display a listing of files and directories at the specified
393 directory path in the repository.
394 Entries shown in this listing may carry one of the following trailing
396 .Bl -column YXZ description
397 .It @ Ta entry is a symbolic link
398 .It / Ta entry is a directory
399 .It * Ta entry is an executable file
404 is specified, list the repository path corresponding to the current
405 directory of the work tree, or the root directory of the repository
406 if there is no work tree.
413 List files and directories as they appear in the specified
415 The expected argument is a commit ID SHA1 hash or an existing reference
416 or tag name which will be resolved to a commit ID.
417 An abbreviated hash argument will be expanded to a full SHA1 hash
418 automatically, provided the abbreviation is unique.
419 .It Fl r Ar repository-path
420 Use the repository at the specified path.
421 If not specified, assume the repository is located at or above the current
423 If this directory is a
425 work tree, use the repository path associated with this work tree.
427 Show object IDs of files (blob objects) and directories (tree objects).
429 Recurse into sub-directories in the repository.
434 .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
435 Manage references in a repository.
437 If no options are passed, expect two arguments and attempt to create,
438 or update, the reference with the given
440 and make it point at the given
442 The target may be an object ID SHA1 hash or an existing reference which
443 will be resolved to an object ID.
444 An abbreviated hash argument will be expanded to a full SHA1 hash
445 automatically, provided the abbreviation is unique.
451 .It Fl r Ar repository-path
452 Use the repository at the specified path.
453 If not specified, assume the repository is located at or above the current
455 If this directory is a
457 work tree, use the repository path associated with this work tree.
459 List all existing references in the repository.
461 Delete the reference with the specified name from the repository.
463 Create a symbolic reference pointing at the specified
465 which must be an existing reference.
466 Care should be taken not to create loops between references when
469 .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 base-branch
470 Manage branches in a repository.
472 Branches are managed via references which live in the
477 command operates on references in this namespace only.
479 If no options are passed, expect one or two arguments and attempt to create
480 a branch with the given
482 and make it point at the given
486 is specified, default to the work tree's current branch if invoked in a
487 work tree, or to the repository's HEAD reference.
493 .It Fl r Ar repository-path
494 Use the repository at the specified path.
495 If not specified, assume the repository is located at or above the current
497 If this directory is a
499 work tree, use the repository path associated with this work tree.
501 List all existing branches in the repository.
502 If invoked in a work tree, the work tree's current branch is shown
503 with one the following annotations:
504 .Bl -column YXZ description
505 .It * Ta work tree's base commit matches the branch tip
506 .It \(a~ Ta work tree's base commit is out-of-date
509 Delete the branch with the specified name from the repository.
510 Only the branch reference is deleted.
511 Any commit, tree, and blob objects belonging to the branch
512 remain in the repository and may be removed separately with
513 Git's garbage collector.
518 .It Cm add Ar file-path ...
519 Schedule unversioned files in a work tree for addition to the
520 repository in the next commit.
521 .It Cm remove Ar file-path ...
522 Remove versioned files from a work tree and schedule them for deletion
523 from the repository in the next commit.
530 Perform the operation even if a file contains uncommitted modifications.
535 .It Cm revert Oo Fl p Oc Oo Fl F Ar response-script Oc Oo Fl R Oc Ar path ...
536 Revert any uncommited changes in files at the specified paths.
537 File contents will be overwritten with those contained in the
538 work tree's base commit.
539 There is no way to bring discarded changes back after
542 If a file was added with
544 it will become an unversioned file again.
545 If a file was deleted with
554 Instead of reverting all changes in files, interactively select or reject
555 changes to revert based on
561 (quit reverting this file) responses.
562 If a file is in modified status, individual patches derived from the
563 modified file content can be reverted.
564 Files in added or deleted status may only be reverted in their entirety.
565 .It Fl F Ar response-script
573 responses line-by-line from the specified
575 file instead of prompting interactively.
577 Permit recursion into directories.
578 If this option is not specified,
580 will refuse to run if a specified
587 .It Cm commit Oo Fl m Ar message Oc Op Ar path ...
588 Create a new commit in the repository from changes in a work tree
589 and use this commit as the new base commit for the work tree.
592 is specified, commit all changes in the work tree.
593 Otherwise, commit changes at or within the specified paths.
595 If changes have been explicitly staged for commit with
597 only commit staged changes and reject any specified paths which
598 have not been staged.
600 Show the status of each affected file, using the following status codes:
601 .Bl -column YXZ description
602 .It M Ta modified file
603 .It D Ta file was deleted
604 .It A Ta new file was added
607 Files which are not part of the new commit will retain their previously
608 recorded base commit.
611 commands may refuse to run while the work tree contains files from
612 multiple base commits.
613 The base commit of such a work tree can be made consistent by running
615 across the entire work tree.
621 environment variable to be set.
628 Use the specified log message when creating the new commit.
633 opens a temporary file in an editor where a log message can be written.
637 will refuse to run if certain preconditions are not met.
638 If the work tree's current branch is not in the
640 reference namespace, new commits may not be created on this branch.
641 Local changes may only be committed if they are based on file content
642 found in the most recent commit on the work tree's branch.
643 If a path is found to be out of date,
645 must be used first in order to merge local changes with changes made
650 .It Cm cherrypick Ar commit
651 Merge changes from a single
656 must be on a different branch than the work tree's base commit.
657 The expected argument is a reference or a commit ID SHA1 hash.
658 An abbreviated hash argument will be expanded to a full SHA1 hash
659 automatically, provided the abbreviation is unique.
661 Show the status of each affected file, using the following status codes:
662 .Bl -column YXZ description
663 .It G Ta file was merged
664 .It C Ta file was merged and conflicts occurred during merge
665 .It ! Ta changes destined for a missing file were not merged
666 .It D Ta file was deleted
667 .It d Ta file's deletion was obstructed by local modifications
668 .It A Ta new file was added
669 .It \(a~ Ta changes destined for a non-regular file were not merged
672 The merged changes will appear as local changes in the work tree, which
675 amended manually or with further
680 or discarded again with
684 will refuse to run if certain preconditions are not met.
685 If the work tree contains multiple base commits it must first be updated
686 to a single base commit with
688 If the work tree already contains files with merge conflicts, these
689 conflicts must be resolved first.
693 .It Cm backout Ar commit
694 Reverse-merge changes from a single
699 must be on the same branch as the work tree's base commit.
700 The expected argument is a reference or a commit ID SHA1 hash.
701 An abbreviated hash argument will be expanded to a full SHA1 hash
702 automatically, provided the abbreviation is unique.
704 Show the status of each affected file, using the following status codes:
705 .Bl -column YXZ description
706 .It G Ta file was merged
707 .It C Ta file was merged and conflicts occurred during merge
708 .It ! Ta changes destined for a missing file were not merged
709 .It D Ta file was deleted
710 .It d Ta file's deletion was obstructed by local modifications
711 .It A Ta new file was added
712 .It \(a~ Ta changes destined for a non-regular file were not merged
715 The reverse-merged changes will appear as local changes in the work tree,
716 which may be viewed with
718 amended manually or with further
723 or discarded again with
727 will refuse to run if certain preconditions are not met.
728 If the work tree contains multiple base commits it must first be updated
729 to a single base commit with
731 If the work tree already contains files with merge conflicts, these
732 conflicts must be resolved first.
736 .It Cm rebase Oo Fl a Oc Oo Fl c Oc Op Ar branch
737 Rebase commits on the specified
739 onto the tip of the current branch of the work tree.
742 must share common ancestry with the work tree's current branch.
743 Rebasing begins with the first descendent commit of the youngest
744 common ancestor commit shared by the specified
746 and the work tree's current branch, and stops once the tip commit
751 Rebased commits are accumulated on a temporary branch which the work tree
752 will remain switched to throughout the entire rebase operation.
753 Commits on this branch represent the same changes with the same log
754 messages as their counterparts on the original
756 but with different commit IDs.
757 Once rebasing has completed successfully, the temporary branch becomes
758 the new version of the specified
760 and the work tree is automatically switched to it.
762 While rebasing commits, show the status of each affected file,
763 using the following status codes:
764 .Bl -column YXZ description
765 .It G Ta file was merged
766 .It C Ta file was merged and conflicts occurred during merge
767 .It ! Ta changes destined for a missing file were not merged
768 .It D Ta file was deleted
769 .It d Ta file's deletion was obstructed by local modifications
770 .It A Ta new file was added
771 .It \(a~ Ta changes destined for a non-regular file were not merged
774 If merge conflicts occur the rebase operation is interrupted and may
775 be continued once conflicts have been resolved.
776 Alternatively, the rebase operation may be aborted which will leave
778 unmodified and the work tree switched back to its original branch.
780 If a merge conflict is resolved in a way which renders the merged
781 change into a no-op change, the corresponding commit will be elided
782 when the rebase operation continues.
785 will refuse to run if certain preconditions are not met.
786 If the work tree contains multiple base commits it must first be updated
787 to a single base commit with
789 If changes have been staged with
791 these changes must first be comitted with
795 If the work tree contains local changes, these changes must first be
802 contains changes to files outside of the work tree's path prefix,
803 the work tree cannot be used to rebase this branch.
809 commands will refuse to run while a rebase operation is in progress.
810 Other commands which manipulate the work tree may be used for
811 conflict resolution purposes.
818 Abort an interrupted rebase operation.
819 If this option is used, no other command-line arguments are allowed.
821 Continue an interrupted rebase operation.
822 If this option is used, no other command-line arguments are allowed.
827 .It Cm histedit Oo Fl a Oc Oo Fl c Oc Op Fl F Ar histedit-script
828 Edit commit history between the work tree's current base commit and
829 the tip commit of the work tree's current branch.
831 Editing of commit history is controlled via a
833 which can be edited interactively or passed on the command line.
834 The format of the histedit script is line-based.
835 Each line in the script begins with a command name, followed by
836 whitespace and an argument.
837 For most commands, the expected argument is a commit ID SHA1 hash.
838 Any remaining text on the line is ignored.
839 Lines which begin with the
841 character are ignored entirely.
843 The available commands are as follows:
844 .Bl -column YXZ pick-commit
845 .It pick Ar commit Ta Use the specified commit as it is.
846 .It edit Ar commit Ta Use the specified commit but once changes have been
847 merged into the work tree interrupt the histedit operation for amending.
848 .It fold Ar commit Ta Combine the specified commit with the next commit
849 listed further below that will be used.
850 .It drop Ar commit Ta Remove this commit from the edited history.
851 .It mesg Ar log-message Ta Use the specified single-line log message for
852 the commit on the previous line.
853 If the log message argument is left empty, open an editor where a new
854 log message can be written.
857 Every commit in the history being edited must be mentioned in the script.
858 Lines may be re-ordered to change the order of commits in the edited history.
860 Edited commits are accumulated on a temporary branch which the work tree
861 will remain switched to throughout the entire histedit operation.
862 Once history editing has completed successfully, the temporary branch becomes
863 the new version of the work tree's branch and the work tree is automatically
866 While merging commits, show the status of each affected file,
867 using the following status codes:
868 .Bl -column YXZ description
869 .It G Ta file was merged
870 .It C Ta file was merged and conflicts occurred during merge
871 .It ! Ta changes destined for a missing file were not merged
872 .It D Ta file was deleted
873 .It d Ta file's deletion was obstructed by local modifications
874 .It A Ta new file was added
875 .It \(a~ Ta changes destined for a non-regular file were not merged
878 If merge conflicts occur the histedit operation is interrupted and may
879 be continued once conflicts have been resolved.
880 Alternatively, the histedit operation may be aborted which will leave
881 the work tree switched back to its original branch.
883 If a merge conflict is resolved in a way which renders the merged
884 change into a no-op change, the corresponding commit will be elided
885 when the histedit operation continues.
888 will refuse to run if certain preconditions are not met.
889 If the work tree's current branch is not in the
891 reference namespace, the history of the branch may not be edited.
892 If the work tree contains multiple base commits it must first be updated
893 to a single base commit with
895 If changes have been staged with
897 these changes must first be comitted with
901 If the work tree contains local changes, these changes must first be
906 If the edited history contains changes to files outside of the work tree's
907 path prefix, the work tree cannot be used to edit the history of this branch.
911 command will refuse to run while a histedit operation is in progress.
912 Other commands which manipulate the work tree may be used, and the
914 command may be used to commit arbitrary changes to the temporary branch
915 while the histedit operation is interrupted.
922 Abort an interrupted histedit operation.
923 If this option is used, no other command-line arguments are allowed.
925 Continue an interrupted histedit operation.
926 If this option is used, no other command-line arguments are allowed.
931 .It Cm stage Oo Fl l Oc Oo Fl p Oc Oo Fl F Ar response-script Oc Op Ar path ...
932 Stage local changes for inclusion in the next commit.
935 is specified, stage all changes in the work tree.
936 Otherwise, stage changes at or within the specified paths.
937 Paths may be staged if they are added, modified, or deleted according to
940 Show the status of each affected file, using the following status codes:
941 .Bl -column YXZ description
942 .It A Ta file addition has been staged
943 .It M Ta file modification has been staged
944 .It D Ta file deletion has been staged
947 Staged file contents are saved in newly created blob objects in the repository.
948 These blobs will be referred to by tree objects once staged changes have been
951 Staged changes affect the behaviour of
956 While paths with staged changes exist, the
958 command will refuse to commit any paths which do not have staged changes.
959 Local changes created on top of staged changes can only be committed if
960 the path is staged again, or if the staged changes are committed first.
963 command will show both local changes and staged changes.
966 command is able to display local changes relative to staged changes,
967 and to display staged changes relative to the repository.
970 command cannot revert staged changes but may be used to revert
971 local changes created on top of staged changes.
978 Instead of staging new changes, list paths which are already staged,
979 along with the IDs of staged blob objects and stage status codes.
980 If paths were provided in the command line show the staged paths
981 among the specified paths.
982 Otherwise, show all staged paths.
984 Instead of staging the entire content of a changed file, interactively
985 select or reject changes for staging based on
991 (quit staging this file) responses.
992 If a file is in modified status, individual patches derived from the
993 modified file content can be staged.
994 Files in added or deleted status may only be staged or rejected in
996 .It Fl F Ar response-script
1004 responses line-by-line from the specified
1006 file instead of prompting interactively.
1010 will refuse to run if certain preconditions are not met.
1011 If a file contains merge conflicts, these conflicts must be resolved first.
1012 If a file is found to be out of date relative to the head commit on the
1013 work tree's current branch, the file must be updated with
1015 before it can be staged (however, this does not prevent the file from
1016 becoming out-of-date at some point after having been staged).
1023 commands will refuse to run while staged changes exist.
1024 If staged changes cannot be committed because a staged path
1025 is out of date, the path must be unstaged with
1027 before it can be updated with
1029 and may then be staged again if necessary.
1033 .It Cm unstage Oo Fl p Oc Oo Fl F Ar response-script Oc Op Ar path ...
1034 Merge staged changes back into the work tree and put affected paths
1035 back into non-staged status.
1038 is specified, unstage all staged changes across the entire work tree.
1039 Otherwise, unstage changes at or within the specified paths.
1041 Show the status of each affected file, using the following status codes:
1042 .Bl -column YXZ description
1043 .It G Ta file was unstaged
1044 .It C Ta file was unstaged and conflicts occurred during merge
1045 .It ! Ta changes destined for a missing file were not merged
1046 .It D Ta file was staged as deleted and still is deleted
1047 .It d Ta file's deletion was obstructed by local modifications
1048 .It \(a~ Ta changes destined for a non-regular file were not merged
1056 Instead of unstaging the entire content of a changed file, interactively
1057 select or reject changes for unstaging based on
1061 (keep change staged), and
1063 (quit unstaging this file) responses.
1064 If a file is staged in modified status, individual patches derived from the
1065 staged file content can be unstaged.
1066 Files staged in added or deleted status may only be unstaged in their entirety.
1067 .It Fl F Ar response-script
1075 responses line-by-line from the specified
1077 file instead of prompting interactively.
1084 .Bl -tag -width GOT_AUTHOR
1086 The author's name and email address for
1091 .An Flan Hacker Aq Mt flan_hacker@openbsd.org .
1094 may fail to parse commits without an email address in author data,
1098 environment variables with a missing email address.
1099 .It Ev VISUAL , EDITOR
1100 The editor spawned by
1106 Clone an existing Git repository for use with
1108 This step currently requires
1112 .Dl $ git clone --bare https://github.com/openbsd/src.git
1114 Alternatively, for quick and dirty local testing of
1116 a new Git repository could be created and populated with files,
1117 e.g. from a temporary CVS checkout located at
1120 .Dl $ got init /var/git/src.git
1121 .Dl $ got import -r /var/git/src.git -I CVS -I obj /tmp/src
1123 Check out a work tree from the Git repository to /usr/src:
1125 .Dl $ got checkout /var/git/src.git /usr/src
1127 View local changes in a work tree directory:
1130 .Dl $ got diff | less
1132 Interactively revert selected local changes in a work tree directory:
1134 .Dl $ got revert -p -R\ .
1136 In a work tree or a git repository directory, list all branch references:
1140 In a work tree or a git repository directory, create a new branch called
1141 .Dq unified-buffer-cache
1142 which is forked off the
1146 .Dl $ got branch unified-buffer-cache master
1148 Switch an existing work tree to the branch
1149 .Dq unified-buffer-cache .
1150 Local changes in the work tree will be preserved and merged if necessary:
1152 .Dl $ got update -b unified-buffer-cache
1154 Create a new commit from local changes in a work tree directory.
1155 This new commit will become the head commit of the work tree's current branch:
1159 In a work tree or a git repository directory, view changes committed in
1160 the 3 most recent commits to the work tree's branch, or the branch resolved
1161 via the repository's HEAD reference, respectively:
1163 .Dl $ got log -p -l 3 -f
1165 Add new files and remove obsolete files in a work tree directory:
1167 .Dl $ got add sys/uvm/uvm_ubc.c
1168 .Dl $ got remove sys/uvm/uvm_vnode.c
1170 Create a new commit from local changes in a work tree directory
1171 with a pre-defined log message.
1173 .Dl $ got commit -m 'unify the buffer cache'
1175 Update any work tree checked out from the
1176 .Dq unified-buffer-cache
1177 branch to the latest commit on this branch:
1181 Roll file content on the unified-buffer-cache branch back by one commit,
1182 and then fetch the rolled-back change into the work tree as a local change
1183 to be amended and perhaps committed again:
1185 .Dl $ got backout unified-buffer-cache
1186 .Dl $ got commit -m 'roll back previous'
1187 .Dl $ # now back out the previous backout :-)
1188 .Dl $ got backout unified-buffer-cache
1190 Fetch new upstream commits into the local repository's master branch.
1191 This step currently requires
1194 .Dl $ cd /var/git/src.git
1195 .Dl $ git fetch origin master:master
1198 .Dq unified-buffer-cache
1199 branch on top of the new head commit of the
1203 .Dl $ got update -b master
1204 .Dl $ got rebase unified-buffer-cache
1206 Create a patch from all changes on the unified-buffer-cache branch.
1207 The patch can be mailed out for review and applied to
1211 .Dl $ got diff master unified-buffer-cache > /tmp/ubc.diff
1213 Edit the entire commit history of the
1214 .Dq unified-buffer-cache
1217 .Dl $ got update -b unified-buffer-cache
1218 .Dl $ got update -c master
1221 Additional steps are necessary if local changes need to be pushed back
1222 to the remote repository, which currently requires
1226 Before working against existing branches in a repository cloned with
1227 .Dq git clone --bare ,
1230 must be configured to map all references in the remote repository
1233 namespace of the local repository.
1234 This can achieved by setting Git's
1235 .Pa remote.origin.fetch
1236 configuration variable to the value
1237 .Dq +refs/heads/*:refs/remotes/origin/*
1242 .Dl $ cd /var/git/repo
1243 .Dl $ git config remote.origin.fetch '+refs/heads/*:refs/remotes/origin/*'
1245 Alternatively, the following
1247 configuration item can be added manually to the Git repository's
1251 .Dl [remote "origin"]
1253 .Dl fetch = +refs/heads/*:refs/remotes/origin/*
1255 This configuration leaves the local repository's
1257 namespace free for use by local branches checked out with
1259 and, if needed, created with
1264 namespace can be updated with incoming changes from the remote
1268 .Dl $ cd /var/git/repo
1271 Before outgoing changes on the local
1273 branch can be pushed to the remote repository, the local
1275 branch must be rebased onto the
1279 .Dl $ got update -b origin/master
1280 .Dl $ got rebase master
1282 Changes on the local
1284 branch can then be pushed to the remote
1288 .Dl $ cd /var/git/repo
1289 .Dl $ git push origin master
1292 .Xr git-repository 5 ,
1295 .An Stefan Sperling Aq Mt stsp@openbsd.org
1296 .An Martin Pieuchot Aq Mt mpi@openbsd.org
1297 .An joshua stein Aq Mt jcs@openbsd.org
1300 is a work-in-progress and many commands remain to be implemented.
1301 At present, the user has to fall back on
1303 to perform many tasks, in particular tasks related to repository
1304 administration and tasks which require a network connection.
