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 info Oo Fl r Ar repository-path Oc
57 Display information about a repository.
58 This includes some configuration settings from
60 and the number of objects stored in the repository, in packed or
61 loose form, as well as the current on-disk size of these objects.
67 .It Fl r Ar repository-path
68 Use the repository at the specified path.
69 If not specified, assume the repository is located at or above the current
72 .It Cm pack Oo Fl a Oc Oo Fl r Ar repository-path Oc Oo Fl x Ar reference Oc Op Ar reference ...
73 Generate a new pack file and a corresponding pack file index.
74 By default, add any loose objects which are reachable via any references
75 to the generated pack file.
79 arguments is specified, only add objects which are reachable via the specified
83 argument may either specify a specific reference or a reference namespace,
84 in which case all references within this namespace will be used.
87 always ignores references in the
89 namespace, effectively treating such references as if they did not refer
97 Add objects to the generated pack file even if they are already packed
98 in a different pack file.
99 Unless this option is specified, only loose objects will be added.
100 .It Fl r Ar repository-path
101 Use the repository at the specified path.
102 If not specified, assume the repository is located at or above the current
104 .It Fl x Ar reference
105 Exclude objects reachable via the specified
110 argument may either specify a specific reference or a reference namespace,
111 in which case all references within this namespace will be excluded.
114 option may be specified multiple times to build a list of references to exclude.
116 Exclusion takes precedence over inclusion.
117 If a reference appears in both the included and excluded lists, it will
121 .It Cm indexpack Ar packfile-path
123 Create a pack index for the pack file at
126 A pack index is required for using the corresponding pack file with
128 Usually, a pack index will be created by commands such as
132 as part of regular operation.
134 .Cm gotadmin indexpack
135 command may be used to recover from a corrupt or missing index.
136 A given pack file will always yield the same bit-identical index.
140 must be located within the
142 directory of the repository and should end in
144 The filename of the corresponding pack index is equivalent, except
148 .It Cm listpack Oo Fl h Oc Oo Fl s Oc Ar packfile-path
150 List the contents of the pack file at
153 Each object contained in the pack file will be displayed on a single line.
154 The information shown includes the object ID, object type, object offset,
157 If a packed object is deltified against another object the delta base
158 will be shown as well.
159 For offset deltas, the delta base is identified via an offset into the
161 For reference deltas, the delta base is identified via an object ID.
165 must be located within the
167 directory of the repository and should end in
171 .Cm gotadmin listpack
175 Show object sizes in human-readable form.
177 Display statistics about the pack file after listing objects.
178 This includes the total number of objects stored in the pack file
179 and a break-down of the number of objects per object type.
182 .It Cm cleanup Oo Fl a Oc Oo Fl p Oc Oo Fl n Oc Oo Fl r Ar repository-path Oc Oo Fl q Oc
184 Purge unreferenced loose objects from the repository and display
185 the amount of disk space which has been freed as a result.
187 Unreferenced objects are present in the repository but cannot be
188 reached via any reference in the entire
192 Loose objects are stored as individual files beneath the repository's
195 spread across 256 sub-directories named after the 256 possible
196 hexadecimal values of the first byte of an object identifier.
198 Packed objects stored in pack files under
201 However, if redundant copies of packed objects exist in loose form,
202 such redundant copies will be purged.
204 Objects will usually become unreferenced as a result of deleting
205 branches or tags with
209 Deleting arbitrary references with
211 may also leave unreferenced objects behind.
213 In order to determine the set of objects which are referenced, search
214 all references for commit objects and tag objects, and traverse the
215 corresponding tree object hierarchies.
216 Any loose object IDs not encountered during this search are unreferenced
217 and thus subject to removal.
218 Display the number of commits which have been searched to indicate progress.
222 namespace may prevent objects from being purged.
223 This includes references in the
224 .Pa refs/got/worktree
229 as well as references in the
236 will only purge corresponding objects once such references have been
240 Some Git repositories contain pack index files which lack a corresponding
241 pack file, which is an inconsistent repository state.
243 .Cm gotadmin cleanup -p -n
244 will display a list of affected pack index files.
245 Whenever possible the missing pack files should be restored.
246 If restoring missing pack files is not possible then affected pack index
247 files can be removed with
248 .Cm gotadmin cleanup -p .
252 Git extension is intended to prevent the removal of objects from a repository.
254 will refuse to operate on repositories where this extension is active.
261 Delete all loose objects.
262 By default, objects which are newer than an implementation-defined
263 modification timestamp are kept on disk to prevent race conditions
264 with other commands that add new objects to the repository while
268 Instead of purging unreferenced loose objects, remove any pack index files
269 which do not have a corresponding pack file.
271 Display the usual progress output and summary information but do not actually
272 remove any files from disk.
273 .It Fl r Ar repository-path
274 Use the repository at the specified path.
275 If not specified, assume the repository is located at or above the current
278 Suppress progress reporting and disk space summary output.
286 .Xr git-repository 5 ,
289 .An Stefan Sperling Aq Mt stsp@openbsd.org
290 .An Ori Bernstein Aq Mt ori@openbsd.org
293 is a work-in-progress and some features remain to be implemented.
295 At present, the user has to fall back on
297 to perform some tasks.
301 Removing redundant or unreferenced packed objects requires
306 Exporting data from repositories requires
307 .Xr git-fast-export 1 .
309 Importing data into repositories requires
310 .Xr git-fast-import 1 .
313 Disk space savings reported by
315 will be misleading if the repository contains object files that were
316 hard-linked from another repository.
317 Such hard-links will be created by certain
322 will never create hard-linked object files.
