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 8e13c46f 2019-08-05 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 fef8a0d3 2019-08-04 stsp Display usage information and exit immediately.
57 53ccebc2 2019-07-30 stsp .It Fl V
58 53ccebc2 2019-07-30 stsp Display program version and exit immediately.
59 1b6b95a8 2018-03-12 stsp .El
60 1b6b95a8 2018-03-12 stsp .Pp
61 38e11793 2018-06-13 stsp The commands for
62 38e11793 2018-06-13 stsp .Nm
63 38e11793 2018-06-13 stsp are as follows:
64 0bb8a95e 2018-03-12 stsp .Bl -tag -width checkout
65 09ea71ba 2019-07-27 stsp .It Cm init Ar repository-path
66 2c7829a4 2019-06-17 stsp Create a new empty repository at the specified
67 09ea71ba 2019-07-27 stsp .Ar repository-path .
68 3ce1b845 2019-07-15 stsp .Pp
69 3ce1b845 2019-07-15 stsp After
70 3ce1b845 2019-07-15 stsp .Cm got init ,
71 3ce1b845 2019-07-15 stsp the
72 3ce1b845 2019-07-15 stsp .Cm got import
73 3ce1b845 2019-07-15 stsp command must be used to populate the empty repository before
74 3ce1b845 2019-07-15 stsp .Cm got checkout
75 3ce1b845 2019-07-15 stsp can be used.
76 bc26cce8 2019-08-04 stsp .It Cm in
77 bc26cce8 2019-08-04 stsp Short alias for
78 bc26cce8 2019-08-04 stsp .Cm init .
79 dfc23429 2019-08-11 stsp .It Cm import Oo Fl b Ar branch Oc Oo Fl m Ar message Oc Oo Fl r Ar repository-path Oc Oo Fl I Ar pattern Oc Ar directory
80 3ce1b845 2019-07-15 stsp Create an initial commit in a repository from the file hierarchy
81 3ce1b845 2019-07-15 stsp within the specified
82 3ce1b845 2019-07-15 stsp .Ar directory .
83 3ce1b845 2019-07-15 stsp The created commit will not have any parent commits, i.e. it will be a
84 3ce1b845 2019-07-15 stsp root commit.
85 3ce1b845 2019-07-15 stsp Also create a new reference which provides a branch name for the newly
86 3ce1b845 2019-07-15 stsp created commit.
87 21a44f98 2019-07-15 stsp Show the path of each imported file to indicate progress.
88 3ce1b845 2019-07-15 stsp .Pp
89 21a44f98 2019-07-15 stsp The
90 21a44f98 2019-07-15 stsp .Cm got import
91 21a44f98 2019-07-15 stsp command requires the
92 21a44f98 2019-07-15 stsp .Ev GOT_AUTHOR
93 21a44f98 2019-07-15 stsp environment variable to be set.
94 3ce1b845 2019-07-15 stsp .Pp
95 3ce1b845 2019-07-15 stsp The options for
96 3ce1b845 2019-07-15 stsp .Cm got import
97 3ce1b845 2019-07-15 stsp are as follows:
98 3ce1b845 2019-07-15 stsp .Bl -tag -width Ds
99 3ce1b845 2019-07-15 stsp .It Fl b Ar branch
100 3ce1b845 2019-07-15 stsp Create the specified
101 3ce1b845 2019-07-15 stsp .Ar branch
102 3ce1b845 2019-07-15 stsp instead of creating the default branch
103 3ce1b845 2019-07-15 stsp .Dq master .
104 3ce1b845 2019-07-15 stsp Use of this option is required if the
105 3ce1b845 2019-07-15 stsp .Dq master
106 3ce1b845 2019-07-15 stsp branch already exists.
107 3ce1b845 2019-07-15 stsp .It Fl m Ar message
108 3ce1b845 2019-07-15 stsp Use the specified log message when creating the new commit.
109 3ce1b845 2019-07-15 stsp Without the
110 3ce1b845 2019-07-15 stsp .Fl m
111 3ce1b845 2019-07-15 stsp option,
112 3ce1b845 2019-07-15 stsp .Cm got import
113 3ce1b845 2019-07-15 stsp opens a temporary file in an editor where a log message can be written.
114 3ce1b845 2019-07-15 stsp .It Fl r Ar repository-path
115 3ce1b845 2019-07-15 stsp Use the repository at the specified path.
116 3ce1b845 2019-07-15 stsp If not specified, assume the repository is located at or above the current
117 3ce1b845 2019-07-15 stsp working directory.
118 3ce1b845 2019-07-15 stsp .It Fl I Ar pattern
119 3ce1b845 2019-07-15 stsp Ignore files or directories with a name which matches the specified
120 3ce1b845 2019-07-15 stsp .Ar pattern .
121 3ce1b845 2019-07-15 stsp This option may be specified multiple times to build a list of ignore patterns.
122 3ce1b845 2019-07-15 stsp The
123 3ce1b845 2019-07-15 stsp .Ar pattern
124 3ce1b845 2019-07-15 stsp follows the globbing rules documented in
125 3ce1b845 2019-07-15 stsp .Xr glob 7 .
126 3ce1b845 2019-07-15 stsp .El
127 bc26cce8 2019-08-04 stsp .It Cm im
128 bc26cce8 2019-08-04 stsp Short alias for
129 bc26cce8 2019-08-04 stsp .Cm import .
130 dfc23429 2019-08-11 stsp .It Cm checkout Oo Fl b Ar branch Oc Oo Fl c Ar commit Oc Oo Fl p Ar path-prefix Oc Ar repository-path Op Ar work-tree-path
131 0bb8a95e 2018-03-12 stsp Copy files from a repository into a new work tree.
132 5d7c1dab 2018-04-01 stsp If the
133 5d7c1dab 2018-04-01 stsp .Ar work tree path
134 c844a238 2019-02-06 stsp is not specified, either use the last component of
135 5d7c1dab 2018-04-01 stsp .Ar repository path ,
136 5d7c1dab 2018-04-01 stsp or if a
137 5d7c1dab 2018-04-01 stsp .Ar path prefix
138 c844a238 2019-02-06 stsp was specified use the last component of
139 5d7c1dab 2018-04-01 stsp .Ar path prefix .
140 38e11793 2018-06-13 stsp .Pp
141 38e11793 2018-06-13 stsp The options for
142 38e11793 2018-06-13 stsp .Cm got checkout
143 38e11793 2018-06-13 stsp are as follows:
144 38e11793 2018-06-13 stsp .Bl -tag -width Ds
145 08573d5b 2019-05-14 stsp .It Fl b Ar branch
146 3c575567 2019-07-28 stsp Check out files from a commit on the specified
147 08573d5b 2019-05-14 stsp .Ar branch .
148 08573d5b 2019-05-14 stsp If this option is not specified, a branch resolved via the repository's HEAD
149 08573d5b 2019-05-14 stsp reference will be used.
150 8069f636 2019-01-12 stsp .It Fl c Ar commit
151 8069f636 2019-01-12 stsp Check out files from the specified
152 3c575567 2019-07-28 stsp .Ar commit
153 3c575567 2019-07-28 stsp on the selected branch.
154 30837e32 2019-07-25 stsp The expected argument is a commit ID SHA1 hash or an existing reference
155 303e2782 2019-08-09 stsp or tag name which will be resolved to a commit ID.
156 0e1b0230 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
157 0e1b0230 2019-07-07 stsp automatically, provided the abbreviation is unique.
158 08573d5b 2019-05-14 stsp If this option is not specified, the most recent commit on the selected
159 08573d5b 2019-05-14 stsp branch will be used.
160 38e11793 2018-06-13 stsp .It Fl p Ar path-prefix
161 38e11793 2018-06-13 stsp Restrict the work tree to a subset of the repository's tree hierarchy.
162 38e11793 2018-06-13 stsp Only files beneath the specified
163 38e11793 2018-06-13 stsp .Ar path-prefix
164 38e11793 2018-06-13 stsp will be checked out.
165 38e11793 2018-06-13 stsp .El
166 97b3a7be 2019-07-09 stsp .It Cm co
167 97b3a7be 2019-07-09 stsp Short alias for
168 97b3a7be 2019-07-09 stsp .Cm checkout .
169 dfc23429 2019-08-11 stsp .It Cm update Oo Fl b Ar branch Oc Oo Fl c Ar commit Oc Op Ar path ...
170 024e9686 2019-05-14 stsp Update an existing work tree to a different commit.
171 7f838b36 2019-02-08 stsp Show the status of each affected file, using the following status codes:
172 7f838b36 2019-02-08 stsp .Bl -column YXZ description
173 7f838b36 2019-02-08 stsp .It U Ta file was updated and contained no local changes
174 7f838b36 2019-02-08 stsp .It G Ta file was updated and local changes were merged cleanly
175 7f838b36 2019-02-08 stsp .It C Ta file was updated and conflicts occurred during merge
176 7f838b36 2019-02-08 stsp .It D Ta file was deleted
177 7f838b36 2019-02-08 stsp .It A Ta new file was added
178 1dd86744 2019-08-12 anthony .It \(a~ Ta versioned file is obstructed by a non-regular file
179 a378724f 2019-02-10 stsp .It ! Ta a missing versioned file was restored
180 7f838b36 2019-02-08 stsp .El
181 7f838b36 2019-02-08 stsp .Pp
182 f2ea84fa 2019-07-27 stsp If no
183 c4cdcb68 2019-04-03 stsp .Ar path
184 f2ea84fa 2019-07-27 stsp is specified, update the entire work tree.
185 f2ea84fa 2019-07-27 stsp Otherwise, restrict the update operation to files at or within the
186 f2ea84fa 2019-07-27 stsp specified paths.
187 f2ea84fa 2019-07-27 stsp Each path is required to exist in the update operation's target commit.
188 f2ea84fa 2019-07-27 stsp Files in the work tree outside specified paths will remain unchanged and
189 f2ea84fa 2019-07-27 stsp will retain their previously recorded base commit.
190 f2cf8fbb 2019-04-04 stsp Some
191 f2cf8fbb 2019-04-04 stsp .Nm
192 f2cf8fbb 2019-04-04 stsp commands may refuse to run while the work tree contains files from
193 c4cdcb68 2019-04-03 stsp multiple base commits.
194 f2cf8fbb 2019-04-04 stsp The base commit of such a work tree can be made consistent by running
195 47ec7be7 2019-05-12 stsp .Cm got update
196 47ec7be7 2019-05-12 stsp across the entire work tree.
197 024e9686 2019-05-14 stsp Specifying a
198 024e9686 2019-05-14 stsp .Ar path
199 024e9686 2019-05-14 stsp is incompatible with the
200 024e9686 2019-05-14 stsp .Fl b
201 024e9686 2019-05-14 stsp option.
202 7f838b36 2019-02-08 stsp .Pp
203 4ed9f614 2019-08-04 stsp .Cm got update
204 4ed9f614 2019-08-04 stsp cannot update paths with staged changes.
205 4ed9f614 2019-08-04 stsp If changes have been staged with
206 4ed9f614 2019-08-04 stsp .Cm got stage ,
207 4ed9f614 2019-08-04 stsp these changes must first be comitted with
208 4ed9f614 2019-08-04 stsp .Cm got commit
209 4ed9f614 2019-08-04 stsp or unstaged with
210 4ed9f614 2019-08-04 stsp .Cm got unstage .
211 4ed9f614 2019-08-04 stsp .Pp
212 507dc3bb 2018-12-29 stsp The options for
213 507dc3bb 2018-12-29 stsp .Cm got update
214 507dc3bb 2018-12-29 stsp are as follows:
215 507dc3bb 2018-12-29 stsp .Bl -tag -width Ds
216 024e9686 2019-05-14 stsp .It Fl b Ar branch
217 024e9686 2019-05-14 stsp Switch the work tree's branch reference to the specified
218 024e9686 2019-05-14 stsp .Ar branch
219 024e9686 2019-05-14 stsp before updating the work tree.
220 024e9686 2019-05-14 stsp This option requires that all paths in the work tree are updated.
221 507dc3bb 2018-12-29 stsp .It Fl c Ar commit
222 507dc3bb 2018-12-29 stsp Update the work tree to the specified
223 507dc3bb 2018-12-29 stsp .Ar commit .
224 30837e32 2019-07-25 stsp The expected argument is a commit ID SHA1 hash or an existing reference
225 303e2782 2019-08-09 stsp or tag name which will be resolved to a commit ID.
226 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
227 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
228 024e9686 2019-05-14 stsp If this option is not specified, the most recent commit on the work tree's
229 024e9686 2019-05-14 stsp branch will be used.
230 507dc3bb 2018-12-29 stsp .El
231 97b3a7be 2019-07-09 stsp .It Cm up
232 97b3a7be 2019-07-09 stsp Short alias for
233 97b3a7be 2019-07-09 stsp .Cm update .
234 dfc23429 2019-08-11 stsp .It Cm status Op Ar path ...
235 6cd959e6 2019-03-26 stsp Show the current modification status of files in a work tree,
236 6bad629b 2019-02-04 stsp using the following status codes:
237 6bad629b 2019-02-04 stsp .Bl -column YXZ description
238 6bad629b 2019-02-04 stsp .It M Ta modified file
239 079890a9 2019-03-26 stsp .It A Ta file scheduled for addition in next commit
240 079890a9 2019-03-26 stsp .It D Ta file scheduled for deletion in next commit
241 7154f6ce 2019-03-27 stsp .It C Ta modified or added file which contains merge conflicts
242 6bad629b 2019-02-04 stsp .It ! Ta versioned file was expected on disk but is missing
243 1dd86744 2019-08-12 anthony .It \(a~ Ta versioned file is obstructed by a non-regular file
244 6bad629b 2019-02-04 stsp .It ? Ta unversioned item not tracked by
245 6bad629b 2019-02-04 stsp .Nm
246 6bad629b 2019-02-04 stsp .El
247 6bad629b 2019-02-04 stsp .Pp
248 72ea6654 2019-07-27 stsp If no
249 927df6b7 2019-02-10 stsp .Ar path
250 72ea6654 2019-07-27 stsp is specified, show modifications in the entire work tree.
251 72ea6654 2019-07-27 stsp Otherwise, show modifications at or within the specified paths.
252 4ed9f614 2019-08-04 stsp .Pp
253 4ed9f614 2019-08-04 stsp If changes have been staged with
254 4ed9f614 2019-08-04 stsp .Cm got stage ,
255 4ed9f614 2019-08-04 stsp staged changes are shown in the second output column, using the following
256 4ed9f614 2019-08-04 stsp status codes:
257 4ed9f614 2019-08-04 stsp .Bl -column YXZ description
258 4ed9f614 2019-08-04 stsp .It M Ta file modification is staged
259 4ed9f614 2019-08-04 stsp .It A Ta file addition is staged
260 4ed9f614 2019-08-04 stsp .It D Ta file deletion is staged
261 4ed9f614 2019-08-04 stsp .El
262 4ed9f614 2019-08-04 stsp .Pp
263 95ac67f0 2019-08-08 stsp Changes created on top of staged changes are indicated in the first column:
264 4ed9f614 2019-08-04 stsp .Bl -column YXZ description
265 95ac67f0 2019-08-08 stsp .It MM Ta file was modified after earlier changes have been staged
266 95ac67f0 2019-08-08 stsp .It MA Ta file was modified after having been staged for addition
267 4ed9f614 2019-08-04 stsp .El
268 6841da00 2019-08-08 stsp .Pp
269 6841da00 2019-08-08 stsp For compatibility with
270 6841da00 2019-08-08 stsp .Xr cvs 1 ,
271 6841da00 2019-08-08 stsp .Cm got status
272 6841da00 2019-08-08 stsp parses
273 6841da00 2019-08-08 stsp .Pa .cvsignore
274 6841da00 2019-08-08 stsp files in each traversed directory and will not display unversioned files
275 6841da00 2019-08-08 stsp which match
276 6841da00 2019-08-08 stsp .Xr glob 7
277 6841da00 2019-08-08 stsp ignore patterns contained in
278 6841da00 2019-08-08 stsp .Pa .cvsignore
279 6841da00 2019-08-08 stsp files.
280 6841da00 2019-08-08 stsp Unlike
281 6841da00 2019-08-08 stsp .Xr cvs 1 ,
282 6841da00 2019-08-08 stsp .Cm got status
283 6841da00 2019-08-08 stsp only supports a single ignore pattern per line.
284 97b3a7be 2019-07-09 stsp .It Cm st
285 97b3a7be 2019-07-09 stsp Short alias for
286 97b3a7be 2019-07-09 stsp .Cm status .
287 dfc23429 2019-08-11 stsp .It Cm log Oo Fl c Ar commit Oc Oo Fl C Ar number Oc Oo Fl f Oc Oo Fl l Ar N Oc Oo Fl p Oc Oo Fl r Ar repository-path Oc Op Ar path
288 38e11793 2018-06-13 stsp Display history of a repository.
289 04ca23f4 2018-07-16 stsp If a
290 04ca23f4 2018-07-16 stsp .Ar path
291 04ca23f4 2018-07-16 stsp is specified, show only commits which modified this path.
292 38e11793 2018-06-13 stsp .Pp
293 38e11793 2018-06-13 stsp The options for
294 38e11793 2018-06-13 stsp .Cm got log
295 38e11793 2018-06-13 stsp are as follows:
296 38e11793 2018-06-13 stsp .Bl -tag -width Ds
297 38e11793 2018-06-13 stsp .It Fl c Ar commit
298 38e11793 2018-06-13 stsp Start traversing history at the specified
299 38e11793 2018-06-13 stsp .Ar commit .
300 30837e32 2019-07-25 stsp The expected argument is a commit ID SHA1 hash or an existing reference
301 303e2782 2019-08-09 stsp or tag name which will be resolved to a commit ID.
302 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
303 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
304 1cc14b9f 2019-05-14 stsp If this option is not specified, default to the work tree's current branch
305 1cc14b9f 2019-05-14 stsp if invoked in a work tree, or to the repository's HEAD reference.
306 c0cc5c62 2018-10-18 stsp .It Fl C Ar number
307 c0cc5c62 2018-10-18 stsp Set the number of context lines shown in diffs with
308 c0cc5c62 2018-10-18 stsp .Fl p .
309 c0cc5c62 2018-10-18 stsp By default, 3 lines of context are shown.
310 cc54c501 2019-07-15 stsp .It Fl f
311 cc54c501 2019-07-15 stsp Restrict history traversal to the first parent of each commit.
312 cc54c501 2019-07-15 stsp This shows the linear history of the current branch only.
313 cc54c501 2019-07-15 stsp Merge commits which affected the current branch will be shown but
314 cc54c501 2019-07-15 stsp individual commits which originated on other branches will be omitted.
315 6238ee32 2018-06-13 stsp .It Fl l Ar N
316 6238ee32 2018-06-13 stsp Limit history traversal to a given number of commits.
317 6238ee32 2018-06-13 stsp .It Fl p
318 6238ee32 2018-06-13 stsp Display the patch of modifications made in each commit.
319 04ca23f4 2018-07-16 stsp .It Fl r Ar repository-path
320 04ca23f4 2018-07-16 stsp Use the repository at the specified path.
321 04ca23f4 2018-07-16 stsp If not specified, assume the repository is located at or above the current
322 04ca23f4 2018-07-16 stsp working directory.
323 e9cf2e30 2019-02-05 stsp If this directory is a
324 e9cf2e30 2019-02-05 stsp .Nm
325 e9cf2e30 2019-02-05 stsp work tree, use the repository path associated with this work tree.
326 38e11793 2018-06-13 stsp .El
327 dfc23429 2019-08-11 stsp .It Cm diff Oo Fl C Ar number Oc Oo Fl r Ar repository-path Oc Oo Fl s Oc Op Ar object1 Ar object2 | Ar path
328 927df6b7 2019-02-10 stsp When invoked within a work tree with less than two arguments, display
329 927df6b7 2019-02-10 stsp uncommitted changes in the work tree.
330 927df6b7 2019-02-10 stsp If a
331 927df6b7 2019-02-10 stsp .Ar path
332 927df6b7 2019-02-10 stsp is specified, only show changes within this path.
333 927df6b7 2019-02-10 stsp .Pp
334 d24820bf 2019-08-11 stsp If two arguments are provided, treat each argument as a reference, a tag
335 d24820bf 2019-08-11 stsp name, or an object ID SHA1 hash, and display differences between the
336 d24820bf 2019-08-11 stsp corresponding objects.
337 3f8b7d6a 2018-04-01 stsp Both objects must be of the same type (blobs, trees, or commits).
338 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
339 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
340 c0cc5c62 2018-10-18 stsp .Pp
341 c0cc5c62 2018-10-18 stsp The options for
342 c0cc5c62 2018-10-18 stsp .Cm got diff
343 c0cc5c62 2018-10-18 stsp are as follows:
344 c0cc5c62 2018-10-18 stsp .Bl -tag -width Ds
345 c0cc5c62 2018-10-18 stsp .It Fl C Ar number
346 c0cc5c62 2018-10-18 stsp Set the number of context lines shown in the diff.
347 c0cc5c62 2018-10-18 stsp By default, 3 lines of context are shown.
348 b72f483a 2019-02-05 stsp .It Fl r Ar repository-path
349 b72f483a 2019-02-05 stsp Use the repository at the specified path.
350 b72f483a 2019-02-05 stsp If not specified, assume the repository is located at or above the current
351 b72f483a 2019-02-05 stsp working directory.
352 b72f483a 2019-02-05 stsp If this directory is a
353 b72f483a 2019-02-05 stsp .Nm
354 b72f483a 2019-02-05 stsp work tree, use the repository path associated with this work tree.
355 4ed9f614 2019-08-04 stsp .It Fl s
356 4ed9f614 2019-08-04 stsp Show changes staged with
357 4ed9f614 2019-08-04 stsp .Cm got stage
358 4ed9f614 2019-08-04 stsp instead of showing local changes.
359 4ed9f614 2019-08-04 stsp This option is only valid when
360 4ed9f614 2019-08-04 stsp .Cm got diff
361 4ed9f614 2019-08-04 stsp is invoked in a work tree.
362 c0cc5c62 2018-10-18 stsp .El
363 bc26cce8 2019-08-04 stsp .It Cm di
364 bc26cce8 2019-08-04 stsp Short alias for
365 bc26cce8 2019-08-04 stsp .Cm diff .
366 dfc23429 2019-08-11 stsp .It Cm blame Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Ar path
367 1ff8e573 2018-08-02 stsp Display line-by-line history of a file at the specified path.
368 1ff8e573 2018-08-02 stsp .Pp
369 1ff8e573 2018-08-02 stsp The options for
370 1ff8e573 2018-08-02 stsp .Cm got blame
371 1ff8e573 2018-08-02 stsp are as follows:
372 1ff8e573 2018-08-02 stsp .Bl -tag -width Ds
373 1ff8e573 2018-08-02 stsp .It Fl c Ar commit
374 1ff8e573 2018-08-02 stsp Start traversing history at the specified
375 1ff8e573 2018-08-02 stsp .Ar commit .
376 30837e32 2019-07-25 stsp The expected argument is a commit ID SHA1 hash or an existing reference
377 303e2782 2019-08-09 stsp or tag name which will be resolved to a commit ID.
378 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
379 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
380 1ff8e573 2018-08-02 stsp .It Fl r Ar repository-path
381 1ff8e573 2018-08-02 stsp Use the repository at the specified path.
382 1ff8e573 2018-08-02 stsp If not specified, assume the repository is located at or above the current
383 1ff8e573 2018-08-02 stsp working directory.
384 0c06baac 2019-02-05 stsp If this directory is a
385 0c06baac 2019-02-05 stsp .Nm
386 0c06baac 2019-02-05 stsp work tree, use the repository path associated with this work tree.
387 5c860e29 2018-03-12 stsp .El
388 bc26cce8 2019-08-04 stsp .It Cm bl
389 bc26cce8 2019-08-04 stsp Short alias for
390 bc26cce8 2019-08-04 stsp .Cm blame .
391 dfc23429 2019-08-11 stsp .It Cm tree Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Oo Fl i Oc Oo Fl R Oc Op Ar path
392 5de5890b 2018-10-18 stsp Display a listing of files and directories at the specified
393 5de5890b 2018-10-18 stsp directory path in the repository.
394 db0c2996 2019-02-10 stsp Entries shown in this listing may carry one of the following trailing
395 db0c2996 2019-02-10 stsp annotations:
396 db0c2996 2019-02-10 stsp .Bl -column YXZ description
397 848d6979 2019-08-12 stsp .It @ Ta entry is a symbolic link
398 db0c2996 2019-02-10 stsp .It / Ta entry is a directory
399 db0c2996 2019-02-10 stsp .It * Ta entry is an executable file
400 db0c2996 2019-02-10 stsp .El
401 db0c2996 2019-02-10 stsp .Pp
402 0c849583 2019-02-05 stsp If no
403 0c849583 2019-02-05 stsp .Ar path
404 0c849583 2019-02-05 stsp is specified, list the repository path corresponding to the current
405 0c849583 2019-02-05 stsp directory of the work tree, or the root directory of the repository
406 0c849583 2019-02-05 stsp if there is no work tree.
407 5de5890b 2018-10-18 stsp .Pp
408 5de5890b 2018-10-18 stsp The options for
409 5de5890b 2018-10-18 stsp .Cm got tree
410 5de5890b 2018-10-18 stsp are as follows:
411 5de5890b 2018-10-18 stsp .Bl -tag -width Ds
412 5de5890b 2018-10-18 stsp .It Fl c Ar commit
413 5de5890b 2018-10-18 stsp List files and directories as they appear in the specified
414 5de5890b 2018-10-18 stsp .Ar commit .
415 30837e32 2019-07-25 stsp The expected argument is a commit ID SHA1 hash or an existing reference
416 303e2782 2019-08-09 stsp or tag name which will be resolved to a commit ID.
417 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
418 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
419 5de5890b 2018-10-18 stsp .It Fl r Ar repository-path
420 5de5890b 2018-10-18 stsp Use the repository at the specified path.
421 5de5890b 2018-10-18 stsp If not specified, assume the repository is located at or above the current
422 5de5890b 2018-10-18 stsp working directory.
423 0c849583 2019-02-05 stsp If this directory is a
424 0c849583 2019-02-05 stsp .Nm
425 0c849583 2019-02-05 stsp work tree, use the repository path associated with this work tree.
426 5de5890b 2018-10-18 stsp .It Fl i
427 5de5890b 2018-10-18 stsp Show object IDs of files (blob objects) and directories (tree objects).
428 c1669e2e 2019-01-09 stsp .It Fl R
429 0c849583 2019-02-05 stsp Recurse into sub-directories in the repository.
430 d0eebce4 2019-03-11 stsp .El
431 bc26cce8 2019-08-04 stsp .It Cm tr
432 bc26cce8 2019-08-04 stsp Short alias for
433 bc26cce8 2019-08-04 stsp .Cm tree .
434 c55aa27e 2019-08-12 stsp .It Cm ref Oo Fl r Ar repository-path Oc Oo Fl l Oc Oo Fl d Ar name Oc Oo Fl s Oc Op Ar name Ar target
435 d0eebce4 2019-03-11 stsp Manage references in a repository.
436 d0eebce4 2019-03-11 stsp .Pp
437 d0eebce4 2019-03-11 stsp If no options are passed, expect two arguments and attempt to create,
438 d0eebce4 2019-03-11 stsp or update, the reference with the given
439 d0eebce4 2019-03-11 stsp .Ar name ,
440 d0eebce4 2019-03-11 stsp and make it point at the given
441 d83d9d5c 2019-05-13 stsp .Ar target .
442 a54b6686 2019-06-28 stsp The target may be an object ID SHA1 hash or an existing reference which
443 a54b6686 2019-06-28 stsp will be resolved to an object ID.
444 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
445 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
446 d0eebce4 2019-03-11 stsp .Pp
447 d0eebce4 2019-03-11 stsp The options for
448 d0eebce4 2019-03-11 stsp .Cm got ref
449 d0eebce4 2019-03-11 stsp are as follows:
450 d0eebce4 2019-03-11 stsp .Bl -tag -width Ds
451 d0eebce4 2019-03-11 stsp .It Fl r Ar repository-path
452 d0eebce4 2019-03-11 stsp Use the repository at the specified path.
453 d0eebce4 2019-03-11 stsp If not specified, assume the repository is located at or above the current
454 d0eebce4 2019-03-11 stsp working directory.
455 d0eebce4 2019-03-11 stsp If this directory is a
456 d0eebce4 2019-03-11 stsp .Nm
457 d0eebce4 2019-03-11 stsp work tree, use the repository path associated with this work tree.
458 d0eebce4 2019-03-11 stsp .It Fl l
459 d0eebce4 2019-03-11 stsp List all existing references in the repository.
460 d0eebce4 2019-03-11 stsp .It Fl d Ar name
461 d0eebce4 2019-03-11 stsp Delete the reference with the specified name from the repository.
462 d1c1ae5f 2019-08-12 stsp .It Fl s
463 d1c1ae5f 2019-08-12 stsp Create a symbolic reference pointing at the specified
464 d1c1ae5f 2019-08-12 stsp .Ar target ,
465 d1c1ae5f 2019-08-12 stsp which must be an existing reference.
466 d1c1ae5f 2019-08-12 stsp Care should be taken not to create loops between references when
467 d1c1ae5f 2019-08-12 stsp this option is used.
468 4e759de4 2019-06-26 stsp .El
469 dfc23429 2019-08-11 stsp .It Cm branch Oo Fl r Ar repository-path Oc Oo Fl l Oc Oo Fl d Ar name Oc Op Ar name Op Ar base-branch
470 4e759de4 2019-06-26 stsp Manage branches in a repository.
471 4e759de4 2019-06-26 stsp .Pp
472 4e759de4 2019-06-26 stsp Branches are managed via references which live in the
473 4e759de4 2019-06-26 stsp .Dq refs/heads/
474 4e759de4 2019-06-26 stsp reference namespace.
475 4e759de4 2019-06-26 stsp The
476 4e759de4 2019-06-26 stsp .Cm got branch
477 4e759de4 2019-06-26 stsp command operates on references in this namespace only.
478 4e759de4 2019-06-26 stsp .Pp
479 4e759de4 2019-06-26 stsp If no options are passed, expect one or two arguments and attempt to create
480 4e759de4 2019-06-26 stsp a branch with the given
481 4e759de4 2019-06-26 stsp .Ar name ,
482 4e759de4 2019-06-26 stsp and make it point at the given
483 4e759de4 2019-06-26 stsp .Ar base-branch .
484 4e759de4 2019-06-26 stsp If no
485 4e759de4 2019-06-26 stsp .Ar base-branch
486 4e759de4 2019-06-26 stsp is specified, default to the work tree's current branch if invoked in a
487 4e759de4 2019-06-26 stsp work tree, or to the repository's HEAD reference.
488 4e759de4 2019-06-26 stsp .Pp
489 4e759de4 2019-06-26 stsp The options for
490 4e759de4 2019-06-26 stsp .Cm got branch
491 4e759de4 2019-06-26 stsp are as follows:
492 4e759de4 2019-06-26 stsp .Bl -tag -width Ds
493 4e759de4 2019-06-26 stsp .It Fl r Ar repository-path
494 4e759de4 2019-06-26 stsp Use the repository at the specified path.
495 4e759de4 2019-06-26 stsp If not specified, assume the repository is located at or above the current
496 4e759de4 2019-06-26 stsp working directory.
497 4e759de4 2019-06-26 stsp If this directory is a
498 4e759de4 2019-06-26 stsp .Nm
499 4e759de4 2019-06-26 stsp work tree, use the repository path associated with this work tree.
500 4e759de4 2019-06-26 stsp .It Fl l
501 4e759de4 2019-06-26 stsp List all existing branches in the repository.
502 ba882ee3 2019-07-11 stsp If invoked in a work tree, the work tree's current branch is shown
503 ba882ee3 2019-07-11 stsp with one the following annotations:
504 ba882ee3 2019-07-11 stsp .Bl -column YXZ description
505 ba882ee3 2019-07-11 stsp .It * Ta work tree's base commit matches the branch tip
506 1dd86744 2019-08-12 anthony .It \(a~ Ta work tree's base commit is out-of-date
507 ba882ee3 2019-07-11 stsp .El
508 4e759de4 2019-06-26 stsp .It Fl d Ar name
509 4e759de4 2019-06-26 stsp Delete the branch with the specified name from the repository.
510 7acfb25b 2019-07-11 stsp Only the branch reference is deleted.
511 7acfb25b 2019-07-11 stsp Any commit, tree, and blob objects belonging to the branch
512 74d012d1 2019-07-11 stsp remain in the repository and may be removed separately with
513 ce33d90e 2019-07-14 stsp Git's garbage collector.
514 5de5890b 2018-10-18 stsp .El
515 97b3a7be 2019-07-09 stsp .It Cm br
516 97b3a7be 2019-07-09 stsp Short alias for
517 97b3a7be 2019-07-09 stsp .Cm branch .
518 fbb7e5c7 2019-05-11 stsp .It Cm add Ar file-path ...
519 8125ddca 2019-05-11 stsp Schedule unversioned files in a work tree for addition to the
520 d00136be 2019-03-26 stsp repository in the next commit.
521 648e4ef7 2019-07-09 stsp .It Cm remove Ar file-path ...
522 17ed4618 2019-06-02 stsp Remove versioned files from a work tree and schedule them for deletion
523 2ec1f75b 2019-03-26 stsp from the repository in the next commit.
524 2ec1f75b 2019-03-26 stsp .Pp
525 2ec1f75b 2019-03-26 stsp The options for
526 86d25a1b 2019-07-11 stsp .Cm got remove
527 2ec1f75b 2019-03-26 stsp are as follows:
528 2ec1f75b 2019-03-26 stsp .Bl -tag -width Ds
529 2ec1f75b 2019-03-26 stsp .It Fl f
530 17ed4618 2019-06-02 stsp Perform the operation even if a file contains uncommitted modifications.
531 d0eebce4 2019-03-11 stsp .El
532 648e4ef7 2019-07-09 stsp .It Cm rm
533 648e4ef7 2019-07-09 stsp Short alias for
534 648e4ef7 2019-07-09 stsp .Cm remove .
535 dfc23429 2019-08-11 stsp .It Cm revert Oo Fl p Oc Oo Fl F Ar response-script Oc Oo Fl R Oc Ar path ...
536 e20a8b6f 2019-06-04 stsp Revert any uncommited changes in files at the specified paths.
537 a129376b 2019-03-28 stsp File contents will be overwritten with those contained in the
538 1dd86744 2019-08-12 anthony work tree's base commit.
539 1dd86744 2019-08-12 anthony There is no way to bring discarded changes back after
540 a129376b 2019-03-28 stsp .Cm got revert !
541 a129376b 2019-03-28 stsp .Pp
542 e20a8b6f 2019-06-04 stsp If a file was added with
543 a129376b 2019-03-28 stsp .Cm got add
544 a129376b 2019-03-28 stsp it will become an unversioned file again.
545 e20a8b6f 2019-06-04 stsp If a file was deleted with
546 86d25a1b 2019-07-11 stsp .Cm got remove
547 a129376b 2019-03-28 stsp it will be restored.
548 0f6d7415 2019-08-08 stsp .Pp
549 0f6d7415 2019-08-08 stsp The options for
550 0f6d7415 2019-08-08 stsp .Cm got revert
551 0f6d7415 2019-08-08 stsp are as follows:
552 0f6d7415 2019-08-08 stsp .Bl -tag -width Ds
553 33aa809d 2019-08-08 stsp .It Fl p
554 33aa809d 2019-08-08 stsp Instead of reverting all changes in files, interactively select or reject
555 33aa809d 2019-08-08 stsp changes to revert based on
556 33aa809d 2019-08-08 stsp .Dq y
557 33aa809d 2019-08-08 stsp (revert change),
558 33aa809d 2019-08-08 stsp .Dq n
559 33aa809d 2019-08-08 stsp (keep change), and
560 33aa809d 2019-08-08 stsp .Dq q
561 33aa809d 2019-08-08 stsp (quit reverting this file) responses.
562 33aa809d 2019-08-08 stsp If a file is in modified status, individual patches derived from the
563 33aa809d 2019-08-08 stsp modified file content can be reverted.
564 33aa809d 2019-08-08 stsp Files in added or deleted status may only be reverted in their entirety.
565 33aa809d 2019-08-08 stsp .It Fl F Ar response-script
566 33aa809d 2019-08-08 stsp With the
567 33aa809d 2019-08-08 stsp .Fl p
568 33aa809d 2019-08-08 stsp option, read
569 33aa809d 2019-08-08 stsp .Dq y ,
570 33aa809d 2019-08-08 stsp .Dq n ,
571 33aa809d 2019-08-08 stsp and
572 33aa809d 2019-08-08 stsp .Dq q
573 33aa809d 2019-08-08 stsp responses line-by-line from the specified
574 33aa809d 2019-08-08 stsp .Ar response-script
575 33aa809d 2019-08-08 stsp file instead of prompting interactively.
576 0f6d7415 2019-08-08 stsp .It Fl R
577 0f6d7415 2019-08-08 stsp Permit recursion into directories.
578 0f6d7415 2019-08-08 stsp If this option is not specified,
579 0f6d7415 2019-08-08 stsp .Cm got revert
580 0f6d7415 2019-08-08 stsp will refuse to run if a specified
581 0f6d7415 2019-08-08 stsp .Ar path
582 0f6d7415 2019-08-08 stsp is a directory.
583 0f6d7415 2019-08-08 stsp .El
584 97b3a7be 2019-07-09 stsp .It Cm rv
585 97b3a7be 2019-07-09 stsp Short alias for
586 97b3a7be 2019-07-09 stsp .Cm revert .
587 dfc23429 2019-08-11 stsp .It Cm commit Oo Fl m Ar message Oc Op Ar path ...
588 4ed9f614 2019-08-04 stsp Create a new commit in the repository from changes in a work tree
589 15cd91f7 2019-05-12 stsp and use this commit as the new base commit for the work tree.
590 5c1e53bc 2019-07-28 stsp If no
591 90e8619e 2019-07-25 stsp .Ar path
592 4ed9f614 2019-08-04 stsp is specified, commit all changes in the work tree.
593 4ed9f614 2019-08-04 stsp Otherwise, commit changes at or within the specified paths.
594 15cd91f7 2019-05-12 stsp .Pp
595 4ed9f614 2019-08-04 stsp If changes have been explicitly staged for commit with
596 1dd86744 2019-08-12 anthony .Cm got stage ,
597 4ed9f614 2019-08-04 stsp only commit staged changes and reject any specified paths which
598 4ed9f614 2019-08-04 stsp have not been staged.
599 4ed9f614 2019-08-04 stsp .Pp
600 15cd91f7 2019-05-12 stsp Show the status of each affected file, using the following status codes:
601 15cd91f7 2019-05-12 stsp .Bl -column YXZ description
602 15cd91f7 2019-05-12 stsp .It M Ta modified file
603 15cd91f7 2019-05-12 stsp .It D Ta file was deleted
604 15cd91f7 2019-05-12 stsp .It A Ta new file was added
605 15cd91f7 2019-05-12 stsp .El
606 15cd91f7 2019-05-12 stsp .Pp
607 996d5ccd 2019-08-05 stsp Files which are not part of the new commit will retain their previously
608 996d5ccd 2019-08-05 stsp recorded base commit.
609 15cd91f7 2019-05-12 stsp Some
610 15cd91f7 2019-05-12 stsp .Nm
611 15cd91f7 2019-05-12 stsp commands may refuse to run while the work tree contains files from
612 15cd91f7 2019-05-12 stsp multiple base commits.
613 15cd91f7 2019-05-12 stsp The base commit of such a work tree can be made consistent by running
614 47ec7be7 2019-05-12 stsp .Cm got update
615 47ec7be7 2019-05-12 stsp across the entire work tree.
616 15cd91f7 2019-05-12 stsp .Pp
617 15cd91f7 2019-05-12 stsp The
618 15cd91f7 2019-05-12 stsp .Cm got commit
619 15cd91f7 2019-05-12 stsp command requires the
620 74416c47 2019-05-09 stsp .Ev GOT_AUTHOR
621 74416c47 2019-05-09 stsp environment variable to be set.
622 74416c47 2019-05-09 stsp .Pp
623 74416c47 2019-05-09 stsp The options for
624 74416c47 2019-05-09 stsp .Cm got commit
625 74416c47 2019-05-09 stsp are as follows:
626 74416c47 2019-05-09 stsp .Bl -tag -width Ds
627 74ff3f23 2019-07-07 stsp .It Fl m Ar message
628 74416c47 2019-05-09 stsp Use the specified log message when creating the new commit.
629 23594da9 2019-05-13 stsp Without the
630 23594da9 2019-05-13 stsp .Fl m
631 23594da9 2019-05-13 stsp option,
632 23594da9 2019-05-13 stsp .Cm got commit
633 23594da9 2019-05-13 stsp opens a temporary file in an editor where a log message can be written.
634 2ec1f75b 2019-03-26 stsp .El
635 cfce0458 2019-07-28 stsp .Pp
636 cfce0458 2019-07-28 stsp .Cm got commit
637 cfce0458 2019-07-28 stsp will refuse to run if certain preconditions are not met.
638 916f288c 2019-07-30 stsp If the work tree's current branch is not in the
639 916f288c 2019-07-30 stsp .Dq refs/heads/
640 916f288c 2019-07-30 stsp reference namespace, new commits may not be created on this branch.
641 cfce0458 2019-07-28 stsp Local changes may only be committed if they are based on file content
642 cfce0458 2019-07-28 stsp found in the most recent commit on the work tree's branch.
643 cfce0458 2019-07-28 stsp If a path is found to be out of date,
644 cfce0458 2019-07-28 stsp .Cm got update
645 cfce0458 2019-07-28 stsp must be used first in order to merge local changes with changes made
646 cfce0458 2019-07-28 stsp in the repository.
647 97b3a7be 2019-07-09 stsp .It Cm ci
648 97b3a7be 2019-07-09 stsp Short alias for
649 97b3a7be 2019-07-09 stsp .Cm commit .
650 234035bc 2019-06-01 stsp .It Cm cherrypick Ar commit
651 234035bc 2019-06-01 stsp Merge changes from a single
652 234035bc 2019-06-01 stsp .Ar commit
653 234035bc 2019-06-01 stsp into the work tree.
654 234035bc 2019-06-01 stsp The specified
655 234035bc 2019-06-01 stsp .Ar commit
656 234035bc 2019-06-01 stsp must be on a different branch than the work tree's base commit.
657 a54b6686 2019-06-28 stsp The expected argument is a reference or a commit ID SHA1 hash.
658 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
659 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
660 234035bc 2019-06-01 stsp .Pp
661 234035bc 2019-06-01 stsp Show the status of each affected file, using the following status codes:
662 234035bc 2019-06-01 stsp .Bl -column YXZ description
663 234035bc 2019-06-01 stsp .It G Ta file was merged
664 234035bc 2019-06-01 stsp .It C Ta file was merged and conflicts occurred during merge
665 234035bc 2019-06-01 stsp .It ! Ta changes destined for a missing file were not merged
666 234035bc 2019-06-01 stsp .It D Ta file was deleted
667 2b92fad7 2019-06-02 stsp .It d Ta file's deletion was obstructed by local modifications
668 234035bc 2019-06-01 stsp .It A Ta new file was added
669 1dd86744 2019-08-12 anthony .It \(a~ Ta changes destined for a non-regular file were not merged
670 74416c47 2019-05-09 stsp .El
671 234035bc 2019-06-01 stsp .Pp
672 234035bc 2019-06-01 stsp The merged changes will appear as local changes in the work tree, which
673 234035bc 2019-06-01 stsp may be viewed with
674 234035bc 2019-06-01 stsp .Cm got diff ,
675 234035bc 2019-06-01 stsp amended manually or with further
676 234035bc 2019-06-01 stsp .Cm got cherrypick
677 234035bc 2019-06-01 stsp comands,
678 234035bc 2019-06-01 stsp committed with
679 234035bc 2019-06-01 stsp .Cm got commit ,
680 234035bc 2019-06-01 stsp or discarded again with
681 234035bc 2019-06-01 stsp .Cm got revert .
682 234035bc 2019-06-01 stsp .Pp
683 234035bc 2019-06-01 stsp .Cm got cherrypick
684 234035bc 2019-06-01 stsp will refuse to run if certain preconditions are not met.
685 234035bc 2019-06-01 stsp If the work tree contains multiple base commits it must first be updated
686 234035bc 2019-06-01 stsp to a single base commit with
687 234035bc 2019-06-01 stsp .Cm got update .
688 234035bc 2019-06-01 stsp If the work tree already contains files with merge conflicts, these
689 234035bc 2019-06-01 stsp conflicts must be resolved first.
690 016477fd 2019-07-09 stsp .It Cm cy
691 97b3a7be 2019-07-09 stsp Short alias for
692 97b3a7be 2019-07-09 stsp .Cm cherrypick .
693 5ef14e63 2019-06-02 stsp .It Cm backout Ar commit
694 5ef14e63 2019-06-02 stsp Reverse-merge changes from a single
695 5ef14e63 2019-06-02 stsp .Ar commit
696 5ef14e63 2019-06-02 stsp into the work tree.
697 5ef14e63 2019-06-02 stsp The specified
698 5ef14e63 2019-06-02 stsp .Ar commit
699 5ef14e63 2019-06-02 stsp must be on the same branch as the work tree's base commit.
700 a54b6686 2019-06-28 stsp The expected argument is a reference or a commit ID SHA1 hash.
701 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
702 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
703 5ef14e63 2019-06-02 stsp .Pp
704 5ef14e63 2019-06-02 stsp Show the status of each affected file, using the following status codes:
705 5ef14e63 2019-06-02 stsp .Bl -column YXZ description
706 5ef14e63 2019-06-02 stsp .It G Ta file was merged
707 5ef14e63 2019-06-02 stsp .It C Ta file was merged and conflicts occurred during merge
708 5ef14e63 2019-06-02 stsp .It ! Ta changes destined for a missing file were not merged
709 5ef14e63 2019-06-02 stsp .It D Ta file was deleted
710 5ef14e63 2019-06-02 stsp .It d Ta file's deletion was obstructed by local modifications
711 5ef14e63 2019-06-02 stsp .It A Ta new file was added
712 1dd86744 2019-08-12 anthony .It \(a~ Ta changes destined for a non-regular file were not merged
713 234035bc 2019-06-01 stsp .El
714 5ef14e63 2019-06-02 stsp .Pp
715 5ef14e63 2019-06-02 stsp The reverse-merged changes will appear as local changes in the work tree,
716 5ef14e63 2019-06-02 stsp which may be viewed with
717 5ef14e63 2019-06-02 stsp .Cm got diff ,
718 5ef14e63 2019-06-02 stsp amended manually or with further
719 778a73c2 2019-07-12 stsp .Cm got backout
720 5ef14e63 2019-06-02 stsp comands,
721 5ef14e63 2019-06-02 stsp committed with
722 5ef14e63 2019-06-02 stsp .Cm got commit ,
723 5ef14e63 2019-06-02 stsp or discarded again with
724 5ef14e63 2019-06-02 stsp .Cm got revert .
725 5ef14e63 2019-06-02 stsp .Pp
726 92228c38 2019-06-02 stsp .Cm got backout
727 92228c38 2019-06-02 stsp will refuse to run if certain preconditions are not met.
728 92228c38 2019-06-02 stsp If the work tree contains multiple base commits it must first be updated
729 92228c38 2019-06-02 stsp to a single base commit with
730 92228c38 2019-06-02 stsp .Cm got update .
731 92228c38 2019-06-02 stsp If the work tree already contains files with merge conflicts, these
732 92228c38 2019-06-02 stsp conflicts must be resolved first.
733 97b3a7be 2019-07-09 stsp .It Cm bo
734 97b3a7be 2019-07-09 stsp Short alias for
735 97b3a7be 2019-07-09 stsp .Cm backout .
736 dfc23429 2019-08-11 stsp .It Cm rebase Oo Fl a Oc Oo Fl c Oc Op Ar branch
737 818c7501 2019-07-11 stsp Rebase commits on the specified
738 818c7501 2019-07-11 stsp .Ar branch
739 818c7501 2019-07-11 stsp onto the tip of the current branch of the work tree.
740 818c7501 2019-07-11 stsp The
741 818c7501 2019-07-11 stsp .Ar branch
742 818c7501 2019-07-11 stsp must share common ancestry with the work tree's current branch.
743 f09e2405 2019-07-11 stsp Rebasing begins with the first descendent commit of the youngest
744 f09e2405 2019-07-11 stsp common ancestor commit shared by the specified
745 818c7501 2019-07-11 stsp .Ar branch
746 818c7501 2019-07-11 stsp and the work tree's current branch, and stops once the tip commit
747 f09e2405 2019-07-11 stsp of the specified
748 818c7501 2019-07-11 stsp .Ar branch
749 f09e2405 2019-07-11 stsp has been rebased.
750 818c7501 2019-07-11 stsp .Pp
751 c6b4581b 2019-07-28 stsp Rebased commits are accumulated on a temporary branch which the work tree
752 c6b4581b 2019-07-28 stsp will remain switched to throughout the entire rebase operation.
753 c6b4581b 2019-07-28 stsp Commits on this branch represent the same changes with the same log
754 c6b4581b 2019-07-28 stsp messages as their counterparts on the original
755 818c7501 2019-07-11 stsp .Ar branch ,
756 818c7501 2019-07-11 stsp but with different commit IDs.
757 818c7501 2019-07-11 stsp Once rebasing has completed successfully, the temporary branch becomes
758 f09e2405 2019-07-11 stsp the new version of the specified
759 818c7501 2019-07-11 stsp .Ar branch
760 818c7501 2019-07-11 stsp and the work tree is automatically switched to it.
761 818c7501 2019-07-11 stsp .Pp
762 818c7501 2019-07-11 stsp While rebasing commits, show the status of each affected file,
763 818c7501 2019-07-11 stsp using the following status codes:
764 818c7501 2019-07-11 stsp .Bl -column YXZ description
765 818c7501 2019-07-11 stsp .It G Ta file was merged
766 818c7501 2019-07-11 stsp .It C Ta file was merged and conflicts occurred during merge
767 818c7501 2019-07-11 stsp .It ! Ta changes destined for a missing file were not merged
768 818c7501 2019-07-11 stsp .It D Ta file was deleted
769 818c7501 2019-07-11 stsp .It d Ta file's deletion was obstructed by local modifications
770 818c7501 2019-07-11 stsp .It A Ta new file was added
771 1dd86744 2019-08-12 anthony .It \(a~ Ta changes destined for a non-regular file were not merged
772 5ef14e63 2019-06-02 stsp .El
773 818c7501 2019-07-11 stsp .Pp
774 f09e2405 2019-07-11 stsp If merge conflicts occur the rebase operation is interrupted and may
775 f09e2405 2019-07-11 stsp be continued once conflicts have been resolved.
776 818c7501 2019-07-11 stsp Alternatively, the rebase operation may be aborted which will leave
777 818c7501 2019-07-11 stsp .Ar branch
778 818c7501 2019-07-11 stsp unmodified and the work tree switched back to its original branch.
779 818c7501 2019-07-11 stsp .Pp
780 ff0d2220 2019-07-11 stsp If a merge conflict is resolved in a way which renders the merged
781 f09e2405 2019-07-11 stsp change into a no-op change, the corresponding commit will be elided
782 f09e2405 2019-07-11 stsp when the rebase operation continues.
783 ff0d2220 2019-07-11 stsp .Pp
784 818c7501 2019-07-11 stsp .Cm got rebase
785 818c7501 2019-07-11 stsp will refuse to run if certain preconditions are not met.
786 818c7501 2019-07-11 stsp If the work tree contains multiple base commits it must first be updated
787 818c7501 2019-07-11 stsp to a single base commit with
788 818c7501 2019-07-11 stsp .Cm got update .
789 4ed9f614 2019-08-04 stsp If changes have been staged with
790 4ed9f614 2019-08-04 stsp .Cm got stage ,
791 4ed9f614 2019-08-04 stsp these changes must first be comitted with
792 4ed9f614 2019-08-04 stsp .Cm got commit
793 4ed9f614 2019-08-04 stsp or unstaged with
794 4ed9f614 2019-08-04 stsp .Cm got unstage .
795 f09e2405 2019-07-11 stsp If the work tree contains local changes, these changes must first be
796 f09e2405 2019-07-11 stsp committed with
797 f09e2405 2019-07-11 stsp .Cm got commit
798 f09e2405 2019-07-11 stsp or reverted with
799 f09e2405 2019-07-11 stsp .Cm got revert .
800 64c6d990 2019-07-11 stsp If the
801 64c6d990 2019-07-11 stsp .Ar branch
802 64c6d990 2019-07-11 stsp contains changes to files outside of the work tree's path prefix,
803 64c6d990 2019-07-11 stsp the work tree cannot be used to rebase this branch.
804 818c7501 2019-07-11 stsp .Pp
805 7d5807f4 2019-07-11 stsp The
806 7d5807f4 2019-07-11 stsp .Cm got update
807 7d5807f4 2019-07-11 stsp and
808 7d5807f4 2019-07-11 stsp .Cm got commit
809 7d5807f4 2019-07-11 stsp commands will refuse to run while a rebase operation is in progress.
810 7d5807f4 2019-07-11 stsp Other commands which manipulate the work tree may be used for
811 7d5807f4 2019-07-11 stsp conflict resolution purposes.
812 818c7501 2019-07-11 stsp .Pp
813 818c7501 2019-07-11 stsp The options for
814 818c7501 2019-07-11 stsp .Cm got rebase
815 818c7501 2019-07-11 stsp are as follows:
816 818c7501 2019-07-11 stsp .Bl -tag -width Ds
817 818c7501 2019-07-11 stsp .It Fl a
818 818c7501 2019-07-11 stsp Abort an interrupted rebase operation.
819 c478f6d8 2019-08-08 stsp If this option is used, no other command-line arguments are allowed.
820 818c7501 2019-07-11 stsp .It Fl c
821 06067b48 2019-07-11 stsp Continue an interrupted rebase operation.
822 c478f6d8 2019-08-08 stsp If this option is used, no other command-line arguments are allowed.
823 818c7501 2019-07-11 stsp .El
824 818c7501 2019-07-11 stsp .It Cm rb
825 818c7501 2019-07-11 stsp Short alias for
826 818c7501 2019-07-11 stsp .Cm rebase .
827 dfc23429 2019-08-11 stsp .It Cm histedit Oo Fl a Oc Oo Fl c Oc Op Fl F Ar histedit-script
828 0ebf8283 2019-07-24 stsp Edit commit history between the work tree's current base commit and
829 0ebf8283 2019-07-24 stsp the tip commit of the work tree's current branch.
830 0ebf8283 2019-07-24 stsp .Pp
831 0ebf8283 2019-07-24 stsp Editing of commit history is controlled via a
832 0ebf8283 2019-07-24 stsp .Ar histedit script
833 0ebf8283 2019-07-24 stsp which can be edited interactively or passed on the command line.
834 0ebf8283 2019-07-24 stsp The format of the histedit script is line-based.
835 0ebf8283 2019-07-24 stsp Each line in the script begins with a command name, followed by
836 0ebf8283 2019-07-24 stsp whitespace and an argument.
837 0ebf8283 2019-07-24 stsp For most commands, the expected argument is a commit ID SHA1 hash.
838 0ebf8283 2019-07-24 stsp Any remaining text on the line is ignored.
839 0ebf8283 2019-07-24 stsp Lines which begin with the
840 0ebf8283 2019-07-24 stsp .Sq #
841 0ebf8283 2019-07-24 stsp character are ignored entirely.
842 0ebf8283 2019-07-24 stsp .Pp
843 0ebf8283 2019-07-24 stsp The available commands are as follows:
844 0ebf8283 2019-07-24 stsp .Bl -column YXZ pick-commit
845 0ebf8283 2019-07-24 stsp .It pick Ar commit Ta Use the specified commit as it is.
846 a698f62e 2019-07-25 stsp .It edit Ar commit Ta Use the specified commit but once changes have been
847 0ebf8283 2019-07-24 stsp merged into the work tree interrupt the histedit operation for amending.
848 0ebf8283 2019-07-24 stsp .It fold Ar commit Ta Combine the specified commit with the next commit
849 0ebf8283 2019-07-24 stsp listed further below that will be used.
850 0ebf8283 2019-07-24 stsp .It drop Ar commit Ta Remove this commit from the edited history.
851 0ebf8283 2019-07-24 stsp .It mesg Ar log-message Ta Use the specified single-line log message for
852 0ebf8283 2019-07-24 stsp the commit on the previous line.
853 0ebf8283 2019-07-24 stsp If the log message argument is left empty, open an editor where a new
854 0ebf8283 2019-07-24 stsp log message can be written.
855 0ebf8283 2019-07-24 stsp .El
856 0ebf8283 2019-07-24 stsp .Pp
857 ba67992e 2019-07-25 stsp Every commit in the history being edited must be mentioned in the script.
858 0ebf8283 2019-07-24 stsp Lines may be re-ordered to change the order of commits in the edited history.
859 0ebf8283 2019-07-24 stsp .Pp
860 c6b4581b 2019-07-28 stsp Edited commits are accumulated on a temporary branch which the work tree
861 c6b4581b 2019-07-28 stsp will remain switched to throughout the entire histedit operation.
862 0ebf8283 2019-07-24 stsp Once history editing has completed successfully, the temporary branch becomes
863 498a90b7 2019-07-25 stsp the new version of the work tree's branch and the work tree is automatically
864 498a90b7 2019-07-25 stsp switched to it.
865 0ebf8283 2019-07-24 stsp .Pp
866 0ebf8283 2019-07-24 stsp While merging commits, show the status of each affected file,
867 0ebf8283 2019-07-24 stsp using the following status codes:
868 0ebf8283 2019-07-24 stsp .Bl -column YXZ description
869 0ebf8283 2019-07-24 stsp .It G Ta file was merged
870 0ebf8283 2019-07-24 stsp .It C Ta file was merged and conflicts occurred during merge
871 0ebf8283 2019-07-24 stsp .It ! Ta changes destined for a missing file were not merged
872 0ebf8283 2019-07-24 stsp .It D Ta file was deleted
873 0ebf8283 2019-07-24 stsp .It d Ta file's deletion was obstructed by local modifications
874 0ebf8283 2019-07-24 stsp .It A Ta new file was added
875 1dd86744 2019-08-12 anthony .It \(a~ Ta changes destined for a non-regular file were not merged
876 0ebf8283 2019-07-24 stsp .El
877 0ebf8283 2019-07-24 stsp .Pp
878 0ebf8283 2019-07-24 stsp If merge conflicts occur the histedit operation is interrupted and may
879 0ebf8283 2019-07-24 stsp be continued once conflicts have been resolved.
880 0ebf8283 2019-07-24 stsp Alternatively, the histedit operation may be aborted which will leave
881 0ebf8283 2019-07-24 stsp the work tree switched back to its original branch.
882 0ebf8283 2019-07-24 stsp .Pp
883 0ebf8283 2019-07-24 stsp If a merge conflict is resolved in a way which renders the merged
884 0ebf8283 2019-07-24 stsp change into a no-op change, the corresponding commit will be elided
885 0ebf8283 2019-07-24 stsp when the histedit operation continues.
886 0ebf8283 2019-07-24 stsp .Pp
887 0ebf8283 2019-07-24 stsp .Cm got histedit
888 0ebf8283 2019-07-24 stsp will refuse to run if certain preconditions are not met.
889 c7d20a3f 2019-07-30 stsp If the work tree's current branch is not in the
890 c7d20a3f 2019-07-30 stsp .Dq refs/heads/
891 c7d20a3f 2019-07-30 stsp reference namespace, the history of the branch may not be edited.
892 0ebf8283 2019-07-24 stsp If the work tree contains multiple base commits it must first be updated
893 0ebf8283 2019-07-24 stsp to a single base commit with
894 0ebf8283 2019-07-24 stsp .Cm got update .
895 4ed9f614 2019-08-04 stsp If changes have been staged with
896 4ed9f614 2019-08-04 stsp .Cm got stage ,
897 4ed9f614 2019-08-04 stsp these changes must first be comitted with
898 4ed9f614 2019-08-04 stsp .Cm got commit
899 4ed9f614 2019-08-04 stsp or unstaged with
900 4ed9f614 2019-08-04 stsp .Cm got unstage .
901 0ebf8283 2019-07-24 stsp If the work tree contains local changes, these changes must first be
902 0ebf8283 2019-07-24 stsp committed with
903 0ebf8283 2019-07-24 stsp .Cm got commit
904 0ebf8283 2019-07-24 stsp or reverted with
905 0ebf8283 2019-07-24 stsp .Cm got revert .
906 0ebf8283 2019-07-24 stsp If the edited history contains changes to files outside of the work tree's
907 0ebf8283 2019-07-24 stsp path prefix, the work tree cannot be used to edit the history of this branch.
908 0ebf8283 2019-07-24 stsp .Pp
909 0ebf8283 2019-07-24 stsp The
910 0ebf8283 2019-07-24 stsp .Cm got update
911 a698f62e 2019-07-25 stsp command will refuse to run while a histedit operation is in progress.
912 a698f62e 2019-07-25 stsp Other commands which manipulate the work tree may be used, and the
913 0ebf8283 2019-07-24 stsp .Cm got commit
914 a698f62e 2019-07-25 stsp command may be used to commit arbitrary changes to the temporary branch
915 a698f62e 2019-07-25 stsp while the histedit operation is interrupted.
916 0ebf8283 2019-07-24 stsp .Pp
917 0ebf8283 2019-07-24 stsp The options for
918 0ebf8283 2019-07-24 stsp .Cm got histedit
919 0ebf8283 2019-07-24 stsp are as follows:
920 0ebf8283 2019-07-24 stsp .Bl -tag -width Ds
921 0ebf8283 2019-07-24 stsp .It Fl a
922 0ebf8283 2019-07-24 stsp Abort an interrupted histedit operation.
923 c478f6d8 2019-08-08 stsp If this option is used, no other command-line arguments are allowed.
924 0ebf8283 2019-07-24 stsp .It Fl c
925 0ebf8283 2019-07-24 stsp Continue an interrupted histedit operation.
926 c478f6d8 2019-08-08 stsp If this option is used, no other command-line arguments are allowed.
927 818c7501 2019-07-11 stsp .El
928 0ebf8283 2019-07-24 stsp .It Cm he
929 0ebf8283 2019-07-24 stsp Short alias for
930 0ebf8283 2019-07-24 stsp .Cm histedit .
931 dfc23429 2019-08-11 stsp .It Cm stage Oo Fl l Oc Oo Fl p Oc Oo Fl F Ar response-script Oc Op Ar path ...
932 2db2652d 2019-08-07 stsp Stage local changes for inclusion in the next commit.
933 2db2652d 2019-08-07 stsp If no
934 2db2652d 2019-08-07 stsp .Ar path
935 2db2652d 2019-08-07 stsp is specified, stage all changes in the work tree.
936 2db2652d 2019-08-07 stsp Otherwise, stage changes at or within the specified paths.
937 4ed9f614 2019-08-04 stsp Paths may be staged if they are added, modified, or deleted according to
938 4ed9f614 2019-08-04 stsp .Cm got status .
939 4ed9f614 2019-08-04 stsp .Pp
940 9d8b19a4 2019-08-04 stsp Show the status of each affected file, using the following status codes:
941 9d8b19a4 2019-08-04 stsp .Bl -column YXZ description
942 9d8b19a4 2019-08-04 stsp .It A Ta file addition has been staged
943 9d8b19a4 2019-08-04 stsp .It M Ta file modification has been staged
944 9d8b19a4 2019-08-04 stsp .It D Ta file deletion has been staged
945 9d8b19a4 2019-08-04 stsp .El
946 9d8b19a4 2019-08-04 stsp .Pp
947 9d8b19a4 2019-08-04 stsp Staged file contents are saved in newly created blob objects in the repository.
948 52c8d4ac 2019-08-04 stsp These blobs will be referred to by tree objects once staged changes have been
949 9d8b19a4 2019-08-04 stsp committed.
950 9d8b19a4 2019-08-04 stsp .Pp
951 890ea719 2019-08-04 stsp Staged changes affect the behaviour of
952 4ed9f614 2019-08-04 stsp .Cm got commit ,
953 4ed9f614 2019-08-04 stsp .Cm got status ,
954 4ed9f614 2019-08-04 stsp and
955 4ed9f614 2019-08-04 stsp .Cm got diff .
956 4ed9f614 2019-08-04 stsp While paths with staged changes exist, the
957 4ed9f614 2019-08-04 stsp .Cm got commit
958 4ed9f614 2019-08-04 stsp command will refuse to commit any paths which do not have staged changes.
959 4ed9f614 2019-08-04 stsp Local changes created on top of staged changes can only be committed if
960 4ed9f614 2019-08-04 stsp the path is staged again, or if the staged changes are committed first.
961 4ed9f614 2019-08-04 stsp The
962 4ed9f614 2019-08-04 stsp .Cm got status
963 4ed9f614 2019-08-04 stsp command will show both local changes and staged changes.
964 4ed9f614 2019-08-04 stsp The
965 4ed9f614 2019-08-04 stsp .Cm got diff
966 ecf14362 2019-08-04 stsp command is able to display local changes relative to staged changes,
967 ecf14362 2019-08-04 stsp and to display staged changes relative to the repository.
968 4ed9f614 2019-08-04 stsp The
969 4ed9f614 2019-08-04 stsp .Cm got revert
970 4ed9f614 2019-08-04 stsp command cannot revert staged changes but may be used to revert
971 4f2494e6 2019-08-08 stsp local changes created on top of staged changes.
972 4ed9f614 2019-08-04 stsp .Pp
973 4ed9f614 2019-08-04 stsp The options for
974 4ed9f614 2019-08-04 stsp .Cm got stage
975 4ed9f614 2019-08-04 stsp are as follows:
976 4ed9f614 2019-08-04 stsp .Bl -tag -width Ds
977 4ed9f614 2019-08-04 stsp .It Fl l
978 4ed9f614 2019-08-04 stsp Instead of staging new changes, list paths which are already staged,
979 9d8b19a4 2019-08-04 stsp along with the IDs of staged blob objects and stage status codes.
980 9d8b19a4 2019-08-04 stsp If paths were provided in the command line show the staged paths
981 1dd86744 2019-08-12 anthony among the specified paths.
982 1dd86744 2019-08-12 anthony Otherwise, show all staged paths.
983 dc424a06 2019-08-07 stsp .It Fl p
984 dc424a06 2019-08-07 stsp Instead of staging the entire content of a changed file, interactively
985 dc424a06 2019-08-07 stsp select or reject changes for staging based on
986 dc424a06 2019-08-07 stsp .Dq y
987 6d23ec10 2019-08-08 stsp (stage change),
988 dc424a06 2019-08-07 stsp .Dq n
989 6d23ec10 2019-08-08 stsp (reject change), and
990 b353a198 2019-08-07 stsp .Dq q
991 6d23ec10 2019-08-08 stsp (quit staging this file) responses.
992 dc424a06 2019-08-07 stsp If a file is in modified status, individual patches derived from the
993 dc424a06 2019-08-07 stsp modified file content can be staged.
994 6d23ec10 2019-08-08 stsp Files in added or deleted status may only be staged or rejected in
995 6d23ec10 2019-08-08 stsp their entirety.
996 3a070a2b 2019-08-07 stsp .It Fl F Ar response-script
997 dc424a06 2019-08-07 stsp With the
998 dc424a06 2019-08-07 stsp .Fl p
999 3a070a2b 2019-08-07 stsp option, read
1000 3a070a2b 2019-08-07 stsp .Dq y ,
1001 3a070a2b 2019-08-07 stsp .Dq n ,
1002 3a070a2b 2019-08-07 stsp and
1003 3a070a2b 2019-08-07 stsp .Dq q
1004 0e2f5884 2019-08-07 stsp responses line-by-line from the specified
1005 0e2f5884 2019-08-07 stsp .Ar response-script
1006 0e2f5884 2019-08-07 stsp file instead of prompting interactively.
1007 4ed9f614 2019-08-04 stsp .El
1008 4ed9f614 2019-08-04 stsp .Pp
1009 4ed9f614 2019-08-04 stsp .Cm got stage
1010 4ed9f614 2019-08-04 stsp will refuse to run if certain preconditions are not met.
1011 4ed9f614 2019-08-04 stsp If a file contains merge conflicts, these conflicts must be resolved first.
1012 4ed9f614 2019-08-04 stsp If a file is found to be out of date relative to the head commit on the
1013 4ed9f614 2019-08-04 stsp work tree's current branch, the file must be updated with
1014 4ed9f614 2019-08-04 stsp .Cm got update
1015 4ed9f614 2019-08-04 stsp before it can be staged (however, this does not prevent the file from
1016 4ed9f614 2019-08-04 stsp becoming out-of-date at some point after having been staged).
1017 4ed9f614 2019-08-04 stsp .Pp
1018 4ed9f614 2019-08-04 stsp The
1019 4ed9f614 2019-08-04 stsp .Cm got update ,
1020 4ed9f614 2019-08-04 stsp .Cm got rebase ,
1021 4ed9f614 2019-08-04 stsp and
1022 4ed9f614 2019-08-04 stsp .Cm got histedit
1023 4ed9f614 2019-08-04 stsp commands will refuse to run while staged changes exist.
1024 4ed9f614 2019-08-04 stsp If staged changes cannot be committed because a staged path
1025 4ed9f614 2019-08-04 stsp is out of date, the path must be unstaged with
1026 4ed9f614 2019-08-04 stsp .Cm got unstage
1027 4ed9f614 2019-08-04 stsp before it can be updated with
1028 4ed9f614 2019-08-04 stsp .Cm got update ,
1029 4ed9f614 2019-08-04 stsp and may then be staged again if necessary.
1030 4ed9f614 2019-08-04 stsp .It Cm sg
1031 4ed9f614 2019-08-04 stsp Short alias for
1032 4ed9f614 2019-08-04 stsp .Cm stage .
1033 dfc23429 2019-08-11 stsp .It Cm unstage Oo Fl p Oc Oo Fl F Ar response-script Oc Op Ar path ...
1034 4ed9f614 2019-08-04 stsp Merge staged changes back into the work tree and put affected paths
1035 4ed9f614 2019-08-04 stsp back into non-staged status.
1036 4ed9f614 2019-08-04 stsp If no
1037 4ed9f614 2019-08-04 stsp .Ar path
1038 4ed9f614 2019-08-04 stsp is specified, unstage all staged changes across the entire work tree.
1039 2db2652d 2019-08-07 stsp Otherwise, unstage changes at or within the specified paths.
1040 4ed9f614 2019-08-04 stsp .Pp
1041 4ed9f614 2019-08-04 stsp Show the status of each affected file, using the following status codes:
1042 4ed9f614 2019-08-04 stsp .Bl -column YXZ description
1043 4ed9f614 2019-08-04 stsp .It G Ta file was unstaged
1044 4ed9f614 2019-08-04 stsp .It C Ta file was unstaged and conflicts occurred during merge
1045 4ed9f614 2019-08-04 stsp .It ! Ta changes destined for a missing file were not merged
1046 4ed9f614 2019-08-04 stsp .It D Ta file was staged as deleted and still is deleted
1047 4ed9f614 2019-08-04 stsp .It d Ta file's deletion was obstructed by local modifications
1048 1dd86744 2019-08-12 anthony .It \(a~ Ta changes destined for a non-regular file were not merged
1049 4ed9f614 2019-08-04 stsp .El
1050 2e1f37b0 2019-08-08 stsp .Pp
1051 2e1f37b0 2019-08-08 stsp The options for
1052 2e1f37b0 2019-08-08 stsp .Cm got unstage
1053 2e1f37b0 2019-08-08 stsp are as follows:
1054 2e1f37b0 2019-08-08 stsp .Bl -tag -width Ds
1055 2e1f37b0 2019-08-08 stsp .It Fl p
1056 2e1f37b0 2019-08-08 stsp Instead of unstaging the entire content of a changed file, interactively
1057 2e1f37b0 2019-08-08 stsp select or reject changes for unstaging based on
1058 2e1f37b0 2019-08-08 stsp .Dq y
1059 2e1f37b0 2019-08-08 stsp (unstage change),
1060 2e1f37b0 2019-08-08 stsp .Dq n
1061 2e1f37b0 2019-08-08 stsp (keep change staged), and
1062 2e1f37b0 2019-08-08 stsp .Dq q
1063 2e1f37b0 2019-08-08 stsp (quit unstaging this file) responses.
1064 2e1f37b0 2019-08-08 stsp If a file is staged in modified status, individual patches derived from the
1065 2e1f37b0 2019-08-08 stsp staged file content can be unstaged.
1066 2e1f37b0 2019-08-08 stsp Files staged in added or deleted status may only be unstaged in their entirety.
1067 2e1f37b0 2019-08-08 stsp .It Fl F Ar response-script
1068 2e1f37b0 2019-08-08 stsp With the
1069 2e1f37b0 2019-08-08 stsp .Fl p
1070 2e1f37b0 2019-08-08 stsp option, read
1071 2e1f37b0 2019-08-08 stsp .Dq y ,
1072 2e1f37b0 2019-08-08 stsp .Dq n ,
1073 2e1f37b0 2019-08-08 stsp and
1074 2e1f37b0 2019-08-08 stsp .Dq q
1075 2e1f37b0 2019-08-08 stsp responses line-by-line from the specified
1076 2e1f37b0 2019-08-08 stsp .Ar response-script
1077 2e1f37b0 2019-08-08 stsp file instead of prompting interactively.
1078 2e1f37b0 2019-08-08 stsp .El
1079 4ed9f614 2019-08-04 stsp .It Cm ug
1080 4ed9f614 2019-08-04 stsp Short alias for
1081 4ed9f614 2019-08-04 stsp .Cm unstage .
1082 4ed9f614 2019-08-04 stsp .El
1083 74416c47 2019-05-09 stsp .Sh ENVIRONMENT
1084 74416c47 2019-05-09 stsp .Bl -tag -width GOT_AUTHOR
1085 74416c47 2019-05-09 stsp .It Ev GOT_AUTHOR
1086 74416c47 2019-05-09 stsp The author's name and email address for
1087 21a44f98 2019-07-15 stsp .Cm got commit
1088 21a44f98 2019-07-15 stsp and
1089 21a44f98 2019-07-15 stsp .Cm got import ,
1090 74416c47 2019-05-09 stsp for example:
1091 0e444aba 2019-08-08 stsp .An Flan Hacker Aq Mt flan_hacker@openbsd.org .
1092 84792843 2019-08-09 stsp Because
1093 0e444aba 2019-08-08 stsp .Xr git 1
1094 84792843 2019-08-09 stsp may fail to parse commits without an email address in author data,
1095 0e444aba 2019-08-08 stsp .Nm
1096 84792843 2019-08-09 stsp attempts to reject
1097 0e444aba 2019-08-08 stsp .Ev GOT_AUTHOR
1098 84792843 2019-08-09 stsp environment variables with a missing email address.
1099 1dd86744 2019-08-12 anthony .It Ev VISUAL , EDITOR
1100 23594da9 2019-05-13 stsp The editor spawned by
1101 23594da9 2019-05-13 stsp .Cm got commit .
1102 74416c47 2019-05-09 stsp .El
1103 5c860e29 2018-03-12 stsp .Sh EXIT STATUS
1104 5c860e29 2018-03-12 stsp .Ex -std got
1105 97925469 2018-03-17 stsp .Sh EXAMPLES
1106 fa6e0e48 2019-05-23 stsp Clone an existing Git repository for use with
1107 fa6e0e48 2019-05-23 stsp .Nm .
1108 fa6e0e48 2019-05-23 stsp This step currently requires
1109 fa6e0e48 2019-05-23 stsp .Xr git 1 :
1110 d83d9d5c 2019-05-13 stsp .Pp
1111 fa6e0e48 2019-05-23 stsp .Dl $ cd /var/git/
1112 fa6e0e48 2019-05-23 stsp .Dl $ git clone --bare https://github.com/openbsd/src.git
1113 fa6e0e48 2019-05-23 stsp .Pp
1114 3ce1b845 2019-07-15 stsp Alternatively, for quick and dirty local testing of
1115 3ce1b845 2019-07-15 stsp .Nm
1116 3ce1b845 2019-07-15 stsp a new Git repository could be created and populated with files,
1117 3ce1b845 2019-07-15 stsp e.g. from a temporary CVS checkout located at
1118 3ce1b845 2019-07-15 stsp .Pa /tmp/src :
1119 fa6e0e48 2019-05-23 stsp .Pp
1120 3ce1b845 2019-07-15 stsp .Dl $ got init /var/git/src.git
1121 2930ef13 2019-07-15 stsp .Dl $ got import -r /var/git/src.git -I CVS -I obj /tmp/src
1122 3ce1b845 2019-07-15 stsp .Pp
1123 3ce1b845 2019-07-15 stsp Check out a work tree from the Git repository to /usr/src:
1124 3ce1b845 2019-07-15 stsp .Pp
1125 fa6e0e48 2019-05-23 stsp .Dl $ got checkout /var/git/src.git /usr/src
1126 fa6e0e48 2019-05-23 stsp .Pp
1127 e70c17ce 2019-05-22 stsp View local changes in a work tree directory:
1128 e70c17ce 2019-05-22 stsp .Pp
1129 e70c17ce 2019-05-22 stsp .Dl $ got status
1130 e70c17ce 2019-05-22 stsp .Dl $ got diff | less
1131 33aa809d 2019-08-08 stsp .Pp
1132 33aa809d 2019-08-08 stsp Interactively revert selected local changes in a work tree directory:
1133 e70c17ce 2019-05-22 stsp .Pp
1134 33aa809d 2019-08-08 stsp .Dl $ got revert -p -R\ .
1135 33aa809d 2019-08-08 stsp .Pp
1136 e70c17ce 2019-05-22 stsp In a work tree or a git repository directory, list all branch references:
1137 e70c17ce 2019-05-22 stsp .Pp
1138 4e759de4 2019-06-26 stsp .Dl $ got branch -l
1139 e70c17ce 2019-05-22 stsp .Pp
1140 fa6e0e48 2019-05-23 stsp In a work tree or a git repository directory, create a new branch called
1141 e70c17ce 2019-05-22 stsp .Dq unified-buffer-cache
1142 d83d9d5c 2019-05-13 stsp which is forked off the
1143 d83d9d5c 2019-05-13 stsp .Dq master
1144 d83d9d5c 2019-05-13 stsp branch:
1145 d83d9d5c 2019-05-13 stsp .Pp
1146 4e759de4 2019-06-26 stsp .Dl $ got branch unified-buffer-cache master
1147 e70c17ce 2019-05-22 stsp .Pp
1148 e70c17ce 2019-05-22 stsp Switch an existing work tree to the branch
1149 e70c17ce 2019-05-22 stsp .Dq unified-buffer-cache .
1150 e70c17ce 2019-05-22 stsp Local changes in the work tree will be preserved and merged if necessary:
1151 e70c17ce 2019-05-22 stsp .Pp
1152 e70c17ce 2019-05-22 stsp .Dl $ got update -b unified-buffer-cache
1153 e70c17ce 2019-05-22 stsp .Pp
1154 fa6e0e48 2019-05-23 stsp Create a new commit from local changes in a work tree directory.
1155 fa6e0e48 2019-05-23 stsp This new commit will become the head commit of the work tree's current branch:
1156 fa6e0e48 2019-05-23 stsp .Pp
1157 fa6e0e48 2019-05-23 stsp .Dl $ got commit
1158 fa6e0e48 2019-05-23 stsp .Pp
1159 fa6e0e48 2019-05-23 stsp In a work tree or a git repository directory, view changes committed in
1160 fa6e0e48 2019-05-23 stsp the 3 most recent commits to the work tree's branch, or the branch resolved
1161 fa6e0e48 2019-05-23 stsp via the repository's HEAD reference, respectively:
1162 fa6e0e48 2019-05-23 stsp .Pp
1163 cc54c501 2019-07-15 stsp .Dl $ got log -p -l 3 -f
1164 fa6e0e48 2019-05-23 stsp .Pp
1165 e70c17ce 2019-05-22 stsp Add new files and remove obsolete files in a work tree directory:
1166 e70c17ce 2019-05-22 stsp .Pp
1167 fa6e0e48 2019-05-23 stsp .Dl $ got add sys/uvm/uvm_ubc.c
1168 86d25a1b 2019-07-11 stsp .Dl $ got remove sys/uvm/uvm_vnode.c
1169 e70c17ce 2019-05-22 stsp .Pp
1170 e70c17ce 2019-05-22 stsp Create a new commit from local changes in a work tree directory
1171 e70c17ce 2019-05-22 stsp with a pre-defined log message.
1172 e70c17ce 2019-05-22 stsp .Pp
1173 e70c17ce 2019-05-22 stsp .Dl $ got commit -m 'unify the buffer cache'
1174 95fc3404 2019-07-15 stsp .Pp
1175 95fc3404 2019-07-15 stsp Update any work tree checked out from the
1176 95fc3404 2019-07-15 stsp .Dq unified-buffer-cache
1177 95fc3404 2019-07-15 stsp branch to the latest commit on this branch:
1178 95fc3404 2019-07-15 stsp .Pp
1179 95fc3404 2019-07-15 stsp .Dl $ got update
1180 ac90e726 2019-07-15 stsp .Pp
1181 c991308a 2019-07-15 stsp Roll file content on the unified-buffer-cache branch back by one commit,
1182 c991308a 2019-07-15 stsp and then fetch the rolled-back change into the work tree as a local change
1183 ac90e726 2019-07-15 stsp to be amended and perhaps committed again:
1184 e70c17ce 2019-05-22 stsp .Pp
1185 ac90e726 2019-07-15 stsp .Dl $ got backout unified-buffer-cache
1186 ac90e726 2019-07-15 stsp .Dl $ got commit -m 'roll back previous'
1187 59d52b88 2019-07-15 stsp .Dl $ # now back out the previous backout :-)
1188 ac90e726 2019-07-15 stsp .Dl $ got backout unified-buffer-cache
1189 ac90e726 2019-07-15 stsp .Pp
1190 9221fb1e 2019-06-26 stsp Fetch new upstream commits into the local repository's master branch.
1191 9221fb1e 2019-06-26 stsp This step currently requires
1192 9221fb1e 2019-06-26 stsp .Xr git 1 :
1193 fa6e0e48 2019-05-23 stsp .Pp
1194 fa6e0e48 2019-05-23 stsp .Dl $ cd /var/git/src.git
1195 fa6e0e48 2019-05-23 stsp .Dl $ git fetch origin master:master
1196 fa6e0e48 2019-05-23 stsp .Pp
1197 fa6e0e48 2019-05-23 stsp Rebase the
1198 fa6e0e48 2019-05-23 stsp .Dq unified-buffer-cache
1199 fa6e0e48 2019-05-23 stsp branch on top of the new head commit of the
1200 fa6e0e48 2019-05-23 stsp .Dq master
1201 fa6e0e48 2019-05-23 stsp branch.
1202 fa6e0e48 2019-05-23 stsp .Pp
1203 818c7501 2019-07-11 stsp .Dl $ got update -b master
1204 818c7501 2019-07-11 stsp .Dl $ got rebase unified-buffer-cache
1205 7d7ffedb 2019-07-14 stsp .Pp
1206 7d7ffedb 2019-07-14 stsp Create a patch from all changes on the unified-buffer-cache branch.
1207 1dd86744 2019-08-12 anthony The patch can be mailed out for review and applied to
1208 1dd86744 2019-08-12 anthony .Ox Ns 's
1209 1dd86744 2019-08-12 anthony CVS tree:
1210 7d7ffedb 2019-07-14 stsp .Pp
1211 7d7ffedb 2019-07-14 stsp .Dl $ got diff master unified-buffer-cache > /tmp/ubc.diff
1212 7d7ffedb 2019-07-14 stsp .Pp
1213 0ebf8283 2019-07-24 stsp Edit the entire commit history of the
1214 0ebf8283 2019-07-24 stsp .Dq unified-buffer-cache
1215 0ebf8283 2019-07-24 stsp branch:
1216 0ebf8283 2019-07-24 stsp .Pp
1217 0ebf8283 2019-07-24 stsp .Dl $ got update -b unified-buffer-cache
1218 0ebf8283 2019-07-24 stsp .Dl $ got update -c master
1219 0ebf8283 2019-07-24 stsp .Dl $ got histedit
1220 ff2cf171 2019-07-28 stsp .Pp
1221 7b3fde24 2019-07-28 stsp Additional steps are necessary if local changes need to be pushed back
1222 7b3fde24 2019-07-28 stsp to the remote repository, which currently requires
1223 7b3fde24 2019-07-28 stsp .Cm git fetch
1224 7b3fde24 2019-07-28 stsp and
1225 7b3fde24 2019-07-28 stsp .Cm git push .
1226 ff2cf171 2019-07-28 stsp Before working against existing branches in a repository cloned with
1227 ff2cf171 2019-07-28 stsp .Dq git clone --bare ,
1228 ff2cf171 2019-07-28 stsp a Git
1229 ff2cf171 2019-07-28 stsp .Dq refspec
1230 ff2cf171 2019-07-28 stsp must be configured to map all references in the remote repository
1231 ff2cf171 2019-07-28 stsp into the
1232 ff2cf171 2019-07-28 stsp .Dq refs/remotes
1233 ff2cf171 2019-07-28 stsp namespace of the local repository.
1234 ff2cf171 2019-07-28 stsp This can achieved by setting Git's
1235 ff2cf171 2019-07-28 stsp .Pa remote.origin.fetch
1236 ff2cf171 2019-07-28 stsp configuration variable to the value
1237 ff2cf171 2019-07-28 stsp .Dq +refs/heads/*:refs/remotes/origin/*
1238 ff2cf171 2019-07-28 stsp with the
1239 ff2cf171 2019-07-28 stsp .Cm git config
1240 ff2cf171 2019-07-28 stsp command:
1241 ff2cf171 2019-07-28 stsp .Pp
1242 ff2cf171 2019-07-28 stsp .Dl $ cd /var/git/repo
1243 ff2cf171 2019-07-28 stsp .Dl $ git config remote.origin.fetch '+refs/heads/*:refs/remotes/origin/*'
1244 ff2cf171 2019-07-28 stsp .Pp
1245 ff2cf171 2019-07-28 stsp Alternatively, the following
1246 ff2cf171 2019-07-28 stsp .Pa fetch
1247 ff2cf171 2019-07-28 stsp configuration item can be added manually to the Git repository's
1248 ff2cf171 2019-07-28 stsp .Pa config
1249 ff2cf171 2019-07-28 stsp file:
1250 0ebf8283 2019-07-24 stsp .Pp
1251 ff2cf171 2019-07-28 stsp .Dl [remote "origin"]
1252 ff2cf171 2019-07-28 stsp .Dl url = ...
1253 ff2cf171 2019-07-28 stsp .Dl fetch = +refs/heads/*:refs/remotes/origin/*
1254 ff2cf171 2019-07-28 stsp .Pp
1255 fe307c9b 2019-07-28 stsp This configuration leaves the local repository's
1256 ff2cf171 2019-07-28 stsp .Dq refs/heads
1257 ff2cf171 2019-07-28 stsp namespace free for use by local branches checked out with
1258 ff2cf171 2019-07-28 stsp .Cm got checkout
1259 ff2cf171 2019-07-28 stsp and, if needed, created with
1260 ff2cf171 2019-07-28 stsp .Cm got branch .
1261 ff2cf171 2019-07-28 stsp .Pp
1262 ff2cf171 2019-07-28 stsp Branches in the
1263 ff2cf171 2019-07-28 stsp .Dq remotes/origin
1264 ff2cf171 2019-07-28 stsp namespace can be updated with incoming changes from the remote
1265 ff2cf171 2019-07-28 stsp repository with
1266 ff2cf171 2019-07-28 stsp .Cm git fetch :
1267 ff2cf171 2019-07-28 stsp .Pp
1268 ff2cf171 2019-07-28 stsp .Dl $ cd /var/git/repo
1269 ff2cf171 2019-07-28 stsp .Dl $ git fetch
1270 ff2cf171 2019-07-28 stsp .Pp
1271 ff2cf171 2019-07-28 stsp Before outgoing changes on the local
1272 ff2cf171 2019-07-28 stsp .Dq master
1273 ff2cf171 2019-07-28 stsp branch can be pushed to the remote repository, the local
1274 ff2cf171 2019-07-28 stsp .Dq master
1275 ff2cf171 2019-07-28 stsp branch must be rebased onto the
1276 ff2cf171 2019-07-28 stsp .Dq origin/master
1277 ff2cf171 2019-07-28 stsp branch:
1278 ff2cf171 2019-07-28 stsp .Pp
1279 ff2cf171 2019-07-28 stsp .Dl $ got update -b origin/master
1280 ff2cf171 2019-07-28 stsp .Dl $ got rebase master
1281 ff2cf171 2019-07-28 stsp .Pp
1282 ff2cf171 2019-07-28 stsp Changes on the local
1283 ff2cf171 2019-07-28 stsp .Dq master
1284 ff2cf171 2019-07-28 stsp branch can then be pushed to the remote
1285 ff2cf171 2019-07-28 stsp repository with
1286 ff2cf171 2019-07-28 stsp .Cm git push :
1287 ff2cf171 2019-07-28 stsp .Pp
1288 ff2cf171 2019-07-28 stsp .Dl $ cd /var/git/repo
1289 ff2cf171 2019-07-28 stsp .Dl $ git push origin master
1290 5c860e29 2018-03-12 stsp .Sh SEE ALSO
1291 2312fc47 2019-07-15 stsp .Xr tog 1 ,
1292 2312fc47 2019-07-15 stsp .Xr git-repository 5 ,
1293 285dc8a4 2018-03-13 stsp .Xr got-worktree 5
1294 1a208aaf 2018-04-01 stsp .Sh AUTHORS
1295 1a208aaf 2018-04-01 stsp .An Stefan Sperling Aq Mt stsp@openbsd.org
1296 1a208aaf 2018-04-01 stsp .An Martin Pieuchot Aq Mt mpi@openbsd.org
1297 72e28b48 2019-05-14 stsp .An joshua stein Aq Mt jcs@openbsd.org
1298 fa6e0e48 2019-05-23 stsp .Sh CAVEATS
1299 fa6e0e48 2019-05-23 stsp .Nm
1300 fa6e0e48 2019-05-23 stsp is a work-in-progress and many commands remain to be implemented.
1301 fa6e0e48 2019-05-23 stsp At present, the user has to fall back on
1302 fa6e0e48 2019-05-23 stsp .Xr git 1
1303 ff2cf171 2019-07-28 stsp to perform many tasks, in particular tasks related to repository
1304 ff2cf171 2019-07-28 stsp administration and tasks which require a network connection.