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 Oo Fl r Ar repository-path Oc
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.
86 .It Cm pack Oo Fl a Oc Oo Fl r Ar repository-path Oc Oo Fl x Ar reference Oc Oo Fl q Oc Op Ar reference ...
87 Generate a new pack file and a corresponding pack file index.
88 By default, add any loose objects which are reachable via any references
89 to the generated pack file.
93 arguments is specified, only add objects which are reachable via the specified
97 argument may either specify a specific reference or a reference namespace,
98 in which case all references within this namespace will be used.
101 always ignores references in the
103 namespace, effectively treating such references as if they did not refer
111 Add objects to the generated pack file even if they are already packed
112 in a different pack file.
113 Unless this option is specified, only loose objects will be added.
114 .It Fl r Ar repository-path
115 Use the repository at the specified path.
116 If not specified, assume the repository is located at or above the current
118 If this directory is a
120 work tree, use the repository path associated with this work tree.
121 .It Fl x Ar reference
122 Exclude objects reachable via the specified
127 argument may either specify a specific reference or a reference namespace,
128 in which case all references within this namespace will be excluded.
131 option may be specified multiple times to build a list of references to exclude.
133 Exclusion takes precedence over inclusion.
134 If a reference appears in both the included and excluded lists, it will
137 Suppress progress reporting output.
140 .It Cm indexpack Ar packfile-path
142 Create a pack index for the pack file at
145 A pack index is required for using the corresponding pack file with
147 Usually, a pack index will be created by commands such as
151 as part of regular operation.
153 .Cm gotadmin indexpack
154 command may be used to recover from a corrupt or missing index.
155 A given pack file will always yield the same bit-identical index.
159 must be located within the
161 directory of the repository and should end in
163 The filename of the corresponding pack index is equivalent, except
167 .It Cm listpack Oo Fl h Oc Oo Fl s Oc Ar packfile-path
169 List the contents of the pack file at
172 Each object contained in the pack file will be displayed on a single line.
173 The information shown includes the object ID, object type, object offset,
176 If a packed object is deltified against another object, the delta base
177 will be shown as well.
178 For offset deltas, the delta base is identified via an offset into the
180 For reference deltas, the delta base is identified via an object ID.
184 must be located within the
186 directory of the repository and should end in
188 The corresponding pack index must exist and can be created with
189 .Cm gotadmin indexpack
193 .Cm gotadmin listpack
197 Show object sizes in human-readable form.
199 Display statistics about the pack file after listing objects.
200 This includes the total number of objects stored in the pack file
201 and a break-down of the number of objects per object type.
204 .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
206 Purge unreferenced loose objects from the repository and display
207 the amount of disk space which has been freed as a result.
209 Unreferenced objects are present in the repository but cannot be
210 reached via any reference in the entire
214 Loose objects are stored as individual files beneath the repository's
217 spread across 256 sub-directories named after the 256 possible
218 hexadecimal values of the first byte of an object identifier.
220 Packed objects stored in pack files under
223 However, if redundant copies of packed objects exist in loose form,
224 such redundant copies will be purged.
226 Objects will usually become unreferenced as a result of deleting
227 branches or tags with
231 Deleting arbitrary references with
233 may also leave unreferenced objects behind.
235 In order to determine the set of objects which are referenced, search
236 all references for commit objects and tag objects, and traverse the
237 corresponding tree object hierarchies.
238 Any loose object IDs not encountered during this search are unreferenced
239 and thus subject to removal.
240 Display the number of commits which have been searched to indicate progress.
244 namespace may prevent objects from being purged.
245 This includes references in the
246 .Pa refs/got/worktree
251 as well as references in the
258 will only purge corresponding objects once such references have been
262 Some Git repositories contain pack index files which lack a corresponding
263 pack file, which is an inconsistent repository state.
265 .Cm gotadmin cleanup -p -n
266 will display a list of affected pack index files.
267 Whenever possible, the missing pack files should be restored.
268 If restoring missing pack files is not possible, then affected pack index
269 files can be removed with
270 .Cm gotadmin cleanup -p .
274 Git extension is intended to prevent the removal of objects from a repository.
276 will refuse to operate on repositories where this extension is active.
283 Delete all loose objects.
284 By default, objects which are newer than an implementation-defined
285 modification timestamp are kept on disk to prevent race conditions
286 with other commands that add new objects to the repository while
290 Instead of purging unreferenced loose objects, remove any pack index files
291 which do not have a corresponding pack file.
293 Display the usual progress output and summary information but do not actually
294 remove any files from disk.
295 .It Fl r Ar repository-path
296 Use the repository at the specified path.
297 If not specified, assume the repository is located at or above the current
299 If this directory is a
301 work tree, use the repository path associated with this work tree.
303 Suppress progress reporting and disk space summary output.
311 .Xr git-repository 5 ,
314 .An Christian Weisgerber Aq Mt naddy@openbsd.org
315 .An Josh Rickmar Aq Mt jrick@zettaport.com
316 .An Klemens Nanni Aq Mt kn@openbsd.org
317 .An Ori Bernstein Aq Mt ori@openbsd.org
318 .An Stefan Sperling Aq Mt stsp@openbsd.org
319 .An Tracey Emery Aq Mt tracey@traceyemery.net
322 is a work-in-progress and some features remain to be implemented.
324 At present, the user has to fall back on
326 to perform some tasks.
330 Removing redundant or unreferenced packed objects requires
335 Exporting data from repositories requires
336 .Xr git-fast-export 1 .
338 Importing data into repositories requires
339 .Xr git-fast-import 1 .
342 Disk space savings reported by
344 will be misleading if the repository contains object files that were
345 hard-linked from another repository.
346 Such hard-links will be created by certain
351 will never create hard-linked object files.
