2 .\" Copyright (c) 2021 Stefan Sperling
4 .\" Permission to use, copy, modify, and distribute this software for any
5 .\" purpose with or without fee is hereby granted, provided that the above
6 .\" copyright notice and this permission notice appear in all copies.
8 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
21 .Nd Game of Trees repository administration
29 is the repository maintenance tool for the
31 version control system.
34 stores the history of tracked files in a Git repository, as used
35 by the Git version control system.
37 provides commands for inspecting and manipulating the on-disk state of
39 The repository format is described in
40 .Xr git-repository 5 .
43 provides global and command-specific options.
44 Global options must precede the command name, and are as follows:
45 .Bl -tag -width tenletters
47 Display usage information and exit immediately.
49 Display program version and exit immediately.
55 .Bl -tag -width checkout
56 .It Cm init Oo Fl b Ar branch Oc Ar repository-path
57 Create a new empty repository at the specified
64 command must be used to populate the empty repository before
73 Make the repository's HEAD reference point to the specified
75 instead of the default branch
78 .It Cm info Op Fl r Ar repository-path
79 Display information about a repository.
80 This includes some configuration settings from
82 and the number of objects stored in the repository, in packed or
83 loose form, as well as the current on-disk size of these objects.
89 .It Fl r Ar repository-path
90 Use the repository at the specified path.
91 If not specified, assume the repository is located at or above the current
93 If this directory is a
95 work tree, use the repository path associated with this work tree.
100 .Op Fl r Ar repository-path
101 .Op Fl x Ar reference
104 Generate a new pack file and a corresponding pack file index.
105 By default, add any loose objects which are reachable via any references
106 to the generated pack file.
110 arguments is specified, only add objects which are reachable via the specified
114 argument may either specify a specific reference or a reference namespace,
115 in which case all references within this namespace will be used.
118 always ignores references in the
120 namespace, effectively treating such references as if they did not refer
128 Add objects to the generated pack file even if they are already packed
129 in a different pack file.
130 Unless this option is specified, only loose objects will be added.
132 Suppress progress reporting output.
133 .It Fl r Ar repository-path
134 Use the repository at the specified path.
135 If not specified, assume the repository is located at or above the current
137 If this directory is a
139 work tree, use the repository path associated with this work tree.
140 .It Fl x Ar reference
141 Exclude objects reachable via the specified
146 argument may either specify a specific reference or a reference namespace,
147 in which case all references within this namespace will be excluded.
150 option may be specified multiple times to build a list of references to exclude.
152 Exclusion takes precedence over inclusion.
153 If a reference appears in both the included and excluded lists, it will
157 .It Cm indexpack Ar packfile-path
159 Create a pack index for the pack file at
162 A pack index is required for using the corresponding pack file with
164 Usually, a pack index will be created by commands such as
168 as part of regular operation.
170 .Cm gotadmin indexpack
171 command may be used to recover from a corrupt or missing index.
172 A given pack file will always yield the same bit-identical index.
176 must be located within the
178 directory of the repository and should end in
180 The filename of the corresponding pack index is equivalent, except
190 List the contents of the pack file at
193 Each object contained in the pack file will be displayed on a single line.
194 The information shown includes the object ID, object type, object offset,
197 If a packed object is deltified against another object, the delta base
198 will be shown as well.
199 For offset deltas, the delta base is identified via an offset into the
201 For reference deltas, the delta base is identified via an object ID.
205 must be located within the
207 directory of the repository and should end in
209 The corresponding pack index must exist and can be created with
210 .Cm gotadmin indexpack
214 .Cm gotadmin listpack
218 Show object sizes in human-readable form.
220 Display statistics about the pack file after listing objects.
221 This includes the total number of objects stored in the pack file
222 and a break-down of the number of objects per object type.
228 .Op Fl r Ar repository-path
231 Purge unreferenced loose objects from the repository and display
232 the amount of disk space which has been freed as a result.
234 Unreferenced objects are present in the repository but cannot be
235 reached via any reference in the entire
239 Loose objects are stored as individual files beneath the repository's
242 spread across 256 sub-directories named after the 256 possible
243 hexadecimal values of the first byte of an object identifier.
245 Packed objects stored in pack files under
248 However, if redundant copies of packed objects exist in loose form,
249 such redundant copies will be purged.
251 Objects will usually become unreferenced as a result of deleting
252 branches or tags with
256 Deleting arbitrary references with
258 may also leave unreferenced objects behind.
260 In order to determine the set of objects which are referenced, search
261 all references for commit objects and tag objects, and traverse the
262 corresponding tree object hierarchies.
263 Any loose object IDs not encountered during this search are unreferenced
264 and thus subject to removal.
265 Display the number of commits which have been searched to indicate progress.
269 namespace may prevent objects from being purged.
270 This includes references in the
271 .Pa refs/got/worktree
276 as well as references in the
283 will only purge corresponding objects once such references have been
287 Some Git repositories contain pack index files which lack a corresponding
288 pack file, which is an inconsistent repository state.
290 .Cm gotadmin cleanup -p -n
291 will display a list of affected pack index files.
292 Whenever possible, the missing pack files should be restored.
293 If restoring missing pack files is not possible, then affected pack index
294 files can be removed with
295 .Cm gotadmin cleanup -p .
299 Git extension is intended to prevent the removal of objects from a repository.
301 will refuse to operate on repositories where this extension is active.
308 Delete all loose objects.
309 By default, objects which are newer than an implementation-defined
310 modification timestamp are kept on disk to prevent race conditions
311 with other commands that add new objects to the repository while
315 Display the usual progress output and summary information but do not actually
316 remove any files from disk.
318 Instead of purging unreferenced loose objects, remove any pack index files
319 which do not have a corresponding pack file.
321 Suppress progress reporting and disk space summary output.
322 .It Fl r Ar repository-path
323 Use the repository at the specified path.
324 If not specified, assume the repository is located at or above the current
326 If this directory is a
328 work tree, use the repository path associated with this work tree.
336 .Xr git-repository 5 ,
339 .An Christian Weisgerber Aq Mt naddy@openbsd.org
340 .An Josh Rickmar Aq Mt jrick@zettaport.com
341 .An Klemens Nanni Aq Mt kn@openbsd.org
342 .An Ori Bernstein Aq Mt ori@openbsd.org
343 .An Stefan Sperling Aq Mt stsp@openbsd.org
344 .An Tracey Emery Aq Mt tracey@traceyemery.net
347 is a work-in-progress and some features remain to be implemented.
349 At present, the user has to fall back on
351 to perform some tasks.
355 Removing redundant or unreferenced packed objects requires
360 Exporting data from repositories requires
361 .Xr git-fast-export 1 .
363 Importing data into repositories requires
364 .Xr git-fast-import 1 .
367 Disk space savings reported by
369 will be misleading if the repository contains object files that were
370 hard-linked from another repository.
371 Such hard-links will be created by certain
376 will never create hard-linked object files.
