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