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