Blame


1 5c860e29 2018-03-12 stsp .\"
2 5c860e29 2018-03-12 stsp .\" Copyright (c) 2017 Martin Pieuchot
3 5aa81393 2020-01-06 stsp .\" Copyright (c) 2018, 2019, 2020 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 bc3056e3 2019-08-18 stsp Global options must precede 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 83cd27f8 2020-01-13 stsp .It Fl V, -version
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 aba9c984 2019-09-08 stsp environment variable to be set,
94 aba9c984 2019-09-08 stsp unless Git's
95 aba9c984 2019-09-08 stsp .Dv user.name
96 aba9c984 2019-09-08 stsp and
97 709ae9eb 2019-09-08 stsp .Dv user.email
98 709ae9eb 2019-09-08 stsp configuration settings can be obtained from the repository's
99 aba9c984 2019-09-08 stsp .Pa .git/config
100 c9956ddf 2019-09-08 stsp file or from Git's global
101 c9956ddf 2019-09-08 stsp .Pa ~/.gitconfig
102 c9956ddf 2019-09-08 stsp configuration file.
103 3ce1b845 2019-07-15 stsp .Pp
104 3ce1b845 2019-07-15 stsp The options for
105 3ce1b845 2019-07-15 stsp .Cm got import
106 3ce1b845 2019-07-15 stsp are as follows:
107 3ce1b845 2019-07-15 stsp .Bl -tag -width Ds
108 3ce1b845 2019-07-15 stsp .It Fl b Ar branch
109 3ce1b845 2019-07-15 stsp Create the specified
110 3ce1b845 2019-07-15 stsp .Ar branch
111 3ce1b845 2019-07-15 stsp instead of creating the default branch
112 5d67f40d 2019-11-08 stsp .Dq main .
113 3ce1b845 2019-07-15 stsp Use of this option is required if the
114 5d67f40d 2019-11-08 stsp .Dq main
115 3ce1b845 2019-07-15 stsp branch already exists.
116 3ce1b845 2019-07-15 stsp .It Fl m Ar message
117 3ce1b845 2019-07-15 stsp Use the specified log message when creating the new commit.
118 3ce1b845 2019-07-15 stsp Without the
119 3ce1b845 2019-07-15 stsp .Fl m
120 3ce1b845 2019-07-15 stsp option,
121 3ce1b845 2019-07-15 stsp .Cm got import
122 3ce1b845 2019-07-15 stsp opens a temporary file in an editor where a log message can be written.
123 3ce1b845 2019-07-15 stsp .It Fl r Ar repository-path
124 3ce1b845 2019-07-15 stsp Use the repository at the specified path.
125 3ce1b845 2019-07-15 stsp If not specified, assume the repository is located at or above the current
126 3ce1b845 2019-07-15 stsp working directory.
127 3ce1b845 2019-07-15 stsp .It Fl I Ar pattern
128 3ce1b845 2019-07-15 stsp Ignore files or directories with a name which matches the specified
129 3ce1b845 2019-07-15 stsp .Ar pattern .
130 3ce1b845 2019-07-15 stsp This option may be specified multiple times to build a list of ignore patterns.
131 3ce1b845 2019-07-15 stsp The
132 3ce1b845 2019-07-15 stsp .Ar pattern
133 3ce1b845 2019-07-15 stsp follows the globbing rules documented in
134 3ce1b845 2019-07-15 stsp .Xr glob 7 .
135 3ce1b845 2019-07-15 stsp .El
136 bc26cce8 2019-08-04 stsp .It Cm im
137 bc26cce8 2019-08-04 stsp Short alias for
138 bc26cce8 2019-08-04 stsp .Cm import .
139 2ab43947 2020-03-18 stsp .It Cm clone Oo Fl q Oc Oo Fl v Oc Ar repository-URL Op Ar target-directory
140 2ab43947 2020-03-18 stsp Clone a Git repository at the specified
141 2ab43947 2020-03-18 stsp .Ar repository-URL
142 2ab43947 2020-03-18 stsp into the specified
143 2ab43947 2020-03-18 stsp .Ar target-directory .
144 2ab43947 2020-03-18 stsp If no
145 2ab43947 2020-03-18 stsp .Ar target-directory
146 2ab43947 2020-03-18 stsp is specified the directory name will be derived from the name of the
147 2ab43947 2020-03-18 stsp cloned repository.
148 2ab43947 2020-03-18 stsp .Cm got clone
149 2ab43947 2020-03-18 stsp will refuse to run if the
150 2ab43947 2020-03-18 stsp .Ar target-directory
151 2ab43947 2020-03-18 stsp already exists.
152 2ab43947 2020-03-18 stsp .Pp
153 2ab43947 2020-03-18 stsp The
154 2ab43947 2020-03-18 stsp .Ar repository-URL
155 2ab43947 2020-03-18 stsp specifies a protocol scheme, a server hostname, and a path to the repository
156 2ab43947 2020-03-18 stsp on the server:
157 2ab43947 2020-03-18 stsp .Lk scheme://hostname/path/to/repository
158 2ab43947 2020-03-18 stsp .Pp
159 2ab43947 2020-03-18 stsp The following protocol schemes are supported:
160 2ab43947 2020-03-18 stsp .Bl -tag -width git+ssh
161 2ab43947 2020-03-18 stsp .It git
162 2ab43947 2020-03-18 stsp The Git protocol as implemented by the
163 2ab43947 2020-03-18 stsp .Xr git-daemon 1
164 2ab43947 2020-03-18 stsp server.
165 2ab43947 2020-03-18 stsp This protocol is discouraged since it supports neither authentication nor
166 2ab43947 2020-03-18 stsp encryption.
167 2ab43947 2020-03-18 stsp .It git+ssh
168 2ab43947 2020-03-18 stsp The Git protocol wrapped in an authenticated and encrypted
169 2ab43947 2020-03-18 stsp .Xr ssh 1
170 2ab43947 2020-03-18 stsp tunnel.
171 2ab43947 2020-03-18 stsp With this protocol the hostname may contain an embedded username for
172 2ab43947 2020-03-18 stsp .Xr ssh 1
173 2ab43947 2020-03-18 stsp to use:
174 2ab43947 2020-03-18 stsp .Mt user@hostname
175 2ab43947 2020-03-18 stsp .It ssh
176 2ab43947 2020-03-18 stsp Short alias for git+ssh.
177 2ab43947 2020-03-18 stsp .El
178 2ab43947 2020-03-18 stsp .Pp
179 2ab43947 2020-03-18 stsp The options for
180 2ab43947 2020-03-18 stsp .Cm got clone
181 2ab43947 2020-03-18 stsp are as follows:
182 2ab43947 2020-03-18 stsp .Bl -tag -width Ds
183 2ab43947 2020-03-18 stsp .It Fl q
184 2ab43947 2020-03-18 stsp Suppress progress reporting output.
185 2ab43947 2020-03-18 stsp The same option will be passed to
186 2ab43947 2020-03-18 stsp .Xr ssh 1
187 2ab43947 2020-03-18 stsp if applicable.
188 2ab43947 2020-03-18 stsp .It Fl v
189 2ab43947 2020-03-18 stsp Increase the verbosity of progress reporting output.
190 2ab43947 2020-03-18 stsp The same option will be passed to
191 2ab43947 2020-03-18 stsp .Xr ssh 1
192 2ab43947 2020-03-18 stsp if applicable.
193 2ab43947 2020-03-18 stsp Multiple -v options increase the verbosity.
194 2ab43947 2020-03-18 stsp The maximum is 3.
195 2ab43947 2020-03-18 stsp .El
196 267fe567 2020-03-18 stsp .It Cm cl
197 267fe567 2020-03-18 stsp Short alias for
198 267fe567 2020-03-18 stsp .Cm clone .
199 74daf7cb 2020-01-27 stsp .It Cm checkout Oo Fl E Oc Oo Fl b Ar branch Oc Oo Fl c Ar commit Oc Oo Fl p Ar path-prefix Oc Ar repository-path Op Ar work-tree-path
200 0bb8a95e 2018-03-12 stsp Copy files from a repository into a new work tree.
201 bb51a5b4 2020-01-13 stsp Show the status of each affected file, using the following status codes:
202 bb51a5b4 2020-01-13 stsp .Bl -column YXZ description
203 bb51a5b4 2020-01-13 stsp .It A Ta new file was added
204 bb51a5b4 2020-01-13 stsp .It E Ta file already exists in work tree's meta-data
205 bb51a5b4 2020-01-13 stsp .El
206 bb51a5b4 2020-01-13 stsp .Pp
207 5d7c1dab 2018-04-01 stsp If the
208 5d7c1dab 2018-04-01 stsp .Ar work tree path
209 c844a238 2019-02-06 stsp is not specified, either use the last component of
210 5d7c1dab 2018-04-01 stsp .Ar repository path ,
211 5d7c1dab 2018-04-01 stsp or if a
212 5d7c1dab 2018-04-01 stsp .Ar path prefix
213 c844a238 2019-02-06 stsp was specified use the last component of
214 5d7c1dab 2018-04-01 stsp .Ar path prefix .
215 38e11793 2018-06-13 stsp .Pp
216 38e11793 2018-06-13 stsp The options for
217 38e11793 2018-06-13 stsp .Cm got checkout
218 38e11793 2018-06-13 stsp are as follows:
219 38e11793 2018-06-13 stsp .Bl -tag -width Ds
220 bb51a5b4 2020-01-13 stsp .It Fl E
221 bb51a5b4 2020-01-13 stsp Proceed with the checkout operation even if the directory at
222 bb51a5b4 2020-01-13 stsp .Ar work-tree-path
223 bb51a5b4 2020-01-13 stsp is not empty.
224 bb51a5b4 2020-01-13 stsp Existing files will be left intact.
225 08573d5b 2019-05-14 stsp .It Fl b Ar branch
226 3c575567 2019-07-28 stsp Check out files from a commit on the specified
227 08573d5b 2019-05-14 stsp .Ar branch .
228 08573d5b 2019-05-14 stsp If this option is not specified, a branch resolved via the repository's HEAD
229 08573d5b 2019-05-14 stsp reference will be used.
230 8069f636 2019-01-12 stsp .It Fl c Ar commit
231 8069f636 2019-01-12 stsp Check out files from the specified
232 3c575567 2019-07-28 stsp .Ar commit
233 3c575567 2019-07-28 stsp on the selected branch.
234 30837e32 2019-07-25 stsp The expected argument is a commit ID SHA1 hash or an existing reference
235 303e2782 2019-08-09 stsp or tag name which will be resolved to a commit ID.
236 0e1b0230 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
237 0e1b0230 2019-07-07 stsp automatically, provided the abbreviation is unique.
238 08573d5b 2019-05-14 stsp If this option is not specified, the most recent commit on the selected
239 08573d5b 2019-05-14 stsp branch will be used.
240 4b6c9460 2020-03-05 stsp .Pp
241 4b6c9460 2020-03-05 stsp If the specified
242 4b6c9460 2020-03-05 stsp .Ar commit
243 4b6c9460 2020-03-05 stsp is not contained in the selected branch, a different branch which contains
244 4b6c9460 2020-03-05 stsp this commit must be specified with the
245 4b6c9460 2020-03-05 stsp .Fl b
246 4b6c9460 2020-03-05 stsp option.
247 4b6c9460 2020-03-05 stsp If no such branch is known a new branch must be created for this
248 4b6c9460 2020-03-05 stsp commit with
249 4b6c9460 2020-03-05 stsp .Cm got branch
250 4b6c9460 2020-03-05 stsp before
251 4b6c9460 2020-03-05 stsp .Cm got checkout
252 4b6c9460 2020-03-05 stsp can be used.
253 4b6c9460 2020-03-05 stsp Checking out work trees with an unknown branch is intentionally not supported.
254 38e11793 2018-06-13 stsp .It Fl p Ar path-prefix
255 38e11793 2018-06-13 stsp Restrict the work tree to a subset of the repository's tree hierarchy.
256 38e11793 2018-06-13 stsp Only files beneath the specified
257 38e11793 2018-06-13 stsp .Ar path-prefix
258 38e11793 2018-06-13 stsp will be checked out.
259 38e11793 2018-06-13 stsp .El
260 97b3a7be 2019-07-09 stsp .It Cm co
261 97b3a7be 2019-07-09 stsp Short alias for
262 97b3a7be 2019-07-09 stsp .Cm checkout .
263 dfc23429 2019-08-11 stsp .It Cm update Oo Fl b Ar branch Oc Oo Fl c Ar commit Oc Op Ar path ...
264 024e9686 2019-05-14 stsp Update an existing work tree to a different commit.
265 7f838b36 2019-02-08 stsp Show the status of each affected file, using the following status codes:
266 7f838b36 2019-02-08 stsp .Bl -column YXZ description
267 7f838b36 2019-02-08 stsp .It U Ta file was updated and contained no local changes
268 7f838b36 2019-02-08 stsp .It G Ta file was updated and local changes were merged cleanly
269 7f838b36 2019-02-08 stsp .It C Ta file was updated and conflicts occurred during merge
270 7f838b36 2019-02-08 stsp .It D Ta file was deleted
271 7f838b36 2019-02-08 stsp .It A Ta new file was added
272 1dd86744 2019-08-12 anthony .It \(a~ Ta versioned file is obstructed by a non-regular file
273 a378724f 2019-02-10 stsp .It ! Ta a missing versioned file was restored
274 7f838b36 2019-02-08 stsp .El
275 7f838b36 2019-02-08 stsp .Pp
276 f2ea84fa 2019-07-27 stsp If no
277 c4cdcb68 2019-04-03 stsp .Ar path
278 f2ea84fa 2019-07-27 stsp is specified, update the entire work tree.
279 f2ea84fa 2019-07-27 stsp Otherwise, restrict the update operation to files at or within the
280 f2ea84fa 2019-07-27 stsp specified paths.
281 f2ea84fa 2019-07-27 stsp Each path is required to exist in the update operation's target commit.
282 f2ea84fa 2019-07-27 stsp Files in the work tree outside specified paths will remain unchanged and
283 f2ea84fa 2019-07-27 stsp will retain their previously recorded base commit.
284 f2cf8fbb 2019-04-04 stsp Some
285 f2cf8fbb 2019-04-04 stsp .Nm
286 f2cf8fbb 2019-04-04 stsp commands may refuse to run while the work tree contains files from
287 c4cdcb68 2019-04-03 stsp multiple base commits.
288 f2cf8fbb 2019-04-04 stsp The base commit of such a work tree can be made consistent by running
289 47ec7be7 2019-05-12 stsp .Cm got update
290 47ec7be7 2019-05-12 stsp across the entire work tree.
291 024e9686 2019-05-14 stsp Specifying a
292 024e9686 2019-05-14 stsp .Ar path
293 024e9686 2019-05-14 stsp is incompatible with the
294 024e9686 2019-05-14 stsp .Fl b
295 024e9686 2019-05-14 stsp option.
296 7f838b36 2019-02-08 stsp .Pp
297 4ed9f614 2019-08-04 stsp .Cm got update
298 4ed9f614 2019-08-04 stsp cannot update paths with staged changes.
299 4ed9f614 2019-08-04 stsp If changes have been staged with
300 4ed9f614 2019-08-04 stsp .Cm got stage ,
301 bc3056e3 2019-08-18 stsp these changes must first be committed with
302 4ed9f614 2019-08-04 stsp .Cm got commit
303 4ed9f614 2019-08-04 stsp or unstaged with
304 4ed9f614 2019-08-04 stsp .Cm got unstage .
305 4ed9f614 2019-08-04 stsp .Pp
306 507dc3bb 2018-12-29 stsp The options for
307 507dc3bb 2018-12-29 stsp .Cm got update
308 507dc3bb 2018-12-29 stsp are as follows:
309 507dc3bb 2018-12-29 stsp .Bl -tag -width Ds
310 024e9686 2019-05-14 stsp .It Fl b Ar branch
311 024e9686 2019-05-14 stsp Switch the work tree's branch reference to the specified
312 024e9686 2019-05-14 stsp .Ar branch
313 024e9686 2019-05-14 stsp before updating the work tree.
314 024e9686 2019-05-14 stsp This option requires that all paths in the work tree are updated.
315 507dc3bb 2018-12-29 stsp .It Fl c Ar commit
316 507dc3bb 2018-12-29 stsp Update the work tree to the specified
317 507dc3bb 2018-12-29 stsp .Ar commit .
318 30837e32 2019-07-25 stsp The expected argument is a commit ID SHA1 hash or an existing reference
319 303e2782 2019-08-09 stsp or tag name which will be resolved to a commit ID.
320 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
321 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
322 024e9686 2019-05-14 stsp If this option is not specified, the most recent commit on the work tree's
323 024e9686 2019-05-14 stsp branch will be used.
324 507dc3bb 2018-12-29 stsp .El
325 97b3a7be 2019-07-09 stsp .It Cm up
326 97b3a7be 2019-07-09 stsp Short alias for
327 97b3a7be 2019-07-09 stsp .Cm update .
328 dfc23429 2019-08-11 stsp .It Cm status Op Ar path ...
329 6cd959e6 2019-03-26 stsp Show the current modification status of files in a work tree,
330 6bad629b 2019-02-04 stsp using the following status codes:
331 6bad629b 2019-02-04 stsp .Bl -column YXZ description
332 6bad629b 2019-02-04 stsp .It M Ta modified file
333 079890a9 2019-03-26 stsp .It A Ta file scheduled for addition in next commit
334 079890a9 2019-03-26 stsp .It D Ta file scheduled for deletion in next commit
335 7154f6ce 2019-03-27 stsp .It C Ta modified or added file which contains merge conflicts
336 6bad629b 2019-02-04 stsp .It ! Ta versioned file was expected on disk but is missing
337 1dd86744 2019-08-12 anthony .It \(a~ Ta versioned file is obstructed by a non-regular file
338 6bad629b 2019-02-04 stsp .It ? Ta unversioned item not tracked by
339 6bad629b 2019-02-04 stsp .Nm
340 1ebedb77 2019-10-19 stsp .It m Ta modified file modes (executable bit only)
341 2a06fe5f 2019-08-24 stsp .It N Ta non-existent
342 2a06fe5f 2019-08-24 stsp .Ar path
343 2a06fe5f 2019-08-24 stsp specified on the command line
344 6bad629b 2019-02-04 stsp .El
345 6bad629b 2019-02-04 stsp .Pp
346 72ea6654 2019-07-27 stsp If no
347 927df6b7 2019-02-10 stsp .Ar path
348 72ea6654 2019-07-27 stsp is specified, show modifications in the entire work tree.
349 72ea6654 2019-07-27 stsp Otherwise, show modifications at or within the specified paths.
350 4ed9f614 2019-08-04 stsp .Pp
351 4ed9f614 2019-08-04 stsp If changes have been staged with
352 4ed9f614 2019-08-04 stsp .Cm got stage ,
353 4ed9f614 2019-08-04 stsp staged changes are shown in the second output column, using the following
354 4ed9f614 2019-08-04 stsp status codes:
355 4ed9f614 2019-08-04 stsp .Bl -column YXZ description
356 4ed9f614 2019-08-04 stsp .It M Ta file modification is staged
357 4ed9f614 2019-08-04 stsp .It A Ta file addition is staged
358 4ed9f614 2019-08-04 stsp .It D Ta file deletion is staged
359 4ed9f614 2019-08-04 stsp .El
360 4ed9f614 2019-08-04 stsp .Pp
361 95ac67f0 2019-08-08 stsp Changes created on top of staged changes are indicated in the first column:
362 4ed9f614 2019-08-04 stsp .Bl -column YXZ description
363 95ac67f0 2019-08-08 stsp .It MM Ta file was modified after earlier changes have been staged
364 95ac67f0 2019-08-08 stsp .It MA Ta file was modified after having been staged for addition
365 4ed9f614 2019-08-04 stsp .El
366 6841da00 2019-08-08 stsp .Pp
367 6841da00 2019-08-08 stsp For compatibility with
368 bd8de430 2019-10-04 stsp .Xr cvs 1
369 bd8de430 2019-10-04 stsp and
370 bd8de430 2019-10-04 stsp .Xr git 1 ,
371 6841da00 2019-08-08 stsp .Cm got status
372 bd8de430 2019-10-04 stsp reads
373 bd8de430 2019-10-04 stsp .Xr glob 7
374 bd8de430 2019-10-04 stsp patterns from
375 6841da00 2019-08-08 stsp .Pa .cvsignore
376 bd8de430 2019-10-04 stsp and
377 bd8de430 2019-10-04 stsp .Pa .gitignore
378 6841da00 2019-08-08 stsp files in each traversed directory and will not display unversioned files
379 bd8de430 2019-10-04 stsp which match these patterns.
380 bd8de430 2019-10-04 stsp As an extension to
381 6841da00 2019-08-08 stsp .Xr glob 7
382 bd8de430 2019-10-04 stsp matching rules,
383 bd8de430 2019-10-04 stsp .Cm got status
384 bd8de430 2019-10-04 stsp supports consecutive asterisks,
385 bd8de430 2019-10-04 stsp .Dq ** ,
386 bd8de430 2019-10-04 stsp which will match an arbitrary amount of directories.
387 6841da00 2019-08-08 stsp Unlike
388 6841da00 2019-08-08 stsp .Xr cvs 1 ,
389 6841da00 2019-08-08 stsp .Cm got status
390 6841da00 2019-08-08 stsp only supports a single ignore pattern per line.
391 bd8de430 2019-10-04 stsp Unlike
392 bd8de430 2019-10-04 stsp .Xr git 1 ,
393 bd8de430 2019-10-04 stsp .Cm got status
394 bd8de430 2019-10-04 stsp does not support negated ignore patterns prefixed with
395 bd8de430 2019-10-04 stsp .Dq \&! ,
396 bd8de430 2019-10-04 stsp and gives no special significance to the location of path component separators,
397 bd8de430 2019-10-04 stsp .Dq / ,
398 bd8de430 2019-10-04 stsp in a pattern.
399 97b3a7be 2019-07-09 stsp .It Cm st
400 97b3a7be 2019-07-09 stsp Short alias for
401 97b3a7be 2019-07-09 stsp .Cm status .
402 48c8c60d 2020-01-27 stsp .It Cm log Oo Fl b Oc Oo Fl c Ar commit Oc Oo Fl C Ar number Oc Oo Fl l Ar N Oc Oo Fl p Oc Oo Fl s Ar search-pattern Oc Oo Fl r Ar repository-path Oc Op Ar path
403 38e11793 2018-06-13 stsp Display history of a repository.
404 04ca23f4 2018-07-16 stsp If a
405 04ca23f4 2018-07-16 stsp .Ar path
406 04ca23f4 2018-07-16 stsp is specified, show only commits which modified this path.
407 dc990cbf 2020-02-22 stsp If invoked in a work tree, the
408 dc990cbf 2020-02-22 stsp .Ar path
409 dc990cbf 2020-02-22 stsp is interpreted relative to the current working directory,
410 dc990cbf 2020-02-22 stsp and the work tree's path prefix is implicitly prepended.
411 dc990cbf 2020-02-22 stsp Otherwise, the path is interpreted relative to the repository root.
412 38e11793 2018-06-13 stsp .Pp
413 38e11793 2018-06-13 stsp The options for
414 38e11793 2018-06-13 stsp .Cm got log
415 38e11793 2018-06-13 stsp are as follows:
416 38e11793 2018-06-13 stsp .Bl -tag -width Ds
417 48c8c60d 2020-01-27 stsp .It Fl b
418 1137e0ae 2020-01-27 stsp Display individual commits which were merged into the current branch
419 1137e0ae 2020-01-27 stsp from other branches.
420 48c8c60d 2020-01-27 stsp By default,
421 48c8c60d 2020-01-27 stsp .Cm got log
422 48c8c60d 2020-01-27 stsp shows the linear history of the current branch only.
423 38e11793 2018-06-13 stsp .It Fl c Ar commit
424 38e11793 2018-06-13 stsp Start traversing history at the specified
425 38e11793 2018-06-13 stsp .Ar commit .
426 30837e32 2019-07-25 stsp The expected argument is a commit ID SHA1 hash or an existing reference
427 303e2782 2019-08-09 stsp or tag name which will be resolved to a commit ID.
428 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
429 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
430 1cc14b9f 2019-05-14 stsp If this option is not specified, default to the work tree's current branch
431 1cc14b9f 2019-05-14 stsp if invoked in a work tree, or to the repository's HEAD reference.
432 c0cc5c62 2018-10-18 stsp .It Fl C Ar number
433 c0cc5c62 2018-10-18 stsp Set the number of context lines shown in diffs with
434 c0cc5c62 2018-10-18 stsp .Fl p .
435 c0cc5c62 2018-10-18 stsp By default, 3 lines of context are shown.
436 6238ee32 2018-06-13 stsp .It Fl l Ar N
437 6238ee32 2018-06-13 stsp Limit history traversal to a given number of commits.
438 b1ebc001 2019-08-13 stsp If this option is not specified, a default limit value of zero is used,
439 b1ebc001 2019-08-13 stsp which is treated as an unbounded limit.
440 b1ebc001 2019-08-13 stsp The
441 b1ebc001 2019-08-13 stsp .Ev GOT_LOG_DEFAULT_LIMIT
442 b1ebc001 2019-08-13 stsp environment variable may be set to change this default value.
443 6238ee32 2018-06-13 stsp .It Fl p
444 6238ee32 2018-06-13 stsp Display the patch of modifications made in each commit.
445 44392932 2019-08-25 stsp If a
446 44392932 2019-08-25 stsp .Ar path
447 44392932 2019-08-25 stsp is specified, only show the patch of modifications at or within this path.
448 c6390436 2019-11-29 kn .It Fl s Ar search-pattern
449 c6390436 2019-11-29 kn If specified, show only commits with a log message matched by the extended
450 6841bf13 2019-11-29 kn regular expression
451 6841bf13 2019-11-29 kn .Ar search-pattern .
452 6841bf13 2019-11-29 kn Regular expression syntax is documented in
453 6841bf13 2019-11-29 kn .Xr re_format 7 .
454 04ca23f4 2018-07-16 stsp .It Fl r Ar repository-path
455 04ca23f4 2018-07-16 stsp Use the repository at the specified path.
456 04ca23f4 2018-07-16 stsp If not specified, assume the repository is located at or above the current
457 04ca23f4 2018-07-16 stsp working directory.
458 e9cf2e30 2019-02-05 stsp If this directory is a
459 e9cf2e30 2019-02-05 stsp .Nm
460 e9cf2e30 2019-02-05 stsp work tree, use the repository path associated with this work tree.
461 38e11793 2018-06-13 stsp .El
462 63035f9f 2019-10-06 stsp .It Cm diff Oo Fl C Ar number Oc Oo Fl r Ar repository-path Oc Oo Fl s Oc Oo Fl w Oc Op Ar object1 Ar object2 | Ar path
463 927df6b7 2019-02-10 stsp When invoked within a work tree with less than two arguments, display
464 927df6b7 2019-02-10 stsp uncommitted changes in the work tree.
465 927df6b7 2019-02-10 stsp If a
466 927df6b7 2019-02-10 stsp .Ar path
467 927df6b7 2019-02-10 stsp is specified, only show changes within this path.
468 927df6b7 2019-02-10 stsp .Pp
469 d24820bf 2019-08-11 stsp If two arguments are provided, treat each argument as a reference, a tag
470 d24820bf 2019-08-11 stsp name, or an object ID SHA1 hash, and display differences between the
471 d24820bf 2019-08-11 stsp corresponding objects.
472 3f8b7d6a 2018-04-01 stsp Both objects must be of the same type (blobs, trees, or commits).
473 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
474 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
475 c0cc5c62 2018-10-18 stsp .Pp
476 c0cc5c62 2018-10-18 stsp The options for
477 c0cc5c62 2018-10-18 stsp .Cm got diff
478 c0cc5c62 2018-10-18 stsp are as follows:
479 c0cc5c62 2018-10-18 stsp .Bl -tag -width Ds
480 c0cc5c62 2018-10-18 stsp .It Fl C Ar number
481 c0cc5c62 2018-10-18 stsp Set the number of context lines shown in the diff.
482 c0cc5c62 2018-10-18 stsp By default, 3 lines of context are shown.
483 b72f483a 2019-02-05 stsp .It Fl r Ar repository-path
484 b72f483a 2019-02-05 stsp Use the repository at the specified path.
485 b72f483a 2019-02-05 stsp If not specified, assume the repository is located at or above the current
486 b72f483a 2019-02-05 stsp working directory.
487 b72f483a 2019-02-05 stsp If this directory is a
488 b72f483a 2019-02-05 stsp .Nm
489 b72f483a 2019-02-05 stsp work tree, use the repository path associated with this work tree.
490 4ed9f614 2019-08-04 stsp .It Fl s
491 4ed9f614 2019-08-04 stsp Show changes staged with
492 4ed9f614 2019-08-04 stsp .Cm got stage
493 4ed9f614 2019-08-04 stsp instead of showing local changes.
494 4ed9f614 2019-08-04 stsp This option is only valid when
495 4ed9f614 2019-08-04 stsp .Cm got diff
496 4ed9f614 2019-08-04 stsp is invoked in a work tree.
497 63035f9f 2019-10-06 stsp .It Fl w
498 63035f9f 2019-10-06 stsp Ignore whitespace-only changes.
499 c0cc5c62 2018-10-18 stsp .El
500 bc26cce8 2019-08-04 stsp .It Cm di
501 bc26cce8 2019-08-04 stsp Short alias for
502 bc26cce8 2019-08-04 stsp .Cm diff .
503 dfc23429 2019-08-11 stsp .It Cm blame Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Ar path
504 1ff8e573 2018-08-02 stsp Display line-by-line history of a file at the specified path.
505 1ff8e573 2018-08-02 stsp .Pp
506 1ff8e573 2018-08-02 stsp The options for
507 1ff8e573 2018-08-02 stsp .Cm got blame
508 1ff8e573 2018-08-02 stsp are as follows:
509 1ff8e573 2018-08-02 stsp .Bl -tag -width Ds
510 1ff8e573 2018-08-02 stsp .It Fl c Ar commit
511 1ff8e573 2018-08-02 stsp Start traversing history at the specified
512 1ff8e573 2018-08-02 stsp .Ar commit .
513 30837e32 2019-07-25 stsp The expected argument is a commit ID SHA1 hash or an existing reference
514 303e2782 2019-08-09 stsp or tag name which will be resolved to a commit ID.
515 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
516 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
517 1ff8e573 2018-08-02 stsp .It Fl r Ar repository-path
518 1ff8e573 2018-08-02 stsp Use the repository at the specified path.
519 1ff8e573 2018-08-02 stsp If not specified, assume the repository is located at or above the current
520 1ff8e573 2018-08-02 stsp working directory.
521 0c06baac 2019-02-05 stsp If this directory is a
522 0c06baac 2019-02-05 stsp .Nm
523 0c06baac 2019-02-05 stsp work tree, use the repository path associated with this work tree.
524 5c860e29 2018-03-12 stsp .El
525 bc26cce8 2019-08-04 stsp .It Cm bl
526 bc26cce8 2019-08-04 stsp Short alias for
527 bc26cce8 2019-08-04 stsp .Cm blame .
528 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
529 5de5890b 2018-10-18 stsp Display a listing of files and directories at the specified
530 5de5890b 2018-10-18 stsp directory path in the repository.
531 db0c2996 2019-02-10 stsp Entries shown in this listing may carry one of the following trailing
532 db0c2996 2019-02-10 stsp annotations:
533 db0c2996 2019-02-10 stsp .Bl -column YXZ description
534 848d6979 2019-08-12 stsp .It @ Ta entry is a symbolic link
535 db0c2996 2019-02-10 stsp .It / Ta entry is a directory
536 db0c2996 2019-02-10 stsp .It * Ta entry is an executable file
537 63c5ca5d 2019-08-24 stsp .It $ Ta entry is a Git submodule
538 db0c2996 2019-02-10 stsp .El
539 db0c2996 2019-02-10 stsp .Pp
540 0c849583 2019-02-05 stsp If no
541 0c849583 2019-02-05 stsp .Ar path
542 0c849583 2019-02-05 stsp is specified, list the repository path corresponding to the current
543 0c849583 2019-02-05 stsp directory of the work tree, or the root directory of the repository
544 0c849583 2019-02-05 stsp if there is no work tree.
545 5de5890b 2018-10-18 stsp .Pp
546 5de5890b 2018-10-18 stsp The options for
547 5de5890b 2018-10-18 stsp .Cm got tree
548 5de5890b 2018-10-18 stsp are as follows:
549 5de5890b 2018-10-18 stsp .Bl -tag -width Ds
550 5de5890b 2018-10-18 stsp .It Fl c Ar commit
551 5de5890b 2018-10-18 stsp List files and directories as they appear in the specified
552 5de5890b 2018-10-18 stsp .Ar commit .
553 30837e32 2019-07-25 stsp The expected argument is a commit ID SHA1 hash or an existing reference
554 303e2782 2019-08-09 stsp or tag name which will be resolved to a commit ID.
555 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
556 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
557 5de5890b 2018-10-18 stsp .It Fl r Ar repository-path
558 5de5890b 2018-10-18 stsp Use the repository at the specified path.
559 5de5890b 2018-10-18 stsp If not specified, assume the repository is located at or above the current
560 5de5890b 2018-10-18 stsp working directory.
561 0c849583 2019-02-05 stsp If this directory is a
562 0c849583 2019-02-05 stsp .Nm
563 0c849583 2019-02-05 stsp work tree, use the repository path associated with this work tree.
564 5de5890b 2018-10-18 stsp .It Fl i
565 5de5890b 2018-10-18 stsp Show object IDs of files (blob objects) and directories (tree objects).
566 c1669e2e 2019-01-09 stsp .It Fl R
567 0c849583 2019-02-05 stsp Recurse into sub-directories in the repository.
568 d0eebce4 2019-03-11 stsp .El
569 bc26cce8 2019-08-04 stsp .It Cm tr
570 bc26cce8 2019-08-04 stsp Short alias for
571 bc26cce8 2019-08-04 stsp .Cm tree .
572 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
573 d0eebce4 2019-03-11 stsp Manage references in a repository.
574 d0eebce4 2019-03-11 stsp .Pp
575 d0eebce4 2019-03-11 stsp If no options are passed, expect two arguments and attempt to create,
576 d0eebce4 2019-03-11 stsp or update, the reference with the given
577 d0eebce4 2019-03-11 stsp .Ar name ,
578 d0eebce4 2019-03-11 stsp and make it point at the given
579 d83d9d5c 2019-05-13 stsp .Ar target .
580 f16e4044 2019-10-09 stsp The name must be an absolute reference name, i.e. it must begin with
581 f16e4044 2019-10-09 stsp .Dq refs/ .
582 a54b6686 2019-06-28 stsp The target may be an object ID SHA1 hash or an existing reference which
583 a54b6686 2019-06-28 stsp will be resolved to an object ID.
584 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
585 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
586 d0eebce4 2019-03-11 stsp .Pp
587 d0eebce4 2019-03-11 stsp The options for
588 d0eebce4 2019-03-11 stsp .Cm got ref
589 d0eebce4 2019-03-11 stsp are as follows:
590 d0eebce4 2019-03-11 stsp .Bl -tag -width Ds
591 d0eebce4 2019-03-11 stsp .It Fl r Ar repository-path
592 d0eebce4 2019-03-11 stsp Use the repository at the specified path.
593 d0eebce4 2019-03-11 stsp If not specified, assume the repository is located at or above the current
594 d0eebce4 2019-03-11 stsp working directory.
595 d0eebce4 2019-03-11 stsp If this directory is a
596 d0eebce4 2019-03-11 stsp .Nm
597 d0eebce4 2019-03-11 stsp work tree, use the repository path associated with this work tree.
598 d0eebce4 2019-03-11 stsp .It Fl l
599 d0eebce4 2019-03-11 stsp List all existing references in the repository.
600 d0eebce4 2019-03-11 stsp .It Fl d Ar name
601 d0eebce4 2019-03-11 stsp Delete the reference with the specified name from the repository.
602 d1c1ae5f 2019-08-12 stsp .It Fl s
603 d1c1ae5f 2019-08-12 stsp Create a symbolic reference pointing at the specified
604 d1c1ae5f 2019-08-12 stsp .Ar target ,
605 d1c1ae5f 2019-08-12 stsp which must be an existing reference.
606 d1c1ae5f 2019-08-12 stsp Care should be taken not to create loops between references when
607 d1c1ae5f 2019-08-12 stsp this option is used.
608 4e759de4 2019-06-26 stsp .El
609 da76fce2 2020-02-24 stsp .It Cm branch Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Oo Fl l Oc Oo Fl d Ar name Oc Oo Fl n Oc Op Ar name
610 da76fce2 2020-02-24 stsp Create, list, or delete branches.
611 4e759de4 2019-06-26 stsp .Pp
612 4e759de4 2019-06-26 stsp Branches are managed via references which live in the
613 4e759de4 2019-06-26 stsp .Dq refs/heads/
614 4e759de4 2019-06-26 stsp reference namespace.
615 4e759de4 2019-06-26 stsp The
616 4e759de4 2019-06-26 stsp .Cm got branch
617 4e759de4 2019-06-26 stsp command operates on references in this namespace only.
618 4e759de4 2019-06-26 stsp .Pp
619 ad89fa31 2019-10-04 stsp If invoked in a work tree without any arguments, print the name of the
620 ad89fa31 2019-10-04 stsp work tree's current branch.
621 da76fce2 2020-02-24 stsp .Pp
622 a74f7e83 2019-11-10 stsp If a
623 a74f7e83 2019-11-10 stsp .Ar name
624 a74f7e83 2019-11-10 stsp argument is passed, attempt to create a branch reference with the given name.
625 a74f7e83 2019-11-10 stsp By default the new branch reference will point at the latest commit on the
626 a74f7e83 2019-11-10 stsp work tree's current branch if invoked in a work tree, and otherwise to a commit
627 a74f7e83 2019-11-10 stsp resolved via the repository's HEAD reference.
628 4e759de4 2019-06-26 stsp .Pp
629 da76fce2 2020-02-24 stsp If invoked in a work tree, once the branch was created successfully
630 da76fce2 2020-02-24 stsp switch the work tree's head reference to the newly created branch and
631 da76fce2 2020-02-24 stsp update files across the entire work tree, just like
632 da76fce2 2020-02-24 stsp .Cm got update -b Ar name
633 da76fce2 2020-02-24 stsp would do.
634 da76fce2 2020-02-24 stsp Show the status of each affected file, using the following status codes:
635 da76fce2 2020-02-24 stsp .Bl -column YXZ description
636 da76fce2 2020-02-24 stsp .It U Ta file was updated and contained no local changes
637 da76fce2 2020-02-24 stsp .It G Ta file was updated and local changes were merged cleanly
638 da76fce2 2020-02-24 stsp .It C Ta file was updated and conflicts occurred during merge
639 da76fce2 2020-02-24 stsp .It D Ta file was deleted
640 da76fce2 2020-02-24 stsp .It A Ta new file was added
641 da76fce2 2020-02-24 stsp .It \(a~ Ta versioned file is obstructed by a non-regular file
642 da76fce2 2020-02-24 stsp .It ! Ta a missing versioned file was restored
643 da76fce2 2020-02-24 stsp .El
644 da76fce2 2020-02-24 stsp .Pp
645 4e759de4 2019-06-26 stsp The options for
646 4e759de4 2019-06-26 stsp .Cm got branch
647 4e759de4 2019-06-26 stsp are as follows:
648 4e759de4 2019-06-26 stsp .Bl -tag -width Ds
649 a74f7e83 2019-11-10 stsp .It Fl c Ar commit
650 a74f7e83 2019-11-10 stsp Make a newly created branch reference point at the specified
651 a74f7e83 2019-11-10 stsp .Ar commit .
652 a74f7e83 2019-11-10 stsp The expected
653 a74f7e83 2019-11-10 stsp .Ar commit
654 a74f7e83 2019-11-10 stsp argument is a commit ID SHA1 hash or an existing reference
655 a74f7e83 2019-11-10 stsp or tag name which will be resolved to a commit ID.
656 4e759de4 2019-06-26 stsp .It Fl r Ar repository-path
657 4e759de4 2019-06-26 stsp Use the repository at the specified path.
658 4e759de4 2019-06-26 stsp If not specified, assume the repository is located at or above the current
659 4e759de4 2019-06-26 stsp working directory.
660 4e759de4 2019-06-26 stsp If this directory is a
661 4e759de4 2019-06-26 stsp .Nm
662 4e759de4 2019-06-26 stsp work tree, use the repository path associated with this work tree.
663 4e759de4 2019-06-26 stsp .It Fl l
664 4e759de4 2019-06-26 stsp List all existing branches in the repository.
665 ba882ee3 2019-07-11 stsp If invoked in a work tree, the work tree's current branch is shown
666 ba882ee3 2019-07-11 stsp with one the following annotations:
667 ba882ee3 2019-07-11 stsp .Bl -column YXZ description
668 ba882ee3 2019-07-11 stsp .It * Ta work tree's base commit matches the branch tip
669 1dd86744 2019-08-12 anthony .It \(a~ Ta work tree's base commit is out-of-date
670 ba882ee3 2019-07-11 stsp .El
671 4e759de4 2019-06-26 stsp .It Fl d Ar name
672 4e759de4 2019-06-26 stsp Delete the branch with the specified name from the repository.
673 7acfb25b 2019-07-11 stsp Only the branch reference is deleted.
674 7acfb25b 2019-07-11 stsp Any commit, tree, and blob objects belonging to the branch
675 74d012d1 2019-07-11 stsp remain in the repository and may be removed separately with
676 ce33d90e 2019-07-14 stsp Git's garbage collector.
677 da76fce2 2020-02-24 stsp .It Fl n
678 da76fce2 2020-02-24 stsp Do not switch and update the work tree after creating a new branch.
679 5de5890b 2018-10-18 stsp .El
680 97b3a7be 2019-07-09 stsp .It Cm br
681 97b3a7be 2019-07-09 stsp Short alias for
682 97b3a7be 2019-07-09 stsp .Cm branch .
683 80106605 2020-02-24 stsp .It Cm tag Oo Fl c Ar commit Oc Oo Fl m Ar message Oc Oo Fl r Ar repository-path Oc Oo Fl l Oc Ar name
684 8e7bd50a 2019-08-22 stsp Manage tags in a repository.
685 8e7bd50a 2019-08-22 stsp .Pp
686 8e7bd50a 2019-08-22 stsp Tags are managed via references which live in the
687 8e7bd50a 2019-08-22 stsp .Dq refs/tags/
688 8e7bd50a 2019-08-22 stsp reference namespace.
689 8e7bd50a 2019-08-22 stsp The
690 8e7bd50a 2019-08-22 stsp .Cm got tag
691 8e7bd50a 2019-08-22 stsp command operates on references in this namespace only.
692 b3cd068e 2019-08-22 stsp References in this namespace point at tag objects which contain a pointer
693 b3cd068e 2019-08-22 stsp to another object, a tag message, as well as author and timestamp information.
694 8e7bd50a 2019-08-22 stsp .Pp
695 80106605 2020-02-24 stsp Attempt to create a tag with the given
696 8e7bd50a 2019-08-22 stsp .Ar name ,
697 8e7bd50a 2019-08-22 stsp and make this tag point at the given
698 8e7bd50a 2019-08-22 stsp .Ar commit .
699 8e7bd50a 2019-08-22 stsp If no commit is specified, default to the latest commit on the work tree's
700 8e7bd50a 2019-08-22 stsp current branch if invoked in a work tree, and to a commit resolved via
701 8e7bd50a 2019-08-22 stsp the repository's HEAD reference otherwise.
702 8e7bd50a 2019-08-22 stsp .Pp
703 8e7bd50a 2019-08-22 stsp The options for
704 8e7bd50a 2019-08-22 stsp .Cm got tag
705 8e7bd50a 2019-08-22 stsp are as follows:
706 8e7bd50a 2019-08-22 stsp .Bl -tag -width Ds
707 80106605 2020-02-24 stsp .It Fl c Ar commit
708 80106605 2020-02-24 stsp Make the newly created tag reference point at the specified
709 80106605 2020-02-24 stsp .Ar commit .
710 80106605 2020-02-24 stsp The expected
711 80106605 2020-02-24 stsp .Ar commit
712 80106605 2020-02-24 stsp argument is a commit ID SHA1 hash or an existing reference or tag name which
713 80106605 2020-02-24 stsp will be resolved to a commit ID.
714 80106605 2020-02-24 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
715 80106605 2020-02-24 stsp automatically, provided the abbreviation is unique.
716 8e7bd50a 2019-08-22 stsp .It Fl m Ar message
717 80106605 2020-02-24 stsp Use the specified tag message when creating the new tag.
718 8e7bd50a 2019-08-22 stsp Without the
719 8e7bd50a 2019-08-22 stsp .Fl m
720 8e7bd50a 2019-08-22 stsp option,
721 3a62228f 2019-11-08 stsp .Cm got tag
722 8e7bd50a 2019-08-22 stsp opens a temporary file in an editor where a tag message can be written.
723 8e7bd50a 2019-08-22 stsp .It Fl r Ar repository-path
724 8e7bd50a 2019-08-22 stsp Use the repository at the specified path.
725 8e7bd50a 2019-08-22 stsp If not specified, assume the repository is located at or above the current
726 8e7bd50a 2019-08-22 stsp working directory.
727 8e7bd50a 2019-08-22 stsp If this directory is a
728 8e7bd50a 2019-08-22 stsp .Nm
729 8e7bd50a 2019-08-22 stsp work tree, use the repository path associated with this work tree.
730 8e7bd50a 2019-08-22 stsp .It Fl l
731 8e7bd50a 2019-08-22 stsp List all existing tags in the repository instead of creating a new tag.
732 8e7bd50a 2019-08-22 stsp If this option is used, no other command-line arguments are allowed.
733 8e7bd50a 2019-08-22 stsp .El
734 8e7bd50a 2019-08-22 stsp .Pp
735 8e7bd50a 2019-08-22 stsp By design, the
736 8e7bd50a 2019-08-22 stsp .Cm got tag
737 8e7bd50a 2019-08-22 stsp command will not delete tags or change existing tags.
738 8e7bd50a 2019-08-22 stsp If a tag must be deleted, the
739 8e7bd50a 2019-08-22 stsp .Cm got ref
740 8e7bd50a 2019-08-22 stsp command may be used to delete a tag's reference.
741 8e7bd50a 2019-08-22 stsp This should only be done if the tag has not already been copied to
742 8e7bd50a 2019-08-22 stsp another repository.
743 022fae89 2019-12-06 tracey .It Cm add Oo Fl R Oc Oo Fl I Oc Ar path ...
744 8125ddca 2019-05-11 stsp Schedule unversioned files in a work tree for addition to the
745 d00136be 2019-03-26 stsp repository in the next commit.
746 4e68cba3 2019-11-23 stsp .Pp
747 4e68cba3 2019-11-23 stsp The options for
748 4e68cba3 2019-11-23 stsp .Cm got add
749 4e68cba3 2019-11-23 stsp are as follows:
750 4e68cba3 2019-11-23 stsp .Bl -tag -width Ds
751 4e68cba3 2019-11-23 stsp .It Fl R
752 4e68cba3 2019-11-23 stsp Permit recursion into directories.
753 4e68cba3 2019-11-23 stsp If this option is not specified,
754 4e68cba3 2019-11-23 stsp .Cm got add
755 4e68cba3 2019-11-23 stsp will refuse to run if a specified
756 4e68cba3 2019-11-23 stsp .Ar path
757 4e68cba3 2019-11-23 stsp is a directory.
758 022fae89 2019-12-06 tracey .It Fl I
759 022fae89 2019-12-06 tracey With -R, add files even if they match a
760 022fae89 2019-12-06 tracey .Cm got status
761 022fae89 2019-12-06 tracey ignore pattern.
762 4e68cba3 2019-11-23 stsp .El
763 c29c428a 2019-12-16 stsp .It Cm remove Oo Fl f Oc Oo Fl k Oc Oo Fl R Oc Ar path ...
764 17ed4618 2019-06-02 stsp Remove versioned files from a work tree and schedule them for deletion
765 2ec1f75b 2019-03-26 stsp from the repository in the next commit.
766 2ec1f75b 2019-03-26 stsp .Pp
767 2ec1f75b 2019-03-26 stsp The options for
768 86d25a1b 2019-07-11 stsp .Cm got remove
769 2ec1f75b 2019-03-26 stsp are as follows:
770 2ec1f75b 2019-03-26 stsp .Bl -tag -width Ds
771 2ec1f75b 2019-03-26 stsp .It Fl f
772 17ed4618 2019-06-02 stsp Perform the operation even if a file contains uncommitted modifications.
773 70e3e7f5 2019-12-13 tracey .It Fl k
774 70e3e7f5 2019-12-13 tracey Keep affected files on disk.
775 f2a9dc41 2019-12-13 tracey .It Fl R
776 f2a9dc41 2019-12-13 tracey Permit recursion into directories.
777 f2a9dc41 2019-12-13 tracey If this option is not specified,
778 f2a9dc41 2019-12-13 tracey .Cm got remove
779 f2a9dc41 2019-12-13 tracey will refuse to run if a specified
780 f2a9dc41 2019-12-13 tracey .Ar path
781 f2a9dc41 2019-12-13 tracey is a directory.
782 d0eebce4 2019-03-11 stsp .El
783 648e4ef7 2019-07-09 stsp .It Cm rm
784 648e4ef7 2019-07-09 stsp Short alias for
785 648e4ef7 2019-07-09 stsp .Cm remove .
786 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 ...
787 bc3056e3 2019-08-18 stsp Revert any uncommitted changes in files at the specified paths.
788 a129376b 2019-03-28 stsp File contents will be overwritten with those contained in the
789 1dd86744 2019-08-12 anthony work tree's base commit.
790 1dd86744 2019-08-12 anthony There is no way to bring discarded changes back after
791 a129376b 2019-03-28 stsp .Cm got revert !
792 a129376b 2019-03-28 stsp .Pp
793 e20a8b6f 2019-06-04 stsp If a file was added with
794 a129376b 2019-03-28 stsp .Cm got add
795 a129376b 2019-03-28 stsp it will become an unversioned file again.
796 e20a8b6f 2019-06-04 stsp If a file was deleted with
797 86d25a1b 2019-07-11 stsp .Cm got remove
798 a129376b 2019-03-28 stsp it will be restored.
799 0f6d7415 2019-08-08 stsp .Pp
800 0f6d7415 2019-08-08 stsp The options for
801 0f6d7415 2019-08-08 stsp .Cm got revert
802 0f6d7415 2019-08-08 stsp are as follows:
803 0f6d7415 2019-08-08 stsp .Bl -tag -width Ds
804 33aa809d 2019-08-08 stsp .It Fl p
805 33aa809d 2019-08-08 stsp Instead of reverting all changes in files, interactively select or reject
806 33aa809d 2019-08-08 stsp changes to revert based on
807 33aa809d 2019-08-08 stsp .Dq y
808 33aa809d 2019-08-08 stsp (revert change),
809 33aa809d 2019-08-08 stsp .Dq n
810 33aa809d 2019-08-08 stsp (keep change), and
811 33aa809d 2019-08-08 stsp .Dq q
812 33aa809d 2019-08-08 stsp (quit reverting this file) responses.
813 33aa809d 2019-08-08 stsp If a file is in modified status, individual patches derived from the
814 33aa809d 2019-08-08 stsp modified file content can be reverted.
815 33aa809d 2019-08-08 stsp Files in added or deleted status may only be reverted in their entirety.
816 33aa809d 2019-08-08 stsp .It Fl F Ar response-script
817 33aa809d 2019-08-08 stsp With the
818 33aa809d 2019-08-08 stsp .Fl p
819 33aa809d 2019-08-08 stsp option, read
820 33aa809d 2019-08-08 stsp .Dq y ,
821 33aa809d 2019-08-08 stsp .Dq n ,
822 33aa809d 2019-08-08 stsp and
823 33aa809d 2019-08-08 stsp .Dq q
824 33aa809d 2019-08-08 stsp responses line-by-line from the specified
825 33aa809d 2019-08-08 stsp .Ar response-script
826 33aa809d 2019-08-08 stsp file instead of prompting interactively.
827 0f6d7415 2019-08-08 stsp .It Fl R
828 0f6d7415 2019-08-08 stsp Permit recursion into directories.
829 0f6d7415 2019-08-08 stsp If this option is not specified,
830 0f6d7415 2019-08-08 stsp .Cm got revert
831 0f6d7415 2019-08-08 stsp will refuse to run if a specified
832 0f6d7415 2019-08-08 stsp .Ar path
833 0f6d7415 2019-08-08 stsp is a directory.
834 0f6d7415 2019-08-08 stsp .El
835 97b3a7be 2019-07-09 stsp .It Cm rv
836 97b3a7be 2019-07-09 stsp Short alias for
837 97b3a7be 2019-07-09 stsp .Cm revert .
838 dfc23429 2019-08-11 stsp .It Cm commit Oo Fl m Ar message Oc Op Ar path ...
839 4ed9f614 2019-08-04 stsp Create a new commit in the repository from changes in a work tree
840 15cd91f7 2019-05-12 stsp and use this commit as the new base commit for the work tree.
841 5c1e53bc 2019-07-28 stsp If no
842 90e8619e 2019-07-25 stsp .Ar path
843 4ed9f614 2019-08-04 stsp is specified, commit all changes in the work tree.
844 4ed9f614 2019-08-04 stsp Otherwise, commit changes at or within the specified paths.
845 15cd91f7 2019-05-12 stsp .Pp
846 4ed9f614 2019-08-04 stsp If changes have been explicitly staged for commit with
847 1dd86744 2019-08-12 anthony .Cm got stage ,
848 4ed9f614 2019-08-04 stsp only commit staged changes and reject any specified paths which
849 4ed9f614 2019-08-04 stsp have not been staged.
850 4ed9f614 2019-08-04 stsp .Pp
851 15cd91f7 2019-05-12 stsp Show the status of each affected file, using the following status codes:
852 15cd91f7 2019-05-12 stsp .Bl -column YXZ description
853 15cd91f7 2019-05-12 stsp .It M Ta modified file
854 15cd91f7 2019-05-12 stsp .It D Ta file was deleted
855 15cd91f7 2019-05-12 stsp .It A Ta new file was added
856 1ebedb77 2019-10-19 stsp .It m Ta modified file modes (executable bit only)
857 15cd91f7 2019-05-12 stsp .El
858 15cd91f7 2019-05-12 stsp .Pp
859 996d5ccd 2019-08-05 stsp Files which are not part of the new commit will retain their previously
860 996d5ccd 2019-08-05 stsp recorded base commit.
861 15cd91f7 2019-05-12 stsp Some
862 15cd91f7 2019-05-12 stsp .Nm
863 15cd91f7 2019-05-12 stsp commands may refuse to run while the work tree contains files from
864 15cd91f7 2019-05-12 stsp multiple base commits.
865 15cd91f7 2019-05-12 stsp The base commit of such a work tree can be made consistent by running
866 47ec7be7 2019-05-12 stsp .Cm got update
867 47ec7be7 2019-05-12 stsp across the entire work tree.
868 15cd91f7 2019-05-12 stsp .Pp
869 15cd91f7 2019-05-12 stsp The
870 15cd91f7 2019-05-12 stsp .Cm got commit
871 15cd91f7 2019-05-12 stsp command requires the
872 74416c47 2019-05-09 stsp .Ev GOT_AUTHOR
873 aba9c984 2019-09-08 stsp environment variable to be set,
874 aba9c984 2019-09-08 stsp unless Git's
875 aba9c984 2019-09-08 stsp .Dv user.name
876 aba9c984 2019-09-08 stsp and
877 709ae9eb 2019-09-08 stsp .Dv user.email
878 709ae9eb 2019-09-08 stsp configuration settings can be
879 aba9c984 2019-09-08 stsp obtained from the repository's
880 aba9c984 2019-09-08 stsp .Pa .git/config
881 c9956ddf 2019-09-08 stsp file or from Git's global
882 c9956ddf 2019-09-08 stsp .Pa ~/.gitconfig
883 c9956ddf 2019-09-08 stsp configuration file.
884 74416c47 2019-05-09 stsp .Pp
885 74416c47 2019-05-09 stsp The options for
886 74416c47 2019-05-09 stsp .Cm got commit
887 74416c47 2019-05-09 stsp are as follows:
888 74416c47 2019-05-09 stsp .Bl -tag -width Ds
889 74ff3f23 2019-07-07 stsp .It Fl m Ar message
890 74416c47 2019-05-09 stsp Use the specified log message when creating the new commit.
891 23594da9 2019-05-13 stsp Without the
892 23594da9 2019-05-13 stsp .Fl m
893 23594da9 2019-05-13 stsp option,
894 23594da9 2019-05-13 stsp .Cm got commit
895 23594da9 2019-05-13 stsp opens a temporary file in an editor where a log message can be written.
896 2ec1f75b 2019-03-26 stsp .El
897 cfce0458 2019-07-28 stsp .Pp
898 cfce0458 2019-07-28 stsp .Cm got commit
899 cfce0458 2019-07-28 stsp will refuse to run if certain preconditions are not met.
900 916f288c 2019-07-30 stsp If the work tree's current branch is not in the
901 916f288c 2019-07-30 stsp .Dq refs/heads/
902 916f288c 2019-07-30 stsp reference namespace, new commits may not be created on this branch.
903 cfce0458 2019-07-28 stsp Local changes may only be committed if they are based on file content
904 cfce0458 2019-07-28 stsp found in the most recent commit on the work tree's branch.
905 cfce0458 2019-07-28 stsp If a path is found to be out of date,
906 cfce0458 2019-07-28 stsp .Cm got update
907 cfce0458 2019-07-28 stsp must be used first in order to merge local changes with changes made
908 cfce0458 2019-07-28 stsp in the repository.
909 97b3a7be 2019-07-09 stsp .It Cm ci
910 97b3a7be 2019-07-09 stsp Short alias for
911 97b3a7be 2019-07-09 stsp .Cm commit .
912 234035bc 2019-06-01 stsp .It Cm cherrypick Ar commit
913 234035bc 2019-06-01 stsp Merge changes from a single
914 234035bc 2019-06-01 stsp .Ar commit
915 234035bc 2019-06-01 stsp into the work tree.
916 234035bc 2019-06-01 stsp The specified
917 234035bc 2019-06-01 stsp .Ar commit
918 234035bc 2019-06-01 stsp must be on a different branch than the work tree's base commit.
919 a54b6686 2019-06-28 stsp The expected argument is a reference or a commit ID SHA1 hash.
920 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
921 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
922 234035bc 2019-06-01 stsp .Pp
923 234035bc 2019-06-01 stsp Show the status of each affected file, using the following status codes:
924 234035bc 2019-06-01 stsp .Bl -column YXZ description
925 234035bc 2019-06-01 stsp .It G Ta file was merged
926 234035bc 2019-06-01 stsp .It C Ta file was merged and conflicts occurred during merge
927 234035bc 2019-06-01 stsp .It ! Ta changes destined for a missing file were not merged
928 234035bc 2019-06-01 stsp .It D Ta file was deleted
929 2b92fad7 2019-06-02 stsp .It d Ta file's deletion was obstructed by local modifications
930 234035bc 2019-06-01 stsp .It A Ta new file was added
931 1dd86744 2019-08-12 anthony .It \(a~ Ta changes destined for a non-regular file were not merged
932 74416c47 2019-05-09 stsp .El
933 234035bc 2019-06-01 stsp .Pp
934 234035bc 2019-06-01 stsp The merged changes will appear as local changes in the work tree, which
935 234035bc 2019-06-01 stsp may be viewed with
936 234035bc 2019-06-01 stsp .Cm got diff ,
937 234035bc 2019-06-01 stsp amended manually or with further
938 234035bc 2019-06-01 stsp .Cm got cherrypick
939 bc3056e3 2019-08-18 stsp commands,
940 234035bc 2019-06-01 stsp committed with
941 234035bc 2019-06-01 stsp .Cm got commit ,
942 234035bc 2019-06-01 stsp or discarded again with
943 234035bc 2019-06-01 stsp .Cm got revert .
944 234035bc 2019-06-01 stsp .Pp
945 234035bc 2019-06-01 stsp .Cm got cherrypick
946 234035bc 2019-06-01 stsp will refuse to run if certain preconditions are not met.
947 234035bc 2019-06-01 stsp If the work tree contains multiple base commits it must first be updated
948 234035bc 2019-06-01 stsp to a single base commit with
949 234035bc 2019-06-01 stsp .Cm got update .
950 234035bc 2019-06-01 stsp If the work tree already contains files with merge conflicts, these
951 234035bc 2019-06-01 stsp conflicts must be resolved first.
952 016477fd 2019-07-09 stsp .It Cm cy
953 97b3a7be 2019-07-09 stsp Short alias for
954 97b3a7be 2019-07-09 stsp .Cm cherrypick .
955 5ef14e63 2019-06-02 stsp .It Cm backout Ar commit
956 5ef14e63 2019-06-02 stsp Reverse-merge changes from a single
957 5ef14e63 2019-06-02 stsp .Ar commit
958 5ef14e63 2019-06-02 stsp into the work tree.
959 5ef14e63 2019-06-02 stsp The specified
960 5ef14e63 2019-06-02 stsp .Ar commit
961 5ef14e63 2019-06-02 stsp must be on the same branch as the work tree's base commit.
962 a54b6686 2019-06-28 stsp The expected argument is a reference or a commit ID SHA1 hash.
963 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
964 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
965 5ef14e63 2019-06-02 stsp .Pp
966 5ef14e63 2019-06-02 stsp Show the status of each affected file, using the following status codes:
967 5ef14e63 2019-06-02 stsp .Bl -column YXZ description
968 5ef14e63 2019-06-02 stsp .It G Ta file was merged
969 5ef14e63 2019-06-02 stsp .It C Ta file was merged and conflicts occurred during merge
970 5ef14e63 2019-06-02 stsp .It ! Ta changes destined for a missing file were not merged
971 5ef14e63 2019-06-02 stsp .It D Ta file was deleted
972 5ef14e63 2019-06-02 stsp .It d Ta file's deletion was obstructed by local modifications
973 5ef14e63 2019-06-02 stsp .It A Ta new file was added
974 1dd86744 2019-08-12 anthony .It \(a~ Ta changes destined for a non-regular file were not merged
975 234035bc 2019-06-01 stsp .El
976 5ef14e63 2019-06-02 stsp .Pp
977 5ef14e63 2019-06-02 stsp The reverse-merged changes will appear as local changes in the work tree,
978 5ef14e63 2019-06-02 stsp which may be viewed with
979 5ef14e63 2019-06-02 stsp .Cm got diff ,
980 5ef14e63 2019-06-02 stsp amended manually or with further
981 778a73c2 2019-07-12 stsp .Cm got backout
982 bc3056e3 2019-08-18 stsp commands,
983 5ef14e63 2019-06-02 stsp committed with
984 5ef14e63 2019-06-02 stsp .Cm got commit ,
985 5ef14e63 2019-06-02 stsp or discarded again with
986 5ef14e63 2019-06-02 stsp .Cm got revert .
987 5ef14e63 2019-06-02 stsp .Pp
988 92228c38 2019-06-02 stsp .Cm got backout
989 92228c38 2019-06-02 stsp will refuse to run if certain preconditions are not met.
990 92228c38 2019-06-02 stsp If the work tree contains multiple base commits it must first be updated
991 92228c38 2019-06-02 stsp to a single base commit with
992 92228c38 2019-06-02 stsp .Cm got update .
993 92228c38 2019-06-02 stsp If the work tree already contains files with merge conflicts, these
994 92228c38 2019-06-02 stsp conflicts must be resolved first.
995 97b3a7be 2019-07-09 stsp .It Cm bo
996 97b3a7be 2019-07-09 stsp Short alias for
997 97b3a7be 2019-07-09 stsp .Cm backout .
998 dfc23429 2019-08-11 stsp .It Cm rebase Oo Fl a Oc Oo Fl c Oc Op Ar branch
999 818c7501 2019-07-11 stsp Rebase commits on the specified
1000 818c7501 2019-07-11 stsp .Ar branch
1001 818c7501 2019-07-11 stsp onto the tip of the current branch of the work tree.
1002 818c7501 2019-07-11 stsp The
1003 818c7501 2019-07-11 stsp .Ar branch
1004 818c7501 2019-07-11 stsp must share common ancestry with the work tree's current branch.
1005 bc3056e3 2019-08-18 stsp Rebasing begins with the first descendant commit of the youngest
1006 f09e2405 2019-07-11 stsp common ancestor commit shared by the specified
1007 818c7501 2019-07-11 stsp .Ar branch
1008 818c7501 2019-07-11 stsp and the work tree's current branch, and stops once the tip commit
1009 f09e2405 2019-07-11 stsp of the specified
1010 818c7501 2019-07-11 stsp .Ar branch
1011 f09e2405 2019-07-11 stsp has been rebased.
1012 818c7501 2019-07-11 stsp .Pp
1013 2b6826ba 2020-02-24 stsp When
1014 2b6826ba 2020-02-24 stsp .Cm got rebase
1015 2b6826ba 2020-02-24 stsp is used as intended, the specified
1016 2b6826ba 2020-02-24 stsp .Ar branch
1017 c10890ce 2020-02-25 stsp represents a local commit history and may already contain changes
1018 c10890ce 2020-02-25 stsp that are not yet visible in any other repositories.
1019 2b6826ba 2020-02-24 stsp The work tree's current branch, which must be set with
1020 2b6826ba 2020-02-24 stsp .Cm got update -b
1021 2b6826ba 2020-02-24 stsp before starting the
1022 2b6826ba 2020-02-24 stsp .Cm rebase
1023 2b6826ba 2020-02-24 stsp operation, represents a branch from a remote repository which shares
1024 2b6826ba 2020-02-24 stsp a common history with the specified
1025 2b6826ba 2020-02-24 stsp .Ar branch
1026 c10890ce 2020-02-25 stsp but has progressed, and perhaps diverged, due to commits added to the
1027 c10890ce 2020-02-25 stsp remote repository.
1028 2b6826ba 2020-02-24 stsp .Pp
1029 c6b4581b 2019-07-28 stsp Rebased commits are accumulated on a temporary branch which the work tree
1030 c6b4581b 2019-07-28 stsp will remain switched to throughout the entire rebase operation.
1031 c6b4581b 2019-07-28 stsp Commits on this branch represent the same changes with the same log
1032 c6b4581b 2019-07-28 stsp messages as their counterparts on the original
1033 818c7501 2019-07-11 stsp .Ar branch ,
1034 818c7501 2019-07-11 stsp but with different commit IDs.
1035 818c7501 2019-07-11 stsp Once rebasing has completed successfully, the temporary branch becomes
1036 f09e2405 2019-07-11 stsp the new version of the specified
1037 818c7501 2019-07-11 stsp .Ar branch
1038 818c7501 2019-07-11 stsp and the work tree is automatically switched to it.
1039 818c7501 2019-07-11 stsp .Pp
1040 818c7501 2019-07-11 stsp While rebasing commits, show the status of each affected file,
1041 818c7501 2019-07-11 stsp using the following status codes:
1042 818c7501 2019-07-11 stsp .Bl -column YXZ description
1043 818c7501 2019-07-11 stsp .It G Ta file was merged
1044 818c7501 2019-07-11 stsp .It C Ta file was merged and conflicts occurred during merge
1045 818c7501 2019-07-11 stsp .It ! Ta changes destined for a missing file were not merged
1046 818c7501 2019-07-11 stsp .It D Ta file was deleted
1047 818c7501 2019-07-11 stsp .It d Ta file's deletion was obstructed by local modifications
1048 818c7501 2019-07-11 stsp .It A Ta new file was added
1049 1dd86744 2019-08-12 anthony .It \(a~ Ta changes destined for a non-regular file were not merged
1050 5ef14e63 2019-06-02 stsp .El
1051 818c7501 2019-07-11 stsp .Pp
1052 f09e2405 2019-07-11 stsp If merge conflicts occur the rebase operation is interrupted and may
1053 f09e2405 2019-07-11 stsp be continued once conflicts have been resolved.
1054 818c7501 2019-07-11 stsp Alternatively, the rebase operation may be aborted which will leave
1055 818c7501 2019-07-11 stsp .Ar branch
1056 818c7501 2019-07-11 stsp unmodified and the work tree switched back to its original branch.
1057 818c7501 2019-07-11 stsp .Pp
1058 ff0d2220 2019-07-11 stsp If a merge conflict is resolved in a way which renders the merged
1059 f09e2405 2019-07-11 stsp change into a no-op change, the corresponding commit will be elided
1060 f09e2405 2019-07-11 stsp when the rebase operation continues.
1061 ff0d2220 2019-07-11 stsp .Pp
1062 818c7501 2019-07-11 stsp .Cm got rebase
1063 818c7501 2019-07-11 stsp will refuse to run if certain preconditions are not met.
1064 a85446b2 2020-01-04 stsp If the work tree is not yet fully updated to the tip commit of its
1065 a85446b2 2020-01-04 stsp branch then the work tree must first be updated with
1066 818c7501 2019-07-11 stsp .Cm got update .
1067 4ed9f614 2019-08-04 stsp If changes have been staged with
1068 4ed9f614 2019-08-04 stsp .Cm got stage ,
1069 bc3056e3 2019-08-18 stsp these changes must first be committed with
1070 4ed9f614 2019-08-04 stsp .Cm got commit
1071 4ed9f614 2019-08-04 stsp or unstaged with
1072 4ed9f614 2019-08-04 stsp .Cm got unstage .
1073 f09e2405 2019-07-11 stsp If the work tree contains local changes, these changes must first be
1074 f09e2405 2019-07-11 stsp committed with
1075 f09e2405 2019-07-11 stsp .Cm got commit
1076 f09e2405 2019-07-11 stsp or reverted with
1077 f09e2405 2019-07-11 stsp .Cm got revert .
1078 64c6d990 2019-07-11 stsp If the
1079 64c6d990 2019-07-11 stsp .Ar branch
1080 64c6d990 2019-07-11 stsp contains changes to files outside of the work tree's path prefix,
1081 64c6d990 2019-07-11 stsp the work tree cannot be used to rebase this branch.
1082 818c7501 2019-07-11 stsp .Pp
1083 7d5807f4 2019-07-11 stsp The
1084 7d5807f4 2019-07-11 stsp .Cm got update
1085 7d5807f4 2019-07-11 stsp and
1086 7d5807f4 2019-07-11 stsp .Cm got commit
1087 7d5807f4 2019-07-11 stsp commands will refuse to run while a rebase operation is in progress.
1088 7d5807f4 2019-07-11 stsp Other commands which manipulate the work tree may be used for
1089 7d5807f4 2019-07-11 stsp conflict resolution purposes.
1090 818c7501 2019-07-11 stsp .Pp
1091 818c7501 2019-07-11 stsp The options for
1092 818c7501 2019-07-11 stsp .Cm got rebase
1093 818c7501 2019-07-11 stsp are as follows:
1094 818c7501 2019-07-11 stsp .Bl -tag -width Ds
1095 818c7501 2019-07-11 stsp .It Fl a
1096 818c7501 2019-07-11 stsp Abort an interrupted rebase operation.
1097 c478f6d8 2019-08-08 stsp If this option is used, no other command-line arguments are allowed.
1098 818c7501 2019-07-11 stsp .It Fl c
1099 06067b48 2019-07-11 stsp Continue an interrupted rebase operation.
1100 c478f6d8 2019-08-08 stsp If this option is used, no other command-line arguments are allowed.
1101 818c7501 2019-07-11 stsp .El
1102 818c7501 2019-07-11 stsp .It Cm rb
1103 818c7501 2019-07-11 stsp Short alias for
1104 818c7501 2019-07-11 stsp .Cm rebase .
1105 083957f4 2020-02-24 stsp .It Cm histedit Oo Fl a Oc Oo Fl c Oc Oo Fl F Ar histedit-script Oc Oo Fl m Oc
1106 0ebf8283 2019-07-24 stsp Edit commit history between the work tree's current base commit and
1107 0ebf8283 2019-07-24 stsp the tip commit of the work tree's current branch.
1108 6e54d307 2020-02-24 stsp .Pp
1109 6e54d307 2020-02-24 stsp Before starting a
1110 6e54d307 2020-02-24 stsp .Cm histedit
1111 6e54d307 2020-02-24 stsp operation the work tree's current branch must be set with
1112 6e54d307 2020-02-24 stsp .Cm got update -b
1113 6e54d307 2020-02-24 stsp to the branch which should be edited, unless this branch is already the
1114 6e54d307 2020-02-24 stsp current branch of the work tree.
1115 6e54d307 2020-02-24 stsp The tip of this branch represents the upper bound (inclusive) of commits
1116 6e54d307 2020-02-24 stsp touched by the
1117 6e54d307 2020-02-24 stsp .Cm histedit
1118 6e54d307 2020-02-24 stsp operation.
1119 0ebf8283 2019-07-24 stsp .Pp
1120 6e54d307 2020-02-24 stsp Furthermore, the work tree's base commit
1121 6e54d307 2020-02-24 stsp must be set with
1122 6e54d307 2020-02-24 stsp .Cm got update -c
1123 6e54d307 2020-02-24 stsp to a point in this branch's commit history where editing should begin.
1124 6e54d307 2020-02-24 stsp This commit represents the lower bound (non-inclusive) of commits touched
1125 6e54d307 2020-02-24 stsp by the
1126 6e54d307 2020-02-24 stsp .Cm histedit
1127 6e54d307 2020-02-24 stsp operation.
1128 6e54d307 2020-02-24 stsp .Pp
1129 0ebf8283 2019-07-24 stsp Editing of commit history is controlled via a
1130 0ebf8283 2019-07-24 stsp .Ar histedit script
1131 46fa4c83 2020-02-24 stsp which can be written in an editor based on a template, passed on the
1132 46fa4c83 2020-02-24 stsp command line, or generated with the
1133 083957f4 2020-02-24 stsp .Fl m
1134 083957f4 2020-02-24 stsp option if only log messages need to be edited.
1135 083957f4 2020-02-24 stsp .Pp
1136 0ebf8283 2019-07-24 stsp The format of the histedit script is line-based.
1137 0ebf8283 2019-07-24 stsp Each line in the script begins with a command name, followed by
1138 0ebf8283 2019-07-24 stsp whitespace and an argument.
1139 0ebf8283 2019-07-24 stsp For most commands, the expected argument is a commit ID SHA1 hash.
1140 0ebf8283 2019-07-24 stsp Any remaining text on the line is ignored.
1141 0ebf8283 2019-07-24 stsp Lines which begin with the
1142 0ebf8283 2019-07-24 stsp .Sq #
1143 0ebf8283 2019-07-24 stsp character are ignored entirely.
1144 0ebf8283 2019-07-24 stsp .Pp
1145 0ebf8283 2019-07-24 stsp The available commands are as follows:
1146 0ebf8283 2019-07-24 stsp .Bl -column YXZ pick-commit
1147 0ebf8283 2019-07-24 stsp .It pick Ar commit Ta Use the specified commit as it is.
1148 a698f62e 2019-07-25 stsp .It edit Ar commit Ta Use the specified commit but once changes have been
1149 0ebf8283 2019-07-24 stsp merged into the work tree interrupt the histedit operation for amending.
1150 0ebf8283 2019-07-24 stsp .It fold Ar commit Ta Combine the specified commit with the next commit
1151 0ebf8283 2019-07-24 stsp listed further below that will be used.
1152 0ebf8283 2019-07-24 stsp .It drop Ar commit Ta Remove this commit from the edited history.
1153 0ebf8283 2019-07-24 stsp .It mesg Ar log-message Ta Use the specified single-line log message for
1154 0ebf8283 2019-07-24 stsp the commit on the previous line.
1155 0ebf8283 2019-07-24 stsp If the log message argument is left empty, open an editor where a new
1156 0ebf8283 2019-07-24 stsp log message can be written.
1157 0ebf8283 2019-07-24 stsp .El
1158 0ebf8283 2019-07-24 stsp .Pp
1159 ba67992e 2019-07-25 stsp Every commit in the history being edited must be mentioned in the script.
1160 0ebf8283 2019-07-24 stsp Lines may be re-ordered to change the order of commits in the edited history.
1161 5b87815e 2020-03-05 stsp No commit may be listed more than once.
1162 0ebf8283 2019-07-24 stsp .Pp
1163 c6b4581b 2019-07-28 stsp Edited commits are accumulated on a temporary branch which the work tree
1164 c6b4581b 2019-07-28 stsp will remain switched to throughout the entire histedit operation.
1165 0ebf8283 2019-07-24 stsp Once history editing has completed successfully, the temporary branch becomes
1166 498a90b7 2019-07-25 stsp the new version of the work tree's branch and the work tree is automatically
1167 498a90b7 2019-07-25 stsp switched to it.
1168 0ebf8283 2019-07-24 stsp .Pp
1169 0ebf8283 2019-07-24 stsp While merging commits, show the status of each affected file,
1170 0ebf8283 2019-07-24 stsp using the following status codes:
1171 0ebf8283 2019-07-24 stsp .Bl -column YXZ description
1172 0ebf8283 2019-07-24 stsp .It G Ta file was merged
1173 0ebf8283 2019-07-24 stsp .It C Ta file was merged and conflicts occurred during merge
1174 0ebf8283 2019-07-24 stsp .It ! Ta changes destined for a missing file were not merged
1175 0ebf8283 2019-07-24 stsp .It D Ta file was deleted
1176 0ebf8283 2019-07-24 stsp .It d Ta file's deletion was obstructed by local modifications
1177 0ebf8283 2019-07-24 stsp .It A Ta new file was added
1178 1dd86744 2019-08-12 anthony .It \(a~ Ta changes destined for a non-regular file were not merged
1179 0ebf8283 2019-07-24 stsp .El
1180 0ebf8283 2019-07-24 stsp .Pp
1181 0ebf8283 2019-07-24 stsp If merge conflicts occur the histedit operation is interrupted and may
1182 0ebf8283 2019-07-24 stsp be continued once conflicts have been resolved.
1183 0ebf8283 2019-07-24 stsp Alternatively, the histedit operation may be aborted which will leave
1184 0ebf8283 2019-07-24 stsp the work tree switched back to its original branch.
1185 0ebf8283 2019-07-24 stsp .Pp
1186 0ebf8283 2019-07-24 stsp If a merge conflict is resolved in a way which renders the merged
1187 0ebf8283 2019-07-24 stsp change into a no-op change, the corresponding commit will be elided
1188 0ebf8283 2019-07-24 stsp when the histedit operation continues.
1189 0ebf8283 2019-07-24 stsp .Pp
1190 0ebf8283 2019-07-24 stsp .Cm got histedit
1191 0ebf8283 2019-07-24 stsp will refuse to run if certain preconditions are not met.
1192 c7d20a3f 2019-07-30 stsp If the work tree's current branch is not in the
1193 c7d20a3f 2019-07-30 stsp .Dq refs/heads/
1194 c7d20a3f 2019-07-30 stsp reference namespace, the history of the branch may not be edited.
1195 0ebf8283 2019-07-24 stsp If the work tree contains multiple base commits it must first be updated
1196 0ebf8283 2019-07-24 stsp to a single base commit with
1197 0ebf8283 2019-07-24 stsp .Cm got update .
1198 4ed9f614 2019-08-04 stsp If changes have been staged with
1199 4ed9f614 2019-08-04 stsp .Cm got stage ,
1200 bc3056e3 2019-08-18 stsp these changes must first be committed with
1201 4ed9f614 2019-08-04 stsp .Cm got commit
1202 4ed9f614 2019-08-04 stsp or unstaged with
1203 4ed9f614 2019-08-04 stsp .Cm got unstage .
1204 0ebf8283 2019-07-24 stsp If the work tree contains local changes, these changes must first be
1205 0ebf8283 2019-07-24 stsp committed with
1206 0ebf8283 2019-07-24 stsp .Cm got commit
1207 0ebf8283 2019-07-24 stsp or reverted with
1208 0ebf8283 2019-07-24 stsp .Cm got revert .
1209 0ebf8283 2019-07-24 stsp If the edited history contains changes to files outside of the work tree's
1210 0ebf8283 2019-07-24 stsp path prefix, the work tree cannot be used to edit the history of this branch.
1211 0ebf8283 2019-07-24 stsp .Pp
1212 0ebf8283 2019-07-24 stsp The
1213 7ef62c4e 2020-02-24 stsp .Cm got update ,
1214 7ef62c4e 2020-02-24 stsp .Cm got rebase ,
1215 65db4ffb 2020-02-24 stsp and
1216 65db4ffb 2020-02-24 stsp .Cm got integrate
1217 65db4ffb 2020-02-24 stsp commands will refuse to run while a histedit operation is in progress.
1218 a698f62e 2019-07-25 stsp Other commands which manipulate the work tree may be used, and the
1219 0ebf8283 2019-07-24 stsp .Cm got commit
1220 a698f62e 2019-07-25 stsp command may be used to commit arbitrary changes to the temporary branch
1221 a698f62e 2019-07-25 stsp while the histedit operation is interrupted.
1222 0ebf8283 2019-07-24 stsp .Pp
1223 0ebf8283 2019-07-24 stsp The options for
1224 0ebf8283 2019-07-24 stsp .Cm got histedit
1225 0ebf8283 2019-07-24 stsp are as follows:
1226 0ebf8283 2019-07-24 stsp .Bl -tag -width Ds
1227 0ebf8283 2019-07-24 stsp .It Fl a
1228 0ebf8283 2019-07-24 stsp Abort an interrupted histedit operation.
1229 c478f6d8 2019-08-08 stsp If this option is used, no other command-line arguments are allowed.
1230 0ebf8283 2019-07-24 stsp .It Fl c
1231 0ebf8283 2019-07-24 stsp Continue an interrupted histedit operation.
1232 c478f6d8 2019-08-08 stsp If this option is used, no other command-line arguments are allowed.
1233 ddbfac99 2020-02-24 stsp .It Fl F Ar histedit-script
1234 ddbfac99 2020-02-24 stsp Use the specified
1235 ddbfac99 2020-02-24 stsp .Ar histedit-script
1236 ddbfac99 2020-02-24 stsp instead of opening a temporary file in an editor where a histedit script
1237 ddbfac99 2020-02-24 stsp can be written.
1238 083957f4 2020-02-24 stsp .It Fl m
1239 083957f4 2020-02-24 stsp Edit log messages only.
1240 083957f4 2020-02-24 stsp This option is a quick equivalent to a histedit script which edits
1241 2bdefe56 2020-02-24 tracey only log messages but otherwise leaves every picked commit as-is.
1242 083957f4 2020-02-24 stsp The
1243 083957f4 2020-02-24 stsp .Fl m
1244 083957f4 2020-02-24 stsp option can only be used when starting a new histedit operation.
1245 083957f4 2020-02-24 stsp If this option is used, no other command-line arguments are allowed.
1246 818c7501 2019-07-11 stsp .El
1247 0ebf8283 2019-07-24 stsp .It Cm he
1248 0ebf8283 2019-07-24 stsp Short alias for
1249 0ebf8283 2019-07-24 stsp .Cm histedit .
1250 2822a352 2019-10-15 stsp .It Cm integrate Ar branch
1251 2822a352 2019-10-15 stsp Integrate the specified
1252 2822a352 2019-10-15 stsp .Ar branch
1253 2822a352 2019-10-15 stsp into the work tree's current branch.
1254 2822a352 2019-10-15 stsp Files in the work tree are updated to match the contents on the integrated
1255 2822a352 2019-10-15 stsp .Ar branch ,
1256 2822a352 2019-10-15 stsp and the reference of the work tree's branch is changed to point at the
1257 2822a352 2019-10-15 stsp head commit of the integrated
1258 2822a352 2019-10-15 stsp .Ar branch .
1259 2822a352 2019-10-15 stsp .Pp
1260 2822a352 2019-10-15 stsp Both branches can be considered equivalent after integration since they
1261 2822a352 2019-10-15 stsp will be pointing at the same commit.
1262 2822a352 2019-10-15 stsp Both branches remain available for future work, if desired.
1263 2822a352 2019-10-15 stsp In case the integrated
1264 2822a352 2019-10-15 stsp .Ar branch
1265 2822a352 2019-10-15 stsp is no longer needed it may be deleted with
1266 2822a352 2019-10-15 stsp .Cm got branch -d .
1267 2822a352 2019-10-15 stsp .Pp
1268 2822a352 2019-10-15 stsp Show the status of each affected file, using the following status codes:
1269 2822a352 2019-10-15 stsp .Bl -column YXZ description
1270 2822a352 2019-10-15 stsp .It U Ta file was updated
1271 2822a352 2019-10-15 stsp .It D Ta file was deleted
1272 2822a352 2019-10-15 stsp .It A Ta new file was added
1273 2822a352 2019-10-15 stsp .It \(a~ Ta versioned file is obstructed by a non-regular file
1274 2822a352 2019-10-15 stsp .It ! Ta a missing versioned file was restored
1275 2822a352 2019-10-15 stsp .El
1276 2822a352 2019-10-15 stsp .Pp
1277 2822a352 2019-10-15 stsp .Cm got integrate
1278 2822a352 2019-10-15 stsp will refuse to run if certain preconditions are not met.
1279 2822a352 2019-10-15 stsp Most importantly, the
1280 2822a352 2019-10-15 stsp .Ar branch
1281 2822a352 2019-10-15 stsp must have been rebased onto the work tree's current branch with
1282 2822a352 2019-10-15 stsp .Cm got rebase
1283 2822a352 2019-10-15 stsp before it can be integrated, in order to linearize commit history and
1284 2822a352 2019-10-15 stsp resolve merge conflicts.
1285 2822a352 2019-10-15 stsp If the work tree contains multiple base commits it must first be updated
1286 2822a352 2019-10-15 stsp to a single base commit with
1287 2822a352 2019-10-15 stsp .Cm got update .
1288 2822a352 2019-10-15 stsp If changes have been staged with
1289 2822a352 2019-10-15 stsp .Cm got stage ,
1290 2822a352 2019-10-15 stsp these changes must first be committed with
1291 2822a352 2019-10-15 stsp .Cm got commit
1292 2822a352 2019-10-15 stsp or unstaged with
1293 2822a352 2019-10-15 stsp .Cm got unstage .
1294 2822a352 2019-10-15 stsp If the work tree contains local changes, these changes must first be
1295 2822a352 2019-10-15 stsp committed with
1296 2822a352 2019-10-15 stsp .Cm got commit
1297 2822a352 2019-10-15 stsp or reverted with
1298 2822a352 2019-10-15 stsp .Cm got revert .
1299 2822a352 2019-10-15 stsp .It Cm ig
1300 2822a352 2019-10-15 stsp Short alias for
1301 2822a352 2019-10-15 stsp .Cm integrate .
1302 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 ...
1303 2db2652d 2019-08-07 stsp Stage local changes for inclusion in the next commit.
1304 2db2652d 2019-08-07 stsp If no
1305 2db2652d 2019-08-07 stsp .Ar path
1306 2db2652d 2019-08-07 stsp is specified, stage all changes in the work tree.
1307 2db2652d 2019-08-07 stsp Otherwise, stage changes at or within the specified paths.
1308 4ed9f614 2019-08-04 stsp Paths may be staged if they are added, modified, or deleted according to
1309 4ed9f614 2019-08-04 stsp .Cm got status .
1310 4ed9f614 2019-08-04 stsp .Pp
1311 9d8b19a4 2019-08-04 stsp Show the status of each affected file, using the following status codes:
1312 9d8b19a4 2019-08-04 stsp .Bl -column YXZ description
1313 9d8b19a4 2019-08-04 stsp .It A Ta file addition has been staged
1314 9d8b19a4 2019-08-04 stsp .It M Ta file modification has been staged
1315 9d8b19a4 2019-08-04 stsp .It D Ta file deletion has been staged
1316 9d8b19a4 2019-08-04 stsp .El
1317 9d8b19a4 2019-08-04 stsp .Pp
1318 9d8b19a4 2019-08-04 stsp Staged file contents are saved in newly created blob objects in the repository.
1319 52c8d4ac 2019-08-04 stsp These blobs will be referred to by tree objects once staged changes have been
1320 9d8b19a4 2019-08-04 stsp committed.
1321 9d8b19a4 2019-08-04 stsp .Pp
1322 890ea719 2019-08-04 stsp Staged changes affect the behaviour of
1323 4ed9f614 2019-08-04 stsp .Cm got commit ,
1324 4ed9f614 2019-08-04 stsp .Cm got status ,
1325 4ed9f614 2019-08-04 stsp and
1326 4ed9f614 2019-08-04 stsp .Cm got diff .
1327 4ed9f614 2019-08-04 stsp While paths with staged changes exist, the
1328 4ed9f614 2019-08-04 stsp .Cm got commit
1329 4ed9f614 2019-08-04 stsp command will refuse to commit any paths which do not have staged changes.
1330 4ed9f614 2019-08-04 stsp Local changes created on top of staged changes can only be committed if
1331 4ed9f614 2019-08-04 stsp the path is staged again, or if the staged changes are committed first.
1332 4ed9f614 2019-08-04 stsp The
1333 4ed9f614 2019-08-04 stsp .Cm got status
1334 4ed9f614 2019-08-04 stsp command will show both local changes and staged changes.
1335 4ed9f614 2019-08-04 stsp The
1336 4ed9f614 2019-08-04 stsp .Cm got diff
1337 ecf14362 2019-08-04 stsp command is able to display local changes relative to staged changes,
1338 ecf14362 2019-08-04 stsp and to display staged changes relative to the repository.
1339 4ed9f614 2019-08-04 stsp The
1340 4ed9f614 2019-08-04 stsp .Cm got revert
1341 4ed9f614 2019-08-04 stsp command cannot revert staged changes but may be used to revert
1342 4f2494e6 2019-08-08 stsp local changes created on top of staged changes.
1343 4ed9f614 2019-08-04 stsp .Pp
1344 4ed9f614 2019-08-04 stsp The options for
1345 4ed9f614 2019-08-04 stsp .Cm got stage
1346 4ed9f614 2019-08-04 stsp are as follows:
1347 4ed9f614 2019-08-04 stsp .Bl -tag -width Ds
1348 4ed9f614 2019-08-04 stsp .It Fl l
1349 4ed9f614 2019-08-04 stsp Instead of staging new changes, list paths which are already staged,
1350 9d8b19a4 2019-08-04 stsp along with the IDs of staged blob objects and stage status codes.
1351 9d8b19a4 2019-08-04 stsp If paths were provided in the command line show the staged paths
1352 1dd86744 2019-08-12 anthony among the specified paths.
1353 1dd86744 2019-08-12 anthony Otherwise, show all staged paths.
1354 dc424a06 2019-08-07 stsp .It Fl p
1355 dc424a06 2019-08-07 stsp Instead of staging the entire content of a changed file, interactively
1356 dc424a06 2019-08-07 stsp select or reject changes for staging based on
1357 dc424a06 2019-08-07 stsp .Dq y
1358 6d23ec10 2019-08-08 stsp (stage change),
1359 dc424a06 2019-08-07 stsp .Dq n
1360 6d23ec10 2019-08-08 stsp (reject change), and
1361 b353a198 2019-08-07 stsp .Dq q
1362 6d23ec10 2019-08-08 stsp (quit staging this file) responses.
1363 dc424a06 2019-08-07 stsp If a file is in modified status, individual patches derived from the
1364 dc424a06 2019-08-07 stsp modified file content can be staged.
1365 6d23ec10 2019-08-08 stsp Files in added or deleted status may only be staged or rejected in
1366 6d23ec10 2019-08-08 stsp their entirety.
1367 3a070a2b 2019-08-07 stsp .It Fl F Ar response-script
1368 dc424a06 2019-08-07 stsp With the
1369 dc424a06 2019-08-07 stsp .Fl p
1370 3a070a2b 2019-08-07 stsp option, read
1371 3a070a2b 2019-08-07 stsp .Dq y ,
1372 3a070a2b 2019-08-07 stsp .Dq n ,
1373 3a070a2b 2019-08-07 stsp and
1374 3a070a2b 2019-08-07 stsp .Dq q
1375 0e2f5884 2019-08-07 stsp responses line-by-line from the specified
1376 0e2f5884 2019-08-07 stsp .Ar response-script
1377 0e2f5884 2019-08-07 stsp file instead of prompting interactively.
1378 4ed9f614 2019-08-04 stsp .El
1379 4ed9f614 2019-08-04 stsp .Pp
1380 4ed9f614 2019-08-04 stsp .Cm got stage
1381 4ed9f614 2019-08-04 stsp will refuse to run if certain preconditions are not met.
1382 4ed9f614 2019-08-04 stsp If a file contains merge conflicts, these conflicts must be resolved first.
1383 4ed9f614 2019-08-04 stsp If a file is found to be out of date relative to the head commit on the
1384 4ed9f614 2019-08-04 stsp work tree's current branch, the file must be updated with
1385 4ed9f614 2019-08-04 stsp .Cm got update
1386 4ed9f614 2019-08-04 stsp before it can be staged (however, this does not prevent the file from
1387 4ed9f614 2019-08-04 stsp becoming out-of-date at some point after having been staged).
1388 4ed9f614 2019-08-04 stsp .Pp
1389 4ed9f614 2019-08-04 stsp The
1390 4ed9f614 2019-08-04 stsp .Cm got update ,
1391 4ed9f614 2019-08-04 stsp .Cm got rebase ,
1392 4ed9f614 2019-08-04 stsp and
1393 4ed9f614 2019-08-04 stsp .Cm got histedit
1394 4ed9f614 2019-08-04 stsp commands will refuse to run while staged changes exist.
1395 4ed9f614 2019-08-04 stsp If staged changes cannot be committed because a staged path
1396 4ed9f614 2019-08-04 stsp is out of date, the path must be unstaged with
1397 4ed9f614 2019-08-04 stsp .Cm got unstage
1398 4ed9f614 2019-08-04 stsp before it can be updated with
1399 4ed9f614 2019-08-04 stsp .Cm got update ,
1400 4ed9f614 2019-08-04 stsp and may then be staged again if necessary.
1401 4ed9f614 2019-08-04 stsp .It Cm sg
1402 4ed9f614 2019-08-04 stsp Short alias for
1403 4ed9f614 2019-08-04 stsp .Cm stage .
1404 dfc23429 2019-08-11 stsp .It Cm unstage Oo Fl p Oc Oo Fl F Ar response-script Oc Op Ar path ...
1405 4ed9f614 2019-08-04 stsp Merge staged changes back into the work tree and put affected paths
1406 4ed9f614 2019-08-04 stsp back into non-staged status.
1407 4ed9f614 2019-08-04 stsp If no
1408 4ed9f614 2019-08-04 stsp .Ar path
1409 4ed9f614 2019-08-04 stsp is specified, unstage all staged changes across the entire work tree.
1410 2db2652d 2019-08-07 stsp Otherwise, unstage changes at or within the specified paths.
1411 4ed9f614 2019-08-04 stsp .Pp
1412 4ed9f614 2019-08-04 stsp Show the status of each affected file, using the following status codes:
1413 4ed9f614 2019-08-04 stsp .Bl -column YXZ description
1414 4ed9f614 2019-08-04 stsp .It G Ta file was unstaged
1415 4ed9f614 2019-08-04 stsp .It C Ta file was unstaged and conflicts occurred during merge
1416 4ed9f614 2019-08-04 stsp .It ! Ta changes destined for a missing file were not merged
1417 4ed9f614 2019-08-04 stsp .It D Ta file was staged as deleted and still is deleted
1418 4ed9f614 2019-08-04 stsp .It d Ta file's deletion was obstructed by local modifications
1419 1dd86744 2019-08-12 anthony .It \(a~ Ta changes destined for a non-regular file were not merged
1420 4ed9f614 2019-08-04 stsp .El
1421 2e1f37b0 2019-08-08 stsp .Pp
1422 2e1f37b0 2019-08-08 stsp The options for
1423 2e1f37b0 2019-08-08 stsp .Cm got unstage
1424 2e1f37b0 2019-08-08 stsp are as follows:
1425 2e1f37b0 2019-08-08 stsp .Bl -tag -width Ds
1426 2e1f37b0 2019-08-08 stsp .It Fl p
1427 2e1f37b0 2019-08-08 stsp Instead of unstaging the entire content of a changed file, interactively
1428 2e1f37b0 2019-08-08 stsp select or reject changes for unstaging based on
1429 2e1f37b0 2019-08-08 stsp .Dq y
1430 2e1f37b0 2019-08-08 stsp (unstage change),
1431 2e1f37b0 2019-08-08 stsp .Dq n
1432 2e1f37b0 2019-08-08 stsp (keep change staged), and
1433 2e1f37b0 2019-08-08 stsp .Dq q
1434 2e1f37b0 2019-08-08 stsp (quit unstaging this file) responses.
1435 2e1f37b0 2019-08-08 stsp If a file is staged in modified status, individual patches derived from the
1436 2e1f37b0 2019-08-08 stsp staged file content can be unstaged.
1437 2e1f37b0 2019-08-08 stsp Files staged in added or deleted status may only be unstaged in their entirety.
1438 2e1f37b0 2019-08-08 stsp .It Fl F Ar response-script
1439 2e1f37b0 2019-08-08 stsp With the
1440 2e1f37b0 2019-08-08 stsp .Fl p
1441 2e1f37b0 2019-08-08 stsp option, read
1442 2e1f37b0 2019-08-08 stsp .Dq y ,
1443 2e1f37b0 2019-08-08 stsp .Dq n ,
1444 2e1f37b0 2019-08-08 stsp and
1445 2e1f37b0 2019-08-08 stsp .Dq q
1446 2e1f37b0 2019-08-08 stsp responses line-by-line from the specified
1447 2e1f37b0 2019-08-08 stsp .Ar response-script
1448 2e1f37b0 2019-08-08 stsp file instead of prompting interactively.
1449 2e1f37b0 2019-08-08 stsp .El
1450 4ed9f614 2019-08-04 stsp .It Cm ug
1451 4ed9f614 2019-08-04 stsp Short alias for
1452 4ed9f614 2019-08-04 stsp .Cm unstage .
1453 5be72254 2019-08-26 stsp .It Cm cat Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Oo Fl P Oc Ar arg ...
1454 896e9b6f 2019-08-26 stsp Parse and print contents of objects to standard output in a line-based
1455 896e9b6f 2019-08-26 stsp text format.
1456 896e9b6f 2019-08-26 stsp Content of commit, tree, and tag objects is printed in a way similar
1457 896e9b6f 2019-08-26 stsp to the actual content stored in such objects.
1458 896e9b6f 2019-08-26 stsp Blob object contents are printed as they would appear in files on disk.
1459 896e9b6f 2019-08-26 stsp .Pp
1460 896e9b6f 2019-08-26 stsp Attempt to interpret each argument as a reference, a tag name, or
1461 896e9b6f 2019-08-26 stsp an object ID SHA1 hash.
1462 01073a5d 2019-08-22 stsp References will be resolved to an object ID.
1463 01073a5d 2019-08-22 stsp Tag names will resolved to a tag object.
1464 01073a5d 2019-08-22 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
1465 01073a5d 2019-08-22 stsp automatically, provided the abbreviation is unique.
1466 01073a5d 2019-08-22 stsp .Pp
1467 896e9b6f 2019-08-26 stsp If none of the above interpretations produce a valid result, or if the
1468 896e9b6f 2019-08-26 stsp .Fl P
1469 896e9b6f 2019-08-26 stsp option is used, attempt to interpret the argument as a path which will
1470 896e9b6f 2019-08-26 stsp be resolved to the ID of an object found at this path in the repository.
1471 896e9b6f 2019-08-26 stsp .Pp
1472 01073a5d 2019-08-22 stsp The options for
1473 01073a5d 2019-08-22 stsp .Cm got cat
1474 01073a5d 2019-08-22 stsp are as follows:
1475 01073a5d 2019-08-22 stsp .Bl -tag -width Ds
1476 896e9b6f 2019-08-26 stsp .It Fl c Ar commit
1477 896e9b6f 2019-08-26 stsp Look up paths in the specified
1478 896e9b6f 2019-08-26 stsp .Ar commit .
1479 896e9b6f 2019-08-26 stsp If this option is not used, paths are looked up in the commit resolved
1480 896e9b6f 2019-08-26 stsp via the repository's HEAD reference.
1481 896e9b6f 2019-08-26 stsp The expected argument is a commit ID SHA1 hash or an existing reference
1482 896e9b6f 2019-08-26 stsp or tag name which will be resolved to a commit ID.
1483 896e9b6f 2019-08-26 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
1484 896e9b6f 2019-08-26 stsp automatically, provided the abbreviation is unique.
1485 01073a5d 2019-08-22 stsp .It Fl r Ar repository-path
1486 01073a5d 2019-08-22 stsp Use the repository at the specified path.
1487 01073a5d 2019-08-22 stsp If not specified, assume the repository is located at or above the current
1488 01073a5d 2019-08-22 stsp working directory.
1489 01073a5d 2019-08-22 stsp If this directory is a
1490 01073a5d 2019-08-22 stsp .Nm
1491 01073a5d 2019-08-22 stsp work tree, use the repository path associated with this work tree.
1492 896e9b6f 2019-08-26 stsp .It Fl P
1493 896e9b6f 2019-08-26 stsp Interpret all arguments as paths only.
1494 896e9b6f 2019-08-26 stsp This option can be used to resolve ambiguity in cases where paths
1495 896e9b6f 2019-08-26 stsp look like tag names, reference names, or object IDs.
1496 4ed9f614 2019-08-04 stsp .El
1497 01073a5d 2019-08-22 stsp .El
1498 74416c47 2019-05-09 stsp .Sh ENVIRONMENT
1499 74416c47 2019-05-09 stsp .Bl -tag -width GOT_AUTHOR
1500 74416c47 2019-05-09 stsp .It Ev GOT_AUTHOR
1501 74416c47 2019-05-09 stsp The author's name and email address for
1502 21a44f98 2019-07-15 stsp .Cm got commit
1503 21a44f98 2019-07-15 stsp and
1504 21a44f98 2019-07-15 stsp .Cm got import ,
1505 74416c47 2019-05-09 stsp for example:
1506 aba9c984 2019-09-08 stsp .Dq An Flan Hacker Aq Mt flan_hacker@openbsd.org .
1507 84792843 2019-08-09 stsp Because
1508 0e444aba 2019-08-08 stsp .Xr git 1
1509 84792843 2019-08-09 stsp may fail to parse commits without an email address in author data,
1510 0e444aba 2019-08-08 stsp .Nm
1511 84792843 2019-08-09 stsp attempts to reject
1512 0e444aba 2019-08-08 stsp .Ev GOT_AUTHOR
1513 84792843 2019-08-09 stsp environment variables with a missing email address.
1514 c9956ddf 2019-09-08 stsp .Pp
1515 c9956ddf 2019-09-08 stsp If present, Git's
1516 aba9c984 2019-09-08 stsp .Dv user.name
1517 aba9c984 2019-09-08 stsp and
1518 709ae9eb 2019-09-08 stsp .Dv user.email
1519 709ae9eb 2019-09-08 stsp configuration settings in the repository's
1520 aba9c984 2019-09-08 stsp .Pa .git/config
1521 aba9c984 2019-09-08 stsp file will override the value of
1522 aba9c984 2019-09-08 stsp .Ev GOT_AUTHOR .
1523 c9956ddf 2019-09-08 stsp However, the
1524 c9956ddf 2019-09-08 stsp .Dv user.name
1525 c9956ddf 2019-09-08 stsp and
1526 c9956ddf 2019-09-08 stsp .Dv user.email
1527 c9956ddf 2019-09-08 stsp configuration settings contained in Git's global
1528 c9956ddf 2019-09-08 stsp .Pa ~/.gitconfig
1529 c9956ddf 2019-09-08 stsp configuration file will be used only if the
1530 c9956ddf 2019-09-08 stsp .Ev GOT_AUTHOR
1531 c9956ddf 2019-09-08 stsp environment variable is
1532 c9956ddf 2019-09-08 stsp .Em not
1533 c9956ddf 2019-09-08 stsp set.
1534 1dd86744 2019-08-12 anthony .It Ev VISUAL , EDITOR
1535 23594da9 2019-05-13 stsp The editor spawned by
1536 8e7bd50a 2019-08-22 stsp .Cm got commit ,
1537 8e7bd50a 2019-08-22 stsp .Cm got import ,
1538 8e7bd50a 2019-08-22 stsp or
1539 8e7bd50a 2019-08-22 stsp .Cm got tag .
1540 b1ebc001 2019-08-13 stsp .It Ev GOT_LOG_DEFAULT_LIMIT
1541 b1ebc001 2019-08-13 stsp The default limit on the number of commits traversed by
1542 b1ebc001 2019-08-13 stsp .Cm got log .
1543 b1ebc001 2019-08-13 stsp If set to zero, the limit is unbounded.
1544 b1ebc001 2019-08-13 stsp This variable will be silently ignored if it is set to a non-numeric value.
1545 74416c47 2019-05-09 stsp .El
1546 5c860e29 2018-03-12 stsp .Sh EXIT STATUS
1547 5c860e29 2018-03-12 stsp .Ex -std got
1548 97925469 2018-03-17 stsp .Sh EXAMPLES
1549 fa6e0e48 2019-05-23 stsp Clone an existing Git repository for use with
1550 fa6e0e48 2019-05-23 stsp .Nm .
1551 fd039d72 2020-03-18 stsp .Pp
1552 fd039d72 2020-03-18 stsp .Dl $ cd /var/git/
1553 fd039d72 2020-03-18 stsp .Dl $ got clone ssh://git@github.com/openbsd/src.git
1554 fd039d72 2020-03-18 stsp .Pp
1555 fd039d72 2020-03-18 stsp Use of HTTP URLs currently requires
1556 fa6e0e48 2019-05-23 stsp .Xr git 1 :
1557 d83d9d5c 2019-05-13 stsp .Pp
1558 fa6e0e48 2019-05-23 stsp .Dl $ cd /var/git/
1559 fa6e0e48 2019-05-23 stsp .Dl $ git clone --bare https://github.com/openbsd/src.git
1560 fa6e0e48 2019-05-23 stsp .Pp
1561 3ce1b845 2019-07-15 stsp Alternatively, for quick and dirty local testing of
1562 3ce1b845 2019-07-15 stsp .Nm
1563 3ce1b845 2019-07-15 stsp a new Git repository could be created and populated with files,
1564 3ce1b845 2019-07-15 stsp e.g. from a temporary CVS checkout located at
1565 3ce1b845 2019-07-15 stsp .Pa /tmp/src :
1566 fa6e0e48 2019-05-23 stsp .Pp
1567 3ce1b845 2019-07-15 stsp .Dl $ got init /var/git/src.git
1568 2930ef13 2019-07-15 stsp .Dl $ got import -r /var/git/src.git -I CVS -I obj /tmp/src
1569 3ce1b845 2019-07-15 stsp .Pp
1570 3ce1b845 2019-07-15 stsp Check out a work tree from the Git repository to /usr/src:
1571 3ce1b845 2019-07-15 stsp .Pp
1572 fa6e0e48 2019-05-23 stsp .Dl $ got checkout /var/git/src.git /usr/src
1573 fa6e0e48 2019-05-23 stsp .Pp
1574 e70c17ce 2019-05-22 stsp View local changes in a work tree directory:
1575 e70c17ce 2019-05-22 stsp .Pp
1576 e70c17ce 2019-05-22 stsp .Dl $ got status
1577 e70c17ce 2019-05-22 stsp .Dl $ got diff | less
1578 33aa809d 2019-08-08 stsp .Pp
1579 33aa809d 2019-08-08 stsp Interactively revert selected local changes in a work tree directory:
1580 e70c17ce 2019-05-22 stsp .Pp
1581 33aa809d 2019-08-08 stsp .Dl $ got revert -p -R\ .
1582 33aa809d 2019-08-08 stsp .Pp
1583 e70c17ce 2019-05-22 stsp In a work tree or a git repository directory, list all branch references:
1584 e70c17ce 2019-05-22 stsp .Pp
1585 4e759de4 2019-06-26 stsp .Dl $ got branch -l
1586 e70c17ce 2019-05-22 stsp .Pp
1587 fa6e0e48 2019-05-23 stsp In a work tree or a git repository directory, create a new branch called
1588 e70c17ce 2019-05-22 stsp .Dq unified-buffer-cache
1589 d83d9d5c 2019-05-13 stsp which is forked off the
1590 d83d9d5c 2019-05-13 stsp .Dq master
1591 d83d9d5c 2019-05-13 stsp branch:
1592 d83d9d5c 2019-05-13 stsp .Pp
1593 4e759de4 2019-06-26 stsp .Dl $ got branch unified-buffer-cache master
1594 e70c17ce 2019-05-22 stsp .Pp
1595 e70c17ce 2019-05-22 stsp Switch an existing work tree to the branch
1596 e70c17ce 2019-05-22 stsp .Dq unified-buffer-cache .
1597 e70c17ce 2019-05-22 stsp Local changes in the work tree will be preserved and merged if necessary:
1598 e70c17ce 2019-05-22 stsp .Pp
1599 e70c17ce 2019-05-22 stsp .Dl $ got update -b unified-buffer-cache
1600 e70c17ce 2019-05-22 stsp .Pp
1601 fa6e0e48 2019-05-23 stsp Create a new commit from local changes in a work tree directory.
1602 fa6e0e48 2019-05-23 stsp This new commit will become the head commit of the work tree's current branch:
1603 fa6e0e48 2019-05-23 stsp .Pp
1604 fa6e0e48 2019-05-23 stsp .Dl $ got commit
1605 fa6e0e48 2019-05-23 stsp .Pp
1606 fa6e0e48 2019-05-23 stsp In a work tree or a git repository directory, view changes committed in
1607 fa6e0e48 2019-05-23 stsp the 3 most recent commits to the work tree's branch, or the branch resolved
1608 fa6e0e48 2019-05-23 stsp via the repository's HEAD reference, respectively:
1609 fa6e0e48 2019-05-23 stsp .Pp
1610 48c8c60d 2020-01-27 stsp .Dl $ got log -p -l 3
1611 5b666081 2020-02-24 stsp .Pp
1612 5b666081 2020-02-24 stsp In a work tree or a git repository directory, log the history of a subdirectory:
1613 5b666081 2020-02-24 stsp .Pp
1614 5b666081 2020-02-24 stsp .Dl $ got log sys/uvm
1615 5b666081 2020-02-24 stsp .Pp
1616 5b666081 2020-02-24 stsp While operating inside a work tree, paths are specified relative to the current
1617 5b666081 2020-02-24 stsp working directory, so this command will log the subdirectory
1618 5b666081 2020-02-24 stsp .Pa sys/uvm :
1619 fa6e0e48 2019-05-23 stsp .Pp
1620 5b666081 2020-02-24 stsp .Dl $ cd sys/uvm && got log '.'
1621 5b666081 2020-02-24 stsp .Pp
1622 5b666081 2020-02-24 stsp And this command has the same effect:
1623 5b666081 2020-02-24 stsp .Pp
1624 5b666081 2020-02-24 stsp .Dl $ cd sys/dev/usb && got log ../../uvm
1625 5b666081 2020-02-24 stsp .Pp
1626 e70c17ce 2019-05-22 stsp Add new files and remove obsolete files in a work tree directory:
1627 e70c17ce 2019-05-22 stsp .Pp
1628 fa6e0e48 2019-05-23 stsp .Dl $ got add sys/uvm/uvm_ubc.c
1629 86d25a1b 2019-07-11 stsp .Dl $ got remove sys/uvm/uvm_vnode.c
1630 e70c17ce 2019-05-22 stsp .Pp
1631 e70c17ce 2019-05-22 stsp Create a new commit from local changes in a work tree directory
1632 e70c17ce 2019-05-22 stsp with a pre-defined log message.
1633 e70c17ce 2019-05-22 stsp .Pp
1634 e70c17ce 2019-05-22 stsp .Dl $ got commit -m 'unify the buffer cache'
1635 95fc3404 2019-07-15 stsp .Pp
1636 95fc3404 2019-07-15 stsp Update any work tree checked out from the
1637 95fc3404 2019-07-15 stsp .Dq unified-buffer-cache
1638 95fc3404 2019-07-15 stsp branch to the latest commit on this branch:
1639 95fc3404 2019-07-15 stsp .Pp
1640 95fc3404 2019-07-15 stsp .Dl $ got update
1641 ac90e726 2019-07-15 stsp .Pp
1642 c991308a 2019-07-15 stsp Roll file content on the unified-buffer-cache branch back by one commit,
1643 c991308a 2019-07-15 stsp and then fetch the rolled-back change into the work tree as a local change
1644 ac90e726 2019-07-15 stsp to be amended and perhaps committed again:
1645 e70c17ce 2019-05-22 stsp .Pp
1646 ac90e726 2019-07-15 stsp .Dl $ got backout unified-buffer-cache
1647 ac90e726 2019-07-15 stsp .Dl $ got commit -m 'roll back previous'
1648 59d52b88 2019-07-15 stsp .Dl $ # now back out the previous backout :-)
1649 ac90e726 2019-07-15 stsp .Dl $ got backout unified-buffer-cache
1650 ac90e726 2019-07-15 stsp .Pp
1651 9221fb1e 2019-06-26 stsp Fetch new upstream commits into the local repository's master branch.
1652 9221fb1e 2019-06-26 stsp This step currently requires
1653 9221fb1e 2019-06-26 stsp .Xr git 1 :
1654 fa6e0e48 2019-05-23 stsp .Pp
1655 fa6e0e48 2019-05-23 stsp .Dl $ cd /var/git/src.git
1656 fa6e0e48 2019-05-23 stsp .Dl $ git fetch origin master:master
1657 fa6e0e48 2019-05-23 stsp .Pp
1658 fa6e0e48 2019-05-23 stsp Rebase the
1659 fa6e0e48 2019-05-23 stsp .Dq unified-buffer-cache
1660 fa6e0e48 2019-05-23 stsp branch on top of the new head commit of the
1661 fa6e0e48 2019-05-23 stsp .Dq master
1662 fa6e0e48 2019-05-23 stsp branch.
1663 fa6e0e48 2019-05-23 stsp .Pp
1664 818c7501 2019-07-11 stsp .Dl $ got update -b master
1665 818c7501 2019-07-11 stsp .Dl $ got rebase unified-buffer-cache
1666 7d7ffedb 2019-07-14 stsp .Pp
1667 7d7ffedb 2019-07-14 stsp Create a patch from all changes on the unified-buffer-cache branch.
1668 1dd86744 2019-08-12 anthony The patch can be mailed out for review and applied to
1669 1dd86744 2019-08-12 anthony .Ox Ns 's
1670 1dd86744 2019-08-12 anthony CVS tree:
1671 7d7ffedb 2019-07-14 stsp .Pp
1672 7d7ffedb 2019-07-14 stsp .Dl $ got diff master unified-buffer-cache > /tmp/ubc.diff
1673 7d7ffedb 2019-07-14 stsp .Pp
1674 0ebf8283 2019-07-24 stsp Edit the entire commit history of the
1675 0ebf8283 2019-07-24 stsp .Dq unified-buffer-cache
1676 0ebf8283 2019-07-24 stsp branch:
1677 0ebf8283 2019-07-24 stsp .Pp
1678 0ebf8283 2019-07-24 stsp .Dl $ got update -b unified-buffer-cache
1679 0ebf8283 2019-07-24 stsp .Dl $ got update -c master
1680 0ebf8283 2019-07-24 stsp .Dl $ got histedit
1681 ff2cf171 2019-07-28 stsp .Pp
1682 7b3fde24 2019-07-28 stsp Additional steps are necessary if local changes need to be pushed back
1683 7b3fde24 2019-07-28 stsp to the remote repository, which currently requires
1684 7b3fde24 2019-07-28 stsp .Cm git fetch
1685 7b3fde24 2019-07-28 stsp and
1686 7b3fde24 2019-07-28 stsp .Cm git push .
1687 ff2cf171 2019-07-28 stsp Before working against existing branches in a repository cloned with
1688 ff2cf171 2019-07-28 stsp .Dq git clone --bare ,
1689 ff2cf171 2019-07-28 stsp a Git
1690 ff2cf171 2019-07-28 stsp .Dq refspec
1691 ff2cf171 2019-07-28 stsp must be configured to map all references in the remote repository
1692 ff2cf171 2019-07-28 stsp into the
1693 ff2cf171 2019-07-28 stsp .Dq refs/remotes
1694 ff2cf171 2019-07-28 stsp namespace of the local repository.
1695 ff2cf171 2019-07-28 stsp This can achieved by setting Git's
1696 ff2cf171 2019-07-28 stsp .Pa remote.origin.fetch
1697 ff2cf171 2019-07-28 stsp configuration variable to the value
1698 ff2cf171 2019-07-28 stsp .Dq +refs/heads/*:refs/remotes/origin/*
1699 ff2cf171 2019-07-28 stsp with the
1700 ff2cf171 2019-07-28 stsp .Cm git config
1701 ff2cf171 2019-07-28 stsp command:
1702 ff2cf171 2019-07-28 stsp .Pp
1703 ff2cf171 2019-07-28 stsp .Dl $ cd /var/git/repo
1704 ff2cf171 2019-07-28 stsp .Dl $ git config remote.origin.fetch '+refs/heads/*:refs/remotes/origin/*'
1705 ff2cf171 2019-07-28 stsp .Pp
1706 ff2cf171 2019-07-28 stsp Alternatively, the following
1707 ff2cf171 2019-07-28 stsp .Pa fetch
1708 ff2cf171 2019-07-28 stsp configuration item can be added manually to the Git repository's
1709 ff2cf171 2019-07-28 stsp .Pa config
1710 ff2cf171 2019-07-28 stsp file:
1711 0ebf8283 2019-07-24 stsp .Pp
1712 ff2cf171 2019-07-28 stsp .Dl [remote "origin"]
1713 ff2cf171 2019-07-28 stsp .Dl url = ...
1714 ff2cf171 2019-07-28 stsp .Dl fetch = +refs/heads/*:refs/remotes/origin/*
1715 ff2cf171 2019-07-28 stsp .Pp
1716 fe307c9b 2019-07-28 stsp This configuration leaves the local repository's
1717 ff2cf171 2019-07-28 stsp .Dq refs/heads
1718 ff2cf171 2019-07-28 stsp namespace free for use by local branches checked out with
1719 ff2cf171 2019-07-28 stsp .Cm got checkout
1720 ff2cf171 2019-07-28 stsp and, if needed, created with
1721 ff2cf171 2019-07-28 stsp .Cm got branch .
1722 ff2cf171 2019-07-28 stsp .Pp
1723 ff2cf171 2019-07-28 stsp Branches in the
1724 ff2cf171 2019-07-28 stsp .Dq remotes/origin
1725 ff2cf171 2019-07-28 stsp namespace can be updated with incoming changes from the remote
1726 ff2cf171 2019-07-28 stsp repository with
1727 ff2cf171 2019-07-28 stsp .Cm git fetch :
1728 ff2cf171 2019-07-28 stsp .Pp
1729 ff2cf171 2019-07-28 stsp .Dl $ cd /var/git/repo
1730 ff2cf171 2019-07-28 stsp .Dl $ git fetch
1731 ff2cf171 2019-07-28 stsp .Pp
1732 7b0db533 2020-02-04 stsp To make changes fetched from the remote repository appear on the
1733 ff2cf171 2019-07-28 stsp .Dq master
1734 7b0db533 2020-02-04 stsp branch, the
1735 ff2cf171 2019-07-28 stsp .Dq master
1736 ff2cf171 2019-07-28 stsp branch must be rebased onto the
1737 ff2cf171 2019-07-28 stsp .Dq origin/master
1738 7b0db533 2020-02-04 stsp branch.
1739 7b0db533 2020-02-04 stsp This will also merge local changes, if any, with the incoming changes:
1740 ff2cf171 2019-07-28 stsp .Pp
1741 ff2cf171 2019-07-28 stsp .Dl $ got update -b origin/master
1742 ff2cf171 2019-07-28 stsp .Dl $ got rebase master
1743 083957f4 2020-02-24 stsp .Pp
1744 083957f4 2020-02-24 stsp On the
1745 083957f4 2020-02-24 stsp .Dq master
1746 083957f4 2020-02-24 stsp branch, log messages for local changes can now be amended with
1747 083957f4 2020-02-24 stsp .Dq OK
1748 083957f4 2020-02-24 stsp by other developers and any other important new information:
1749 ff2cf171 2019-07-28 stsp .Pp
1750 083957f4 2020-02-24 stsp .Dl $ got update -c origin/master
1751 083957f4 2020-02-24 stsp .Dl $ got histedit -m
1752 083957f4 2020-02-24 stsp .Pp
1753 7b0db533 2020-02-04 stsp Local changes on the
1754 ff2cf171 2019-07-28 stsp .Dq master
1755 ff2cf171 2019-07-28 stsp branch can then be pushed to the remote
1756 ff2cf171 2019-07-28 stsp repository with
1757 ff2cf171 2019-07-28 stsp .Cm git push :
1758 ff2cf171 2019-07-28 stsp .Pp
1759 ff2cf171 2019-07-28 stsp .Dl $ cd /var/git/repo
1760 ff2cf171 2019-07-28 stsp .Dl $ git push origin master
1761 14c25ea2 2019-10-15 stsp .Pp
1762 14c25ea2 2019-10-15 stsp In order to merge changes committed to the
1763 14c25ea2 2019-10-15 stsp .Dq unified-buffer-cache
1764 14c25ea2 2019-10-15 stsp branch back into the
1765 14c25ea2 2019-10-15 stsp .Dq master
1766 14c25ea2 2019-10-15 stsp branch, the
1767 14c25ea2 2019-10-15 stsp .Dq unified-buffer-cache
1768 14c25ea2 2019-10-15 stsp branch must first be rebased onto the
1769 14c25ea2 2019-10-15 stsp .Dq master
1770 14c25ea2 2019-10-15 stsp branch:
1771 14c25ea2 2019-10-15 stsp .Pp
1772 14c25ea2 2019-10-15 stsp .Dl $ got update -b master
1773 14c25ea2 2019-10-15 stsp .Dl $ got rebase unified-buffer-cache
1774 14c25ea2 2019-10-15 stsp .Pp
1775 14c25ea2 2019-10-15 stsp Changes on the
1776 14c25ea2 2019-10-15 stsp .Dq unified-buffer-cache
1777 14c25ea2 2019-10-15 stsp branch can now be made visible on the
1778 14c25ea2 2019-10-15 stsp .Dq master
1779 14c25ea2 2019-10-15 stsp branch with
1780 14c25ea2 2019-10-15 stsp .Cm got integrate .
1781 14c25ea2 2019-10-15 stsp Because the rebase operation switched the work tree to the
1782 14c25ea2 2019-10-15 stsp .Dq unified-buffer-cache
1783 14c25ea2 2019-10-15 stsp branch, the work tree must be switched back to the
1784 14c25ea2 2019-10-15 stsp .Dq master
1785 14c25ea2 2019-10-15 stsp branch before the
1786 14c25ea2 2019-10-15 stsp .Dq unified-buffer-cache
1787 14c25ea2 2019-10-15 stsp branch can be integrated into
1788 14c25ea2 2019-10-15 stsp .Dq master :
1789 14c25ea2 2019-10-15 stsp .Pp
1790 14c25ea2 2019-10-15 stsp .Dl $ got update -b master
1791 14c25ea2 2019-10-15 stsp .Dl $ got integrate unified-buffer-cache
1792 5c860e29 2018-03-12 stsp .Sh SEE ALSO
1793 2312fc47 2019-07-15 stsp .Xr tog 1 ,
1794 2312fc47 2019-07-15 stsp .Xr git-repository 5 ,
1795 285dc8a4 2018-03-13 stsp .Xr got-worktree 5
1796 1a208aaf 2018-04-01 stsp .Sh AUTHORS
1797 1a208aaf 2018-04-01 stsp .An Stefan Sperling Aq Mt stsp@openbsd.org
1798 1a208aaf 2018-04-01 stsp .An Martin Pieuchot Aq Mt mpi@openbsd.org
1799 bc3056e3 2019-08-18 stsp .An Joshua Stein Aq Mt jcs@openbsd.org
1800 83b416ed 2020-03-18 stsp .An Ori Bernstein Aq Mt ori@openbsd.org
1801 fa6e0e48 2019-05-23 stsp .Sh CAVEATS
1802 fa6e0e48 2019-05-23 stsp .Nm
1803 fa6e0e48 2019-05-23 stsp is a work-in-progress and many commands remain to be implemented.
1804 fa6e0e48 2019-05-23 stsp At present, the user has to fall back on
1805 fa6e0e48 2019-05-23 stsp .Xr git 1
1806 ff2cf171 2019-07-28 stsp to perform many tasks, in particular tasks related to repository
1807 ff2cf171 2019-07-28 stsp administration and tasks which require a network connection.