2 20662ea0 2021-04-10 stsp .\" Copyright (c) 2021 Stefan Sperling
4 20662ea0 2021-04-10 stsp .\" Permission to use, copy, modify, and distribute this software for any
5 20662ea0 2021-04-10 stsp .\" purpose with or without fee is hereby granted, provided that the above
6 20662ea0 2021-04-10 stsp .\" copyright notice and this permission notice appear in all copies.
8 20662ea0 2021-04-10 stsp .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9 20662ea0 2021-04-10 stsp .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10 20662ea0 2021-04-10 stsp .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11 20662ea0 2021-04-10 stsp .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12 20662ea0 2021-04-10 stsp .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13 20662ea0 2021-04-10 stsp .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14 20662ea0 2021-04-10 stsp .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16 20662ea0 2021-04-10 stsp .Dd $Mdocdate$
17 20662ea0 2021-04-10 stsp .Dt GOTADMIN 1
20 20662ea0 2021-04-10 stsp .Nm gotadmin
21 20662ea0 2021-04-10 stsp .Nd Game of Trees repository administration
22 20662ea0 2021-04-10 stsp .Sh SYNOPSIS
26 20662ea0 2021-04-10 stsp .Op Ar arg ...
27 20662ea0 2021-04-10 stsp .Sh DESCRIPTION
29 20662ea0 2021-04-10 stsp is the repository maintenance tool for the
31 20662ea0 2021-04-10 stsp version control system.
34 20662ea0 2021-04-10 stsp stores the history of tracked files in a Git repository, as used
35 20662ea0 2021-04-10 stsp by the Git version control system.
37 20662ea0 2021-04-10 stsp provides commands for inspecting and manipulating the on-disk state of
38 20662ea0 2021-04-10 stsp Git repositories.
39 20662ea0 2021-04-10 stsp The repository format is described in
40 20662ea0 2021-04-10 stsp .Xr git-repository 5 .
43 20662ea0 2021-04-10 stsp provides global and command-specific options.
44 20662ea0 2021-04-10 stsp Global options must precede the command name, and are as follows:
45 20662ea0 2021-04-10 stsp .Bl -tag -width tenletters
47 20662ea0 2021-04-10 stsp Display usage information and exit immediately.
48 20662ea0 2021-04-10 stsp .It Fl V , -version
49 20662ea0 2021-04-10 stsp Display program version and exit immediately.
52 20662ea0 2021-04-10 stsp The commands for
54 20662ea0 2021-04-10 stsp are as follows:
55 20662ea0 2021-04-10 stsp .Bl -tag -width checkout
56 e9424ba1 2022-09-20 thomas .It Cm init Oo Fl b Ar branch Oc Ar repository-path
57 27b10c3c 2022-07-04 thomas Create a new empty repository at the specified
58 27b10c3c 2022-07-04 thomas .Ar repository-path .
61 27b10c3c 2022-07-04 thomas .Cm gotadmin init ,
63 27b10c3c 2022-07-04 thomas .Cm got import
64 27b10c3c 2022-07-04 thomas command must be used to populate the empty repository before
65 27b10c3c 2022-07-04 thomas .Cm got checkout
66 27b10c3c 2022-07-04 thomas can be used.
68 e9424ba1 2022-09-20 thomas The options for
69 e9424ba1 2022-09-20 thomas .Cm gotadmin init
70 e9424ba1 2022-09-20 thomas are as follows:
71 e9424ba1 2022-09-20 thomas .Bl -tag -width Ds
72 e9424ba1 2022-09-20 thomas .It Fl b Ar branch
73 e9424ba1 2022-09-20 thomas Make the repository's HEAD reference point to the specified
74 e9424ba1 2022-09-20 thomas .Ar branch
75 e9424ba1 2022-09-20 thomas instead of the default branch
76 e9424ba1 2022-09-20 thomas .Dq main .
78 56c96eff 2022-08-30 thomas .It Cm info Op Fl r Ar repository-path
79 20662ea0 2021-04-10 stsp Display information about a repository.
80 20662ea0 2021-04-10 stsp This includes some configuration settings from
81 20662ea0 2021-04-10 stsp .Xr got.conf 5 ,
82 20662ea0 2021-04-10 stsp and the number of objects stored in the repository, in packed or
83 20662ea0 2021-04-10 stsp loose form, as well as the current on-disk size of these objects.
85 20662ea0 2021-04-10 stsp The options for
86 20662ea0 2021-04-10 stsp .Cm gotadmin info
87 20662ea0 2021-04-10 stsp are as follows:
88 20662ea0 2021-04-10 stsp .Bl -tag -width Ds
89 20662ea0 2021-04-10 stsp .It Fl r Ar repository-path
90 20662ea0 2021-04-10 stsp Use the repository at the specified path.
91 20662ea0 2021-04-10 stsp If not specified, assume the repository is located at or above the current
92 20662ea0 2021-04-10 stsp working directory.
93 1ea7ccc6 2021-11-15 thomas If this directory is a
95 1ea7ccc6 2021-11-15 thomas work tree, use the repository path associated with this work tree.
99 d8253374 2023-02-17 thomas .Op Fl aDq
100 56c96eff 2022-08-30 thomas .Op Fl r Ar repository-path
101 56c96eff 2022-08-30 thomas .Op Fl x Ar reference
102 56c96eff 2022-08-30 thomas .Op Ar reference ...
104 05118f5a 2021-06-22 stsp Generate a new pack file and a corresponding pack file index.
105 05118f5a 2021-06-22 stsp By default, add any loose objects which are reachable via any references
106 05118f5a 2021-06-22 stsp to the generated pack file.
108 05118f5a 2021-06-22 stsp If one or more
109 05118f5a 2021-06-22 stsp .Ar reference
110 05118f5a 2021-06-22 stsp arguments is specified, only add objects which are reachable via the specified
111 05118f5a 2021-06-22 stsp references.
113 05118f5a 2021-06-22 stsp .Ar reference
114 05118f5a 2021-06-22 stsp argument may either specify a specific reference or a reference namespace,
115 05118f5a 2021-06-22 stsp in which case all references within this namespace will be used.
117 05118f5a 2021-06-22 stsp .Cm gotadmin pack
118 05118f5a 2021-06-22 stsp always ignores references in the
119 05118f5a 2021-06-22 stsp .Pa refs/got/
120 05118f5a 2021-06-22 stsp namespace, effectively treating such references as if they did not refer
121 05118f5a 2021-06-22 stsp to any objects.
123 05118f5a 2021-06-22 stsp The options for
124 05118f5a 2021-06-22 stsp .Cm gotadmin pack
125 05118f5a 2021-06-22 stsp are as follows:
126 05118f5a 2021-06-22 stsp .Bl -tag -width Ds
128 05118f5a 2021-06-22 stsp Add objects to the generated pack file even if they are already packed
129 05118f5a 2021-06-22 stsp in a different pack file.
130 05118f5a 2021-06-22 stsp Unless this option is specified, only loose objects will be added.
132 d8253374 2023-02-17 thomas Force the use of ref-delta representation for deltified objects.
133 d8253374 2023-02-17 thomas If this option is not specified, offset-deltas will be used to represent
134 d8253374 2023-02-17 thomas deltified objects.
136 d6506a3d 2022-08-16 thomas Suppress progress reporting output.
137 05118f5a 2021-06-22 stsp .It Fl r Ar repository-path
138 05118f5a 2021-06-22 stsp Use the repository at the specified path.
139 05118f5a 2021-06-22 stsp If not specified, assume the repository is located at or above the current
140 05118f5a 2021-06-22 stsp working directory.
141 1ea7ccc6 2021-11-15 thomas If this directory is a
142 1ea7ccc6 2021-11-15 thomas .Xr got 1
143 1ea7ccc6 2021-11-15 thomas work tree, use the repository path associated with this work tree.
144 05118f5a 2021-06-22 stsp .It Fl x Ar reference
145 05118f5a 2021-06-22 stsp Exclude objects reachable via the specified
146 05118f5a 2021-06-22 stsp .Ar reference
147 05118f5a 2021-06-22 stsp from the pack file.
149 05118f5a 2021-06-22 stsp .Ar reference
150 05118f5a 2021-06-22 stsp argument may either specify a specific reference or a reference namespace,
151 05118f5a 2021-06-22 stsp in which case all references within this namespace will be excluded.
154 05118f5a 2021-06-22 stsp option may be specified multiple times to build a list of references to exclude.
156 05118f5a 2021-06-22 stsp Exclusion takes precedence over inclusion.
157 05118f5a 2021-06-22 stsp If a reference appears in both the included and excluded lists, it will
158 05118f5a 2021-06-22 stsp be excluded.
161 05118f5a 2021-06-22 stsp .It Cm indexpack Ar packfile-path
162 d912d125 2021-11-04 thomas .Dl Pq alias: Cm ix
163 05118f5a 2021-06-22 stsp Create a pack index for the pack file at
164 05118f5a 2021-06-22 stsp .Ar packfile-path .
166 05118f5a 2021-06-22 stsp A pack index is required for using the corresponding pack file with
167 05118f5a 2021-06-22 stsp .Xr got 1 .
168 05118f5a 2021-06-22 stsp Usually, a pack index will be created by commands such as
169 05118f5a 2021-06-22 stsp .Cm gotadmin pack
171 05118f5a 2021-06-22 stsp .Cm got fetch
172 05118f5a 2021-06-22 stsp as part of regular operation.
174 05118f5a 2021-06-22 stsp .Cm gotadmin indexpack
175 05118f5a 2021-06-22 stsp command may be used to recover from a corrupt or missing index.
176 05118f5a 2021-06-22 stsp A given pack file will always yield the same bit-identical index.
178 05118f5a 2021-06-22 stsp The provided
179 05118f5a 2021-06-22 stsp .Ar packfile-path
180 05118f5a 2021-06-22 stsp must be located within the
181 05118f5a 2021-06-22 stsp .Pa objects/pack/
182 05118f5a 2021-06-22 stsp directory of the repository and should end in
183 05118f5a 2021-06-22 stsp .Pa .pack .
184 05118f5a 2021-06-22 stsp The filename of the corresponding pack index is equivalent, except
185 05118f5a 2021-06-22 stsp that it ends in
189 56c96eff 2022-08-30 thomas .Cm listpack
190 56c96eff 2022-08-30 thomas .Op Fl hs
191 56c96eff 2022-08-30 thomas .Ar packfile-path
193 d912d125 2021-11-04 thomas .Dl Pq alias: Cm ls
194 05118f5a 2021-06-22 stsp List the contents of the pack file at
195 05118f5a 2021-06-22 stsp .Ar packfile-path .
197 05118f5a 2021-06-22 stsp Each object contained in the pack file will be displayed on a single line.
198 05118f5a 2021-06-22 stsp The information shown includes the object ID, object type, object offset,
199 05118f5a 2021-06-22 stsp and object size.
201 4b06140e 2022-03-22 thomas If a packed object is deltified against another object, the delta base
202 05118f5a 2021-06-22 stsp will be shown as well.
203 05118f5a 2021-06-22 stsp For offset deltas, the delta base is identified via an offset into the
205 05118f5a 2021-06-22 stsp For reference deltas, the delta base is identified via an object ID.
207 05118f5a 2021-06-22 stsp The provided
208 05118f5a 2021-06-22 stsp .Ar packfile-path
209 05118f5a 2021-06-22 stsp must be located within the
210 05118f5a 2021-06-22 stsp .Pa objects/pack/
211 05118f5a 2021-06-22 stsp directory of the repository and should end in
212 05118f5a 2021-06-22 stsp .Pa .pack .
213 d3830477 2022-03-11 thomas The corresponding pack index must exist and can be created with
214 d3830477 2022-03-11 thomas .Cm gotadmin indexpack
215 d3830477 2022-03-11 thomas if it is missing.
217 05118f5a 2021-06-22 stsp The options for
218 05118f5a 2021-06-22 stsp .Cm gotadmin listpack
219 05118f5a 2021-06-22 stsp are as follows:
220 05118f5a 2021-06-22 stsp .Bl -tag -width Ds
222 05118f5a 2021-06-22 stsp Show object sizes in human-readable form.
224 1fe43c07 2021-10-08 thomas Display statistics about the pack file after listing objects.
225 05118f5a 2021-06-22 stsp This includes the total number of objects stored in the pack file
226 05118f5a 2021-06-22 stsp and a break-down of the number of objects per object type.
230 56c96eff 2022-08-30 thomas .Cm cleanup
231 56c96eff 2022-08-30 thomas .Op Fl anpq
232 56c96eff 2022-08-30 thomas .Op Fl r Ar repository-path
234 d912d125 2021-11-04 thomas .Dl Pq alias: Cm cl
235 afd0da38 2023-06-22 thomas Purge unreferenced loose objects and redundant pack files from the
236 afd0da38 2023-06-22 thomas repository and display the amount of disk space which has been freed
237 afd0da38 2023-06-22 thomas as a result.
239 b3d68e7f 2021-07-03 stsp Unreferenced objects are present in the repository but cannot be
240 b3d68e7f 2021-07-03 stsp reached via any reference in the entire
243 520f13aa 2023-06-22 thomas Objects will usually become unreferenced as a result of deleting
244 39ea9268 2023-06-22 thomas branches, tags, or other references with
245 39ea9268 2023-06-22 thomas .Cm got branch -d ,
246 39ea9268 2023-06-22 thomas .Cm got ref -d ,
248 39ea9268 2023-06-22 thomas .Cm got fetch -X .
250 b3d68e7f 2021-07-03 stsp Loose objects are stored as individual files beneath the repository's
251 b3d68e7f 2021-07-03 stsp .Pa objects/
253 b3d68e7f 2021-07-03 stsp spread across 256 sub-directories named after the 256 possible
254 b3d68e7f 2021-07-03 stsp hexadecimal values of the first byte of an object identifier.
256 afd0da38 2023-06-22 thomas Packed objects are stored in pack files under
257 afd0da38 2023-06-22 thomas .Pa objects/pack/ .
259 afd0da38 2023-06-22 thomas If redundant copies of packed objects exist in loose form, such
260 afd0da38 2023-06-22 thomas redundant copies will be purged.
261 afd0da38 2023-06-22 thomas If all the objects of a pack file are present in other pack files,
262 afd0da38 2023-06-22 thomas the redundant pack file will be purged.
263 afd0da38 2023-06-22 thomas Pack files will usually become redundant as a result of repacking the
264 afd0da38 2023-06-22 thomas repository with
266 afd0da38 2023-06-22 thomas .Cm pack Fl a .
268 b3d68e7f 2021-07-03 stsp References in the
269 b3d68e7f 2021-07-03 stsp .Pa refs/got
270 b3d68e7f 2021-07-03 stsp namespace may prevent objects from being purged.
271 b3d68e7f 2021-07-03 stsp This includes references in the
272 b3d68e7f 2021-07-03 stsp .Pa refs/got/worktree
273 b3d68e7f 2021-07-03 stsp namespace created by
274 b3d68e7f 2021-07-03 stsp .Cm got checkout
276 b3d68e7f 2021-07-03 stsp .Cm got update ,
277 b3d68e7f 2021-07-03 stsp as well as references in the
278 b3d68e7f 2021-07-03 stsp .Pa refs/got/backup
279 b3d68e7f 2021-07-03 stsp namespace created by
280 b3d68e7f 2021-07-03 stsp .Cm got rebase
282 b3d68e7f 2021-07-03 stsp .Cm got histedit .
283 b3d68e7f 2021-07-03 stsp .Cm gotadmin cleanup
284 b3d68e7f 2021-07-03 stsp will only purge corresponding objects once such references have been
285 b3d68e7f 2021-07-03 stsp deleted with
286 0a41a152 2023-06-22 thomas .Cm got rebase -X ,
287 0a41a152 2023-06-22 thomas .Cm got histedit -X ,
289 b3d68e7f 2021-07-03 stsp .Cm got ref -d .
292 520f13aa 2023-06-22 thomas .Dq preciousObjects
293 520f13aa 2023-06-22 thomas Git extension is intended to prevent the removal of objects from a repository.
294 520f13aa 2023-06-22 thomas .Cm gotadmin cleanup
295 520f13aa 2023-06-22 thomas will refuse to operate on repositories where this extension is active.
297 520f13aa 2023-06-22 thomas For compatibility with Git, if a file with the extension
298 520f13aa 2023-06-22 thomas .Pa .keep
299 520f13aa 2023-06-22 thomas exists and corresponds to a pack file with the extension
300 520f13aa 2023-06-22 thomas .Pa .pack
301 520f13aa 2023-06-22 thomas then this pack file will not be removed.
303 1124fe40 2021-07-07 stsp Some Git repositories contain pack index files which lack a corresponding
304 1124fe40 2021-07-07 stsp pack file, which is an inconsistent repository state.
305 1124fe40 2021-07-07 stsp In such cases,
306 1124fe40 2021-07-07 stsp .Cm gotadmin cleanup -p -n
307 1124fe40 2021-07-07 stsp will display a list of affected pack index files.
308 4b06140e 2022-03-22 thomas Whenever possible, the missing pack files should be restored.
309 4b06140e 2022-03-22 thomas If restoring missing pack files is not possible, then affected pack index
310 1124fe40 2021-07-07 stsp files can be removed with
311 1124fe40 2021-07-07 stsp .Cm gotadmin cleanup -p .
313 b3d68e7f 2021-07-03 stsp The options for
314 d4445ca5 2021-07-03 stsp .Cm gotadmin cleanup
315 b3d68e7f 2021-07-03 stsp are as follows:
316 b3d68e7f 2021-07-03 stsp .Bl -tag -width Ds
318 ef8ec606 2021-07-27 stsp Delete all loose objects.
319 ef8ec606 2021-07-27 stsp By default, objects which are newer than an implementation-defined
320 ef8ec606 2021-07-27 stsp modification timestamp are kept on disk to prevent race conditions
321 ef8ec606 2021-07-27 stsp with other commands that add new objects to the repository while
322 ef8ec606 2021-07-27 stsp .Cm gotadmin cleanup
323 ef8ec606 2021-07-27 stsp is running.
325 b3d68e7f 2021-07-03 stsp Display the usual progress output and summary information but do not actually
326 1124fe40 2021-07-07 stsp remove any files from disk.
328 ddaab153 2023-06-22 thomas Instead of purging unreferenced loose objects and redundant pack files,
329 ddaab153 2023-06-22 thomas remove any pack index files which do not have a corresponding pack file.
331 d6506a3d 2022-08-16 thomas Suppress progress reporting and disk space summary output.
332 b3d68e7f 2021-07-03 stsp .It Fl r Ar repository-path
333 b3d68e7f 2021-07-03 stsp Use the repository at the specified path.
334 b3d68e7f 2021-07-03 stsp If not specified, assume the repository is located at or above the current
335 b3d68e7f 2021-07-03 stsp working directory.
336 1ea7ccc6 2021-11-15 thomas If this directory is a
337 1ea7ccc6 2021-11-15 thomas .Xr got 1
338 1ea7ccc6 2021-11-15 thomas work tree, use the repository path associated with this work tree.
341 20662ea0 2021-04-10 stsp .Sh EXIT STATUS
342 20662ea0 2021-04-10 stsp .Ex -std gotadmin
343 20662ea0 2021-04-10 stsp .Sh SEE ALSO
344 20662ea0 2021-04-10 stsp .Xr got 1 ,
345 20662ea0 2021-04-10 stsp .Xr tog 1 ,
346 20662ea0 2021-04-10 stsp .Xr git-repository 5 ,
347 20662ea0 2021-04-10 stsp .Xr got.conf 5
348 20662ea0 2021-04-10 stsp .Sh AUTHORS
349 60c73080 2022-07-05 thomas .An Christian Weisgerber Aq Mt naddy@openbsd.org
350 60c73080 2022-07-05 thomas .An Josh Rickmar Aq Mt jrick@zettaport.com
351 60c73080 2022-07-05 thomas .An Klemens Nanni Aq Mt kn@openbsd.org
352 57048aa5 2023-06-22 thomas .An Omar Polo Aq Mt op@openbsd.org
353 05118f5a 2021-06-22 stsp .An Ori Bernstein Aq Mt ori@openbsd.org
354 60c73080 2022-07-05 thomas .An Stefan Sperling Aq Mt stsp@openbsd.org
355 60c73080 2022-07-05 thomas .An Tracey Emery Aq Mt tracey@traceyemery.net
356 7e36bc2b 2021-06-25 stsp .Sh CAVEATS
358 7e36bc2b 2021-06-25 stsp is a work-in-progress and some features remain to be implemented.
360 7e36bc2b 2021-06-25 stsp At present, the user has to fall back on
362 7e36bc2b 2021-06-25 stsp to perform some tasks.
363 7e36bc2b 2021-06-25 stsp In particular:
364 7e36bc2b 2021-06-25 stsp .Bl -bullet
366 7e36bc2b 2021-06-25 stsp Exporting data from repositories requires
367 7e36bc2b 2021-06-25 stsp .Xr git-fast-export 1 .
369 7e36bc2b 2021-06-25 stsp Importing data into repositories requires
370 7e36bc2b 2021-06-25 stsp .Xr git-fast-import 1 .
373 aaf7c342 2021-07-03 stsp Disk space savings reported by
374 aaf7c342 2021-07-03 stsp .Cm gotadmin cleanup
375 aaf7c342 2021-07-03 stsp will be misleading if the repository contains object files that were
376 aaf7c342 2021-07-03 stsp hard-linked from another repository.
377 aaf7c342 2021-07-03 stsp Such hard-links will be created by certain
382 aaf7c342 2021-07-03 stsp will never create hard-linked object files.
