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