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 Ar repository-path
57 Create a new empty repository at the specified
64 command must be used to populate the empty repository before
67 .It Cm info Op Fl r Ar repository-path
68 Display information about a repository.
69 This includes some configuration settings from
71 and the number of objects stored in the repository, in packed or
72 loose form, as well as the current on-disk size of these objects.
78 .It Fl r Ar repository-path
79 Use the repository at the specified path.
80 If not specified, assume the repository is located at or above the current
82 If this directory is a
84 work tree, use the repository path associated with this work tree.
89 .Op Fl r Ar repository-path
93 Generate a new pack file and a corresponding pack file index.
94 By default, add any loose objects which are reachable via any references
95 to the generated pack file.
99 arguments is specified, only add objects which are reachable via the specified
103 argument may either specify a specific reference or a reference namespace,
104 in which case all references within this namespace will be used.
107 always ignores references in the
109 namespace, effectively treating such references as if they did not refer
117 Add objects to the generated pack file even if they are already packed
118 in a different pack file.
119 Unless this option is specified, only loose objects will be added.
121 Suppress progress reporting output.
122 .It Fl r Ar repository-path
123 Use the repository at the specified path.
124 If not specified, assume the repository is located at or above the current
126 If this directory is a
128 work tree, use the repository path associated with this work tree.
129 .It Fl x Ar reference
130 Exclude objects reachable via the specified
135 argument may either specify a specific reference or a reference namespace,
136 in which case all references within this namespace will be excluded.
139 option may be specified multiple times to build a list of references to exclude.
141 Exclusion takes precedence over inclusion.
142 If a reference appears in both the included and excluded lists, it will
146 .It Cm indexpack Ar packfile-path
148 Create a pack index for the pack file at
151 A pack index is required for using the corresponding pack file with
153 Usually, a pack index will be created by commands such as
157 as part of regular operation.
159 .Cm gotadmin indexpack
160 command may be used to recover from a corrupt or missing index.
161 A given pack file will always yield the same bit-identical index.
165 must be located within the
167 directory of the repository and should end in
169 The filename of the corresponding pack index is equivalent, except
179 List the contents of the pack file at
182 Each object contained in the pack file will be displayed on a single line.
183 The information shown includes the object ID, object type, object offset,
186 If a packed object is deltified against another object, the delta base
187 will be shown as well.
188 For offset deltas, the delta base is identified via an offset into the
190 For reference deltas, the delta base is identified via an object ID.
194 must be located within the
196 directory of the repository and should end in
198 The corresponding pack index must exist and can be created with
199 .Cm gotadmin indexpack
203 .Cm gotadmin listpack
207 Show object sizes in human-readable form.
209 Display statistics about the pack file after listing objects.
210 This includes the total number of objects stored in the pack file
211 and a break-down of the number of objects per object type.
217 .Op Fl r Ar repository-path
220 Purge unreferenced loose objects from the repository and display
221 the amount of disk space which has been freed as a result.
223 Unreferenced objects are present in the repository but cannot be
224 reached via any reference in the entire
228 Loose objects are stored as individual files beneath the repository's
231 spread across 256 sub-directories named after the 256 possible
232 hexadecimal values of the first byte of an object identifier.
234 Packed objects stored in pack files under
237 However, if redundant copies of packed objects exist in loose form,
238 such redundant copies will be purged.
240 Objects will usually become unreferenced as a result of deleting
241 branches or tags with
245 Deleting arbitrary references with
247 may also leave unreferenced objects behind.
249 In order to determine the set of objects which are referenced, search
250 all references for commit objects and tag objects, and traverse the
251 corresponding tree object hierarchies.
252 Any loose object IDs not encountered during this search are unreferenced
253 and thus subject to removal.
254 Display the number of commits which have been searched to indicate progress.
258 namespace may prevent objects from being purged.
259 This includes references in the
260 .Pa refs/got/worktree
265 as well as references in the
272 will only purge corresponding objects once such references have been
276 Some Git repositories contain pack index files which lack a corresponding
277 pack file, which is an inconsistent repository state.
279 .Cm gotadmin cleanup -p -n
280 will display a list of affected pack index files.
281 Whenever possible, the missing pack files should be restored.
282 If restoring missing pack files is not possible, then affected pack index
283 files can be removed with
284 .Cm gotadmin cleanup -p .
288 Git extension is intended to prevent the removal of objects from a repository.
290 will refuse to operate on repositories where this extension is active.
297 Delete all loose objects.
298 By default, objects which are newer than an implementation-defined
299 modification timestamp are kept on disk to prevent race conditions
300 with other commands that add new objects to the repository while
304 Display the usual progress output and summary information but do not actually
305 remove any files from disk.
307 Instead of purging unreferenced loose objects, remove any pack index files
308 which do not have a corresponding pack file.
310 Suppress progress reporting and disk space summary output.
311 .It Fl r Ar repository-path
312 Use the repository at the specified path.
313 If not specified, assume the repository is located at or above the current
315 If this directory is a
317 work tree, use the repository path associated with this work tree.
325 .Xr git-repository 5 ,
328 .An Christian Weisgerber Aq Mt naddy@openbsd.org
329 .An Josh Rickmar Aq Mt jrick@zettaport.com
330 .An Klemens Nanni Aq Mt kn@openbsd.org
331 .An Ori Bernstein Aq Mt ori@openbsd.org
332 .An Stefan Sperling Aq Mt stsp@openbsd.org
333 .An Tracey Emery Aq Mt tracey@traceyemery.net
336 is a work-in-progress and some features remain to be implemented.
338 At present, the user has to fall back on
340 to perform some tasks.
344 Removing redundant or unreferenced packed objects requires
349 Exporting data from repositories requires
350 .Xr git-fast-export 1 .
352 Importing data into repositories requires
353 .Xr git-fast-import 1 .
356 Disk space savings reported by
358 will be misleading if the repository contains object files that were
359 hard-linked from another repository.
360 Such hard-links will be created by certain
365 will never create hard-linked object files.
