gotadmin/gotadmin.1

   1 .\"
   2 .\" Copyright (c) 2021 Stefan Sperling
   3 .\"
   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.
   7 .\"
   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.
  15 .\"
  16 .Dd $Mdocdate$
  17 .Dt GOTADMIN 1
  18 .Os
  19 .Sh NAME
  20 .Nm gotadmin
  21 .Nd Game of Trees repository administration
  22 .Sh SYNOPSIS
  23 .Nm
  24 .Op Fl hV
  25 .Ar command
  26 .Op Ar arg ...
  27 .Sh DESCRIPTION
  28 .Nm
  29 is the repository maintenance tool for the
  30 .Xr got 1
  31 version control system.
  32 .Pp
  33 .Xr got 1
  34 stores the history of tracked files in a Git repository, as used
  35 by the Git version control system.
  36 .Nm
  37 provides commands for inspecting and manipulating the on-disk state of
  38 Git repositories.
  39 The repository format is described in
  40 .Xr git-repository 5 .
  41 .Pp
  42 .Nm
  43 provides global and command-specific options.
  44 Global options must precede the command name, and are as follows:
  45 .Bl -tag -width tenletters
  46 .It Fl h
  47 Display usage information and exit immediately.
  48 .It Fl V , -version
  49 Display program version and exit immediately.
  50 .El
  51 .Pp
  52 The commands for
  53 .Nm
  54 are as follows:
  55 .Bl -tag -width checkout
  56 .It Cm init Oo Fl b Ar branch Oc Ar repository-path
  57 Create a new empty repository at the specified
  58 .Ar repository-path .
  59 .Pp
  60 After
  61 .Cm gotadmin init ,
  62 the
  63 .Cm got import
  64 command must be used to populate the empty repository before
  65 .Cm got checkout
  66 can be used.
  67 .Pp
  68 The options for
  69 .Cm gotadmin init
  70 are as follows:
  71 .Bl -tag -width Ds
  72 .It Fl b Ar branch
  73 Make the repository's HEAD reference point to the specified
  74 .Ar branch
  75 instead of the default branch
  76 .Dq main .
  77 .El
  78 .It Cm info Op Fl r Ar repository-path
  79 Display information about a repository.
  80 This includes some configuration settings from
  81 .Xr got.conf 5 ,
  82 and the number of objects stored in the repository, in packed or
  83 loose form, as well as the current on-disk size of these objects.
  84 .Pp
  85 The options for
  86 .Cm gotadmin info
  87 are as follows:
  88 .Bl -tag -width Ds
  89 .It Fl r Ar repository-path
  90 Use the repository at the specified path.
  91 If not specified, assume the repository is located at or above the current
  92 working directory.
  93 If this directory is a
  94 .Xr got 1
  95 work tree, use the repository path associated with this work tree.
  96 .El
  97 .It Xo
  98 .Cm pack
  99 .Op Fl aDq
 100 .Op Fl r Ar repository-path
 101 .Op Fl x Ar reference
 102 .Op Ar reference ...
 103 .Xc
 104 Generate a new pack file and a corresponding pack file index.
 105 By default, add any loose objects which are reachable via any references
 106 to the generated pack file.
 107 .Pp
 108 If one or more
 109 .Ar reference
 110 arguments is specified, only add objects which are reachable via the specified
 111 references.
 112 Each
 113 .Ar reference
 114 argument may either specify a specific reference or a reference namespace,
 115 in which case all references within this namespace will be used.
 116 .Pp
 117 .Cm gotadmin pack
 118 always ignores references in the
 119 .Pa refs/got/
 120 namespace, effectively treating such references as if they did not refer
 121 to any objects.
 122 .Pp
 123 The options for
 124 .Cm gotadmin pack
 125 are as follows:
 126 .Bl -tag -width Ds
 127 .It Fl a
 128 Add objects to the generated pack file even if they are already packed
 129 in a different pack file.
 130 Unless this option is specified, only loose objects will be added.
 131 .It Fl D
 132 Force the use of ref-delta representation for deltified objects.
 133 If this option is not specified, offset-deltas will be used to represent
 134 deltified objects.
 135 .It Fl q
 136 Suppress progress reporting output.
 137 .It Fl r Ar repository-path
 138 Use the repository at the specified path.
 139 If not specified, assume the repository is located at or above the current
 140 working directory.
 141 If this directory is a
 142 .Xr got 1
 143 work tree, use the repository path associated with this work tree.
 144 .It Fl x Ar reference
 145 Exclude objects reachable via the specified
 146 .Ar reference
 147 from the pack file.
 148 The
 149 .Ar reference
 150 argument may either specify a specific reference or a reference namespace,
 151 in which case all references within this namespace will be excluded.
 152 The
 153 .Fl x
 154 option may be specified multiple times to build a list of references to exclude.
 155 .Pp
 156 Exclusion takes precedence over inclusion.
 157 If a reference appears in both the included and excluded lists, it will
 158 be excluded.
 159 .El
 160 .Tg ix
 161 .It Cm indexpack Ar packfile-path
 162 .Dl Pq alias: Cm ix
 163 Create a pack index for the pack file at
 164 .Ar packfile-path .
 165 .Pp
 166 A pack index is required for using the corresponding pack file with
 167 .Xr got 1 .
 168 Usually, a pack index will be created by commands such as
 169 .Cm gotadmin pack
 170 or
 171 .Cm got fetch
 172 as part of regular operation.
 173 The
 174 .Cm gotadmin indexpack
 175 command may be used to recover from a corrupt or missing index.
 176 A given pack file will always yield the same bit-identical index.
 177 .Pp
 178 The provided
 179 .Ar packfile-path
 180 must be located within the
 181 .Pa objects/pack/
 182 directory of the repository and should end in
 183 .Pa .pack .
 184 The filename of the corresponding pack index is equivalent, except
 185 that it ends in
 186 .Pa .idx .
 187 .Tg ls
 188 .It Xo
 189 .Cm listpack
 190 .Op Fl hs
 191 .Ar packfile-path
 192 .Xc
 193 .Dl Pq alias: Cm ls
 194 List the contents of the pack file at
 195 .Ar packfile-path .
 196 .Pp
 197 Each object contained in the pack file will be displayed on a single line.
 198 The information shown includes the object ID, object type, object offset,
 199 and object size.
 200 .Pp
 201 If a packed object is deltified against another object, the delta base
 202 will be shown as well.
 203 For offset deltas, the delta base is identified via an offset into the
 204 pack file.
 205 For reference deltas, the delta base is identified via an object ID.
 206 .Pp
 207 The provided
 208 .Ar packfile-path
 209 must be located within the
 210 .Pa objects/pack/
 211 directory of the repository and should end in
 212 .Pa .pack .
 213 The corresponding pack index must exist and can be created with
 214 .Cm gotadmin indexpack
 215 if it is missing.
 216 .Pp
 217 The options for
 218 .Cm gotadmin listpack
 219 are as follows:
 220 .Bl -tag -width Ds
 221 .It Fl h
 222 Show object sizes in human-readable form.
 223 .It Fl s
 224 Display statistics about the pack file after listing objects.
 225 This includes the total number of objects stored in the pack file
 226 and a break-down of the number of objects per object type.
 227 .El
 228 .Tg cl
 229 .It Xo
 230 .Cm cleanup
 231 .Op Fl anpq
 232 .Op Fl r Ar repository-path
 233 .Xc
 234 .Dl Pq alias: Cm cl
 235 Purge unreferenced loose objects from the repository and display
 236 the amount of disk space which has been freed as a result.
 237 .Pp
 238 Unreferenced objects are present in the repository but cannot be
 239 reached via any reference in the entire
 240 .Pa refs/
 241 namespace.
 242 .Pp
 243 Loose objects are stored as individual files beneath the repository's
 244 .Pa objects/
 245 directory,
 246 spread across 256 sub-directories named after the 256 possible
 247 hexadecimal values of the first byte of an object identifier.
 248 .Pp
 249 Packed objects stored in pack files under
 250 .Pa objects/pack/
 251 will not be purged.
 252 However, if redundant copies of packed objects exist in loose form,
 253 such redundant copies will be purged.
 254 .Pp
 255 Objects will usually become unreferenced as a result of deleting
 256 branches or tags with
 257 .Cm got branch -d
 258 or
 259 .Cm got tag -d .
 260 Deleting arbitrary references with
 261 .Cm got ref -d
 262 may also leave unreferenced objects behind.
 263 .Pp
 264 In order to determine the set of objects which are referenced, search
 265 all references for commit objects and tag objects, and traverse the
 266 corresponding tree object hierarchies.
 267 Any loose object IDs not encountered during this search are unreferenced
 268 and thus subject to removal.
 269 Display the number of commits which have been searched to indicate progress.
 270 .Pp
 271 References in the
 272 .Pa refs/got
 273 namespace may prevent objects from being purged.
 274 This includes references in the
 275 .Pa refs/got/worktree
 276 namespace created by
 277 .Cm got checkout
 278 and
 279 .Cm got update ,
 280 as well as references in the
 281 .Pa refs/got/backup
 282 namespace created by
 283 .Cm got rebase
 284 and
 285 .Cm got histedit .
 286 .Cm gotadmin cleanup
 287 will only purge corresponding objects once such references have been
 288 deleted with
 289 .Cm got ref -d .
 290 .Pp
 291 Some Git repositories contain pack index files which lack a corresponding
 292 pack file, which is an inconsistent repository state.
 293 In such cases,
 294 .Cm gotadmin cleanup -p -n
 295 will display a list of affected pack index files.
 296 Whenever possible, the missing pack files should be restored.
 297 If restoring missing pack files is not possible, then affected pack index
 298 files can be removed with
 299 .Cm gotadmin cleanup -p .
 300 .Pp
 301 The
 302 .Dq preciousObjects
 303 Git extension is intended to prevent the removal of objects from a repository.
 304 .Cm gotadmin cleanup
 305 will refuse to operate on repositories where this extension is active.
 306 .Pp
 307 The options for
 308 .Cm gotadmin cleanup
 309 are as follows:
 310 .Bl -tag -width Ds
 311 .It Fl a
 312 Delete all loose objects.
 313 By default, objects which are newer than an implementation-defined
 314 modification timestamp are kept on disk to prevent race conditions
 315 with other commands that add new objects to the repository while
 316 .Cm gotadmin cleanup
 317 is running.
 318 .It Fl n
 319 Display the usual progress output and summary information but do not actually
 320 remove any files from disk.
 321 .It Fl p
 322 Instead of purging unreferenced loose objects, remove any pack index files
 323 which do not have a corresponding pack file.
 324 .It Fl q
 325 Suppress progress reporting and disk space summary output.
 326 .It Fl r Ar repository-path
 327 Use the repository at the specified path.
 328 If not specified, assume the repository is located at or above the current
 329 working directory.
 330 If this directory is a
 331 .Xr got 1
 332 work tree, use the repository path associated with this work tree.
 333 .El
 334 .El
 335 .Sh EXIT STATUS
 336 .Ex -std gotadmin
 337 .Sh SEE ALSO
 338 .Xr got 1 ,
 339 .Xr tog 1 ,
 340 .Xr git-repository 5 ,
 341 .Xr got.conf 5
 342 .Sh AUTHORS
 343 .An Christian Weisgerber Aq Mt naddy@openbsd.org
 344 .An Josh Rickmar Aq Mt jrick@zettaport.com
 345 .An Klemens Nanni Aq Mt kn@openbsd.org
 346 .An Ori Bernstein Aq Mt ori@openbsd.org
 347 .An Stefan Sperling Aq Mt stsp@openbsd.org
 348 .An Tracey Emery Aq Mt tracey@traceyemery.net
 349 .Sh CAVEATS
 350 .Nm
 351 is a work-in-progress and some features remain to be implemented.
 352 .Pp
 353 At present, the user has to fall back on
 354 .Xr git 1
 355 to perform some tasks.
 356 In particular:
 357 .Bl -bullet
 358 .It
 359 Removing redundant or unreferenced packed objects requires
 360 .Xr git-gc 1
 361 and perhaps
 362 .Xr git-repack 1 .
 363 .It
 364 Exporting data from repositories requires
 365 .Xr git-fast-export 1 .
 366 .It
 367 Importing data into repositories requires
 368 .Xr git-fast-import 1 .
 369 .El
 370 .Sh BUGS
 371 Disk space savings reported by
 372 .Cm gotadmin cleanup
 373 will be misleading if the repository contains object files that were
 374 hard-linked from another repository.
 375 Such hard-links will be created by certain
 376 .Xr git 1
 377 commands.
 378 By itself,
 379 .Xr got 1
 380 will never create hard-linked object files.