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
80 .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
81 Create an initial commit in a repository from the file hierarchy
84 The created commit will not have any parent commits, i.e. it will be a
86 Also create a new reference which provides a branch name for the newly
88 Show the path of each imported file to indicate progress.
94 environment variable to be set.
103 instead of creating the default branch
105 Use of this option is required if the
107 branch already exists.
109 Use the specified log message when creating the new commit.
114 opens a temporary file in an editor where a log message can be written.
115 .It Fl r Ar repository-path
116 Use the repository at the specified path.
117 If not specified, assume the repository is located at or above the current
120 Ignore files or directories with a name which matches the specified
122 This option may be specified multiple times to build a list of ignore patterns.
125 follows the globbing rules documented in
131 .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
132 Copy files from a repository into a new work tree.
135 is not specified, either use the last component of
136 .Ar repository path ,
139 was specified use the last component of
147 Check out files from a commit on the specified
149 If this option is not specified, a branch resolved via the repository's HEAD
150 reference will be used.
152 Check out files from the specified
154 on the selected branch.
155 The expected argument is a commit ID SHA1 hash or an existing reference
156 or tag name which will be resolved to a commit ID.
157 An abbreviated hash argument will be expanded to a full SHA1 hash
158 automatically, provided the abbreviation is unique.
159 If this option is not specified, the most recent commit on the selected
161 .It Fl p Ar path-prefix
162 Restrict the work tree to a subset of the repository's tree hierarchy.
163 Only files beneath the specified
170 .It Cm update Oo Fl b Ar branch Oc Oo Fl c Ar commit Oc Op Ar path ...
171 Update an existing work tree to a different commit.
172 Show the status of each affected file, using the following status codes:
173 .Bl -column YXZ description
174 .It U Ta file was updated and contained no local changes
175 .It G Ta file was updated and local changes were merged cleanly
176 .It C Ta file was updated and conflicts occurred during merge
177 .It D Ta file was deleted
178 .It A Ta new file was added
179 .It ~ Ta versioned file is obstructed by a non-regular file
180 .It ! Ta a missing versioned file was restored
185 is specified, update the entire work tree.
186 Otherwise, restrict the update operation to files at or within the
188 Each path is required to exist in the update operation's target commit.
189 Files in the work tree outside specified paths will remain unchanged and
190 will retain their previously recorded base commit.
193 commands may refuse to run while the work tree contains files from
194 multiple base commits.
195 The base commit of such a work tree can be made consistent by running
197 across the entire work tree.
200 is incompatible with the
205 cannot update paths with staged changes.
206 If changes have been staged with
208 these changes must first be comitted with
218 Switch the work tree's branch reference to the specified
220 before updating the work tree.
221 This option requires that all paths in the work tree are updated.
223 Update the work tree to the specified
225 The expected argument is a commit ID SHA1 hash or an existing reference
226 or tag name which will be resolved to a commit ID.
227 An abbreviated hash argument will be expanded to a full SHA1 hash
228 automatically, provided the abbreviation is unique.
229 If this option is not specified, the most recent commit on the work tree's
235 .It Cm status Op Ar path ...
236 Show the current modification status of files in a work tree,
237 using the following status codes:
238 .Bl -column YXZ description
239 .It M Ta modified file
240 .It A Ta file scheduled for addition in next commit
241 .It D Ta file scheduled for deletion in next commit
242 .It C Ta modified or added file which contains merge conflicts
243 .It ! Ta versioned file was expected on disk but is missing
244 .It ~ Ta versioned file is obstructed by a non-regular file
245 .It ? Ta unversioned item not tracked by
251 is specified, show modifications in the entire work tree.
252 Otherwise, show modifications at or within the specified paths.
254 If changes have been staged with
256 staged changes are shown in the second output column, using the following
258 .Bl -column YXZ description
259 .It M Ta file modification is staged
260 .It A Ta file addition is staged
261 .It D Ta file deletion is staged
264 Changes created on top of staged changes are indicated in the first column:
265 .Bl -column YXZ description
266 .It MM Ta file was modified after earlier changes have been staged
267 .It MA Ta file was modified after having been staged for addition
270 For compatibility with
275 files in each traversed directory and will not display unversioned files
278 ignore patterns contained in
284 only supports a single ignore pattern per line.
288 .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
289 Display history of a repository.
292 is specified, show only commits which modified this path.
299 Start traversing history at the specified
301 The expected argument is a commit ID SHA1 hash or an existing reference
302 or tag name which will be resolved to a commit ID.
303 An abbreviated hash argument will be expanded to a full SHA1 hash
304 automatically, provided the abbreviation is unique.
305 If this option is not specified, default to the work tree's current branch
306 if invoked in a work tree, or to the repository's HEAD reference.
308 Set the number of context lines shown in diffs with
310 By default, 3 lines of context are shown.
312 Restrict history traversal to the first parent of each commit.
313 This shows the linear history of the current branch only.
314 Merge commits which affected the current branch will be shown but
315 individual commits which originated on other branches will be omitted.
317 Limit history traversal to a given number of commits.
319 Display the patch of modifications made in each commit.
320 .It Fl r Ar repository-path
321 Use the repository at the specified path.
322 If not specified, assume the repository is located at or above the current
324 If this directory is a
326 work tree, use the repository path associated with this work tree.
328 .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
329 When invoked within a work tree with less than two arguments, display
330 uncommitted changes in the work tree.
333 is specified, only show changes within this path.
335 If two arguments are provided, treat each argument as a reference, a tag
336 name, or an object ID SHA1 hash, and display differences between the
337 corresponding objects.
338 Both objects must be of the same type (blobs, trees, or commits).
339 An abbreviated hash argument will be expanded to a full SHA1 hash
340 automatically, provided the abbreviation is unique.
347 Set the number of context lines shown in the diff.
348 By default, 3 lines of context are shown.
349 .It Fl r Ar repository-path
350 Use the repository at the specified path.
351 If not specified, assume the repository is located at or above the current
353 If this directory is a
355 work tree, use the repository path associated with this work tree.
357 Show changes staged with
359 instead of showing local changes.
360 This option is only valid when
362 is invoked in a work tree.
367 .It Cm blame Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Ar path
368 Display line-by-line history of a file at the specified path.
375 Start traversing history at the specified
377 The expected argument is a commit ID SHA1 hash or an existing reference
378 or tag name which will be resolved to a commit ID.
379 An abbreviated hash argument will be expanded to a full SHA1 hash
380 automatically, provided the abbreviation is unique.
381 .It Fl r Ar repository-path
382 Use the repository at the specified path.
383 If not specified, assume the repository is located at or above the current
385 If this directory is a
387 work tree, use the repository path associated with this work tree.
392 .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
393 Display a listing of files and directories at the specified
394 directory path in the repository.
395 Entries shown in this listing may carry one of the following trailing
397 .Bl -column YXZ description
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 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 .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
464 Manage branches in a repository.
466 Branches are managed via references which live in the
471 command operates on references in this namespace only.
473 If no options are passed, expect one or two arguments and attempt to create
474 a branch with the given
476 and make it point at the given
480 is specified, default to the work tree's current branch if invoked in a
481 work tree, or to the repository's HEAD reference.
487 .It Fl r Ar repository-path
488 Use the repository at the specified path.
489 If not specified, assume the repository is located at or above the current
491 If this directory is a
493 work tree, use the repository path associated with this work tree.
495 List all existing branches in the repository.
496 If invoked in a work tree, the work tree's current branch is shown
497 with one the following annotations:
498 .Bl -column YXZ description
499 .It * Ta work tree's base commit matches the branch tip
500 .It ~ Ta work tree's base commit is out-of-date
503 Delete the branch with the specified name from the repository.
504 Only the branch reference is deleted.
505 Any commit, tree, and blob objects belonging to the branch
506 remain in the repository and may be removed separately with
507 Git's garbage collector.
512 .It Cm add Ar file-path ...
513 Schedule unversioned files in a work tree for addition to the
514 repository in the next commit.
515 .It Cm remove Ar file-path ...
516 Remove versioned files from a work tree and schedule them for deletion
517 from the repository in the next commit.
524 Perform the operation even if a file contains uncommitted modifications.
529 .It Cm revert Oo Fl p Oc Oo Fl F Ar response-script Oc Oo Fl R Oc Ar path ...
530 Revert any uncommited changes in files at the specified paths.
531 File contents will be overwritten with those contained in the
532 work tree's base commit. There is no way to bring discarded
536 If a file was added with
538 it will become an unversioned file again.
539 If a file was deleted with
548 Instead of reverting all changes in files, interactively select or reject
549 changes to revert based on
555 (quit reverting this file) responses.
556 If a file is in modified status, individual patches derived from the
557 modified file content can be reverted.
558 Files in added or deleted status may only be reverted in their entirety.
559 .It Fl F Ar response-script
567 responses line-by-line from the specified
569 file instead of prompting interactively.
571 Permit recursion into directories.
572 If this option is not specified,
574 will refuse to run if a specified
581 .It Cm commit Oo Fl m Ar message Oc Op Ar path ...
582 Create a new commit in the repository from changes in a work tree
583 and use this commit as the new base commit for the work tree.
586 is specified, commit all changes in the work tree.
587 Otherwise, commit changes at or within the specified paths.
589 If changes have been explicitly staged for commit with
591 only commit staged changes and reject any specified paths which
592 have not been staged.
594 Show the status of each affected file, using the following status codes:
595 .Bl -column YXZ description
596 .It M Ta modified file
597 .It D Ta file was deleted
598 .It A Ta new file was added
601 Files which are not part of the new commit will retain their previously
602 recorded base commit.
605 commands may refuse to run while the work tree contains files from
606 multiple base commits.
607 The base commit of such a work tree can be made consistent by running
609 across the entire work tree.
615 environment variable to be set.
622 Use the specified log message when creating the new commit.
627 opens a temporary file in an editor where a log message can be written.
631 will refuse to run if certain preconditions are not met.
632 If the work tree's current branch is not in the
634 reference namespace, new commits may not be created on this branch.
635 Local changes may only be committed if they are based on file content
636 found in the most recent commit on the work tree's branch.
637 If a path is found to be out of date,
639 must be used first in order to merge local changes with changes made
644 .It Cm cherrypick Ar commit
645 Merge changes from a single
650 must be on a different branch than the work tree's base commit.
651 The expected argument is a reference or a commit ID SHA1 hash.
652 An abbreviated hash argument will be expanded to a full SHA1 hash
653 automatically, provided the abbreviation is unique.
655 Show the status of each affected file, using the following status codes:
656 .Bl -column YXZ description
657 .It G Ta file was merged
658 .It C Ta file was merged and conflicts occurred during merge
659 .It ! Ta changes destined for a missing file were not merged
660 .It D Ta file was deleted
661 .It d Ta file's deletion was obstructed by local modifications
662 .It A Ta new file was added
663 .It ~ Ta changes destined for a non-regular file were not merged
666 The merged changes will appear as local changes in the work tree, which
669 amended manually or with further
674 or discarded again with
678 will refuse to run if certain preconditions are not met.
679 If the work tree contains multiple base commits it must first be updated
680 to a single base commit with
682 If the work tree already contains files with merge conflicts, these
683 conflicts must be resolved first.
687 .It Cm backout Ar commit
688 Reverse-merge changes from a single
693 must be on the same branch as the work tree's base commit.
694 The expected argument is a reference or a commit ID SHA1 hash.
695 An abbreviated hash argument will be expanded to a full SHA1 hash
696 automatically, provided the abbreviation is unique.
698 Show the status of each affected file, using the following status codes:
699 .Bl -column YXZ description
700 .It G Ta file was merged
701 .It C Ta file was merged and conflicts occurred during merge
702 .It ! Ta changes destined for a missing file were not merged
703 .It D Ta file was deleted
704 .It d Ta file's deletion was obstructed by local modifications
705 .It A Ta new file was added
706 .It ~ Ta changes destined for a non-regular file were not merged
709 The reverse-merged changes will appear as local changes in the work tree,
710 which may be viewed with
712 amended manually or with further
717 or discarded again with
721 will refuse to run if certain preconditions are not met.
722 If the work tree contains multiple base commits it must first be updated
723 to a single base commit with
725 If the work tree already contains files with merge conflicts, these
726 conflicts must be resolved first.
730 .It Cm rebase Oo Fl a Oc Oo Fl c Oc Op Ar branch
731 Rebase commits on the specified
733 onto the tip of the current branch of the work tree.
736 must share common ancestry with the work tree's current branch.
737 Rebasing begins with the first descendent commit of the youngest
738 common ancestor commit shared by the specified
740 and the work tree's current branch, and stops once the tip commit
745 Rebased commits are accumulated on a temporary branch which the work tree
746 will remain switched to throughout the entire rebase operation.
747 Commits on this branch represent the same changes with the same log
748 messages as their counterparts on the original
750 but with different commit IDs.
751 Once rebasing has completed successfully, the temporary branch becomes
752 the new version of the specified
754 and the work tree is automatically switched to it.
756 While rebasing commits, show the status of each affected file,
757 using the following status codes:
758 .Bl -column YXZ description
759 .It G Ta file was merged
760 .It C Ta file was merged and conflicts occurred during merge
761 .It ! Ta changes destined for a missing file were not merged
762 .It D Ta file was deleted
763 .It d Ta file's deletion was obstructed by local modifications
764 .It A Ta new file was added
765 .It ~ Ta changes destined for a non-regular file were not merged
768 If merge conflicts occur the rebase operation is interrupted and may
769 be continued once conflicts have been resolved.
770 Alternatively, the rebase operation may be aborted which will leave
772 unmodified and the work tree switched back to its original branch.
774 If a merge conflict is resolved in a way which renders the merged
775 change into a no-op change, the corresponding commit will be elided
776 when the rebase operation continues.
779 will refuse to run if certain preconditions are not met.
780 If the work tree contains multiple base commits it must first be updated
781 to a single base commit with
783 If changes have been staged with
785 these changes must first be comitted with
789 If the work tree contains local changes, these changes must first be
796 contains changes to files outside of the work tree's path prefix,
797 the work tree cannot be used to rebase this branch.
803 commands will refuse to run while a rebase operation is in progress.
804 Other commands which manipulate the work tree may be used for
805 conflict resolution purposes.
812 Abort an interrupted rebase operation.
813 If this option is used, no other command-line arguments are allowed.
815 Continue an interrupted rebase operation.
816 If this option is used, no other command-line arguments are allowed.
821 .It Cm histedit Oo Fl a Oc Oo Fl c Oc Op Fl F Ar histedit-script
822 Edit commit history between the work tree's current base commit and
823 the tip commit of the work tree's current branch.
825 Editing of commit history is controlled via a
827 which can be edited interactively or passed on the command line.
828 The format of the histedit script is line-based.
829 Each line in the script begins with a command name, followed by
830 whitespace and an argument.
831 For most commands, the expected argument is a commit ID SHA1 hash.
832 Any remaining text on the line is ignored.
833 Lines which begin with the
835 character are ignored entirely.
837 The available commands are as follows:
838 .Bl -column YXZ pick-commit
839 .It pick Ar commit Ta Use the specified commit as it is.
840 .It edit Ar commit Ta Use the specified commit but once changes have been
841 merged into the work tree interrupt the histedit operation for amending.
842 .It fold Ar commit Ta Combine the specified commit with the next commit
843 listed further below that will be used.
844 .It drop Ar commit Ta Remove this commit from the edited history.
845 .It mesg Ar log-message Ta Use the specified single-line log message for
846 the commit on the previous line.
847 If the log message argument is left empty, open an editor where a new
848 log message can be written.
851 Every commit in the history being edited must be mentioned in the script.
852 Lines may be re-ordered to change the order of commits in the edited history.
854 Edited commits are accumulated on a temporary branch which the work tree
855 will remain switched to throughout the entire histedit operation.
856 Once history editing has completed successfully, the temporary branch becomes
857 the new version of the work tree's branch and the work tree is automatically
860 While merging commits, show the status of each affected file,
861 using the following status codes:
862 .Bl -column YXZ description
863 .It G Ta file was merged
864 .It C Ta file was merged and conflicts occurred during merge
865 .It ! Ta changes destined for a missing file were not merged
866 .It D Ta file was deleted
867 .It d Ta file's deletion was obstructed by local modifications
868 .It A Ta new file was added
869 .It ~ Ta changes destined for a non-regular file were not merged
872 If merge conflicts occur the histedit operation is interrupted and may
873 be continued once conflicts have been resolved.
874 Alternatively, the histedit operation may be aborted which will leave
875 the work tree switched back to its original branch.
877 If a merge conflict is resolved in a way which renders the merged
878 change into a no-op change, the corresponding commit will be elided
879 when the histedit operation continues.
882 will refuse to run if certain preconditions are not met.
883 If the work tree's current branch is not in the
885 reference namespace, the history of the branch may not be edited.
886 If the work tree contains multiple base commits it must first be updated
887 to a single base commit with
889 If changes have been staged with
891 these changes must first be comitted with
895 If the work tree contains local changes, these changes must first be
900 If the edited history contains changes to files outside of the work tree's
901 path prefix, the work tree cannot be used to edit the history of this branch.
905 command will refuse to run while a histedit operation is in progress.
906 Other commands which manipulate the work tree may be used, and the
908 command may be used to commit arbitrary changes to the temporary branch
909 while the histedit operation is interrupted.
916 Abort an interrupted histedit operation.
917 If this option is used, no other command-line arguments are allowed.
919 Continue an interrupted histedit operation.
920 If this option is used, no other command-line arguments are allowed.
925 .It Cm stage Oo Fl l Oc Oo Fl p Oc Oo Fl F Ar response-script Oc Op Ar path ...
926 Stage local changes for inclusion in the next commit.
929 is specified, stage all changes in the work tree.
930 Otherwise, stage changes at or within the specified paths.
931 Paths may be staged if they are added, modified, or deleted according to
934 Show the status of each affected file, using the following status codes:
935 .Bl -column YXZ description
936 .It A Ta file addition has been staged
937 .It M Ta file modification has been staged
938 .It D Ta file deletion has been staged
941 Staged file contents are saved in newly created blob objects in the repository.
942 These blobs will be referred to by tree objects once staged changes have been
945 Staged changes affect the behaviour of
950 While paths with staged changes exist, the
952 command will refuse to commit any paths which do not have staged changes.
953 Local changes created on top of staged changes can only be committed if
954 the path is staged again, or if the staged changes are committed first.
957 command will show both local changes and staged changes.
960 command is able to display local changes relative to staged changes,
961 and to display staged changes relative to the repository.
964 command cannot revert staged changes but may be used to revert
965 local changes created on top of staged changes.
972 Instead of staging new changes, list paths which are already staged,
973 along with the IDs of staged blob objects and stage status codes.
974 If paths were provided in the command line show the staged paths
975 among the specified paths. Otherwise, show all staged paths.
977 Instead of staging the entire content of a changed file, interactively
978 select or reject changes for staging based on
984 (quit staging this file) responses.
985 If a file is in modified status, individual patches derived from the
986 modified file content can be staged.
987 Files in added or deleted status may only be staged or rejected in
989 .It Fl F Ar response-script
997 responses line-by-line from the specified
999 file instead of prompting interactively.
1003 will refuse to run if certain preconditions are not met.
1004 If a file contains merge conflicts, these conflicts must be resolved first.
1005 If a file is found to be out of date relative to the head commit on the
1006 work tree's current branch, the file must be updated with
1008 before it can be staged (however, this does not prevent the file from
1009 becoming out-of-date at some point after having been staged).
1016 commands will refuse to run while staged changes exist.
1017 If staged changes cannot be committed because a staged path
1018 is out of date, the path must be unstaged with
1020 before it can be updated with
1022 and may then be staged again if necessary.
1026 .It Cm unstage Oo Fl p Oc Oo Fl F Ar response-script Oc Op Ar path ...
1027 Merge staged changes back into the work tree and put affected paths
1028 back into non-staged status.
1031 is specified, unstage all staged changes across the entire work tree.
1032 Otherwise, unstage changes at or within the specified paths.
1034 Show the status of each affected file, using the following status codes:
1035 .Bl -column YXZ description
1036 .It G Ta file was unstaged
1037 .It C Ta file was unstaged and conflicts occurred during merge
1038 .It ! Ta changes destined for a missing file were not merged
1039 .It D Ta file was staged as deleted and still is deleted
1040 .It d Ta file's deletion was obstructed by local modifications
1041 .It ~ Ta changes destined for a non-regular file were not merged
1049 Instead of unstaging the entire content of a changed file, interactively
1050 select or reject changes for unstaging based on
1054 (keep change staged), and
1056 (quit unstaging this file) responses.
1057 If a file is staged in modified status, individual patches derived from the
1058 staged file content can be unstaged.
1059 Files staged in added or deleted status may only be unstaged in their entirety.
1060 .It Fl F Ar response-script
1068 responses line-by-line from the specified
1070 file instead of prompting interactively.
1077 .Bl -tag -width GOT_AUTHOR
1079 The author's name and email address for
1084 .An Flan Hacker Aq Mt flan_hacker@openbsd.org .
1087 may fail to parse commits without an email address in author data,
1091 environment variables with a missing email address.
1092 .It Ev VISUAL, Ev EDITOR
1093 The editor spawned by
1099 Clone an existing Git repository for use with
1101 This step currently requires
1105 .Dl $ git clone --bare https://github.com/openbsd/src.git
1107 Alternatively, for quick and dirty local testing of
1109 a new Git repository could be created and populated with files,
1110 e.g. from a temporary CVS checkout located at
1113 .Dl $ got init /var/git/src.git
1114 .Dl $ got import -r /var/git/src.git -I CVS -I obj /tmp/src
1116 Check out a work tree from the Git repository to /usr/src:
1118 .Dl $ got checkout /var/git/src.git /usr/src
1120 View local changes in a work tree directory:
1123 .Dl $ got diff | less
1125 Interactively revert selected local changes in a work tree directory:
1127 .Dl $ got revert -p -R\ .
1129 In a work tree or a git repository directory, list all branch references:
1133 In a work tree or a git repository directory, create a new branch called
1134 .Dq unified-buffer-cache
1135 which is forked off the
1139 .Dl $ got branch unified-buffer-cache master
1141 Switch an existing work tree to the branch
1142 .Dq unified-buffer-cache .
1143 Local changes in the work tree will be preserved and merged if necessary:
1145 .Dl $ got update -b unified-buffer-cache
1147 Create a new commit from local changes in a work tree directory.
1148 This new commit will become the head commit of the work tree's current branch:
1152 In a work tree or a git repository directory, view changes committed in
1153 the 3 most recent commits to the work tree's branch, or the branch resolved
1154 via the repository's HEAD reference, respectively:
1156 .Dl $ got log -p -l 3 -f
1158 Add new files and remove obsolete files in a work tree directory:
1160 .Dl $ got add sys/uvm/uvm_ubc.c
1161 .Dl $ got remove sys/uvm/uvm_vnode.c
1163 Create a new commit from local changes in a work tree directory
1164 with a pre-defined log message.
1166 .Dl $ got commit -m 'unify the buffer cache'
1168 Update any work tree checked out from the
1169 .Dq unified-buffer-cache
1170 branch to the latest commit on this branch:
1174 Roll file content on the unified-buffer-cache branch back by one commit,
1175 and then fetch the rolled-back change into the work tree as a local change
1176 to be amended and perhaps committed again:
1178 .Dl $ got backout unified-buffer-cache
1179 .Dl $ got commit -m 'roll back previous'
1180 .Dl $ # now back out the previous backout :-)
1181 .Dl $ got backout unified-buffer-cache
1183 Fetch new upstream commits into the local repository's master branch.
1184 This step currently requires
1187 .Dl $ cd /var/git/src.git
1188 .Dl $ git fetch origin master:master
1191 .Dq unified-buffer-cache
1192 branch on top of the new head commit of the
1196 .Dl $ got update -b master
1197 .Dl $ got rebase unified-buffer-cache
1199 Create a patch from all changes on the unified-buffer-cache branch.
1200 The patch can be mailed out for review and applied to OpenBSD's CVS tree:
1202 .Dl $ got diff master unified-buffer-cache > /tmp/ubc.diff
1204 Edit the entire commit history of the
1205 .Dq unified-buffer-cache
1208 .Dl $ got update -b unified-buffer-cache
1209 .Dl $ got update -c master
1212 Additional steps are necessary if local changes need to be pushed back
1213 to the remote repository, which currently requires
1217 Before working against existing branches in a repository cloned with
1218 .Dq git clone --bare ,
1221 must be configured to map all references in the remote repository
1224 namespace of the local repository.
1225 This can achieved by setting Git's
1226 .Pa remote.origin.fetch
1227 configuration variable to the value
1228 .Dq +refs/heads/*:refs/remotes/origin/*
1233 .Dl $ cd /var/git/repo
1234 .Dl $ git config remote.origin.fetch '+refs/heads/*:refs/remotes/origin/*'
1236 Alternatively, the following
1238 configuration item can be added manually to the Git repository's
1242 .Dl [remote "origin"]
1244 .Dl fetch = +refs/heads/*:refs/remotes/origin/*
1246 This configuration leaves the local repository's
1248 namespace free for use by local branches checked out with
1250 and, if needed, created with
1255 namespace can be updated with incoming changes from the remote
1259 .Dl $ cd /var/git/repo
1262 Before outgoing changes on the local
1264 branch can be pushed to the remote repository, the local
1266 branch must be rebased onto the
1270 .Dl $ got update -b origin/master
1271 .Dl $ got rebase master
1273 Changes on the local
1275 branch can then be pushed to the remote
1279 .Dl $ cd /var/git/repo
1280 .Dl $ git push origin master
1284 .Xr git-repository 5 ,
1287 .An Stefan Sperling Aq Mt stsp@openbsd.org
1288 .An Martin Pieuchot Aq Mt mpi@openbsd.org
1289 .An joshua stein Aq Mt jcs@openbsd.org
1292 is a work-in-progress and many commands remain to be implemented.
1293 At present, the user has to fall back on
1295 to perform many tasks, in particular tasks related to repository
1296 administration and tasks which require a network connection.
