Blame


1 5c860e29 2018-03-12 stsp .\"
2 5c860e29 2018-03-12 stsp .\" Copyright (c) 2017 Martin Pieuchot
3 5d56da81 2019-01-13 stsp .\" Copyright (c) 2018, 2019 Stefan Sperling
4 5c860e29 2018-03-12 stsp .\"
5 5c860e29 2018-03-12 stsp .\" Permission to use, copy, modify, and distribute this software for any
6 5c860e29 2018-03-12 stsp .\" purpose with or without fee is hereby granted, provided that the above
7 5c860e29 2018-03-12 stsp .\" copyright notice and this permission notice appear in all copies.
8 5c860e29 2018-03-12 stsp .\"
9 5c860e29 2018-03-12 stsp .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10 5c860e29 2018-03-12 stsp .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11 5c860e29 2018-03-12 stsp .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12 5c860e29 2018-03-12 stsp .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13 5c860e29 2018-03-12 stsp .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14 5c860e29 2018-03-12 stsp .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15 5c860e29 2018-03-12 stsp .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16 5c860e29 2018-03-12 stsp .\"
17 5c860e29 2018-03-12 stsp .Dd $Mdocdate$
18 5c860e29 2018-03-12 stsp .Dt GOT 1
19 5c860e29 2018-03-12 stsp .Os
20 5c860e29 2018-03-12 stsp .Sh NAME
21 5c860e29 2018-03-12 stsp .Nm got
22 eb7dbff5 2019-05-09 stsp .Nd game of trees
23 5c860e29 2018-03-12 stsp .Sh SYNOPSIS
24 0bb8a95e 2018-03-12 stsp .Nm
25 5c860e29 2018-03-12 stsp .Ar command
26 1b6b95a8 2018-03-12 stsp .Op Fl h
27 5c860e29 2018-03-12 stsp .Op Ar arg ...
28 5c860e29 2018-03-12 stsp .Sh DESCRIPTION
29 5c860e29 2018-03-12 stsp .Nm
30 4dfb2f0f 2019-03-26 stsp is a version control system which stores the history of tracked files
31 4dfb2f0f 2019-03-26 stsp in a Git repository, as used by the Git version control system.
32 285dc8a4 2018-03-13 stsp This repository format is described in
33 5e5560e1 2018-08-01 stsp .Xr git-repository 5 .
34 285dc8a4 2018-03-13 stsp .Pp
35 4129c201 2018-03-13 stsp .Nm
36 4129c201 2018-03-13 stsp is a
37 ae73e26f 2019-03-26 stsp .Dq distributed
38 4129c201 2018-03-13 stsp version control system because every copy of a repository is writeable.
39 4129c201 2018-03-13 stsp Modifications made to files can be synchronized between repositories
40 97925469 2018-03-17 stsp at any time.
41 4129c201 2018-03-13 stsp .Pp
42 285dc8a4 2018-03-13 stsp Files managed by
43 285dc8a4 2018-03-13 stsp .Nm
44 4129c201 2018-03-13 stsp must be checked out from the repository for modification.
45 285dc8a4 2018-03-13 stsp Checked out files are stored in a
46 285dc8a4 2018-03-13 stsp .Em work tree
47 c5867b47 2018-03-13 stsp which can be placed at an arbitrary directory in the filesystem hierarchy.
48 fb2921d0 2019-03-26 stsp The on-disk format of this work tree is described in
49 285dc8a4 2018-03-13 stsp .Xr got-worktree 5 .
50 285dc8a4 2018-03-13 stsp .Pp
51 285dc8a4 2018-03-13 stsp .Nm
52 285dc8a4 2018-03-13 stsp provides global and command-specific options.
53 285dc8a4 2018-03-13 stsp Global options must preceed the command name, and are as follows:
54 1b6b95a8 2018-03-12 stsp .Bl -tag -width tenletters
55 1b6b95a8 2018-03-12 stsp .It Fl h
56 1b6b95a8 2018-03-12 stsp Display usage information.
57 1b6b95a8 2018-03-12 stsp .El
58 1b6b95a8 2018-03-12 stsp .Pp
59 38e11793 2018-06-13 stsp The commands for
60 38e11793 2018-06-13 stsp .Nm
61 38e11793 2018-06-13 stsp are as follows:
62 0bb8a95e 2018-03-12 stsp .Bl -tag -width checkout
63 2c7829a4 2019-06-17 stsp .It Cm init Ar path
64 2c7829a4 2019-06-17 stsp Create a new empty repository at the specified
65 2c7829a4 2019-06-17 stsp .Ar path .
66 3ce1b845 2019-07-15 stsp .Pp
67 3ce1b845 2019-07-15 stsp After
68 3ce1b845 2019-07-15 stsp .Cm got init ,
69 3ce1b845 2019-07-15 stsp the
70 3ce1b845 2019-07-15 stsp .Cm got import
71 3ce1b845 2019-07-15 stsp command must be used to populate the empty repository before
72 3ce1b845 2019-07-15 stsp .Cm got checkout
73 3ce1b845 2019-07-15 stsp can be used.
74 3ce1b845 2019-07-15 stsp .Pp
75 3ce1b845 2019-07-15 stsp .It Cm import [ Fl b Ar branch ] [ Fl m Ar message ] [ Fl r Ar repository-path ] [ Fl I Ar pattern ] directory
76 3ce1b845 2019-07-15 stsp Create an initial commit in a repository from the file hierarchy
77 3ce1b845 2019-07-15 stsp within the specified
78 3ce1b845 2019-07-15 stsp .Ar directory .
79 3ce1b845 2019-07-15 stsp The created commit will not have any parent commits, i.e. it will be a
80 3ce1b845 2019-07-15 stsp root commit.
81 3ce1b845 2019-07-15 stsp Also create a new reference which provides a branch name for the newly
82 3ce1b845 2019-07-15 stsp created commit.
83 21a44f98 2019-07-15 stsp Show the path of each imported file to indicate progress.
84 3ce1b845 2019-07-15 stsp .Pp
85 21a44f98 2019-07-15 stsp The
86 21a44f98 2019-07-15 stsp .Cm got import
87 21a44f98 2019-07-15 stsp command requires the
88 21a44f98 2019-07-15 stsp .Ev GOT_AUTHOR
89 21a44f98 2019-07-15 stsp environment variable to be set.
90 3ce1b845 2019-07-15 stsp .Pp
91 3ce1b845 2019-07-15 stsp The options for
92 3ce1b845 2019-07-15 stsp .Cm got import
93 3ce1b845 2019-07-15 stsp are as follows:
94 3ce1b845 2019-07-15 stsp .Bl -tag -width Ds
95 3ce1b845 2019-07-15 stsp .It Fl b Ar branch
96 3ce1b845 2019-07-15 stsp Create the specified
97 3ce1b845 2019-07-15 stsp .Ar branch
98 3ce1b845 2019-07-15 stsp instead of creating the default branch
99 3ce1b845 2019-07-15 stsp .Dq master .
100 3ce1b845 2019-07-15 stsp Use of this option is required if the
101 3ce1b845 2019-07-15 stsp .Dq master
102 3ce1b845 2019-07-15 stsp branch already exists.
103 3ce1b845 2019-07-15 stsp .It Fl m Ar message
104 3ce1b845 2019-07-15 stsp Use the specified log message when creating the new commit.
105 3ce1b845 2019-07-15 stsp Without the
106 3ce1b845 2019-07-15 stsp .Fl m
107 3ce1b845 2019-07-15 stsp option,
108 3ce1b845 2019-07-15 stsp .Cm got import
109 3ce1b845 2019-07-15 stsp opens a temporary file in an editor where a log message can be written.
110 3ce1b845 2019-07-15 stsp .It Fl r Ar repository-path
111 3ce1b845 2019-07-15 stsp Use the repository at the specified path.
112 3ce1b845 2019-07-15 stsp If not specified, assume the repository is located at or above the current
113 3ce1b845 2019-07-15 stsp working directory.
114 3ce1b845 2019-07-15 stsp .It Fl I Ar pattern
115 3ce1b845 2019-07-15 stsp Ignore files or directories with a name which matches the specified
116 3ce1b845 2019-07-15 stsp .Ar pattern .
117 3ce1b845 2019-07-15 stsp This option may be specified multiple times to build a list of ignore patterns.
118 3ce1b845 2019-07-15 stsp The
119 3ce1b845 2019-07-15 stsp .Ar pattern
120 3ce1b845 2019-07-15 stsp follows the globbing rules documented in
121 3ce1b845 2019-07-15 stsp .Xr glob 7 .
122 3ce1b845 2019-07-15 stsp .El
123 08573d5b 2019-05-14 stsp .It Cm checkout [ Fl b Ar branch ] [ Fl c Ar commit ] [ Fl p Ar path-prefix ] repository-path [ work-tree-path ]
124 0bb8a95e 2018-03-12 stsp Copy files from a repository into a new work tree.
125 5d7c1dab 2018-04-01 stsp If the
126 5d7c1dab 2018-04-01 stsp .Ar work tree path
127 c844a238 2019-02-06 stsp is not specified, either use the last component of
128 5d7c1dab 2018-04-01 stsp .Ar repository path ,
129 5d7c1dab 2018-04-01 stsp or if a
130 5d7c1dab 2018-04-01 stsp .Ar path prefix
131 c844a238 2019-02-06 stsp was specified use the last component of
132 5d7c1dab 2018-04-01 stsp .Ar path prefix .
133 38e11793 2018-06-13 stsp .Pp
134 38e11793 2018-06-13 stsp The options for
135 38e11793 2018-06-13 stsp .Cm got checkout
136 38e11793 2018-06-13 stsp are as follows:
137 38e11793 2018-06-13 stsp .Bl -tag -width Ds
138 08573d5b 2019-05-14 stsp .It Fl b Ar branch
139 08573d5b 2019-05-14 stsp Check out files from the specified
140 08573d5b 2019-05-14 stsp .Ar branch .
141 08573d5b 2019-05-14 stsp If this option is not specified, a branch resolved via the repository's HEAD
142 08573d5b 2019-05-14 stsp reference will be used.
143 8069f636 2019-01-12 stsp .It Fl c Ar commit
144 8069f636 2019-01-12 stsp Check out files from the specified
145 8069f636 2019-01-12 stsp .Ar commit .
146 0e1b0230 2019-07-07 stsp The expected argument is a commit ID SHA1 hash.
147 0e1b0230 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
148 0e1b0230 2019-07-07 stsp automatically, provided the abbreviation is unique.
149 08573d5b 2019-05-14 stsp If this option is not specified, the most recent commit on the selected
150 08573d5b 2019-05-14 stsp branch will be used.
151 38e11793 2018-06-13 stsp .It Fl p Ar path-prefix
152 38e11793 2018-06-13 stsp Restrict the work tree to a subset of the repository's tree hierarchy.
153 38e11793 2018-06-13 stsp Only files beneath the specified
154 38e11793 2018-06-13 stsp .Ar path-prefix
155 38e11793 2018-06-13 stsp will be checked out.
156 38e11793 2018-06-13 stsp .El
157 97b3a7be 2019-07-09 stsp .It Cm co
158 97b3a7be 2019-07-09 stsp Short alias for
159 97b3a7be 2019-07-09 stsp .Cm checkout .
160 024e9686 2019-05-14 stsp .It Cm update [ Fl b Ar branch ] [ Fl c Ar commit ] [ Ar path ]
161 024e9686 2019-05-14 stsp Update an existing work tree to a different commit.
162 7f838b36 2019-02-08 stsp Show the status of each affected file, using the following status codes:
163 7f838b36 2019-02-08 stsp .Bl -column YXZ description
164 7f838b36 2019-02-08 stsp .It U Ta file was updated and contained no local changes
165 7f838b36 2019-02-08 stsp .It G Ta file was updated and local changes were merged cleanly
166 7f838b36 2019-02-08 stsp .It C Ta file was updated and conflicts occurred during merge
167 7f838b36 2019-02-08 stsp .It D Ta file was deleted
168 7f838b36 2019-02-08 stsp .It A Ta new file was added
169 7f838b36 2019-02-08 stsp .It ~ Ta versioned file is obstructed by a non-regular file
170 a378724f 2019-02-10 stsp .It ! Ta a missing versioned file was restored
171 7f838b36 2019-02-08 stsp .El
172 7f838b36 2019-02-08 stsp .Pp
173 c4cdcb68 2019-04-03 stsp If a
174 c4cdcb68 2019-04-03 stsp .Ar path
175 c4cdcb68 2019-04-03 stsp is specified, restrict the update operation to files at or within this path.
176 f2cf8fbb 2019-04-04 stsp The path is required to exist in the update operation's target commit.
177 f2cf8fbb 2019-04-04 stsp Files in the work tree outside this path will remain unchanged and will
178 f2cf8fbb 2019-04-04 stsp retain their previously recorded base commit.
179 f2cf8fbb 2019-04-04 stsp Some
180 f2cf8fbb 2019-04-04 stsp .Nm
181 f2cf8fbb 2019-04-04 stsp commands may refuse to run while the work tree contains files from
182 c4cdcb68 2019-04-03 stsp multiple base commits.
183 f2cf8fbb 2019-04-04 stsp The base commit of such a work tree can be made consistent by running
184 47ec7be7 2019-05-12 stsp .Cm got update
185 47ec7be7 2019-05-12 stsp across the entire work tree.
186 024e9686 2019-05-14 stsp Specifying a
187 024e9686 2019-05-14 stsp .Ar path
188 024e9686 2019-05-14 stsp is incompatible with the
189 024e9686 2019-05-14 stsp .Fl b
190 024e9686 2019-05-14 stsp option.
191 7f838b36 2019-02-08 stsp .Pp
192 507dc3bb 2018-12-29 stsp The options for
193 507dc3bb 2018-12-29 stsp .Cm got update
194 507dc3bb 2018-12-29 stsp are as follows:
195 507dc3bb 2018-12-29 stsp .Bl -tag -width Ds
196 024e9686 2019-05-14 stsp .It Fl b Ar branch
197 024e9686 2019-05-14 stsp Switch the work tree's branch reference to the specified
198 024e9686 2019-05-14 stsp .Ar branch
199 024e9686 2019-05-14 stsp before updating the work tree.
200 024e9686 2019-05-14 stsp This option requires that all paths in the work tree are updated.
201 507dc3bb 2018-12-29 stsp .It Fl c Ar commit
202 507dc3bb 2018-12-29 stsp Update the work tree to the specified
203 507dc3bb 2018-12-29 stsp .Ar commit .
204 a54b6686 2019-06-28 stsp The expected argument is a commit ID SHA1 hash.
205 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
206 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
207 024e9686 2019-05-14 stsp If this option is not specified, the most recent commit on the work tree's
208 024e9686 2019-05-14 stsp branch will be used.
209 507dc3bb 2018-12-29 stsp .El
210 97b3a7be 2019-07-09 stsp .It Cm up
211 97b3a7be 2019-07-09 stsp Short alias for
212 97b3a7be 2019-07-09 stsp .Cm update .
213 927df6b7 2019-02-10 stsp .It Cm status [ Ar path ]
214 6cd959e6 2019-03-26 stsp Show the current modification status of files in a work tree,
215 6bad629b 2019-02-04 stsp using the following status codes:
216 6bad629b 2019-02-04 stsp .Bl -column YXZ description
217 6bad629b 2019-02-04 stsp .It M Ta modified file
218 079890a9 2019-03-26 stsp .It A Ta file scheduled for addition in next commit
219 079890a9 2019-03-26 stsp .It D Ta file scheduled for deletion in next commit
220 7154f6ce 2019-03-27 stsp .It C Ta modified or added file which contains merge conflicts
221 6bad629b 2019-02-04 stsp .It ! Ta versioned file was expected on disk but is missing
222 0dbc2271 2019-02-05 stsp .It ~ Ta versioned file is obstructed by a non-regular file
223 6bad629b 2019-02-04 stsp .It ? Ta unversioned item not tracked by
224 6bad629b 2019-02-04 stsp .Nm
225 6bad629b 2019-02-04 stsp .El
226 6bad629b 2019-02-04 stsp .Pp
227 927df6b7 2019-02-10 stsp If a
228 927df6b7 2019-02-10 stsp .Ar path
229 927df6b7 2019-02-10 stsp is specified, only show modifications within this path.
230 97b3a7be 2019-07-09 stsp .It Cm st
231 97b3a7be 2019-07-09 stsp Short alias for
232 97b3a7be 2019-07-09 stsp .Cm status .
233 f400486b 2019-07-15 stsp .It Cm log [ Fl c Ar commit ] [ Fl C Ar number ] [ Fl f ] [ Fl l Ar N ] [ Fl p ] [ Fl r Ar repository-path ] [ path ]
234 38e11793 2018-06-13 stsp Display history of a repository.
235 04ca23f4 2018-07-16 stsp If a
236 04ca23f4 2018-07-16 stsp .Ar path
237 04ca23f4 2018-07-16 stsp is specified, show only commits which modified this path.
238 38e11793 2018-06-13 stsp .Pp
239 38e11793 2018-06-13 stsp The options for
240 38e11793 2018-06-13 stsp .Cm got log
241 38e11793 2018-06-13 stsp are as follows:
242 38e11793 2018-06-13 stsp .Bl -tag -width Ds
243 38e11793 2018-06-13 stsp .It Fl c Ar commit
244 38e11793 2018-06-13 stsp Start traversing history at the specified
245 38e11793 2018-06-13 stsp .Ar commit .
246 a54b6686 2019-06-28 stsp The expected argument is the name of a branch or a commit ID SHA1 hash.
247 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
248 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
249 1cc14b9f 2019-05-14 stsp If this option is not specified, default to the work tree's current branch
250 1cc14b9f 2019-05-14 stsp if invoked in a work tree, or to the repository's HEAD reference.
251 c0cc5c62 2018-10-18 stsp .It Fl C Ar number
252 c0cc5c62 2018-10-18 stsp Set the number of context lines shown in diffs with
253 c0cc5c62 2018-10-18 stsp .Fl p .
254 c0cc5c62 2018-10-18 stsp By default, 3 lines of context are shown.
255 cc54c501 2019-07-15 stsp .It Fl f
256 cc54c501 2019-07-15 stsp Restrict history traversal to the first parent of each commit.
257 cc54c501 2019-07-15 stsp This shows the linear history of the current branch only.
258 cc54c501 2019-07-15 stsp Merge commits which affected the current branch will be shown but
259 cc54c501 2019-07-15 stsp individual commits which originated on other branches will be omitted.
260 6238ee32 2018-06-13 stsp .It Fl l Ar N
261 6238ee32 2018-06-13 stsp Limit history traversal to a given number of commits.
262 6238ee32 2018-06-13 stsp .It Fl p
263 6238ee32 2018-06-13 stsp Display the patch of modifications made in each commit.
264 04ca23f4 2018-07-16 stsp .It Fl r Ar repository-path
265 04ca23f4 2018-07-16 stsp Use the repository at the specified path.
266 04ca23f4 2018-07-16 stsp If not specified, assume the repository is located at or above the current
267 04ca23f4 2018-07-16 stsp working directory.
268 e9cf2e30 2019-02-05 stsp If this directory is a
269 e9cf2e30 2019-02-05 stsp .Nm
270 e9cf2e30 2019-02-05 stsp work tree, use the repository path associated with this work tree.
271 38e11793 2018-06-13 stsp .El
272 927df6b7 2019-02-10 stsp .It Cm diff [ Fl C Ar number ] [ Fl r Ar repository-path ] [ Ar object1 Ar object2 | Ar path ]
273 927df6b7 2019-02-10 stsp When invoked within a work tree with less than two arguments, display
274 927df6b7 2019-02-10 stsp uncommitted changes in the work tree.
275 927df6b7 2019-02-10 stsp If a
276 927df6b7 2019-02-10 stsp .Ar path
277 927df6b7 2019-02-10 stsp is specified, only show changes within this path.
278 927df6b7 2019-02-10 stsp .Pp
279 e02e74af 2019-05-28 stsp If two arguments are provided, treat each argument as a reference,
280 a54b6686 2019-06-28 stsp or an object ID SHA1 hash, and display differences between these objects.
281 3f8b7d6a 2018-04-01 stsp Both objects must be of the same type (blobs, trees, or commits).
282 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
283 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
284 c0cc5c62 2018-10-18 stsp .Pp
285 c0cc5c62 2018-10-18 stsp The options for
286 c0cc5c62 2018-10-18 stsp .Cm got diff
287 c0cc5c62 2018-10-18 stsp are as follows:
288 c0cc5c62 2018-10-18 stsp .Bl -tag -width Ds
289 c0cc5c62 2018-10-18 stsp .It Fl C Ar number
290 c0cc5c62 2018-10-18 stsp Set the number of context lines shown in the diff.
291 c0cc5c62 2018-10-18 stsp By default, 3 lines of context are shown.
292 b72f483a 2019-02-05 stsp .It Fl r Ar repository-path
293 b72f483a 2019-02-05 stsp Use the repository at the specified path.
294 b72f483a 2019-02-05 stsp If not specified, assume the repository is located at or above the current
295 b72f483a 2019-02-05 stsp working directory.
296 b72f483a 2019-02-05 stsp If this directory is a
297 b72f483a 2019-02-05 stsp .Nm
298 b72f483a 2019-02-05 stsp work tree, use the repository path associated with this work tree.
299 c0cc5c62 2018-10-18 stsp .El
300 1ff8e573 2018-08-02 stsp .It Cm blame [ Fl c Ar commit ] [ Fl r Ar repository-path ] Ar path
301 1ff8e573 2018-08-02 stsp Display line-by-line history of a file at the specified path.
302 1ff8e573 2018-08-02 stsp .Pp
303 1ff8e573 2018-08-02 stsp The options for
304 1ff8e573 2018-08-02 stsp .Cm got blame
305 1ff8e573 2018-08-02 stsp are as follows:
306 1ff8e573 2018-08-02 stsp .Bl -tag -width Ds
307 1ff8e573 2018-08-02 stsp .It Fl c Ar commit
308 1ff8e573 2018-08-02 stsp Start traversing history at the specified
309 1ff8e573 2018-08-02 stsp .Ar commit .
310 a54b6686 2019-06-28 stsp The expected argument is the name of a branch or a commit ID SHA1 hash.
311 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
312 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
313 1ff8e573 2018-08-02 stsp .It Fl r Ar repository-path
314 1ff8e573 2018-08-02 stsp Use the repository at the specified path.
315 1ff8e573 2018-08-02 stsp If not specified, assume the repository is located at or above the current
316 1ff8e573 2018-08-02 stsp working directory.
317 0c06baac 2019-02-05 stsp If this directory is a
318 0c06baac 2019-02-05 stsp .Nm
319 0c06baac 2019-02-05 stsp work tree, use the repository path associated with this work tree.
320 5c860e29 2018-03-12 stsp .El
321 c1669e2e 2019-01-09 stsp .It Cm tree [ Fl c Ar commit ] [ Fl r Ar repository-path ] [ Fl i ] [ Fl R] [ Ar path ]
322 5de5890b 2018-10-18 stsp Display a listing of files and directories at the specified
323 5de5890b 2018-10-18 stsp directory path in the repository.
324 db0c2996 2019-02-10 stsp Entries shown in this listing may carry one of the following trailing
325 db0c2996 2019-02-10 stsp annotations:
326 db0c2996 2019-02-10 stsp .Bl -column YXZ description
327 db0c2996 2019-02-10 stsp .It / Ta entry is a directory
328 db0c2996 2019-02-10 stsp .It * Ta entry is an executable file
329 db0c2996 2019-02-10 stsp .El
330 db0c2996 2019-02-10 stsp .Pp
331 0c849583 2019-02-05 stsp If no
332 0c849583 2019-02-05 stsp .Ar path
333 0c849583 2019-02-05 stsp is specified, list the repository path corresponding to the current
334 0c849583 2019-02-05 stsp directory of the work tree, or the root directory of the repository
335 0c849583 2019-02-05 stsp if there is no work tree.
336 5de5890b 2018-10-18 stsp .Pp
337 5de5890b 2018-10-18 stsp The options for
338 5de5890b 2018-10-18 stsp .Cm got tree
339 5de5890b 2018-10-18 stsp are as follows:
340 5de5890b 2018-10-18 stsp .Bl -tag -width Ds
341 5de5890b 2018-10-18 stsp .It Fl c Ar commit
342 5de5890b 2018-10-18 stsp List files and directories as they appear in the specified
343 5de5890b 2018-10-18 stsp .Ar commit .
344 a54b6686 2019-06-28 stsp The expected argument is the name of a branch or a commit ID SHA1 hash.
345 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
346 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
347 5de5890b 2018-10-18 stsp .It Fl r Ar repository-path
348 5de5890b 2018-10-18 stsp Use the repository at the specified path.
349 5de5890b 2018-10-18 stsp If not specified, assume the repository is located at or above the current
350 5de5890b 2018-10-18 stsp working directory.
351 0c849583 2019-02-05 stsp If this directory is a
352 0c849583 2019-02-05 stsp .Nm
353 0c849583 2019-02-05 stsp work tree, use the repository path associated with this work tree.
354 5de5890b 2018-10-18 stsp .It Fl i
355 5de5890b 2018-10-18 stsp Show object IDs of files (blob objects) and directories (tree objects).
356 c1669e2e 2019-01-09 stsp .It Fl R
357 0c849583 2019-02-05 stsp Recurse into sub-directories in the repository.
358 d0eebce4 2019-03-11 stsp .El
359 d83d9d5c 2019-05-13 stsp .It Cm ref [ Fl r Ar repository-path ] [ Fl l ] [ Fl d Ar name ] [ Ar name Ar target ]
360 d0eebce4 2019-03-11 stsp Manage references in a repository.
361 d0eebce4 2019-03-11 stsp .Pp
362 d0eebce4 2019-03-11 stsp If no options are passed, expect two arguments and attempt to create,
363 d0eebce4 2019-03-11 stsp or update, the reference with the given
364 d0eebce4 2019-03-11 stsp .Ar name ,
365 d0eebce4 2019-03-11 stsp and make it point at the given
366 d83d9d5c 2019-05-13 stsp .Ar target .
367 a54b6686 2019-06-28 stsp The target may be an object ID SHA1 hash or an existing reference which
368 a54b6686 2019-06-28 stsp will be resolved to an object ID.
369 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
370 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
371 d0eebce4 2019-03-11 stsp .Pp
372 d0eebce4 2019-03-11 stsp The options for
373 d0eebce4 2019-03-11 stsp .Cm got ref
374 d0eebce4 2019-03-11 stsp are as follows:
375 d0eebce4 2019-03-11 stsp .Bl -tag -width Ds
376 d0eebce4 2019-03-11 stsp .It Fl r Ar repository-path
377 d0eebce4 2019-03-11 stsp Use the repository at the specified path.
378 d0eebce4 2019-03-11 stsp If not specified, assume the repository is located at or above the current
379 d0eebce4 2019-03-11 stsp working directory.
380 d0eebce4 2019-03-11 stsp If this directory is a
381 d0eebce4 2019-03-11 stsp .Nm
382 d0eebce4 2019-03-11 stsp work tree, use the repository path associated with this work tree.
383 d0eebce4 2019-03-11 stsp .It Fl l
384 d0eebce4 2019-03-11 stsp List all existing references in the repository.
385 d0eebce4 2019-03-11 stsp .It Fl d Ar name
386 d0eebce4 2019-03-11 stsp Delete the reference with the specified name from the repository.
387 4e759de4 2019-06-26 stsp .El
388 4e759de4 2019-06-26 stsp .It Cm branch [ Fl r Ar repository-path ] [ Fl l ] [ Fl d Ar name ] [ Ar name [ Ar base-branch ] ]
389 4e759de4 2019-06-26 stsp Manage branches in a repository.
390 4e759de4 2019-06-26 stsp .Pp
391 4e759de4 2019-06-26 stsp Branches are managed via references which live in the
392 4e759de4 2019-06-26 stsp .Dq refs/heads/
393 4e759de4 2019-06-26 stsp reference namespace.
394 4e759de4 2019-06-26 stsp The
395 4e759de4 2019-06-26 stsp .Cm got branch
396 4e759de4 2019-06-26 stsp command operates on references in this namespace only.
397 4e759de4 2019-06-26 stsp .Pp
398 4e759de4 2019-06-26 stsp If no options are passed, expect one or two arguments and attempt to create
399 4e759de4 2019-06-26 stsp a branch with the given
400 4e759de4 2019-06-26 stsp .Ar name ,
401 4e759de4 2019-06-26 stsp and make it point at the given
402 4e759de4 2019-06-26 stsp .Ar base-branch .
403 4e759de4 2019-06-26 stsp If no
404 4e759de4 2019-06-26 stsp .Ar base-branch
405 4e759de4 2019-06-26 stsp is specified, default to the work tree's current branch if invoked in a
406 4e759de4 2019-06-26 stsp work tree, or to the repository's HEAD reference.
407 4e759de4 2019-06-26 stsp .Pp
408 4e759de4 2019-06-26 stsp The options for
409 4e759de4 2019-06-26 stsp .Cm got branch
410 4e759de4 2019-06-26 stsp are as follows:
411 4e759de4 2019-06-26 stsp .Bl -tag -width Ds
412 4e759de4 2019-06-26 stsp .It Fl r Ar repository-path
413 4e759de4 2019-06-26 stsp Use the repository at the specified path.
414 4e759de4 2019-06-26 stsp If not specified, assume the repository is located at or above the current
415 4e759de4 2019-06-26 stsp working directory.
416 4e759de4 2019-06-26 stsp If this directory is a
417 4e759de4 2019-06-26 stsp .Nm
418 4e759de4 2019-06-26 stsp work tree, use the repository path associated with this work tree.
419 4e759de4 2019-06-26 stsp .It Fl l
420 4e759de4 2019-06-26 stsp List all existing branches in the repository.
421 ba882ee3 2019-07-11 stsp If invoked in a work tree, the work tree's current branch is shown
422 ba882ee3 2019-07-11 stsp with one the following annotations:
423 ba882ee3 2019-07-11 stsp .Bl -column YXZ description
424 ba882ee3 2019-07-11 stsp .It * Ta work tree's base commit matches the branch tip
425 ba882ee3 2019-07-11 stsp .It ~ Ta work tree's base commit is out-of-date
426 ba882ee3 2019-07-11 stsp .El
427 4e759de4 2019-06-26 stsp .It Fl d Ar name
428 4e759de4 2019-06-26 stsp Delete the branch with the specified name from the repository.
429 7acfb25b 2019-07-11 stsp Only the branch reference is deleted.
430 7acfb25b 2019-07-11 stsp Any commit, tree, and blob objects belonging to the branch
431 74d012d1 2019-07-11 stsp remain in the repository and may be removed separately with
432 ce33d90e 2019-07-14 stsp Git's garbage collector.
433 5de5890b 2018-10-18 stsp .El
434 97b3a7be 2019-07-09 stsp .It Cm br
435 97b3a7be 2019-07-09 stsp Short alias for
436 97b3a7be 2019-07-09 stsp .Cm branch .
437 fbb7e5c7 2019-05-11 stsp .It Cm add Ar file-path ...
438 8125ddca 2019-05-11 stsp Schedule unversioned files in a work tree for addition to the
439 d00136be 2019-03-26 stsp repository in the next commit.
440 648e4ef7 2019-07-09 stsp .It Cm remove Ar file-path ...
441 17ed4618 2019-06-02 stsp Remove versioned files from a work tree and schedule them for deletion
442 2ec1f75b 2019-03-26 stsp from the repository in the next commit.
443 2ec1f75b 2019-03-26 stsp .Pp
444 2ec1f75b 2019-03-26 stsp The options for
445 86d25a1b 2019-07-11 stsp .Cm got remove
446 2ec1f75b 2019-03-26 stsp are as follows:
447 2ec1f75b 2019-03-26 stsp .Bl -tag -width Ds
448 2ec1f75b 2019-03-26 stsp .It Fl f
449 17ed4618 2019-06-02 stsp Perform the operation even if a file contains uncommitted modifications.
450 d0eebce4 2019-03-11 stsp .El
451 648e4ef7 2019-07-09 stsp .It Cm rm
452 648e4ef7 2019-07-09 stsp Short alias for
453 648e4ef7 2019-07-09 stsp .Cm remove .
454 e20a8b6f 2019-06-04 stsp .It Cm revert Ar file-path ...
455 e20a8b6f 2019-06-04 stsp Revert any uncommited changes in files at the specified paths.
456 a129376b 2019-03-28 stsp File contents will be overwritten with those contained in the
457 a129376b 2019-03-28 stsp work tree's base commit. There is no way to bring discarded
458 a129376b 2019-03-28 stsp changes back after
459 a129376b 2019-03-28 stsp .Cm got revert !
460 a129376b 2019-03-28 stsp .Pp
461 e20a8b6f 2019-06-04 stsp If a file was added with
462 a129376b 2019-03-28 stsp .Cm got add
463 a129376b 2019-03-28 stsp it will become an unversioned file again.
464 e20a8b6f 2019-06-04 stsp If a file was deleted with
465 86d25a1b 2019-07-11 stsp .Cm got remove
466 a129376b 2019-03-28 stsp it will be restored.
467 97b3a7be 2019-07-09 stsp .It Cm rv
468 97b3a7be 2019-07-09 stsp Short alias for
469 97b3a7be 2019-07-09 stsp .Cm revert .
470 74ff3f23 2019-07-07 stsp .It Cm commit [ Fl m Ar message ] [ file-path ]
471 15cd91f7 2019-05-12 stsp Create a new commit in the repository from local changes in a work tree
472 15cd91f7 2019-05-12 stsp and use this commit as the new base commit for the work tree.
473 15cd91f7 2019-05-12 stsp .Pp
474 15cd91f7 2019-05-12 stsp Show the status of each affected file, using the following status codes:
475 15cd91f7 2019-05-12 stsp .Bl -column YXZ description
476 15cd91f7 2019-05-12 stsp .It M Ta modified file
477 15cd91f7 2019-05-12 stsp .It D Ta file was deleted
478 15cd91f7 2019-05-12 stsp .It A Ta new file was added
479 15cd91f7 2019-05-12 stsp .El
480 15cd91f7 2019-05-12 stsp .Pp
481 15cd91f7 2019-05-12 stsp Files without local changes will retain their previously recorded base
482 15cd91f7 2019-05-12 stsp commit.
483 15cd91f7 2019-05-12 stsp Some
484 15cd91f7 2019-05-12 stsp .Nm
485 15cd91f7 2019-05-12 stsp commands may refuse to run while the work tree contains files from
486 15cd91f7 2019-05-12 stsp multiple base commits.
487 15cd91f7 2019-05-12 stsp The base commit of such a work tree can be made consistent by running
488 47ec7be7 2019-05-12 stsp .Cm got update
489 47ec7be7 2019-05-12 stsp across the entire work tree.
490 15cd91f7 2019-05-12 stsp .Pp
491 15cd91f7 2019-05-12 stsp The
492 15cd91f7 2019-05-12 stsp .Cm got commit
493 15cd91f7 2019-05-12 stsp command requires the
494 74416c47 2019-05-09 stsp .Ev GOT_AUTHOR
495 74416c47 2019-05-09 stsp environment variable to be set.
496 74416c47 2019-05-09 stsp .Pp
497 74416c47 2019-05-09 stsp The options for
498 74416c47 2019-05-09 stsp .Cm got commit
499 74416c47 2019-05-09 stsp are as follows:
500 74416c47 2019-05-09 stsp .Bl -tag -width Ds
501 74ff3f23 2019-07-07 stsp .It Fl m Ar message
502 74416c47 2019-05-09 stsp Use the specified log message when creating the new commit.
503 23594da9 2019-05-13 stsp Without the
504 23594da9 2019-05-13 stsp .Fl m
505 23594da9 2019-05-13 stsp option,
506 23594da9 2019-05-13 stsp .Cm got commit
507 23594da9 2019-05-13 stsp opens a temporary file in an editor where a log message can be written.
508 2ec1f75b 2019-03-26 stsp .El
509 97b3a7be 2019-07-09 stsp .It Cm ci
510 97b3a7be 2019-07-09 stsp Short alias for
511 97b3a7be 2019-07-09 stsp .Cm commit .
512 234035bc 2019-06-01 stsp .It Cm cherrypick Ar commit
513 234035bc 2019-06-01 stsp Merge changes from a single
514 234035bc 2019-06-01 stsp .Ar commit
515 234035bc 2019-06-01 stsp into the work tree.
516 234035bc 2019-06-01 stsp The specified
517 234035bc 2019-06-01 stsp .Ar commit
518 234035bc 2019-06-01 stsp must be on a different branch than the work tree's base commit.
519 a54b6686 2019-06-28 stsp The expected argument is a reference or a commit ID SHA1 hash.
520 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
521 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
522 234035bc 2019-06-01 stsp .Pp
523 234035bc 2019-06-01 stsp Show the status of each affected file, using the following status codes:
524 234035bc 2019-06-01 stsp .Bl -column YXZ description
525 234035bc 2019-06-01 stsp .It G Ta file was merged
526 234035bc 2019-06-01 stsp .It C Ta file was merged and conflicts occurred during merge
527 234035bc 2019-06-01 stsp .It ! Ta changes destined for a missing file were not merged
528 234035bc 2019-06-01 stsp .It D Ta file was deleted
529 2b92fad7 2019-06-02 stsp .It d Ta file's deletion was obstructed by local modifications
530 234035bc 2019-06-01 stsp .It A Ta new file was added
531 2b92fad7 2019-06-02 stsp .It ~ Ta changes destined for a non-regular file were not merged
532 74416c47 2019-05-09 stsp .El
533 234035bc 2019-06-01 stsp .Pp
534 234035bc 2019-06-01 stsp The merged changes will appear as local changes in the work tree, which
535 234035bc 2019-06-01 stsp may be viewed with
536 234035bc 2019-06-01 stsp .Cm got diff ,
537 234035bc 2019-06-01 stsp amended manually or with further
538 234035bc 2019-06-01 stsp .Cm got cherrypick
539 234035bc 2019-06-01 stsp comands,
540 234035bc 2019-06-01 stsp committed with
541 234035bc 2019-06-01 stsp .Cm got commit ,
542 234035bc 2019-06-01 stsp or discarded again with
543 234035bc 2019-06-01 stsp .Cm got revert .
544 234035bc 2019-06-01 stsp .Pp
545 234035bc 2019-06-01 stsp .Cm got cherrypick
546 234035bc 2019-06-01 stsp will refuse to run if certain preconditions are not met.
547 234035bc 2019-06-01 stsp If the work tree contains multiple base commits it must first be updated
548 234035bc 2019-06-01 stsp to a single base commit with
549 234035bc 2019-06-01 stsp .Cm got update .
550 234035bc 2019-06-01 stsp If the work tree already contains files with merge conflicts, these
551 234035bc 2019-06-01 stsp conflicts must be resolved first.
552 016477fd 2019-07-09 stsp .It Cm cy
553 97b3a7be 2019-07-09 stsp Short alias for
554 97b3a7be 2019-07-09 stsp .Cm cherrypick .
555 5ef14e63 2019-06-02 stsp .It Cm backout Ar commit
556 5ef14e63 2019-06-02 stsp Reverse-merge changes from a single
557 5ef14e63 2019-06-02 stsp .Ar commit
558 5ef14e63 2019-06-02 stsp into the work tree.
559 5ef14e63 2019-06-02 stsp The specified
560 5ef14e63 2019-06-02 stsp .Ar commit
561 5ef14e63 2019-06-02 stsp must be on the same branch as the work tree's base commit.
562 a54b6686 2019-06-28 stsp The expected argument is a reference or a commit ID SHA1 hash.
563 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
564 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
565 5ef14e63 2019-06-02 stsp .Pp
566 5ef14e63 2019-06-02 stsp Show the status of each affected file, using the following status codes:
567 5ef14e63 2019-06-02 stsp .Bl -column YXZ description
568 5ef14e63 2019-06-02 stsp .It G Ta file was merged
569 5ef14e63 2019-06-02 stsp .It C Ta file was merged and conflicts occurred during merge
570 5ef14e63 2019-06-02 stsp .It ! Ta changes destined for a missing file were not merged
571 5ef14e63 2019-06-02 stsp .It D Ta file was deleted
572 5ef14e63 2019-06-02 stsp .It d Ta file's deletion was obstructed by local modifications
573 5ef14e63 2019-06-02 stsp .It A Ta new file was added
574 5ef14e63 2019-06-02 stsp .It ~ Ta changes destined for a non-regular file were not merged
575 234035bc 2019-06-01 stsp .El
576 5ef14e63 2019-06-02 stsp .Pp
577 5ef14e63 2019-06-02 stsp The reverse-merged changes will appear as local changes in the work tree,
578 5ef14e63 2019-06-02 stsp which may be viewed with
579 5ef14e63 2019-06-02 stsp .Cm got diff ,
580 5ef14e63 2019-06-02 stsp amended manually or with further
581 778a73c2 2019-07-12 stsp .Cm got backout
582 5ef14e63 2019-06-02 stsp comands,
583 5ef14e63 2019-06-02 stsp committed with
584 5ef14e63 2019-06-02 stsp .Cm got commit ,
585 5ef14e63 2019-06-02 stsp or discarded again with
586 5ef14e63 2019-06-02 stsp .Cm got revert .
587 5ef14e63 2019-06-02 stsp .Pp
588 92228c38 2019-06-02 stsp .Cm got backout
589 92228c38 2019-06-02 stsp will refuse to run if certain preconditions are not met.
590 92228c38 2019-06-02 stsp If the work tree contains multiple base commits it must first be updated
591 92228c38 2019-06-02 stsp to a single base commit with
592 92228c38 2019-06-02 stsp .Cm got update .
593 92228c38 2019-06-02 stsp If the work tree already contains files with merge conflicts, these
594 92228c38 2019-06-02 stsp conflicts must be resolved first.
595 97b3a7be 2019-07-09 stsp .It Cm bo
596 97b3a7be 2019-07-09 stsp Short alias for
597 97b3a7be 2019-07-09 stsp .Cm backout .
598 cd98404f 2019-07-14 stsp .It Cm rebase [ Fl a ] [ Fl c] [ Ar branch ]
599 818c7501 2019-07-11 stsp Rebase commits on the specified
600 818c7501 2019-07-11 stsp .Ar branch
601 818c7501 2019-07-11 stsp onto the tip of the current branch of the work tree.
602 818c7501 2019-07-11 stsp The
603 818c7501 2019-07-11 stsp .Ar branch
604 818c7501 2019-07-11 stsp must share common ancestry with the work tree's current branch.
605 f09e2405 2019-07-11 stsp Rebasing begins with the first descendent commit of the youngest
606 f09e2405 2019-07-11 stsp common ancestor commit shared by the specified
607 818c7501 2019-07-11 stsp .Ar branch
608 818c7501 2019-07-11 stsp and the work tree's current branch, and stops once the tip commit
609 f09e2405 2019-07-11 stsp of the specified
610 818c7501 2019-07-11 stsp .Ar branch
611 f09e2405 2019-07-11 stsp has been rebased.
612 818c7501 2019-07-11 stsp .Pp
613 818c7501 2019-07-11 stsp Rebased commits are accumulated on a temporary branch and represent
614 f09e2405 2019-07-11 stsp the same changes with the same log messages as their counterparts
615 f09e2405 2019-07-11 stsp on the original
616 818c7501 2019-07-11 stsp .Ar branch ,
617 818c7501 2019-07-11 stsp but with different commit IDs.
618 818c7501 2019-07-11 stsp Once rebasing has completed successfully, the temporary branch becomes
619 f09e2405 2019-07-11 stsp the new version of the specified
620 818c7501 2019-07-11 stsp .Ar branch
621 818c7501 2019-07-11 stsp and the work tree is automatically switched to it.
622 818c7501 2019-07-11 stsp .Pp
623 818c7501 2019-07-11 stsp While rebasing commits, show the status of each affected file,
624 818c7501 2019-07-11 stsp using the following status codes:
625 818c7501 2019-07-11 stsp .Bl -column YXZ description
626 818c7501 2019-07-11 stsp .It G Ta file was merged
627 818c7501 2019-07-11 stsp .It C Ta file was merged and conflicts occurred during merge
628 818c7501 2019-07-11 stsp .It ! Ta changes destined for a missing file were not merged
629 818c7501 2019-07-11 stsp .It D Ta file was deleted
630 818c7501 2019-07-11 stsp .It d Ta file's deletion was obstructed by local modifications
631 818c7501 2019-07-11 stsp .It A Ta new file was added
632 818c7501 2019-07-11 stsp .It ~ Ta changes destined for a non-regular file were not merged
633 5ef14e63 2019-06-02 stsp .El
634 818c7501 2019-07-11 stsp .Pp
635 f09e2405 2019-07-11 stsp If merge conflicts occur the rebase operation is interrupted and may
636 f09e2405 2019-07-11 stsp be continued once conflicts have been resolved.
637 818c7501 2019-07-11 stsp Alternatively, the rebase operation may be aborted which will leave
638 818c7501 2019-07-11 stsp .Ar branch
639 818c7501 2019-07-11 stsp unmodified and the work tree switched back to its original branch.
640 818c7501 2019-07-11 stsp .Pp
641 ff0d2220 2019-07-11 stsp If a merge conflict is resolved in a way which renders the merged
642 f09e2405 2019-07-11 stsp change into a no-op change, the corresponding commit will be elided
643 f09e2405 2019-07-11 stsp when the rebase operation continues.
644 ff0d2220 2019-07-11 stsp .Pp
645 818c7501 2019-07-11 stsp .Cm got rebase
646 818c7501 2019-07-11 stsp will refuse to run if certain preconditions are not met.
647 818c7501 2019-07-11 stsp If the work tree contains multiple base commits it must first be updated
648 818c7501 2019-07-11 stsp to a single base commit with
649 818c7501 2019-07-11 stsp .Cm got update .
650 f09e2405 2019-07-11 stsp If the work tree contains local changes, these changes must first be
651 f09e2405 2019-07-11 stsp committed with
652 f09e2405 2019-07-11 stsp .Cm got commit
653 f09e2405 2019-07-11 stsp or reverted with
654 f09e2405 2019-07-11 stsp .Cm got revert .
655 64c6d990 2019-07-11 stsp If the
656 64c6d990 2019-07-11 stsp .Ar branch
657 64c6d990 2019-07-11 stsp contains changes to files outside of the work tree's path prefix,
658 64c6d990 2019-07-11 stsp the work tree cannot be used to rebase this branch.
659 818c7501 2019-07-11 stsp .Pp
660 7d5807f4 2019-07-11 stsp The
661 7d5807f4 2019-07-11 stsp .Cm got update
662 7d5807f4 2019-07-11 stsp and
663 7d5807f4 2019-07-11 stsp .Cm got commit
664 7d5807f4 2019-07-11 stsp commands will refuse to run while a rebase operation is in progress.
665 7d5807f4 2019-07-11 stsp Other commands which manipulate the work tree may be used for
666 7d5807f4 2019-07-11 stsp conflict resolution purposes.
667 818c7501 2019-07-11 stsp .Pp
668 818c7501 2019-07-11 stsp The options for
669 818c7501 2019-07-11 stsp .Cm got rebase
670 818c7501 2019-07-11 stsp are as follows:
671 818c7501 2019-07-11 stsp .Bl -tag -width Ds
672 818c7501 2019-07-11 stsp .It Fl a
673 818c7501 2019-07-11 stsp Abort an interrupted rebase operation.
674 cd98404f 2019-07-14 stsp If this option is used, no further command-line arguments are allowed.
675 818c7501 2019-07-11 stsp .It Fl c
676 06067b48 2019-07-11 stsp Continue an interrupted rebase operation.
677 cd98404f 2019-07-14 stsp If this option is used, no further command-line arguments are allowed.
678 818c7501 2019-07-11 stsp .El
679 818c7501 2019-07-11 stsp .It Cm rb
680 818c7501 2019-07-11 stsp Short alias for
681 818c7501 2019-07-11 stsp .Cm rebase .
682 0ebf8283 2019-07-24 stsp .It Cm histedit [ Fl a ] [ Fl c] [ Fl F Ar histedit-script ]
683 0ebf8283 2019-07-24 stsp Edit commit history between the work tree's current base commit and
684 0ebf8283 2019-07-24 stsp the tip commit of the work tree's current branch.
685 0ebf8283 2019-07-24 stsp .Pp
686 0ebf8283 2019-07-24 stsp Editing of commit history is controlled via a
687 0ebf8283 2019-07-24 stsp .Ar histedit script
688 0ebf8283 2019-07-24 stsp which can be edited interactively or passed on the command line.
689 0ebf8283 2019-07-24 stsp The format of the histedit script is line-based.
690 0ebf8283 2019-07-24 stsp Each line in the script begins with a command name, followed by
691 0ebf8283 2019-07-24 stsp whitespace and an argument.
692 0ebf8283 2019-07-24 stsp For most commands, the expected argument is a commit ID SHA1 hash.
693 0ebf8283 2019-07-24 stsp Any remaining text on the line is ignored.
694 0ebf8283 2019-07-24 stsp Lines which begin with the
695 0ebf8283 2019-07-24 stsp .Sq #
696 0ebf8283 2019-07-24 stsp character are ignored entirely.
697 0ebf8283 2019-07-24 stsp .Pp
698 0ebf8283 2019-07-24 stsp The available commands are as follows:
699 0ebf8283 2019-07-24 stsp .Bl -column YXZ pick-commit
700 0ebf8283 2019-07-24 stsp .It pick Ar commit Ta Use the specified commit as it is.
701 0ebf8283 2019-07-24 stsp .It edit Ar commit Ta Use the specfified commit but once changes have been
702 0ebf8283 2019-07-24 stsp merged into the work tree interrupt the histedit operation for amending.
703 0ebf8283 2019-07-24 stsp .It fold Ar commit Ta Combine the specified commit with the next commit
704 0ebf8283 2019-07-24 stsp listed further below that will be used.
705 0ebf8283 2019-07-24 stsp .It drop Ar commit Ta Remove this commit from the edited history.
706 0ebf8283 2019-07-24 stsp .It mesg Ar log-message Ta Use the specified single-line log message for
707 0ebf8283 2019-07-24 stsp the commit on the previous line.
708 0ebf8283 2019-07-24 stsp If the log message argument is left empty, open an editor where a new
709 0ebf8283 2019-07-24 stsp log message can be written.
710 0ebf8283 2019-07-24 stsp .El
711 0ebf8283 2019-07-24 stsp .Pp
712 0ebf8283 2019-07-24 stsp Every commit in the history being edited must be mentioned in histedit script.
713 0ebf8283 2019-07-24 stsp Lines may be re-ordered to change the order of commits in the edited history.
714 0ebf8283 2019-07-24 stsp .Pp
715 0ebf8283 2019-07-24 stsp Edited commits are accumulated on a temporary branch.
716 0ebf8283 2019-07-24 stsp Once history editing has completed successfully, the temporary branch becomes
717 0ebf8283 2019-07-24 stsp the new version of the work tree's base branch and the work tree is
718 0ebf8283 2019-07-24 stsp automatically switched to it.
719 0ebf8283 2019-07-24 stsp .Pp
720 0ebf8283 2019-07-24 stsp While merging commits, show the status of each affected file,
721 0ebf8283 2019-07-24 stsp using the following status codes:
722 0ebf8283 2019-07-24 stsp .Bl -column YXZ description
723 0ebf8283 2019-07-24 stsp .It G Ta file was merged
724 0ebf8283 2019-07-24 stsp .It C Ta file was merged and conflicts occurred during merge
725 0ebf8283 2019-07-24 stsp .It ! Ta changes destined for a missing file were not merged
726 0ebf8283 2019-07-24 stsp .It D Ta file was deleted
727 0ebf8283 2019-07-24 stsp .It d Ta file's deletion was obstructed by local modifications
728 0ebf8283 2019-07-24 stsp .It A Ta new file was added
729 0ebf8283 2019-07-24 stsp .It ~ Ta changes destined for a non-regular file were not merged
730 0ebf8283 2019-07-24 stsp .El
731 0ebf8283 2019-07-24 stsp .Pp
732 0ebf8283 2019-07-24 stsp If merge conflicts occur the histedit operation is interrupted and may
733 0ebf8283 2019-07-24 stsp be continued once conflicts have been resolved.
734 0ebf8283 2019-07-24 stsp Alternatively, the histedit operation may be aborted which will leave
735 0ebf8283 2019-07-24 stsp the work tree switched back to its original branch.
736 0ebf8283 2019-07-24 stsp .Pp
737 0ebf8283 2019-07-24 stsp If a merge conflict is resolved in a way which renders the merged
738 0ebf8283 2019-07-24 stsp change into a no-op change, the corresponding commit will be elided
739 0ebf8283 2019-07-24 stsp when the histedit operation continues.
740 0ebf8283 2019-07-24 stsp .Pp
741 0ebf8283 2019-07-24 stsp .Cm got histedit
742 0ebf8283 2019-07-24 stsp will refuse to run if certain preconditions are not met.
743 0ebf8283 2019-07-24 stsp If the work tree contains multiple base commits it must first be updated
744 0ebf8283 2019-07-24 stsp to a single base commit with
745 0ebf8283 2019-07-24 stsp .Cm got update .
746 0ebf8283 2019-07-24 stsp If the work tree contains local changes, these changes must first be
747 0ebf8283 2019-07-24 stsp committed with
748 0ebf8283 2019-07-24 stsp .Cm got commit
749 0ebf8283 2019-07-24 stsp or reverted with
750 0ebf8283 2019-07-24 stsp .Cm got revert .
751 0ebf8283 2019-07-24 stsp If the edited history contains changes to files outside of the work tree's
752 0ebf8283 2019-07-24 stsp path prefix, the work tree cannot be used to edit the history of this branch.
753 0ebf8283 2019-07-24 stsp .Pp
754 0ebf8283 2019-07-24 stsp The
755 0ebf8283 2019-07-24 stsp .Cm got update
756 0ebf8283 2019-07-24 stsp and
757 0ebf8283 2019-07-24 stsp .Cm got commit
758 0ebf8283 2019-07-24 stsp commands will refuse to run while a histedit operation is in progress.
759 0ebf8283 2019-07-24 stsp Other commands which manipulate the work tree may be used for
760 0ebf8283 2019-07-24 stsp conflict resolution purposes.
761 0ebf8283 2019-07-24 stsp .Pp
762 0ebf8283 2019-07-24 stsp The options for
763 0ebf8283 2019-07-24 stsp .Cm got histedit
764 0ebf8283 2019-07-24 stsp are as follows:
765 0ebf8283 2019-07-24 stsp .Bl -tag -width Ds
766 0ebf8283 2019-07-24 stsp .It Fl a
767 0ebf8283 2019-07-24 stsp Abort an interrupted histedit operation.
768 0ebf8283 2019-07-24 stsp If this option is used, no further command-line arguments are allowed.
769 0ebf8283 2019-07-24 stsp .It Fl c
770 0ebf8283 2019-07-24 stsp Continue an interrupted histedit operation.
771 0ebf8283 2019-07-24 stsp If this option is used, no further command-line arguments are allowed.
772 818c7501 2019-07-11 stsp .El
773 0ebf8283 2019-07-24 stsp .It Cm he
774 0ebf8283 2019-07-24 stsp Short alias for
775 0ebf8283 2019-07-24 stsp .Cm histedit .
776 0ebf8283 2019-07-24 stsp .El
777 74416c47 2019-05-09 stsp .Sh ENVIRONMENT
778 74416c47 2019-05-09 stsp .Bl -tag -width GOT_AUTHOR
779 74416c47 2019-05-09 stsp .It Ev GOT_AUTHOR
780 74416c47 2019-05-09 stsp The author's name and email address for
781 21a44f98 2019-07-15 stsp .Cm got commit
782 21a44f98 2019-07-15 stsp and
783 21a44f98 2019-07-15 stsp .Cm got import ,
784 74416c47 2019-05-09 stsp for example:
785 74416c47 2019-05-09 stsp .An Stefan Sperling Aq Mt stsp@openbsd.org
786 23594da9 2019-05-13 stsp .It Ev VISUAL, Ev EDITOR
787 23594da9 2019-05-13 stsp The editor spawned by
788 23594da9 2019-05-13 stsp .Cm got commit .
789 74416c47 2019-05-09 stsp .El
790 5c860e29 2018-03-12 stsp .Sh EXIT STATUS
791 5c860e29 2018-03-12 stsp .Ex -std got
792 97925469 2018-03-17 stsp .Sh EXAMPLES
793 fa6e0e48 2019-05-23 stsp Clone an existing Git repository for use with
794 fa6e0e48 2019-05-23 stsp .Nm .
795 fa6e0e48 2019-05-23 stsp This step currently requires
796 fa6e0e48 2019-05-23 stsp .Xr git 1 :
797 d83d9d5c 2019-05-13 stsp .Pp
798 fa6e0e48 2019-05-23 stsp .Dl $ cd /var/git/
799 fa6e0e48 2019-05-23 stsp .Dl $ git clone --bare https://github.com/openbsd/src.git
800 fa6e0e48 2019-05-23 stsp .Pp
801 3ce1b845 2019-07-15 stsp Alternatively, for quick and dirty local testing of
802 3ce1b845 2019-07-15 stsp .Nm
803 3ce1b845 2019-07-15 stsp a new Git repository could be created and populated with files,
804 3ce1b845 2019-07-15 stsp e.g. from a temporary CVS checkout located at
805 3ce1b845 2019-07-15 stsp .Pa /tmp/src :
806 fa6e0e48 2019-05-23 stsp .Pp
807 3ce1b845 2019-07-15 stsp .Dl $ got init /var/git/src.git
808 2930ef13 2019-07-15 stsp .Dl $ got import -r /var/git/src.git -I CVS -I obj /tmp/src
809 3ce1b845 2019-07-15 stsp .Pp
810 3ce1b845 2019-07-15 stsp Check out a work tree from the Git repository to /usr/src:
811 3ce1b845 2019-07-15 stsp .Pp
812 fa6e0e48 2019-05-23 stsp .Dl $ got checkout /var/git/src.git /usr/src
813 fa6e0e48 2019-05-23 stsp .Pp
814 e70c17ce 2019-05-22 stsp View local changes in a work tree directory:
815 e70c17ce 2019-05-22 stsp .Pp
816 e70c17ce 2019-05-22 stsp .Dl $ got status
817 e70c17ce 2019-05-22 stsp .Dl $ got diff | less
818 e70c17ce 2019-05-22 stsp .Pp
819 e70c17ce 2019-05-22 stsp In a work tree or a git repository directory, list all branch references:
820 e70c17ce 2019-05-22 stsp .Pp
821 4e759de4 2019-06-26 stsp .Dl $ got branch -l
822 e70c17ce 2019-05-22 stsp .Pp
823 fa6e0e48 2019-05-23 stsp In a work tree or a git repository directory, create a new branch called
824 e70c17ce 2019-05-22 stsp .Dq unified-buffer-cache
825 d83d9d5c 2019-05-13 stsp which is forked off the
826 d83d9d5c 2019-05-13 stsp .Dq master
827 d83d9d5c 2019-05-13 stsp branch:
828 d83d9d5c 2019-05-13 stsp .Pp
829 4e759de4 2019-06-26 stsp .Dl $ got branch unified-buffer-cache master
830 e70c17ce 2019-05-22 stsp .Pp
831 e70c17ce 2019-05-22 stsp Switch an existing work tree to the branch
832 e70c17ce 2019-05-22 stsp .Dq unified-buffer-cache .
833 e70c17ce 2019-05-22 stsp Local changes in the work tree will be preserved and merged if necessary:
834 e70c17ce 2019-05-22 stsp .Pp
835 e70c17ce 2019-05-22 stsp .Dl $ got update -b unified-buffer-cache
836 e70c17ce 2019-05-22 stsp .Pp
837 fa6e0e48 2019-05-23 stsp Create a new commit from local changes in a work tree directory.
838 fa6e0e48 2019-05-23 stsp This new commit will become the head commit of the work tree's current branch:
839 fa6e0e48 2019-05-23 stsp .Pp
840 fa6e0e48 2019-05-23 stsp .Dl $ got commit
841 fa6e0e48 2019-05-23 stsp .Pp
842 fa6e0e48 2019-05-23 stsp In a work tree or a git repository directory, view changes committed in
843 fa6e0e48 2019-05-23 stsp the 3 most recent commits to the work tree's branch, or the branch resolved
844 fa6e0e48 2019-05-23 stsp via the repository's HEAD reference, respectively:
845 fa6e0e48 2019-05-23 stsp .Pp
846 cc54c501 2019-07-15 stsp .Dl $ got log -p -l 3 -f
847 fa6e0e48 2019-05-23 stsp .Pp
848 e70c17ce 2019-05-22 stsp Add new files and remove obsolete files in a work tree directory:
849 e70c17ce 2019-05-22 stsp .Pp
850 fa6e0e48 2019-05-23 stsp .Dl $ got add sys/uvm/uvm_ubc.c
851 86d25a1b 2019-07-11 stsp .Dl $ got remove sys/uvm/uvm_vnode.c
852 e70c17ce 2019-05-22 stsp .Pp
853 e70c17ce 2019-05-22 stsp Create a new commit from local changes in a work tree directory
854 e70c17ce 2019-05-22 stsp with a pre-defined log message.
855 e70c17ce 2019-05-22 stsp .Pp
856 e70c17ce 2019-05-22 stsp .Dl $ got commit -m 'unify the buffer cache'
857 95fc3404 2019-07-15 stsp .Pp
858 95fc3404 2019-07-15 stsp Update any work tree checked out from the
859 95fc3404 2019-07-15 stsp .Dq unified-buffer-cache
860 95fc3404 2019-07-15 stsp branch to the latest commit on this branch:
861 95fc3404 2019-07-15 stsp .Pp
862 95fc3404 2019-07-15 stsp .Dl $ got update
863 ac90e726 2019-07-15 stsp .Pp
864 c991308a 2019-07-15 stsp Roll file content on the unified-buffer-cache branch back by one commit,
865 c991308a 2019-07-15 stsp and then fetch the rolled-back change into the work tree as a local change
866 ac90e726 2019-07-15 stsp to be amended and perhaps committed again:
867 e70c17ce 2019-05-22 stsp .Pp
868 ac90e726 2019-07-15 stsp .Dl $ got backout unified-buffer-cache
869 ac90e726 2019-07-15 stsp .Dl $ got commit -m 'roll back previous'
870 59d52b88 2019-07-15 stsp .Dl $ # now back out the previous backout :-)
871 ac90e726 2019-07-15 stsp .Dl $ got backout unified-buffer-cache
872 ac90e726 2019-07-15 stsp .Pp
873 9221fb1e 2019-06-26 stsp Fetch new upstream commits into the local repository's master branch.
874 9221fb1e 2019-06-26 stsp This step currently requires
875 9221fb1e 2019-06-26 stsp .Xr git 1 :
876 fa6e0e48 2019-05-23 stsp .Pp
877 fa6e0e48 2019-05-23 stsp .Dl $ cd /var/git/src.git
878 fa6e0e48 2019-05-23 stsp .Dl $ git fetch origin master:master
879 fa6e0e48 2019-05-23 stsp .Pp
880 fa6e0e48 2019-05-23 stsp Rebase the
881 fa6e0e48 2019-05-23 stsp .Dq unified-buffer-cache
882 fa6e0e48 2019-05-23 stsp branch on top of the new head commit of the
883 fa6e0e48 2019-05-23 stsp .Dq master
884 fa6e0e48 2019-05-23 stsp branch.
885 fa6e0e48 2019-05-23 stsp .Pp
886 818c7501 2019-07-11 stsp .Dl $ got update -b master
887 818c7501 2019-07-11 stsp .Dl $ got rebase unified-buffer-cache
888 7d7ffedb 2019-07-14 stsp .Pp
889 7d7ffedb 2019-07-14 stsp Create a patch from all changes on the unified-buffer-cache branch.
890 7d7ffedb 2019-07-14 stsp The patch can be mailed out for review and applied to OpenBSD's CVS tree:
891 7d7ffedb 2019-07-14 stsp .Pp
892 7d7ffedb 2019-07-14 stsp .Dl $ got diff master unified-buffer-cache > /tmp/ubc.diff
893 7d7ffedb 2019-07-14 stsp .Pp
894 0ebf8283 2019-07-24 stsp Edit the entire commit history of the
895 0ebf8283 2019-07-24 stsp .Dq unified-buffer-cache
896 0ebf8283 2019-07-24 stsp branch:
897 0ebf8283 2019-07-24 stsp .Pp
898 0ebf8283 2019-07-24 stsp .Dl $ got update -b unified-buffer-cache
899 0ebf8283 2019-07-24 stsp .Dl $ got update -c master
900 0ebf8283 2019-07-24 stsp .Dl $ got histedit
901 0ebf8283 2019-07-24 stsp .Pp
902 5c860e29 2018-03-12 stsp .Sh SEE ALSO
903 2312fc47 2019-07-15 stsp .Xr tog 1 ,
904 2312fc47 2019-07-15 stsp .Xr git-repository 5 ,
905 285dc8a4 2018-03-13 stsp .Xr got-worktree 5
906 1a208aaf 2018-04-01 stsp .Sh AUTHORS
907 1a208aaf 2018-04-01 stsp .An Stefan Sperling Aq Mt stsp@openbsd.org
908 1a208aaf 2018-04-01 stsp .An Martin Pieuchot Aq Mt mpi@openbsd.org
909 72e28b48 2019-05-14 stsp .An joshua stein Aq Mt jcs@openbsd.org
910 fa6e0e48 2019-05-23 stsp .Sh CAVEATS
911 fa6e0e48 2019-05-23 stsp .Nm
912 fa6e0e48 2019-05-23 stsp is a work-in-progress and many commands remain to be implemented.
913 fa6e0e48 2019-05-23 stsp At present, the user has to fall back on
914 fa6e0e48 2019-05-23 stsp .Xr git 1
915 b48be8cf 2019-07-14 stsp to perform tasks related to repository administration and tasks
916 b48be8cf 2019-07-14 stsp which require a network connection.
917 fa6e0e48 2019-05-23 stsp .Pp
918 fa6e0e48 2019-05-23 stsp When working against a repository created with
919 fa6e0e48 2019-05-23 stsp .Dq git clone --bare ,
920 fa6e0e48 2019-05-23 stsp local commits to the
921 fa6e0e48 2019-05-23 stsp .Dq master
922 fa6e0e48 2019-05-23 stsp branch are discouraged, for now, if changes committed to the upstream
923 fa6e0e48 2019-05-23 stsp repository need to be tracked.
924 fa6e0e48 2019-05-23 stsp See the EXAMPLES section.
925 723bd6d4 2019-07-14 stsp Future built-in
926 723bd6d4 2019-07-14 stsp .Cm clone
927 723bd6d4 2019-07-14 stsp and
928 723bd6d4 2019-07-14 stsp .Cm fetch
929 723bd6d4 2019-07-14 stsp commands should alleviate this problem.