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
  14 DESCRIPTION
  15 -----------
  16
  17 This command provides low-level access to refs.
  18
  19 COMMANDS
  20 --------
  21
  22 migrate::
  23         Migrate ref store between different formats.
  24
  25 OPTIONS
  26 -------
  27
  28 The following options are specific to 'git refs migrate':
  29
  30 --ref-format=<format>::
  31         The ref format to migrate the ref store to. Can be one of:
  32 +
  33 include::ref-storage-format.txt[]
  34
  35 --dry-run::
  36         Perform the migration, but do not modify the repository. The migrated
  37         refs will be written into a separate directory that can be inspected
  38         separately. The name of the directory will be reported on stdout. This
  39         can be used to double check that the migration works as expected before
  40         performing the actual migration.
  41
  42 KNOWN LIMITATIONS
  43 -----------------
  44
  45 The ref format migration has several known limitations in its current form:
  46
  47 * It is not possible to migrate repositories that have reflogs.
  48
  49 * It is not possible to migrate repositories that have worktrees.
  50
  51 * There is no way to block concurrent writes to the repository during an
  52   ongoing migration. Concurrent writes can lead to an inconsistent migrated
  53   state. Users are expected to block writes on a higher level. If your
  54   repository is registered for scheduled maintenance, it is recommended to
  55   unregister it first with git-maintenance(1).
  56
  57 These limitations may eventually be lifted.
  58
  59 GIT
  60 ---
  61 Part of the linkgit:git[1] suite