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