Documentation/git-refs.txt

   1 git-refs(1)
   2 ===========
   3
   4 NAME
   5 ----
   6 git-refs - Low-level access to refs
   7
   8
   9 SYNOPSIS
  10 --------
  11 [verse]
  12 'git refs migrate' --ref-format=<format> [--dry-run]
  13 'git refs verify' [--strict] [--verbose]
  14
  15 DESCRIPTION
  16 -----------
  17
  18 This command provides low-level access to refs.
  19
  20 COMMANDS
  21 --------
  22
  23 migrate::
  24         Migrate ref store between different formats.
  25
  26 verify::
  27         Verify reference database consistency.
  28
  29 OPTIONS
  30 -------
  31
  32 The following options are specific to 'git refs migrate':
  33
  34 --ref-format=<format>::
  35         The ref format to migrate the ref store to. Can be one of:
  36 +
  37 include::ref-storage-format.txt[]
  38
  39 --dry-run::
  40         Perform the migration, but do not modify the repository. The migrated
  41         refs will be written into a separate directory that can be inspected
  42         separately. The name of the directory will be reported on stdout. This
  43         can be used to double check that the migration works as expected before
  44         performing the actual migration.
  45
  46 The following options are specific to 'git refs verify':
  47
  48 --strict::
  49         Enable stricter error checking. This will cause warnings to be
  50         reported as errors. See linkgit:git-fsck[1].
  51
  52 --verbose::
  53         When verifying the reference database consistency, be chatty.
  54
  55 KNOWN LIMITATIONS
  56 -----------------
  57
  58 The ref format migration has several known limitations in its current form:
  59
  60 * It is not possible to migrate repositories that have reflogs.
  61
  62 * It is not possible to migrate repositories that have worktrees.
  63
  64 * There is no way to block concurrent writes to the repository during an
  65   ongoing migration. Concurrent writes can lead to an inconsistent migrated
  66   state. Users are expected to block writes on a higher level. If your
  67   repository is registered for scheduled maintenance, it is recommended to
  68   unregister it first with git-maintenance(1).
  69
  70 These limitations may eventually be lifted.
  71
  72 GIT
  73 ---
  74 Part of the linkgit:git[1] suite