2 20662ea0 2021-04-10 stsp .\" Copyright (c) 2021 Stefan Sperling
4 20662ea0 2021-04-10 stsp .\" Permission to use, copy, modify, and distribute this software for any
5 20662ea0 2021-04-10 stsp .\" purpose with or without fee is hereby granted, provided that the above
6 20662ea0 2021-04-10 stsp .\" copyright notice and this permission notice appear in all copies.
8 20662ea0 2021-04-10 stsp .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9 20662ea0 2021-04-10 stsp .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10 20662ea0 2021-04-10 stsp .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11 20662ea0 2021-04-10 stsp .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12 20662ea0 2021-04-10 stsp .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13 20662ea0 2021-04-10 stsp .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14 20662ea0 2021-04-10 stsp .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16 20662ea0 2021-04-10 stsp .Dd $Mdocdate$
17 20662ea0 2021-04-10 stsp .Dt GOTADMIN 1
20 20662ea0 2021-04-10 stsp .Nm gotadmin
21 20662ea0 2021-04-10 stsp .Nd Game of Trees repository administration
22 20662ea0 2021-04-10 stsp .Sh SYNOPSIS
26 20662ea0 2021-04-10 stsp .Op Ar arg ...
27 20662ea0 2021-04-10 stsp .Sh DESCRIPTION
29 20662ea0 2021-04-10 stsp is the repository maintenance tool for the
31 20662ea0 2021-04-10 stsp version control system.
34 20662ea0 2021-04-10 stsp stores the history of tracked files in a Git repository, as used
35 20662ea0 2021-04-10 stsp by the Git version control system.
37 20662ea0 2021-04-10 stsp provides commands for inspecting and manipulating the on-disk state of
38 20662ea0 2021-04-10 stsp Git repositories.
39 20662ea0 2021-04-10 stsp The repository format is described in
40 20662ea0 2021-04-10 stsp .Xr git-repository 5 .
43 20662ea0 2021-04-10 stsp provides global and command-specific options.
44 20662ea0 2021-04-10 stsp Global options must precede the command name, and are as follows:
45 20662ea0 2021-04-10 stsp .Bl -tag -width tenletters
47 20662ea0 2021-04-10 stsp Display usage information and exit immediately.
48 20662ea0 2021-04-10 stsp .It Fl V , -version
49 20662ea0 2021-04-10 stsp Display program version and exit immediately.
52 20662ea0 2021-04-10 stsp The commands for
54 20662ea0 2021-04-10 stsp are as follows:
55 20662ea0 2021-04-10 stsp .Bl -tag -width checkout
56 20662ea0 2021-04-10 stsp .It Cm info Oo Fl r Ar repository-path Oc
57 20662ea0 2021-04-10 stsp Display information about a repository.
58 20662ea0 2021-04-10 stsp This includes some configuration settings from
59 20662ea0 2021-04-10 stsp .Xr got.conf 5 ,
60 20662ea0 2021-04-10 stsp and the number of objects stored in the repository, in packed or
61 20662ea0 2021-04-10 stsp loose form, as well as the current on-disk size of these objects.
63 20662ea0 2021-04-10 stsp The options for
64 20662ea0 2021-04-10 stsp .Cm gotadmin info
65 20662ea0 2021-04-10 stsp are as follows:
66 20662ea0 2021-04-10 stsp .Bl -tag -width Ds
67 20662ea0 2021-04-10 stsp .It Fl r Ar repository-path
68 20662ea0 2021-04-10 stsp Use the repository at the specified path.
69 20662ea0 2021-04-10 stsp If not specified, assume the repository is located at or above the current
70 20662ea0 2021-04-10 stsp working directory.
72 05118f5a 2021-06-22 stsp .It Cm pack Oo Fl a Oc Oo Fl r Ar repository-path Oc Oo Fl x Ar reference Oc Op Ar reference ...
73 05118f5a 2021-06-22 stsp Generate a new pack file and a corresponding pack file index.
74 05118f5a 2021-06-22 stsp By default, add any loose objects which are reachable via any references
75 05118f5a 2021-06-22 stsp to the generated pack file.
77 05118f5a 2021-06-22 stsp If one or more
78 05118f5a 2021-06-22 stsp .Ar reference
79 05118f5a 2021-06-22 stsp arguments is specified, only add objects which are reachable via the specified
82 05118f5a 2021-06-22 stsp .Ar reference
83 05118f5a 2021-06-22 stsp argument may either specify a specific reference or a reference namespace,
84 05118f5a 2021-06-22 stsp in which case all references within this namespace will be used.
86 05118f5a 2021-06-22 stsp .Cm gotadmin pack
87 05118f5a 2021-06-22 stsp always ignores references in the
88 05118f5a 2021-06-22 stsp .Pa refs/got/
89 05118f5a 2021-06-22 stsp namespace, effectively treating such references as if they did not refer
90 05118f5a 2021-06-22 stsp to any objects.
92 05118f5a 2021-06-22 stsp The options for
93 05118f5a 2021-06-22 stsp .Cm gotadmin pack
94 05118f5a 2021-06-22 stsp are as follows:
95 05118f5a 2021-06-22 stsp .Bl -tag -width Ds
97 05118f5a 2021-06-22 stsp Add objects to the generated pack file even if they are already packed
98 05118f5a 2021-06-22 stsp in a different pack file.
99 05118f5a 2021-06-22 stsp Unless this option is specified, only loose objects will be added.
100 05118f5a 2021-06-22 stsp .It Fl r Ar repository-path
101 05118f5a 2021-06-22 stsp Use the repository at the specified path.
102 05118f5a 2021-06-22 stsp If not specified, assume the repository is located at or above the current
103 05118f5a 2021-06-22 stsp working directory.
104 05118f5a 2021-06-22 stsp .It Fl x Ar reference
105 05118f5a 2021-06-22 stsp Exclude objects reachable via the specified
106 05118f5a 2021-06-22 stsp .Ar reference
107 05118f5a 2021-06-22 stsp from the pack file.
109 05118f5a 2021-06-22 stsp .Ar reference
110 05118f5a 2021-06-22 stsp argument may either specify a specific reference or a reference namespace,
111 05118f5a 2021-06-22 stsp in which case all references within this namespace will be excluded.
114 05118f5a 2021-06-22 stsp option may be specified multiple times to build a list of references to exclude.
116 05118f5a 2021-06-22 stsp Exclusion takes precedence over inclusion.
117 05118f5a 2021-06-22 stsp If a reference appears in both the included and excluded lists, it will
118 05118f5a 2021-06-22 stsp be excluded.
121 05118f5a 2021-06-22 stsp .It Cm indexpack Ar packfile-path
122 5b5b660d 2021-10-08 thomas .Dl (alias: Cm ix )
123 05118f5a 2021-06-22 stsp Create a pack index for the pack file at
124 05118f5a 2021-06-22 stsp .Ar packfile-path .
126 05118f5a 2021-06-22 stsp A pack index is required for using the corresponding pack file with
127 05118f5a 2021-06-22 stsp .Xr got 1 .
128 05118f5a 2021-06-22 stsp Usually, a pack index will be created by commands such as
129 05118f5a 2021-06-22 stsp .Cm gotadmin pack
131 05118f5a 2021-06-22 stsp .Cm got fetch
132 05118f5a 2021-06-22 stsp as part of regular operation.
134 05118f5a 2021-06-22 stsp .Cm gotadmin indexpack
135 05118f5a 2021-06-22 stsp command may be used to recover from a corrupt or missing index.
136 05118f5a 2021-06-22 stsp A given pack file will always yield the same bit-identical index.
138 05118f5a 2021-06-22 stsp The provided
139 05118f5a 2021-06-22 stsp .Ar packfile-path
140 05118f5a 2021-06-22 stsp must be located within the
141 05118f5a 2021-06-22 stsp .Pa objects/pack/
142 05118f5a 2021-06-22 stsp directory of the repository and should end in
143 05118f5a 2021-06-22 stsp .Pa .pack .
144 05118f5a 2021-06-22 stsp The filename of the corresponding pack index is equivalent, except
145 05118f5a 2021-06-22 stsp that it ends in
148 05118f5a 2021-06-22 stsp .It Cm listpack Oo Fl h Oc Oo Fl s Oc Ar packfile-path
149 5b5b660d 2021-10-08 thomas .Dl (alias: Cm ls )
150 05118f5a 2021-06-22 stsp List the contents of the pack file at
151 05118f5a 2021-06-22 stsp .Ar packfile-path .
153 05118f5a 2021-06-22 stsp Each object contained in the pack file will be displayed on a single line.
154 05118f5a 2021-06-22 stsp The information shown includes the object ID, object type, object offset,
155 05118f5a 2021-06-22 stsp and object size.
157 05118f5a 2021-06-22 stsp If a packed object is deltified against another object the delta base
158 05118f5a 2021-06-22 stsp will be shown as well.
159 05118f5a 2021-06-22 stsp For offset deltas, the delta base is identified via an offset into the
161 05118f5a 2021-06-22 stsp For reference deltas, the delta base is identified via an object ID.
163 05118f5a 2021-06-22 stsp The provided
164 05118f5a 2021-06-22 stsp .Ar packfile-path
165 05118f5a 2021-06-22 stsp must be located within the
166 05118f5a 2021-06-22 stsp .Pa objects/pack/
167 05118f5a 2021-06-22 stsp directory of the repository and should end in
168 05118f5a 2021-06-22 stsp .Pa .pack .
170 05118f5a 2021-06-22 stsp The options for
171 05118f5a 2021-06-22 stsp .Cm gotadmin listpack
172 05118f5a 2021-06-22 stsp are as follows:
173 05118f5a 2021-06-22 stsp .Bl -tag -width Ds
175 05118f5a 2021-06-22 stsp Show object sizes in human-readable form.
177 1fe43c07 2021-10-08 thomas Display statistics about the pack file after listing objects.
178 05118f5a 2021-06-22 stsp This includes the total number of objects stored in the pack file
179 05118f5a 2021-06-22 stsp and a break-down of the number of objects per object type.
182 ef8ec606 2021-07-27 stsp .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
183 5b5b660d 2021-10-08 thomas .Dl (alias: Cm cl )
184 b3d68e7f 2021-07-03 stsp Purge unreferenced loose objects from the repository and display
185 b3d68e7f 2021-07-03 stsp the amount of disk space which has been freed as a result.
187 b3d68e7f 2021-07-03 stsp Unreferenced objects are present in the repository but cannot be
188 b3d68e7f 2021-07-03 stsp reached via any reference in the entire
192 b3d68e7f 2021-07-03 stsp Loose objects are stored as individual files beneath the repository's
193 b3d68e7f 2021-07-03 stsp .Pa objects/
195 b3d68e7f 2021-07-03 stsp spread across 256 sub-directories named after the 256 possible
196 b3d68e7f 2021-07-03 stsp hexadecimal values of the first byte of an object identifier.
198 b3d68e7f 2021-07-03 stsp Packed objects stored in pack files under
199 1fe43c07 2021-10-08 thomas .Pa objects/pack/
200 b3d68e7f 2021-07-03 stsp will not be purged.
201 b3d68e7f 2021-07-03 stsp However, if redundant copies of packed objects exist in loose form,
202 b3d68e7f 2021-07-03 stsp such redundant copies will be purged.
204 b3d68e7f 2021-07-03 stsp Objects will usually become unreferenced as a result of deleting
205 b3d68e7f 2021-07-03 stsp branches or tags with
206 b3d68e7f 2021-07-03 stsp .Cm got branch -d
208 b3d68e7f 2021-07-03 stsp .Cm got tag -d .
209 b3d68e7f 2021-07-03 stsp Deleting arbitrary references with
210 1fe43c07 2021-10-08 thomas .Cm got ref -d
211 b3d68e7f 2021-07-03 stsp may also leave unreferenced objects behind.
213 b3d68e7f 2021-07-03 stsp In order to determine the set of objects which are referenced, search
214 b3d68e7f 2021-07-03 stsp all references for commit objects and tag objects, and traverse the
215 b3d68e7f 2021-07-03 stsp corresponding tree object hierarchies.
216 b3d68e7f 2021-07-03 stsp Any loose object IDs not encountered during this search are unreferenced
217 b3d68e7f 2021-07-03 stsp and thus subject to removal.
218 b3d68e7f 2021-07-03 stsp Display the number of commits which have been searched to indicate progress.
220 b3d68e7f 2021-07-03 stsp References in the
221 b3d68e7f 2021-07-03 stsp .Pa refs/got
222 b3d68e7f 2021-07-03 stsp namespace may prevent objects from being purged.
223 b3d68e7f 2021-07-03 stsp This includes references in the
224 b3d68e7f 2021-07-03 stsp .Pa refs/got/worktree
225 b3d68e7f 2021-07-03 stsp namespace created by
226 b3d68e7f 2021-07-03 stsp .Cm got checkout
228 b3d68e7f 2021-07-03 stsp .Cm got update ,
229 b3d68e7f 2021-07-03 stsp as well as references in the
230 b3d68e7f 2021-07-03 stsp .Pa refs/got/backup
231 b3d68e7f 2021-07-03 stsp namespace created by
232 b3d68e7f 2021-07-03 stsp .Cm got rebase
234 b3d68e7f 2021-07-03 stsp .Cm got histedit .
235 b3d68e7f 2021-07-03 stsp .Cm gotadmin cleanup
236 b3d68e7f 2021-07-03 stsp will only purge corresponding objects once such references have been
237 b3d68e7f 2021-07-03 stsp deleted with
238 b3d68e7f 2021-07-03 stsp .Cm got ref -d .
240 1124fe40 2021-07-07 stsp Some Git repositories contain pack index files which lack a corresponding
241 1124fe40 2021-07-07 stsp pack file, which is an inconsistent repository state.
242 1124fe40 2021-07-07 stsp In such cases,
243 1124fe40 2021-07-07 stsp .Cm gotadmin cleanup -p -n
244 1124fe40 2021-07-07 stsp will display a list of affected pack index files.
245 1124fe40 2021-07-07 stsp Whenever possible the missing pack files should be restored.
246 1124fe40 2021-07-07 stsp If restoring missing pack files is not possible then affected pack index
247 1124fe40 2021-07-07 stsp files can be removed with
248 1124fe40 2021-07-07 stsp .Cm gotadmin cleanup -p .
251 9188bd78 2021-07-03 stsp .Dq preciousObjects
252 9188bd78 2021-07-03 stsp Git extension is intended to prevent the removal of objects from a repository.
253 1fe43c07 2021-10-08 thomas .Cm gotadmin cleanup
254 9188bd78 2021-07-03 stsp will refuse to operate on repositories where this extension is active.
256 b3d68e7f 2021-07-03 stsp The options for
257 d4445ca5 2021-07-03 stsp .Cm gotadmin cleanup
258 b3d68e7f 2021-07-03 stsp are as follows:
259 b3d68e7f 2021-07-03 stsp .Bl -tag -width Ds
261 ef8ec606 2021-07-27 stsp Delete all loose objects.
262 ef8ec606 2021-07-27 stsp By default, objects which are newer than an implementation-defined
263 ef8ec606 2021-07-27 stsp modification timestamp are kept on disk to prevent race conditions
264 ef8ec606 2021-07-27 stsp with other commands that add new objects to the repository while
265 ef8ec606 2021-07-27 stsp .Cm gotadmin cleanup
266 ef8ec606 2021-07-27 stsp is running.
268 1124fe40 2021-07-07 stsp Instead of purging unreferenced loose objects, remove any pack index files
269 1124fe40 2021-07-07 stsp which do not have a corresponding pack file.
271 b3d68e7f 2021-07-03 stsp Display the usual progress output and summary information but do not actually
272 1124fe40 2021-07-07 stsp remove any files from disk.
273 b3d68e7f 2021-07-03 stsp .It Fl r Ar repository-path
274 b3d68e7f 2021-07-03 stsp Use the repository at the specified path.
275 b3d68e7f 2021-07-03 stsp If not specified, assume the repository is located at or above the current
276 b3d68e7f 2021-07-03 stsp working directory.
278 b3d68e7f 2021-07-03 stsp Suppress progress reporting and disk space summary output.
281 20662ea0 2021-04-10 stsp .Sh EXIT STATUS
282 20662ea0 2021-04-10 stsp .Ex -std gotadmin
283 20662ea0 2021-04-10 stsp .Sh SEE ALSO
284 20662ea0 2021-04-10 stsp .Xr got 1 ,
285 20662ea0 2021-04-10 stsp .Xr tog 1 ,
286 20662ea0 2021-04-10 stsp .Xr git-repository 5 ,
287 20662ea0 2021-04-10 stsp .Xr got.conf 5
288 20662ea0 2021-04-10 stsp .Sh AUTHORS
289 20662ea0 2021-04-10 stsp .An Stefan Sperling Aq Mt stsp@openbsd.org
290 05118f5a 2021-06-22 stsp .An Ori Bernstein Aq Mt ori@openbsd.org
291 7e36bc2b 2021-06-25 stsp .Sh CAVEATS
293 7e36bc2b 2021-06-25 stsp is a work-in-progress and some features remain to be implemented.
295 7e36bc2b 2021-06-25 stsp At present, the user has to fall back on
297 7e36bc2b 2021-06-25 stsp to perform some tasks.
298 7e36bc2b 2021-06-25 stsp In particular:
299 7e36bc2b 2021-06-25 stsp .Bl -bullet
301 b3d68e7f 2021-07-03 stsp Removing redundant or unreferenced packed objects requires
302 b3d68e7f 2021-07-03 stsp .Xr git-gc 1
303 b3d68e7f 2021-07-03 stsp and perhaps
304 b3d68e7f 2021-07-03 stsp .Xr git-repack 1 .
306 7e36bc2b 2021-06-25 stsp Exporting data from repositories requires
307 7e36bc2b 2021-06-25 stsp .Xr git-fast-export 1 .
309 7e36bc2b 2021-06-25 stsp Importing data into repositories requires
310 7e36bc2b 2021-06-25 stsp .Xr git-fast-import 1 .
313 aaf7c342 2021-07-03 stsp Disk space savings reported by
314 aaf7c342 2021-07-03 stsp .Cm gotadmin cleanup
315 aaf7c342 2021-07-03 stsp will be misleading if the repository contains object files that were
316 aaf7c342 2021-07-03 stsp hard-linked from another repository.
317 aaf7c342 2021-07-03 stsp Such hard-links will be created by certain
322 aaf7c342 2021-07-03 stsp will never create hard-linked object files.
