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
120 .It Cm indexpack Ar packfile-path
121 Create a pack index for the pack file at
124 A pack index is required for using the corresponding pack file with
126 Usually, a pack index will be created by commands such as
130 as part of regular operation.
132 .Cm gotadmin indexpack
133 command may be used to recover from a corrupt or missing index.
134 A given pack file will always yield the same bit-identical index.
138 must be located within the
140 directory of the repository and should end in
142 The filename of the corresponding pack index is equivalent, except
149 .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.
184 .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
185 Purge unreferenced loose objects from the repository and display
186 the amount of disk space which has been freed as a result.
188 Unreferenced objects are present in the repository but cannot be
189 reached via any reference in the entire
193 Loose objects are stored as individual files beneath the repository's
196 spread across 256 sub-directories named after the 256 possible
197 hexadecimal values of the first byte of an object identifier.
199 Packed objects stored in pack files under
202 However, if redundant copies of packed objects exist in loose form,
203 such redundant copies will be purged.
205 Objects will usually become unreferenced as a result of deleting
206 branches or tags with
210 Deleting arbitrary references with
212 may also leave unreferenced objects behind.
214 In order to determine the set of objects which are referenced, search
215 all references for commit objects and tag objects, and traverse the
216 corresponding tree object hierarchies.
217 Any loose object IDs not encountered during this search are unreferenced
218 and thus subject to removal.
219 Display the number of commits which have been searched to indicate progress.
223 namespace may prevent objects from being purged.
224 This includes references in the
225 .Pa refs/got/worktree
230 as well as references in the
237 will only purge corresponding objects once such references have been
241 Some Git repositories contain pack index files which lack a corresponding
242 pack file, which is an inconsistent repository state.
244 .Cm gotadmin cleanup -p -n
245 will display a list of affected pack index files.
246 Whenever possible the missing pack files should be restored.
247 If restoring missing pack files is not possible then affected pack index
248 files can be removed with
249 .Cm gotadmin cleanup -p .
253 Git extension is intended to prevent the removal of objects from a repository.
255 will refuse to operate on repositories where this extension is active.
262 Delete all loose objects.
263 By default, objects which are newer than an implementation-defined
264 modification timestamp are kept on disk to prevent race conditions
265 with other commands that add new objects to the repository while
269 Instead of purging unreferenced loose objects, remove any pack index files
270 which do not have a corresponding pack file.
272 Display the usual progress output and summary information but do not actually
273 remove any files from disk.
274 .It Fl r Ar repository-path
275 Use the repository at the specified path.
276 If not specified, assume the repository is located at or above the current
279 Suppress progress reporting and disk space summary output.
290 .Xr git-repository 5 ,
293 .An Stefan Sperling Aq Mt stsp@openbsd.org
294 .An Ori Bernstein Aq Mt ori@openbsd.org
297 is a work-in-progress and some features remain to be implemented.
299 At present, the user has to fall back on
301 to perform some tasks.
305 Removing redundant or unreferenced packed objects requires
310 Exporting data from repositories requires
311 .Xr git-fast-export 1 .
313 Importing data into repositories requires
314 .Xr git-fast-import 1 .
317 Disk space savings reported by
319 will be misleading if the repository contains object files that were
320 hard-linked from another repository.
321 Such hard-links will be created by certain
326 will never create hard-linked object files.
