2 .\" Copyright (c) 2017 Martin Pieuchot
3 .\" Copyright (c) 2018, 2019, 2020 Stefan Sperling
5 .\" Permission to use, copy, modify, and distribute this software for any
6 .\" purpose with or without fee is hereby granted, provided that the above
7 .\" copyright notice and this permission notice appear in all copies.
9 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
30 is a version control system which stores the history of tracked files
31 in a Git repository, as used by the Git version control system.
32 This repository format is described in
33 .Xr git-repository 5 .
38 version control system because every copy of a repository is writeable.
39 Modifications made to files can be synchronized between repositories
44 must be checked out from the repository for modification.
45 Checked out files are stored in a
47 which can be placed at an arbitrary directory in the filesystem hierarchy.
48 The on-disk format of this work tree is described in
52 provides global and command-specific options.
53 Global options must precede the command name, and are as follows:
54 .Bl -tag -width tenletters
56 Display usage information and exit immediately.
58 Display program version and exit immediately.
64 .Bl -tag -width checkout
65 .It Cm init Ar repository-path
66 Create a new empty repository at the specified
73 command must be used to populate the empty repository before
76 .It Cm import Oo Fl b Ar branch Oc Oo Fl m Ar message Oc Oo Fl r Ar repository-path Oc Oo Fl I Ar pattern Oc Ar directory
77 Create an initial commit in a repository from the file hierarchy
80 The created commit will not have any parent commits, i.e. it will be a
82 Also create a new reference which provides a branch name for the newly
84 Show the path of each imported file to indicate progress.
90 environment variable to be set,
95 configuration settings can be obtained from the repository's
97 file or from Git's global
108 instead of creating the default branch
110 Use of this option is required if the
112 branch already exists.
114 Use the specified log message when creating the new commit.
119 opens a temporary file in an editor where a log message can be written.
120 .It Fl r Ar repository-path
121 Use the repository at the specified path.
122 If not specified, assume the repository is located at or above the current
125 Ignore files or directories with a name which matches the specified
127 This option may be specified multiple times to build a list of ignore patterns.
130 follows the globbing rules documented in
136 .It Cm clone Oo Fl a Oc Oo Fl b Ar branch Oc Oo Fl l Oc Oo Fl m Oc Oo Fl q Oc Oo Fl v Oc Oo Fl R Ar reference Oc Ar repository-URL Op Ar directory
137 Clone a Git repository at the specified
143 is specified the directory name will be derived from the name of the
146 will refuse to run if the
152 specifies a protocol scheme, a server hostname, an optional port number
153 separated from the hostname by a colon, and a path to the repository on
155 .Lk scheme://hostname:port/path/to/repository
157 The following protocol schemes are supported:
158 .Bl -tag -width git+ssh
160 The Git protocol as implemented by the
163 Use of this protocol is discouraged since it supports neither authentication
166 The Git protocol wrapped in an authenticated and encrypted
169 With this protocol the hostname may contain an embedded username for
174 Short alias for git+ssh.
177 Objects in the cloned repository are stored in a pack file which is downloaded
179 This pack file will then be indexed to facilitate access to the objects stored
181 If any objects in the pack file are stored in deltified form, all deltas will
182 be fully resolved in order to compute the ID of such objects.
183 This can take some time.
184 More details about the pack file format are documented in
185 .Xr git-repository 5 .
188 creates a remote repository entry in the
190 file of the cloned repository to store the
202 Fetch all branches from the remote repository's
205 If this option is not specified, a branch resolved via the remote
206 repository's HEAD reference will be fetched.
207 Cannot be used together with the
213 from the remote repository's
216 This option may be specified multiple times to build a list of branches
218 If the branch corresponding to the remote repository's HEAD reference is not
219 in this list, the cloned repository's HEAD reference will be set to the first
220 branch which was fetched.
221 If this option is not specified, a branch resolved via the remote
222 repository's HEAD reference will be fetched.
223 Cannot be used together with the
227 List branches and tags available for fetching from the remote repository
228 and exit immediately.
229 Cannot be used together with any of the other options except
232 Create the cloned repository as a mirror of the original repository.
233 This is useful if the cloned repository will not be used to store
234 locally created commits.
238 file will be set up with the
240 option enabled, such that
244 will write incoming changes directly to branches in the
246 reference namespace, rather than to branches in the
249 This avoids the usual requirement of having to run
253 in order to make incoming changes appear on branches in the
256 But maintaining custom changes in the cloned repository becomes difficult
257 since such changes will be at risk of being discarded whenever incoming
260 Suppress progress reporting output.
261 The same option will be passed to
268 to print debugging messages to standard error output.
269 This option will be passed to
272 Multiple -v options increase the verbosity.
274 .It Fl R Ar reference
275 In addition to the branches and tags that will be fetched, fetch an arbitrary
277 from the remote repository's
280 This option may be specified multiple times to build a list of additional
284 may either be a path to a specific reference, or a reference namespace
285 which will cause all references in this namespace to be fetched.
287 Each reference will be mapped into the cloned repository's
289 namespace, unless the
291 option is used to mirror references directly into the cloned repository's
296 will refuse to fetch references from the remote repository's
305 .It Cm fetch Oo Fl a Oc Oo Fl b Ar branch Oc Oo Fl d Oc Oo Fl l Oc Oo Fl r Ar repository-path Oc Oo Fl t Oc Oo Fl q Oc Oo Fl v Oc Oo Fl R Ar reference Oc Op Ar remote-repository
306 Fetch new changes from a remote repository.
308 .Ar remote-repository
312 The remote repository's URL is obtained from the corresponding entry in the
314 file of the local repository, as created by
317 New changes will be stored in a separate pack file downloaded from the server.
318 Optionally, separate pack files stored in the repository can be combined with
321 By default, branch references in the
323 reference namespace will be updated to point at the newly fetched commits.
326 command can then be used to make new changes visible on branches in the
328 namespace, merging incoming changes with the changes on those branches
331 If the repository was created as a mirror with
333 then all branches in the
335 namespace will be updated directly to match the corresponding branches in
336 the remote repository.
337 If those branches contained local commits, these commits will no longer be
338 reachable via a reference and will therefore be at risk of being discarded
339 by Git's garbage collector.
340 Maintaining custom changes in a mirror repository is therefore discouraged.
342 In any case, references in the
344 namespace will always be fetched and mapped directly to local references
345 in the same namespace.
352 Fetch all branches from the remote repository's
355 If this option is not specified, a branch resolved via the remote
356 repository's HEAD reference will be fetched.
357 Cannot be used together with the
363 from the remote repository's
366 This option may be specified multiple times to build a list of branches
368 If this option is not specified, a branch resolved via the remote
369 repository's HEAD reference will be fetched.
370 Cannot be used together with the
374 Delete branches and tags from the local repository which are no longer
375 present in the remote repository.
376 Only references are deleted.
377 Any commit, tree, tag, and blob objects belonging to deleted branches or
378 tags remain in the repository and may be removed separately with
379 Git's garbage collector.
381 List branches and tags available for fetching from the remote repository
382 and exit immediately.
383 Cannot be used together with any of the other options except
388 Allow existing references in the
390 namespace to be updated if they have changed on the server.
391 If not specified, only new tag references will be created.
392 .It Fl r Ar repository-path
393 Use the repository at the specified path.
394 If not specified, assume the repository is located at or above the current
396 If this directory is a
398 work tree, use the repository path associated with this work tree.
400 Suppress progress reporting output.
401 The same option will be passed to
408 to print debugging messages to standard error output.
409 The same option will be passed to
412 Multiple -v options increase the verbosity.
414 .It Fl R Ar reference
415 In addition to the branches and tags that will be fetched, fetch an arbitrary
417 from the remote repository's
420 This option may be specified multiple times to build a list of additional
424 may either be a path to a specific reference, or a reference namespace
425 which will cause all references in this namespace to be fetched.
427 Each reference will be mapped into the local repository's
429 namespace, unless the local repository was created as a mirror with
431 in which case references will be mapped directly into the local repository's
435 Once a reference has been fetched, a branch based on it can be created with
440 will refuse to fetch references from the remote repository's
449 .It Cm checkout Oo Fl E Oc Oo Fl b Ar branch Oc Oo Fl c Ar commit Oc Oo Fl p Ar path-prefix Oc Ar repository-path Op Ar work-tree-path
450 Copy files from a repository into a new work tree.
451 Show the status of each affected file, using the following status codes:
452 .Bl -column YXZ description
453 .It A Ta new file was added
454 .It E Ta file already exists in work tree's meta-data
459 is not specified, either use the last component of
460 .Ar repository path ,
463 was specified use the last component of
471 Proceed with the checkout operation even if the directory at
474 Existing files will be left intact.
476 Check out files from a commit on the specified
478 If this option is not specified, a branch resolved via the repository's HEAD
479 reference will be used.
481 Check out files from the specified
483 on the selected branch.
484 The expected argument is a commit ID SHA1 hash or an existing reference
485 or tag name which will be resolved to a commit ID.
486 An abbreviated hash argument will be expanded to a full SHA1 hash
487 automatically, provided the abbreviation is unique.
488 If this option is not specified, the most recent commit on the selected
493 is not contained in the selected branch, a different branch which contains
494 this commit must be specified with the
497 If no such branch is known a new branch must be created for this
503 Checking out work trees with an unknown branch is intentionally not supported.
504 .It Fl p Ar path-prefix
505 Restrict the work tree to a subset of the repository's tree hierarchy.
506 Only files beneath the specified
513 .It Cm update Oo Fl b Ar branch Oc Oo Fl c Ar commit Oc Op Ar path ...
514 Update an existing work tree to a different
516 Change existing files in the work tree as necessary to match file contents
518 Preserve any local changes in the work tree and merge them with the
521 Files which already contain merge conflicts will not be updated to avoid
522 further complications.
523 Such files will be updated when
525 is run again after merge conflicts have been resolved.
526 If the conflicting changes are no longer needed affected files can be
533 Show the status of each affected file, using the following status codes:
534 .Bl -column YXZ description
535 .It U Ta file was updated and contained no local changes
536 .It G Ta file was updated and local changes were merged cleanly
537 .It C Ta file was updated and conflicts occurred during merge
538 .It D Ta file was deleted
539 .It A Ta new file was added
540 .It \(a~ Ta versioned file is obstructed by a non-regular file
541 .It ! Ta a missing versioned file was restored
542 .It # Ta file was not updated because it contains merge conflicts
543 .It ? Ta changes destined for an unversioned file were not merged
548 is specified, update the entire work tree.
549 Otherwise, restrict the update operation to files at or within the
551 Each path is required to exist in the update operation's target commit.
552 Files in the work tree outside specified paths will remain unchanged and
553 will retain their previously recorded base commit.
556 commands may refuse to run while the work tree contains files from
557 multiple base commits.
558 The base commit of such a work tree can be made consistent by running
560 across the entire work tree.
563 is incompatible with the
568 cannot update paths with staged changes.
569 If changes have been staged with
571 these changes must first be committed with
581 Switch the work tree's branch reference to the specified
583 before updating the work tree.
584 This option requires that all paths in the work tree are updated.
586 As usual, any local changes in the work tree will be preserved.
587 This can be useful when switching to a newly created branch in order
588 to commit existing local changes to this branch.
590 Any local changes must be dealt with separately in order to obtain a
591 work tree with pristine file contents corresponding exactly to the specified
593 Such changes could first be committed to a different branch with
595 or could be discarded with
598 Update the work tree to the specified
600 The expected argument is a commit ID SHA1 hash or an existing reference
601 or tag name which will be resolved to a commit ID.
602 An abbreviated hash argument will be expanded to a full SHA1 hash
603 automatically, provided the abbreviation is unique.
604 If this option is not specified, the most recent commit on the work tree's
610 .It Cm status Oo Fl s Ar status-codes Oc Op Ar path ...
611 Show the current modification status of files in a work tree,
612 using the following status codes:
613 .Bl -column YXZ description
614 .It M Ta modified file
615 .It A Ta file scheduled for addition in next commit
616 .It D Ta file scheduled for deletion in next commit
617 .It C Ta modified or added file which contains merge conflicts
618 .It ! Ta versioned file was expected on disk but is missing
619 .It \(a~ Ta versioned file is obstructed by a non-regular file
620 .It ? Ta unversioned item not tracked by
622 .It m Ta modified file modes (executable bit only)
623 .It N Ta non-existent
625 specified on the command line
630 is specified, show modifications in the entire work tree.
631 Otherwise, show modifications at or within the specified paths.
633 If changes have been staged with
635 staged changes are shown in the second output column, using the following
637 .Bl -column YXZ description
638 .It M Ta file modification is staged
639 .It A Ta file addition is staged
640 .It D Ta file deletion is staged
643 Changes created on top of staged changes are indicated in the first column:
644 .Bl -column YXZ description
645 .It MM Ta file was modified after earlier changes have been staged
646 .It MA Ta file was modified after having been staged for addition
653 .It Fl s Ar status-codes
654 Only show files with a modification status matching any of the
655 single-character status codes contained in the
658 Any combination of codes from the above list of possible status codes
660 For staged files, status codes displayed in either column will be matched.
663 For compatibility with
674 files in each traversed directory and will not display unversioned files
675 which match these patterns.
680 supports consecutive asterisks,
682 which will match an arbitrary amount of directories.
686 only supports a single ignore pattern per line.
690 does not support negated ignore patterns prefixed with
692 and gives no special significance to the location of path component separators,
698 .It Cm log Oo Fl b Oc Oo Fl c Ar commit Oc Oo Fl C Ar number Oc Oo Fl l Ar N Oc Oo Fl p Oc Oo Fl P Oc Oo Fl s Ar search-pattern Oc Oo Fl r Ar repository-path Oc Oo Fl R Oc Oo Fl x Ar commit Oc Op Ar path
699 Display history of a repository.
702 is specified, show only commits which modified this path.
703 If invoked in a work tree, the
705 is interpreted relative to the current working directory,
706 and the work tree's path prefix is implicitly prepended.
707 Otherwise, the path is interpreted relative to the repository root.
714 Display individual commits which were merged into the current branch
718 shows the linear history of the current branch only.
720 Start traversing history at the specified
722 The expected argument is a commit ID SHA1 hash or an existing reference
723 or tag name which will be resolved to a commit ID.
724 An abbreviated hash argument will be expanded to a full SHA1 hash
725 automatically, provided the abbreviation is unique.
726 If this option is not specified, default to the work tree's current branch
727 if invoked in a work tree, or to the repository's HEAD reference.
729 Set the number of context lines shown in diffs with
731 By default, 3 lines of context are shown.
733 Limit history traversal to a given number of commits.
734 If this option is not specified, a default limit value of zero is used,
735 which is treated as an unbounded limit.
737 .Ev GOT_LOG_DEFAULT_LIMIT
738 environment variable may be set to change this default value.
740 Display the patch of modifications made in each commit.
743 is specified, only show the patch of modifications at or within this path.
745 Display the list of file paths changed in each commit, using the following
747 .Bl -column YXZ description
748 .It M Ta modified file
749 .It D Ta file was deleted
750 .It A Ta new file was added
751 .It m Ta modified file modes (executable bit only)
753 .It Fl s Ar search-pattern
754 If specified, show only commits with a log message matched by the extended
757 When used together with
759 then the file paths changed by a commit can be matched as well.
760 Regular expression syntax is documented in
762 .It Fl r Ar repository-path
763 Use the repository at the specified path.
764 If not specified, assume the repository is located at or above the current
766 If this directory is a
768 work tree, use the repository path associated with this work tree.
770 Determine a set of commits to display as usual, but display these commits
773 Stop traversing commit history as soon as the specified
776 This option has no effect if the specified
780 .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
781 When invoked within a work tree with less than two arguments, display
782 local changes in the work tree.
785 is specified, only show changes within this path.
787 If two arguments are provided, treat each argument as a reference, a tag
788 name, or an object ID SHA1 hash, and display differences between the
789 corresponding objects.
790 Both objects must be of the same type (blobs, trees, or commits).
791 An abbreviated hash argument will be expanded to a full SHA1 hash
792 automatically, provided the abbreviation is unique.
799 Set the number of context lines shown in the diff.
800 By default, 3 lines of context are shown.
801 .It Fl r Ar repository-path
802 Use the repository at the specified path.
803 If not specified, assume the repository is located at or above the current
805 If this directory is a
807 work tree, use the repository path associated with this work tree.
809 Show changes staged with
811 instead of showing local changes in the work tree.
812 This option is only valid when
814 is invoked in a work tree.
816 Ignore whitespace-only changes.
821 .It Cm blame Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Ar path
822 Display line-by-line history of a file at the specified path.
829 Start traversing history at the specified
831 The expected argument is a commit ID SHA1 hash or an existing reference
832 or tag name which will be resolved to a commit ID.
833 An abbreviated hash argument will be expanded to a full SHA1 hash
834 automatically, provided the abbreviation is unique.
835 .It Fl r Ar repository-path
836 Use the repository at the specified path.
837 If not specified, assume the repository is located at or above the current
839 If this directory is a
841 work tree, use the repository path associated with this work tree.
846 .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
847 Display a listing of files and directories at the specified
848 directory path in the repository.
849 Entries shown in this listing may carry one of the following trailing
851 .Bl -column YXZ description
852 .It @ Ta entry is a symbolic link
853 .It / Ta entry is a directory
854 .It * Ta entry is an executable file
855 .It $ Ta entry is a Git submodule
858 Symbolic link entries are also annotated with the target path of the link.
862 is specified, list the repository path corresponding to the current
863 directory of the work tree, or the root directory of the repository
864 if there is no work tree.
871 List files and directories as they appear in the specified
873 The expected argument is a commit ID SHA1 hash or an existing reference
874 or tag name which will be resolved to a commit ID.
875 An abbreviated hash argument will be expanded to a full SHA1 hash
876 automatically, provided the abbreviation is unique.
877 .It Fl r Ar repository-path
878 Use the repository at the specified path.
879 If not specified, assume the repository is located at or above the current
881 If this directory is a
883 work tree, use the repository path associated with this work tree.
885 Show object IDs of files (blob objects) and directories (tree objects).
887 Recurse into sub-directories in the repository.
892 .It Cm ref Oo Fl r Ar repository-path Oc Oo Fl l Oc Oo Fl c Ar object Oc Oo Fl s Ar reference Oc Oo Fl d Oc Op Ar name
893 Manage references in a repository.
895 References may be listed, created, deleted, and changed.
896 When creating, deleting, or changing a reference the specified
898 must be an absolute reference name, i.e. it must begin with
905 .It Fl r Ar repository-path
906 Use the repository at the specified path.
907 If not specified, assume the repository is located at or above the current
909 If this directory is a
911 work tree, use the repository path associated with this work tree.
913 List references in the repository.
916 is specified, list all existing references in the repository.
919 is a reference namespace, list all references in this namespace.
920 Otherwise, show only the reference with the given
922 Cannot be used together with any other options except
925 Create a reference or change an existing reference.
926 The reference with the specified
928 will point at the specified
932 argument is a ID SHA1 hash or an existing reference or tag name which will
933 be resolved to the ID of a corresponding commit, tree, tag, or blob object.
934 Cannot be used together with any other options except
936 .It Fl s Ar reference
937 Create a symbolic reference, or change an existing symbolic reference.
938 The symbolic reference with the specified
940 will point at the specified
942 which must already exist in the repository.
943 Care should be taken not to create loops between references when
945 Cannot be used together with any other options except
948 Delete the reference with the specified
951 Cannot be used together with any other options except
954 .It Cm branch Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Oo Fl l Oc Oo Fl d Ar name Oc Oo Fl n Oc Op Ar name
955 Create, list, or delete branches.
957 Branches are managed via references which live in the
962 command operates on references in this namespace only.
964 If invoked in a work tree without any arguments, print the name of the
965 work tree's current branch.
969 argument is passed, attempt to create a branch reference with the given name.
970 By default the new branch reference will point at the latest commit on the
971 work tree's current branch if invoked in a work tree, and otherwise to a commit
972 resolved via the repository's HEAD reference.
974 If invoked in a work tree, once the branch was created successfully
975 switch the work tree's head reference to the newly created branch and
976 update files across the entire work tree, just like
977 .Cm got update -b Ar name
979 Show the status of each affected file, using the following status codes:
980 .Bl -column YXZ description
981 .It U Ta file was updated and contained no local changes
982 .It G Ta file was updated and local changes were merged cleanly
983 .It C Ta file was updated and conflicts occurred during merge
984 .It D Ta file was deleted
985 .It A Ta new file was added
986 .It \(a~ Ta versioned file is obstructed by a non-regular file
987 .It ! Ta a missing versioned file was restored
995 Make a newly created branch reference point at the specified
999 argument is a commit ID SHA1 hash or an existing reference
1000 or tag name which will be resolved to a commit ID.
1001 .It Fl r Ar repository-path
1002 Use the repository at the specified path.
1003 If not specified, assume the repository is located at or above the current
1005 If this directory is a
1007 work tree, use the repository path associated with this work tree.
1009 List all existing branches in the repository.
1010 If invoked in a work tree, the work tree's current branch is shown
1011 with one the following annotations:
1012 .Bl -column YXZ description
1013 .It * Ta work tree's base commit matches the branch tip
1014 .It \(a~ Ta work tree's base commit is out-of-date
1017 Delete the branch with the specified name from the repository.
1018 Only the branch reference is deleted.
1019 Any commit, tree, and blob objects belonging to the branch
1020 remain in the repository and may be removed separately with
1021 Git's garbage collector.
1023 Do not switch and update the work tree after creating a new branch.
1028 .It Cm tag Oo Fl c Ar commit Oc Oo Fl m Ar message Oc Oo Fl r Ar repository-path Oc Oo Fl l Oc Ar name
1029 Manage tags in a repository.
1031 Tags are managed via references which live in the
1033 reference namespace.
1036 command operates on references in this namespace only.
1037 References in this namespace point at tag objects which contain a pointer
1038 to another object, a tag message, as well as author and timestamp information.
1040 Attempt to create a tag with the given
1042 and make this tag point at the given
1044 If no commit is specified, default to the latest commit on the work tree's
1045 current branch if invoked in a work tree, and to a commit resolved via
1046 the repository's HEAD reference otherwise.
1053 Make the newly created tag reference point at the specified
1057 argument is a commit ID SHA1 hash or an existing reference or tag name which
1058 will be resolved to a commit ID.
1059 An abbreviated hash argument will be expanded to a full SHA1 hash
1060 automatically, provided the abbreviation is unique.
1062 Use the specified tag message when creating the new tag.
1067 opens a temporary file in an editor where a tag message can be written.
1068 .It Fl r Ar repository-path
1069 Use the repository at the specified path.
1070 If not specified, assume the repository is located at or above the current
1072 If this directory is a
1074 work tree, use the repository path associated with this work tree.
1076 List all existing tags in the repository instead of creating a new tag.
1077 If this option is used, no other command-line arguments are allowed.
1082 command will not delete tags or change existing tags.
1083 If a tag must be deleted, the
1085 command may be used to delete a tag's reference.
1086 This should only be done if the tag has not already been copied to
1088 .It Cm add Oo Fl R Oc Oo Fl I Oc Ar path ...
1089 Schedule unversioned files in a work tree for addition to the
1090 repository in the next commit.
1097 Permit recursion into directories.
1098 If this option is not specified,
1100 will refuse to run if a specified
1104 With -R, add files even if they match a
1108 .It Cm remove Oo Fl f Oc Oo Fl k Oc Oo Fl R Oc Oo Fl s Ar status-codes Oc Ar path ...
1109 Remove versioned files from a work tree and schedule them for deletion
1110 from the repository in the next commit.
1117 Perform the operation even if a file contains local modifications.
1119 Keep affected files on disk.
1121 Permit recursion into directories.
1122 If this option is not specified,
1124 will refuse to run if a specified
1127 .It Fl s Ar status-codes
1128 Only delete files with a modification status matching one of the
1129 single-character status codes contained in the
1132 The following status codes may be specified:
1133 .Bl -column YXZ description
1134 .It M Ta modified file (this implies the
1137 .It ! Ta versioned file expected on disk but missing
1143 .It Cm revert Oo Fl p Oc Oo Fl F Ar response-script Oc Oo Fl R Oc Ar path ...
1144 Revert any local changes in files at the specified paths in a work tree.
1145 File contents will be overwritten with those contained in the
1146 work tree's base commit.
1147 There is no way to bring discarded changes back after
1150 If a file was added with
1152 it will become an unversioned file again.
1153 If a file was deleted with
1155 it will be restored.
1162 Instead of reverting all changes in files, interactively select or reject
1163 changes to revert based on
1169 (quit reverting this file) responses.
1170 If a file is in modified status, individual patches derived from the
1171 modified file content can be reverted.
1172 Files in added or deleted status may only be reverted in their entirety.
1173 .It Fl F Ar response-script
1181 responses line-by-line from the specified
1183 file instead of prompting interactively.
1185 Permit recursion into directories.
1186 If this option is not specified,
1188 will refuse to run if a specified
1195 .It Cm commit Oo Fl m Ar message Oc Oo Fl S Oc Op Ar path ...
1196 Create a new commit in the repository from changes in a work tree
1197 and use this commit as the new base commit for the work tree.
1200 is specified, commit all changes in the work tree.
1201 Otherwise, commit changes at or within the specified paths.
1203 If changes have been explicitly staged for commit with
1205 only commit staged changes and reject any specified paths which
1206 have not been staged.
1208 Show the status of each affected file, using the following status codes:
1209 .Bl -column YXZ description
1210 .It M Ta modified file
1211 .It D Ta file was deleted
1212 .It A Ta new file was added
1213 .It m Ta modified file modes (executable bit only)
1216 Files which are not part of the new commit will retain their previously
1217 recorded base commit.
1220 commands may refuse to run while the work tree contains files from
1221 multiple base commits.
1222 The base commit of such a work tree can be made consistent by running
1224 across the entire work tree.
1228 command requires the
1230 environment variable to be set,
1235 configuration settings can be
1236 obtained from the repository's
1238 file or from Git's global
1247 Use the specified log message when creating the new commit.
1252 opens a temporary file in an editor where a log message can be written.
1254 Allow the addition of symbolic links which point outside of the path space
1255 that is under version control.
1258 will reject such symbolic links due to safety concerns.
1261 may decide to represent such a symbolic link as a regular file which contains
1262 the link's target path, rather than creating an actual symbolic link which
1263 points outside of the work tree.
1264 Use of this option is discouraged because external mechanisms such as
1266 are better suited for managing symbolic links to paths not under
1271 will refuse to run if certain preconditions are not met.
1272 If the work tree's current branch is not in the
1274 reference namespace, new commits may not be created on this branch.
1275 Local changes may only be committed if they are based on file content
1276 found in the most recent commit on the work tree's branch.
1277 If a path is found to be out of date,
1279 must be used first in order to merge local changes with changes made
1284 .It Cm cherrypick Ar commit
1285 Merge changes from a single
1290 must be on a different branch than the work tree's base commit.
1291 The expected argument is a reference or a commit ID SHA1 hash.
1292 An abbreviated hash argument will be expanded to a full SHA1 hash
1293 automatically, provided the abbreviation is unique.
1295 Show the status of each affected file, using the following status codes:
1296 .Bl -column YXZ description
1297 .It G Ta file was merged
1298 .It C Ta file was merged and conflicts occurred during merge
1299 .It ! Ta changes destined for a missing file were not merged
1300 .It D Ta file was deleted
1301 .It d Ta file's deletion was obstructed by local modifications
1302 .It A Ta new file was added
1303 .It \(a~ Ta changes destined for a non-regular file were not merged
1304 .It ? Ta changes destined for an unversioned file were not merged
1307 The merged changes will appear as local changes in the work tree, which
1310 amended manually or with further
1315 or discarded again with
1319 will refuse to run if certain preconditions are not met.
1320 If the work tree contains multiple base commits it must first be updated
1321 to a single base commit with
1323 If the work tree already contains files with merge conflicts, these
1324 conflicts must be resolved first.
1328 .It Cm backout Ar commit
1329 Reverse-merge changes from a single
1334 must be on the same branch as the work tree's base commit.
1335 The expected argument is a reference or a commit ID SHA1 hash.
1336 An abbreviated hash argument will be expanded to a full SHA1 hash
1337 automatically, provided the abbreviation is unique.
1339 Show the status of each affected file, using the following status codes:
1340 .Bl -column YXZ description
1341 .It G Ta file was merged
1342 .It C Ta file was merged and conflicts occurred during merge
1343 .It ! Ta changes destined for a missing file were not merged
1344 .It D Ta file was deleted
1345 .It d Ta file's deletion was obstructed by local modifications
1346 .It A Ta new file was added
1347 .It \(a~ Ta changes destined for a non-regular file were not merged
1348 .It ? Ta changes destined for an unversioned file were not merged
1351 The reverse-merged changes will appear as local changes in the work tree,
1352 which may be viewed with
1354 amended manually or with further
1359 or discarded again with
1363 will refuse to run if certain preconditions are not met.
1364 If the work tree contains multiple base commits it must first be updated
1365 to a single base commit with
1367 If the work tree already contains files with merge conflicts, these
1368 conflicts must be resolved first.
1372 .It Cm rebase Oo Fl a Oc Oo Fl c Oc Op Ar branch
1373 Rebase commits on the specified
1375 onto the tip of the current branch of the work tree.
1378 must share common ancestry with the work tree's current branch.
1379 Rebasing begins with the first descendant commit of the youngest
1380 common ancestor commit shared by the specified
1382 and the work tree's current branch, and stops once the tip commit
1389 is used as intended, the specified
1391 represents a local commit history and may already contain changes
1392 that are not yet visible in any other repositories.
1393 The work tree's current branch, which must be set with
1397 operation, represents a branch from a remote repository which shares
1398 a common history with the specified
1400 but has progressed, and perhaps diverged, due to commits added to the
1403 Rebased commits are accumulated on a temporary branch which the work tree
1404 will remain switched to throughout the entire rebase operation.
1405 Commits on this branch represent the same changes with the same log
1406 messages as their counterparts on the original
1408 but with different commit IDs.
1409 Once rebasing has completed successfully, the temporary branch becomes
1410 the new version of the specified
1412 and the work tree is automatically switched to it.
1414 While rebasing commits, show the status of each affected file,
1415 using the following status codes:
1416 .Bl -column YXZ description
1417 .It G Ta file was merged
1418 .It C Ta file was merged and conflicts occurred during merge
1419 .It ! Ta changes destined for a missing file were not merged
1420 .It D Ta file was deleted
1421 .It d Ta file's deletion was obstructed by local modifications
1422 .It A Ta new file was added
1423 .It \(a~ Ta changes destined for a non-regular file were not merged
1424 .It ? Ta changes destined for an unversioned file were not merged
1427 If merge conflicts occur the rebase operation is interrupted and may
1428 be continued once conflicts have been resolved.
1429 Alternatively, the rebase operation may be aborted which will leave
1431 unmodified and the work tree switched back to its original branch.
1433 If a merge conflict is resolved in a way which renders the merged
1434 change into a no-op change, the corresponding commit will be elided
1435 when the rebase operation continues.
1438 will refuse to run if certain preconditions are not met.
1439 If the work tree is not yet fully updated to the tip commit of its
1440 branch then the work tree must first be updated with
1442 If changes have been staged with
1444 these changes must first be committed with
1448 If the work tree contains local changes, these changes must first be
1455 contains changes to files outside of the work tree's path prefix,
1456 the work tree cannot be used to rebase this branch.
1462 commands will refuse to run while a rebase operation is in progress.
1463 Other commands which manipulate the work tree may be used for
1464 conflict resolution purposes.
1471 Abort an interrupted rebase operation.
1472 If this option is used, no other command-line arguments are allowed.
1474 Continue an interrupted rebase operation.
1475 If this option is used, no other command-line arguments are allowed.
1480 .It Cm histedit Oo Fl a Oc Oo Fl c Oc Oo Fl F Ar histedit-script Oc Oo Fl m Oc
1481 Edit commit history between the work tree's current base commit and
1482 the tip commit of the work tree's current branch.
1486 operation the work tree's current branch must be set with
1488 to the branch which should be edited, unless this branch is already the
1489 current branch of the work tree.
1490 The tip of this branch represents the upper bound (inclusive) of commits
1495 Furthermore, the work tree's base commit
1498 to a point in this branch's commit history where editing should begin.
1499 This commit represents the lower bound (non-inclusive) of commits touched
1504 Editing of commit history is controlled via a
1506 which can be written in an editor based on a template, passed on the
1507 command line, or generated with the
1509 option if only log messages need to be edited.
1511 The format of the histedit script is line-based.
1512 Each line in the script begins with a command name, followed by
1513 whitespace and an argument.
1514 For most commands, the expected argument is a commit ID SHA1 hash.
1515 Any remaining text on the line is ignored.
1516 Lines which begin with the
1518 character are ignored entirely.
1520 The available commands are as follows:
1521 .Bl -column YXZ pick-commit
1522 .It pick Ar commit Ta Use the specified commit as it is.
1523 .It edit Ar commit Ta Use the specified commit but once changes have been
1524 merged into the work tree interrupt the histedit operation for amending.
1525 .It fold Ar commit Ta Combine the specified commit with the next commit
1526 listed further below that will be used.
1527 .It drop Ar commit Ta Remove this commit from the edited history.
1528 .It mesg Ar log-message Ta Use the specified single-line log message for
1529 the commit on the previous line.
1530 If the log message argument is left empty, open an editor where a new
1531 log message can be written.
1534 Every commit in the history being edited must be mentioned in the script.
1535 Lines may be re-ordered to change the order of commits in the edited history.
1536 No commit may be listed more than once.
1538 Edited commits are accumulated on a temporary branch which the work tree
1539 will remain switched to throughout the entire histedit operation.
1540 Once history editing has completed successfully, the temporary branch becomes
1541 the new version of the work tree's branch and the work tree is automatically
1544 While merging commits, show the status of each affected file,
1545 using the following status codes:
1546 .Bl -column YXZ description
1547 .It G Ta file was merged
1548 .It C Ta file was merged and conflicts occurred during merge
1549 .It ! Ta changes destined for a missing file were not merged
1550 .It D Ta file was deleted
1551 .It d Ta file's deletion was obstructed by local modifications
1552 .It A Ta new file was added
1553 .It \(a~ Ta changes destined for a non-regular file were not merged
1554 .It ? Ta changes destined for an unversioned file were not merged
1557 If merge conflicts occur the histedit operation is interrupted and may
1558 be continued once conflicts have been resolved.
1559 Alternatively, the histedit operation may be aborted which will leave
1560 the work tree switched back to its original branch.
1562 If a merge conflict is resolved in a way which renders the merged
1563 change into a no-op change, the corresponding commit will be elided
1564 when the histedit operation continues.
1567 will refuse to run if certain preconditions are not met.
1568 If the work tree's current branch is not in the
1570 reference namespace, the history of the branch may not be edited.
1571 If the work tree contains multiple base commits it must first be updated
1572 to a single base commit with
1574 If changes have been staged with
1576 these changes must first be committed with
1580 If the work tree contains local changes, these changes must first be
1585 If the edited history contains changes to files outside of the work tree's
1586 path prefix, the work tree cannot be used to edit the history of this branch.
1593 commands will refuse to run while a histedit operation is in progress.
1594 Other commands which manipulate the work tree may be used, and the
1596 command may be used to commit arbitrary changes to the temporary branch
1597 while the histedit operation is interrupted.
1604 Abort an interrupted histedit operation.
1605 If this option is used, no other command-line arguments are allowed.
1607 Continue an interrupted histedit operation.
1608 If this option is used, no other command-line arguments are allowed.
1609 .It Fl F Ar histedit-script
1612 instead of opening a temporary file in an editor where a histedit script
1615 Edit log messages only.
1616 This option is a quick equivalent to a histedit script which edits
1617 only log messages but otherwise leaves every picked commit as-is.
1620 option can only be used when starting a new histedit operation.
1621 If this option is used, no other command-line arguments are allowed.
1626 .It Cm integrate Ar branch
1627 Integrate the specified
1629 into the work tree's current branch.
1630 Files in the work tree are updated to match the contents on the integrated
1632 and the reference of the work tree's branch is changed to point at the
1633 head commit of the integrated
1636 Both branches can be considered equivalent after integration since they
1637 will be pointing at the same commit.
1638 Both branches remain available for future work, if desired.
1639 In case the integrated
1641 is no longer needed it may be deleted with
1644 Show the status of each affected file, using the following status codes:
1645 .Bl -column YXZ description
1646 .It U Ta file was updated
1647 .It D Ta file was deleted
1648 .It A Ta new file was added
1649 .It \(a~ Ta versioned file is obstructed by a non-regular file
1650 .It ! Ta a missing versioned file was restored
1654 will refuse to run if certain preconditions are not met.
1655 Most importantly, the
1657 must have been rebased onto the work tree's current branch with
1659 before it can be integrated, in order to linearize commit history and
1660 resolve merge conflicts.
1661 If the work tree contains multiple base commits it must first be updated
1662 to a single base commit with
1664 If changes have been staged with
1666 these changes must first be committed with
1670 If the work tree contains local changes, these changes must first be
1678 .It Cm stage Oo Fl l Oc Oo Fl p Oc Oo Fl F Ar response-script Oc Oo Fl S Oc Op Ar path ...
1679 Stage local changes for inclusion in the next commit.
1682 is specified, stage all changes in the work tree.
1683 Otherwise, stage changes at or within the specified paths.
1684 Paths may be staged if they are added, modified, or deleted according to
1687 Show the status of each affected file, using the following status codes:
1688 .Bl -column YXZ description
1689 .It A Ta file addition has been staged
1690 .It M Ta file modification has been staged
1691 .It D Ta file deletion has been staged
1694 Staged file contents are saved in newly created blob objects in the repository.
1695 These blobs will be referred to by tree objects once staged changes have been
1698 Staged changes affect the behaviour of
1703 While paths with staged changes exist, the
1705 command will refuse to commit any paths which do not have staged changes.
1706 Local changes created on top of staged changes can only be committed if
1707 the path is staged again, or if the staged changes are committed first.
1710 command will show both local changes and staged changes.
1713 command is able to display local changes relative to staged changes,
1714 and to display staged changes relative to the repository.
1717 command cannot revert staged changes but may be used to revert
1718 local changes created on top of staged changes.
1725 Instead of staging new changes, list paths which are already staged,
1726 along with the IDs of staged blob objects and stage status codes.
1727 If paths were provided in the command line show the staged paths
1728 among the specified paths.
1729 Otherwise, show all staged paths.
1731 Instead of staging the entire content of a changed file, interactively
1732 select or reject changes for staging based on
1736 (reject change), and
1738 (quit staging this file) responses.
1739 If a file is in modified status, individual patches derived from the
1740 modified file content can be staged.
1741 Files in added or deleted status may only be staged or rejected in
1743 .It Fl F Ar response-script
1751 responses line-by-line from the specified
1753 file instead of prompting interactively.
1755 Allow staging of symbolic links which point outside of the path space
1756 that is under version control.
1759 will reject such symbolic links due to safety concerns.
1762 may decide to represent such a symbolic link as a regular file which contains
1763 the link's target path, rather than creating an actual symbolic link which
1764 points outside of the work tree.
1765 Use of this option is discouraged because external mechanisms such as
1767 are better suited for managing symbolic links to paths not under
1772 will refuse to run if certain preconditions are not met.
1773 If a file contains merge conflicts, these conflicts must be resolved first.
1774 If a file is found to be out of date relative to the head commit on the
1775 work tree's current branch, the file must be updated with
1777 before it can be staged (however, this does not prevent the file from
1778 becoming out-of-date at some point after having been staged).
1785 commands will refuse to run while staged changes exist.
1786 If staged changes cannot be committed because a staged path
1787 is out of date, the path must be unstaged with
1789 before it can be updated with
1791 and may then be staged again if necessary.
1795 .It Cm unstage Oo Fl p Oc Oo Fl F Ar response-script Oc Op Ar path ...
1796 Merge staged changes back into the work tree and put affected paths
1797 back into non-staged status.
1800 is specified, unstage all staged changes across the entire work tree.
1801 Otherwise, unstage changes at or within the specified paths.
1803 Show the status of each affected file, using the following status codes:
1804 .Bl -column YXZ description
1805 .It G Ta file was unstaged
1806 .It C Ta file was unstaged and conflicts occurred during merge
1807 .It ! Ta changes destined for a missing file were not merged
1808 .It D Ta file was staged as deleted and still is deleted
1809 .It d Ta file's deletion was obstructed by local modifications
1810 .It \(a~ Ta changes destined for a non-regular file were not merged
1818 Instead of unstaging the entire content of a changed file, interactively
1819 select or reject changes for unstaging based on
1823 (keep change staged), and
1825 (quit unstaging this file) responses.
1826 If a file is staged in modified status, individual patches derived from the
1827 staged file content can be unstaged.
1828 Files staged in added or deleted status may only be unstaged in their entirety.
1829 .It Fl F Ar response-script
1837 responses line-by-line from the specified
1839 file instead of prompting interactively.
1844 .It Cm cat Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Oo Fl P Oc Ar arg ...
1845 Parse and print contents of objects to standard output in a line-based
1847 Content of commit, tree, and tag objects is printed in a way similar
1848 to the actual content stored in such objects.
1849 Blob object contents are printed as they would appear in files on disk.
1851 Attempt to interpret each argument as a reference, a tag name, or
1852 an object ID SHA1 hash.
1853 References will be resolved to an object ID.
1854 Tag names will resolved to a tag object.
1855 An abbreviated hash argument will be expanded to a full SHA1 hash
1856 automatically, provided the abbreviation is unique.
1858 If none of the above interpretations produce a valid result, or if the
1860 option is used, attempt to interpret the argument as a path which will
1861 be resolved to the ID of an object found at this path in the repository.
1868 Look up paths in the specified
1870 If this option is not used, paths are looked up in the commit resolved
1871 via the repository's HEAD reference.
1872 The expected argument is a commit ID SHA1 hash or an existing reference
1873 or tag name which will be resolved to a commit ID.
1874 An abbreviated hash argument will be expanded to a full SHA1 hash
1875 automatically, provided the abbreviation is unique.
1876 .It Fl r Ar repository-path
1877 Use the repository at the specified path.
1878 If not specified, assume the repository is located at or above the current
1880 If this directory is a
1882 work tree, use the repository path associated with this work tree.
1884 Interpret all arguments as paths only.
1885 This option can be used to resolve ambiguity in cases where paths
1886 look like tag names, reference names, or object IDs.
1888 .It Cm info Op Ar path ...
1889 Display meta-data stored in a work tree.
1894 The work tree to use is resolved implicitly by walking upwards from the
1895 current working directory.
1899 arguments are specified, show additional per-file information for tracked
1900 files located at or within these paths.
1903 argument corresponds to the work tree's root directory, display information
1904 for all tracked files.
1907 .Bl -tag -width GOT_AUTHOR
1909 The author's name and email address for
1914 .Dq An Flan Hacker Aq Mt flan_hacker@openbsd.org .
1917 may fail to parse commits without an email address in author data,
1921 environment variables with a missing email address.
1927 configuration settings in the repository's
1929 file will override the value of
1935 configuration settings contained in Git's global
1937 configuration file will be used only if the
1939 environment variable is
1942 .It Ev VISUAL , EDITOR
1943 The editor spawned by
1948 .It Ev GOT_LOG_DEFAULT_LIMIT
1949 The default limit on the number of commits traversed by
1951 If set to zero, the limit is unbounded.
1952 This variable will be silently ignored if it is set to a non-numeric value.
1957 Clone an existing Git repository for use with
1961 .Dl $ got clone ssh://git@github.com/openbsd/src.git
1963 Use of HTTP URLs currently requires
1967 .Dl $ git clone --bare https://github.com/openbsd/src.git
1969 Alternatively, for quick and dirty local testing of
1971 a new Git repository could be created and populated with files,
1972 e.g. from a temporary CVS checkout located at
1975 .Dl $ got init /var/git/src.git
1976 .Dl $ got import -r /var/git/src.git -I CVS -I obj /tmp/src
1978 Check out a work tree from the Git repository to /usr/src:
1980 .Dl $ got checkout /var/git/src.git /usr/src
1982 View local changes in a work tree directory:
1984 .Dl $ got diff | less
1986 In a work tree, display files in a potentially problematic state:
1988 .Dl $ got status -s 'C!~?'
1990 Interactively revert selected local changes in a work tree directory:
1992 .Dl $ got revert -p -R\ .
1994 In a work tree or a git repository directory, list all branch references:
1998 In a work tree or a git repository directory, create a new branch called
1999 .Dq unified-buffer-cache
2000 which is forked off the
2004 .Dl $ got branch unified-buffer-cache master
2006 Switch an existing work tree to the branch
2007 .Dq unified-buffer-cache .
2008 Local changes in the work tree will be preserved and merged if necessary:
2010 .Dl $ got update -b unified-buffer-cache
2012 Create a new commit from local changes in a work tree directory.
2013 This new commit will become the head commit of the work tree's current branch:
2017 In a work tree or a git repository directory, view changes committed in
2018 the 3 most recent commits to the work tree's branch, or the branch resolved
2019 via the repository's HEAD reference, respectively:
2021 .Dl $ got log -p -l 3
2023 As above, but display changes in the order in which
2025 could apply them in sequence:
2027 .Dl $ got log -p -l 3 -R
2029 In a work tree or a git repository directory, log the history of a subdirectory:
2031 .Dl $ got log sys/uvm
2033 While operating inside a work tree, paths are specified relative to the current
2034 working directory, so this command will log the subdirectory
2037 .Dl $ cd sys/uvm && got log\ .
2039 And this command has the same effect:
2041 .Dl $ cd sys/dev/usb && got log ../../uvm
2043 And this command displays work tree meta-data about all tracked files:
2046 .Dl $ got info\ . | less
2048 Add new files and remove obsolete files in a work tree directory:
2050 .Dl $ got add sys/uvm/uvm_ubc.c
2051 .Dl $ got remove sys/uvm/uvm_vnode.c
2053 Create a new commit from local changes in a work tree directory
2054 with a pre-defined log message.
2056 .Dl $ got commit -m 'unify the buffer cache'
2058 Alternatively, create a new commit from local changes in a work tree
2059 directory with a log message that has been prepared in the file
2066 can be read into the buffer for review:
2071 Update any work tree checked out from the
2072 .Dq unified-buffer-cache
2073 branch to the latest commit on this branch:
2077 Roll file content on the unified-buffer-cache branch back by one commit,
2078 and then fetch the rolled-back change into the work tree as a local change
2079 to be amended and perhaps committed again:
2081 .Dl $ got backout unified-buffer-cache
2082 .Dl $ got commit -m 'roll back previous'
2083 .Dl $ # now back out the previous backout :-)
2084 .Dl $ got backout unified-buffer-cache
2086 Fetch new upstream commits into the local repository's
2093 In a repository created with a HTTP URL and
2094 .Cm git clone --bare
2097 command must be used instead:
2099 .Dl $ cd /var/git/src.git
2100 .Dl $ git fetch origin master:refs/remotes/origin/master
2104 branch to merge the new changes that are now visible on the
2109 .Dl $ got update -b origin/master
2110 .Dl $ got rebase master
2113 .Dq unified-buffer-cache
2114 branch on top of the new head commit of the
2118 .Dl $ got update -b master
2119 .Dl $ got rebase unified-buffer-cache
2121 Create a patch from all changes on the unified-buffer-cache branch.
2122 The patch can be mailed out for review and applied to
2126 .Dl $ got diff master unified-buffer-cache > /tmp/ubc.diff
2128 Edit the entire commit history of the
2129 .Dq unified-buffer-cache
2132 .Dl $ got update -b unified-buffer-cache
2133 .Dl $ got update -c master
2136 In order to merge changes committed to the
2137 .Dq unified-buffer-cache
2138 branch back into the
2141 .Dq unified-buffer-cache
2142 branch must first be rebased onto the
2146 .Dl $ got update -b master
2147 .Dl $ got rebase unified-buffer-cache
2150 .Dq unified-buffer-cache
2151 branch can now be made visible on the
2155 Because the rebase operation switched the work tree to the
2156 .Dq unified-buffer-cache
2157 branch, the work tree must be switched back to the
2160 .Dq unified-buffer-cache
2161 branch can be integrated into
2164 .Dl $ got update -b master
2165 .Dl $ got integrate unified-buffer-cache
2167 Additional steps may be necessary if local changes need to be pushed back
2168 to the remote repository, which currently requires
2170 Before working against existing branches in a repository cloned with
2171 .Cm git clone --bare
2176 must be configured to map all references in the remote repository
2179 namespace of the local repository.
2180 This can achieved by setting Git's
2181 .Pa remote.origin.fetch
2182 configuration variable to the value
2183 .Dq +refs/heads/*:refs/remotes/origin/*
2188 .Dl $ cd /var/git/repo
2189 .Dl $ git config remote.origin.fetch '+refs/heads/*:refs/remotes/origin/*'
2193 option must be disabled:
2195 .Dl $ cd /var/git/repo
2196 .Dl $ git config remote.origin.mirror false
2198 Alternatively, the following
2200 configuration item can be added manually to the Git repository's
2204 .Dl [remote "origin"]
2206 .Dl fetch = +refs/heads/*:refs/remotes/origin/*
2209 This configuration leaves the local repository's
2211 namespace free for use by local branches checked out with
2213 and, if needed, created with
2218 namespace can now be updated with incoming changes from the remote
2223 without extra command line arguments:
2225 .Dl $ cd /var/git/repo
2228 To make changes fetched from the remote repository appear on the
2232 branch must be rebased onto the
2235 This will also merge local changes, if any, with the incoming changes:
2237 .Dl $ got update -b origin/master
2238 .Dl $ got rebase master
2242 branch, log messages for local changes can now be amended with
2244 by other developers and any other important new information:
2246 .Dl $ got update -c origin/master
2247 .Dl $ got histedit -m
2249 Local changes on the
2251 branch can then be pushed to the remote
2255 .Dl $ cd /var/git/repo
2256 .Dl $ git push origin master
2259 .Xr git-repository 5 ,
2262 .An Stefan Sperling Aq Mt stsp@openbsd.org
2263 .An Martin Pieuchot Aq Mt mpi@openbsd.org
2264 .An Joshua Stein Aq Mt jcs@openbsd.org
2265 .An Ori Bernstein Aq Mt ori@openbsd.org
2268 is a work-in-progress and many commands remain to be implemented.
2269 At present, the user has to fall back on
2271 to perform many tasks, in particular tasks related to repository
2272 administration and tasks which require a network connection.