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 02a5c5d0 2022-07-04 stsp .It Cm init Ar repository-path
57 02a5c5d0 2022-07-04 stsp Create a new empty repository at the specified
58 02a5c5d0 2022-07-04 stsp .Ar repository-path .
61 02a5c5d0 2022-07-04 stsp .Cm gotadmin init ,
63 02a5c5d0 2022-07-04 stsp .Cm got import
64 02a5c5d0 2022-07-04 stsp command must be used to populate the empty repository before
65 02a5c5d0 2022-07-04 stsp .Cm got checkout
66 02a5c5d0 2022-07-04 stsp can be used.
67 5fc4f020 2022-08-30 op .It Cm info Op Fl r Ar repository-path
68 20662ea0 2021-04-10 stsp Display information about a repository.
69 20662ea0 2021-04-10 stsp This includes some configuration settings from
70 20662ea0 2021-04-10 stsp .Xr got.conf 5 ,
71 20662ea0 2021-04-10 stsp and the number of objects stored in the repository, in packed or
72 20662ea0 2021-04-10 stsp loose form, as well as the current on-disk size of these objects.
74 20662ea0 2021-04-10 stsp The options for
75 20662ea0 2021-04-10 stsp .Cm gotadmin info
76 20662ea0 2021-04-10 stsp are as follows:
77 20662ea0 2021-04-10 stsp .Bl -tag -width Ds
78 20662ea0 2021-04-10 stsp .It Fl r Ar repository-path
79 20662ea0 2021-04-10 stsp Use the repository at the specified path.
80 20662ea0 2021-04-10 stsp If not specified, assume the repository is located at or above the current
81 20662ea0 2021-04-10 stsp working directory.
82 7d69d862 2021-11-15 stsp If this directory is a
84 7d69d862 2021-11-15 stsp work tree, use the repository path associated with this work tree.
89 5fc4f020 2022-08-30 op .Op Fl r Ar repository-path
90 5fc4f020 2022-08-30 op .Op Fl x Ar reference
91 5fc4f020 2022-08-30 op .Op Ar reference ...
93 05118f5a 2021-06-22 stsp Generate a new pack file and a corresponding pack file index.
94 05118f5a 2021-06-22 stsp By default, add any loose objects which are reachable via any references
95 05118f5a 2021-06-22 stsp to the generated pack file.
97 05118f5a 2021-06-22 stsp If one or more
98 05118f5a 2021-06-22 stsp .Ar reference
99 05118f5a 2021-06-22 stsp arguments is specified, only add objects which are reachable via the specified
100 05118f5a 2021-06-22 stsp references.
102 05118f5a 2021-06-22 stsp .Ar reference
103 05118f5a 2021-06-22 stsp argument may either specify a specific reference or a reference namespace,
104 05118f5a 2021-06-22 stsp in which case all references within this namespace will be used.
106 05118f5a 2021-06-22 stsp .Cm gotadmin pack
107 05118f5a 2021-06-22 stsp always ignores references in the
108 05118f5a 2021-06-22 stsp .Pa refs/got/
109 05118f5a 2021-06-22 stsp namespace, effectively treating such references as if they did not refer
110 05118f5a 2021-06-22 stsp to any objects.
112 05118f5a 2021-06-22 stsp The options for
113 05118f5a 2021-06-22 stsp .Cm gotadmin pack
114 05118f5a 2021-06-22 stsp are as follows:
115 05118f5a 2021-06-22 stsp .Bl -tag -width Ds
117 05118f5a 2021-06-22 stsp Add objects to the generated pack file even if they are already packed
118 05118f5a 2021-06-22 stsp in a different pack file.
119 05118f5a 2021-06-22 stsp Unless this option is specified, only loose objects will be added.
121 827a167b 2022-08-16 stsp Suppress progress reporting output.
122 05118f5a 2021-06-22 stsp .It Fl r Ar repository-path
123 05118f5a 2021-06-22 stsp Use the repository at the specified path.
124 05118f5a 2021-06-22 stsp If not specified, assume the repository is located at or above the current
125 05118f5a 2021-06-22 stsp working directory.
126 7d69d862 2021-11-15 stsp If this directory is a
128 7d69d862 2021-11-15 stsp work tree, use the repository path associated with this work tree.
129 05118f5a 2021-06-22 stsp .It Fl x Ar reference
130 05118f5a 2021-06-22 stsp Exclude objects reachable via the specified
131 05118f5a 2021-06-22 stsp .Ar reference
132 05118f5a 2021-06-22 stsp from the pack file.
134 05118f5a 2021-06-22 stsp .Ar reference
135 05118f5a 2021-06-22 stsp argument may either specify a specific reference or a reference namespace,
136 05118f5a 2021-06-22 stsp in which case all references within this namespace will be excluded.
139 05118f5a 2021-06-22 stsp option may be specified multiple times to build a list of references to exclude.
141 05118f5a 2021-06-22 stsp Exclusion takes precedence over inclusion.
142 05118f5a 2021-06-22 stsp If a reference appears in both the included and excluded lists, it will
143 05118f5a 2021-06-22 stsp be excluded.
146 05118f5a 2021-06-22 stsp .It Cm indexpack Ar packfile-path
147 4683a10b 2021-11-04 kn .Dl Pq alias: Cm ix
148 05118f5a 2021-06-22 stsp Create a pack index for the pack file at
149 05118f5a 2021-06-22 stsp .Ar packfile-path .
151 05118f5a 2021-06-22 stsp A pack index is required for using the corresponding pack file with
152 05118f5a 2021-06-22 stsp .Xr got 1 .
153 05118f5a 2021-06-22 stsp Usually, a pack index will be created by commands such as
154 05118f5a 2021-06-22 stsp .Cm gotadmin pack
156 05118f5a 2021-06-22 stsp .Cm got fetch
157 05118f5a 2021-06-22 stsp as part of regular operation.
159 05118f5a 2021-06-22 stsp .Cm gotadmin indexpack
160 05118f5a 2021-06-22 stsp command may be used to recover from a corrupt or missing index.
161 05118f5a 2021-06-22 stsp A given pack file will always yield the same bit-identical index.
163 05118f5a 2021-06-22 stsp The provided
164 05118f5a 2021-06-22 stsp .Ar packfile-path
165 05118f5a 2021-06-22 stsp must be located within the
166 05118f5a 2021-06-22 stsp .Pa objects/pack/
167 05118f5a 2021-06-22 stsp directory of the repository and should end in
168 05118f5a 2021-06-22 stsp .Pa .pack .
169 05118f5a 2021-06-22 stsp The filename of the corresponding pack index is equivalent, except
170 05118f5a 2021-06-22 stsp that it ends in
176 5fc4f020 2022-08-30 op .Ar packfile-path
178 4683a10b 2021-11-04 kn .Dl Pq alias: Cm ls
179 05118f5a 2021-06-22 stsp List the contents of the pack file at
180 05118f5a 2021-06-22 stsp .Ar packfile-path .
182 05118f5a 2021-06-22 stsp Each object contained in the pack file will be displayed on a single line.
183 05118f5a 2021-06-22 stsp The information shown includes the object ID, object type, object offset,
184 05118f5a 2021-06-22 stsp and object size.
186 e38d4cde 2022-03-21 naddy If a packed object is deltified against another object, the delta base
187 05118f5a 2021-06-22 stsp will be shown as well.
188 05118f5a 2021-06-22 stsp For offset deltas, the delta base is identified via an offset into the
190 05118f5a 2021-06-22 stsp For reference deltas, the delta base is identified via an object ID.
192 05118f5a 2021-06-22 stsp The provided
193 05118f5a 2021-06-22 stsp .Ar packfile-path
194 05118f5a 2021-06-22 stsp must be located within the
195 05118f5a 2021-06-22 stsp .Pa objects/pack/
196 05118f5a 2021-06-22 stsp directory of the repository and should end in
197 05118f5a 2021-06-22 stsp .Pa .pack .
198 8e26059c 2022-03-10 stsp The corresponding pack index must exist and can be created with
199 8e26059c 2022-03-10 stsp .Cm gotadmin indexpack
200 8e26059c 2022-03-10 stsp if it is missing.
202 05118f5a 2021-06-22 stsp The options for
203 05118f5a 2021-06-22 stsp .Cm gotadmin listpack
204 05118f5a 2021-06-22 stsp are as follows:
205 05118f5a 2021-06-22 stsp .Bl -tag -width Ds
207 05118f5a 2021-06-22 stsp Show object sizes in human-readable form.
209 0c079dbc 2021-10-06 kn Display statistics about the pack file after listing objects.
210 05118f5a 2021-06-22 stsp This includes the total number of objects stored in the pack file
211 05118f5a 2021-06-22 stsp and a break-down of the number of objects per object type.
217 5fc4f020 2022-08-30 op .Op Fl r Ar repository-path
219 4683a10b 2021-11-04 kn .Dl Pq alias: Cm cl
220 b3d68e7f 2021-07-03 stsp Purge unreferenced loose objects from the repository and display
221 b3d68e7f 2021-07-03 stsp the amount of disk space which has been freed as a result.
223 b3d68e7f 2021-07-03 stsp Unreferenced objects are present in the repository but cannot be
224 b3d68e7f 2021-07-03 stsp reached via any reference in the entire
228 b3d68e7f 2021-07-03 stsp Loose objects are stored as individual files beneath the repository's
229 b3d68e7f 2021-07-03 stsp .Pa objects/
231 b3d68e7f 2021-07-03 stsp spread across 256 sub-directories named after the 256 possible
232 b3d68e7f 2021-07-03 stsp hexadecimal values of the first byte of an object identifier.
234 b3d68e7f 2021-07-03 stsp Packed objects stored in pack files under
235 0c079dbc 2021-10-06 kn .Pa objects/pack/
236 b3d68e7f 2021-07-03 stsp will not be purged.
237 b3d68e7f 2021-07-03 stsp However, if redundant copies of packed objects exist in loose form,
238 b3d68e7f 2021-07-03 stsp such redundant copies will be purged.
240 b3d68e7f 2021-07-03 stsp Objects will usually become unreferenced as a result of deleting
241 b3d68e7f 2021-07-03 stsp branches or tags with
242 b3d68e7f 2021-07-03 stsp .Cm got branch -d
244 b3d68e7f 2021-07-03 stsp .Cm got tag -d .
245 b3d68e7f 2021-07-03 stsp Deleting arbitrary references with
246 0c079dbc 2021-10-06 kn .Cm got ref -d
247 b3d68e7f 2021-07-03 stsp may also leave unreferenced objects behind.
249 b3d68e7f 2021-07-03 stsp In order to determine the set of objects which are referenced, search
250 b3d68e7f 2021-07-03 stsp all references for commit objects and tag objects, and traverse the
251 b3d68e7f 2021-07-03 stsp corresponding tree object hierarchies.
252 b3d68e7f 2021-07-03 stsp Any loose object IDs not encountered during this search are unreferenced
253 b3d68e7f 2021-07-03 stsp and thus subject to removal.
254 b3d68e7f 2021-07-03 stsp Display the number of commits which have been searched to indicate progress.
256 b3d68e7f 2021-07-03 stsp References in the
257 b3d68e7f 2021-07-03 stsp .Pa refs/got
258 b3d68e7f 2021-07-03 stsp namespace may prevent objects from being purged.
259 b3d68e7f 2021-07-03 stsp This includes references in the
260 b3d68e7f 2021-07-03 stsp .Pa refs/got/worktree
261 b3d68e7f 2021-07-03 stsp namespace created by
262 b3d68e7f 2021-07-03 stsp .Cm got checkout
264 b3d68e7f 2021-07-03 stsp .Cm got update ,
265 b3d68e7f 2021-07-03 stsp as well as references in the
266 b3d68e7f 2021-07-03 stsp .Pa refs/got/backup
267 b3d68e7f 2021-07-03 stsp namespace created by
268 b3d68e7f 2021-07-03 stsp .Cm got rebase
270 b3d68e7f 2021-07-03 stsp .Cm got histedit .
271 b3d68e7f 2021-07-03 stsp .Cm gotadmin cleanup
272 b3d68e7f 2021-07-03 stsp will only purge corresponding objects once such references have been
273 b3d68e7f 2021-07-03 stsp deleted with
274 b3d68e7f 2021-07-03 stsp .Cm got ref -d .
276 1124fe40 2021-07-07 stsp Some Git repositories contain pack index files which lack a corresponding
277 1124fe40 2021-07-07 stsp pack file, which is an inconsistent repository state.
278 1124fe40 2021-07-07 stsp In such cases,
279 1124fe40 2021-07-07 stsp .Cm gotadmin cleanup -p -n
280 1124fe40 2021-07-07 stsp will display a list of affected pack index files.
281 e38d4cde 2022-03-21 naddy Whenever possible, the missing pack files should be restored.
282 e38d4cde 2022-03-21 naddy If restoring missing pack files is not possible, then affected pack index
283 1124fe40 2021-07-07 stsp files can be removed with
284 1124fe40 2021-07-07 stsp .Cm gotadmin cleanup -p .
287 9188bd78 2021-07-03 stsp .Dq preciousObjects
288 9188bd78 2021-07-03 stsp Git extension is intended to prevent the removal of objects from a repository.
289 0c079dbc 2021-10-06 kn .Cm gotadmin cleanup
290 9188bd78 2021-07-03 stsp will refuse to operate on repositories where this extension is active.
292 b3d68e7f 2021-07-03 stsp The options for
293 d4445ca5 2021-07-03 stsp .Cm gotadmin cleanup
294 b3d68e7f 2021-07-03 stsp are as follows:
295 b3d68e7f 2021-07-03 stsp .Bl -tag -width Ds
297 ef8ec606 2021-07-27 stsp Delete all loose objects.
298 ef8ec606 2021-07-27 stsp By default, objects which are newer than an implementation-defined
299 ef8ec606 2021-07-27 stsp modification timestamp are kept on disk to prevent race conditions
300 ef8ec606 2021-07-27 stsp with other commands that add new objects to the repository while
301 ef8ec606 2021-07-27 stsp .Cm gotadmin cleanup
302 ef8ec606 2021-07-27 stsp is running.
304 b3d68e7f 2021-07-03 stsp Display the usual progress output and summary information but do not actually
305 1124fe40 2021-07-07 stsp remove any files from disk.
307 827a167b 2022-08-16 stsp Instead of purging unreferenced loose objects, remove any pack index files
308 827a167b 2022-08-16 stsp which do not have a corresponding pack file.
310 827a167b 2022-08-16 stsp Suppress progress reporting and disk space summary output.
311 b3d68e7f 2021-07-03 stsp .It Fl r Ar repository-path
312 b3d68e7f 2021-07-03 stsp Use the repository at the specified path.
313 b3d68e7f 2021-07-03 stsp If not specified, assume the repository is located at or above the current
314 b3d68e7f 2021-07-03 stsp working directory.
315 7d69d862 2021-11-15 stsp If this directory is a
317 7d69d862 2021-11-15 stsp work tree, use the repository path associated with this work tree.
320 20662ea0 2021-04-10 stsp .Sh EXIT STATUS
321 20662ea0 2021-04-10 stsp .Ex -std gotadmin
322 20662ea0 2021-04-10 stsp .Sh SEE ALSO
323 20662ea0 2021-04-10 stsp .Xr got 1 ,
324 20662ea0 2021-04-10 stsp .Xr tog 1 ,
325 20662ea0 2021-04-10 stsp .Xr git-repository 5 ,
326 20662ea0 2021-04-10 stsp .Xr got.conf 5
327 20662ea0 2021-04-10 stsp .Sh AUTHORS
328 8ca658b9 2022-07-05 stsp .An Christian Weisgerber Aq Mt naddy@openbsd.org
329 8ca658b9 2022-07-05 stsp .An Josh Rickmar Aq Mt jrick@zettaport.com
330 8ca658b9 2022-07-05 stsp .An Klemens Nanni Aq Mt kn@openbsd.org
331 05118f5a 2021-06-22 stsp .An Ori Bernstein Aq Mt ori@openbsd.org
332 8ca658b9 2022-07-05 stsp .An Stefan Sperling Aq Mt stsp@openbsd.org
333 8ca658b9 2022-07-05 stsp .An Tracey Emery Aq Mt tracey@traceyemery.net
334 7e36bc2b 2021-06-25 stsp .Sh CAVEATS
336 7e36bc2b 2021-06-25 stsp is a work-in-progress and some features remain to be implemented.
338 7e36bc2b 2021-06-25 stsp At present, the user has to fall back on
340 7e36bc2b 2021-06-25 stsp to perform some tasks.
341 7e36bc2b 2021-06-25 stsp In particular:
342 7e36bc2b 2021-06-25 stsp .Bl -bullet
344 b3d68e7f 2021-07-03 stsp Removing redundant or unreferenced packed objects requires
345 b3d68e7f 2021-07-03 stsp .Xr git-gc 1
346 b3d68e7f 2021-07-03 stsp and perhaps
347 b3d68e7f 2021-07-03 stsp .Xr git-repack 1 .
349 7e36bc2b 2021-06-25 stsp Exporting data from repositories requires
350 7e36bc2b 2021-06-25 stsp .Xr git-fast-export 1 .
352 7e36bc2b 2021-06-25 stsp Importing data into repositories requires
353 7e36bc2b 2021-06-25 stsp .Xr git-fast-import 1 .
356 aaf7c342 2021-07-03 stsp Disk space savings reported by
357 aaf7c342 2021-07-03 stsp .Cm gotadmin cleanup
358 aaf7c342 2021-07-03 stsp will be misleading if the repository contains object files that were
359 aaf7c342 2021-07-03 stsp hard-linked from another repository.
360 aaf7c342 2021-07-03 stsp Such hard-links will be created by certain
365 aaf7c342 2021-07-03 stsp will never create hard-linked object files.
