man1/git-refs.1

   1 '\" t
   2 .\"     Title: git-refs
   3 .\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
   4 .\" Generator: DocBook XSL Stylesheets v1.79.2 <http://docbook.sf.net/>
   5 .\"      Date: 2024-08-21
   6 .\"    Manual: Git Manual
   7 .\"    Source: Git 2.46.0.288.g3a7362eb9f
   8 .\"  Language: English
   9 .\"
  10 .TH "GIT\-REFS" "1" "2024-08-21" "Git 2\&.46\&.0\&.288\&.g3a7362" "Git Manual"
  11 .\" -----------------------------------------------------------------
  12 .\" * Define some portability stuff
  13 .\" -----------------------------------------------------------------
  14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  15 .\" http://bugs.debian.org/507673
  16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
  17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  18 .ie \n(.g .ds Aq \(aq
  19 .el       .ds Aq '
  20 .\" -----------------------------------------------------------------
  21 .\" * set default formatting
  22 .\" -----------------------------------------------------------------
  23 .\" disable hyphenation
  24 .nh
  25 .\" disable justification (adjust text to left margin only)
  26 .ad l
  27 .\" -----------------------------------------------------------------
  28 .\" * MAIN CONTENT STARTS HERE *
  29 .\" -----------------------------------------------------------------
  30 .SH "NAME"
  31 git-refs \- Low\-level access to refs
  32 .SH "SYNOPSIS"
  33 .sp
  34 .nf
  35 \fIgit refs migrate\fR \-\-ref\-format=<format> [\-\-dry\-run]
  36 \fIgit refs verify\fR [\-\-strict] [\-\-verbose]
  37 .fi
  38 .SH "DESCRIPTION"
  39 .sp
  40 This command provides low\-level access to refs\&.
  41 .SH "COMMANDS"
  42 .PP
  43 migrate
  44 .RS 4
  45 Migrate ref store between different formats\&.
  46 .RE
  47 .PP
  48 verify
  49 .RS 4
  50 Verify reference database consistency\&.
  51 .RE
  52 .SH "OPTIONS"
  53 .sp
  54 The following options are specific to \fIgit refs migrate\fR:
  55 .PP
  56 \-\-ref\-format=<format>
  57 .RS 4
  58 The ref format to migrate the ref store to\&. Can be one of:
  59 .sp
  60 .RS 4
  61 .ie n \{\
  62 \h'-04'\(bu\h'+03'\c
  63 .\}
  64 .el \{\
  65 .sp -1
  66 .IP \(bu 2.3
  67 .\}
  68 \fBfiles\fR
  69 for loose files with packed\-refs\&. This is the default\&.
  70 .RE
  71 .sp
  72 .RS 4
  73 .ie n \{\
  74 \h'-04'\(bu\h'+03'\c
  75 .\}
  76 .el \{\
  77 .sp -1
  78 .IP \(bu 2.3
  79 .\}
  80 \fBreftable\fR
  81 for the reftable format\&. This format is experimental and its internals are subject to change\&.
  82 .RE
  83 .RE
  84 .PP
  85 \-\-dry\-run
  86 .RS 4
  87 Perform the migration, but do not modify the repository\&. The migrated refs will be written into a separate directory that can be inspected separately\&. The name of the directory will be reported on stdout\&. This can be used to double check that the migration works as expected before performing the actual migration\&.
  88 .RE
  89 .sp
  90 The following options are specific to \fIgit refs verify\fR:
  91 .PP
  92 \-\-strict
  93 .RS 4
  94 Enable stricter error checking\&. This will cause warnings to be reported as errors\&. See
  95 \fBgit-fsck\fR(1)\&.
  96 .RE
  97 .PP
  98 \-\-verbose
  99 .RS 4
 100 When verifying the reference database consistency, be chatty\&.
 101 .RE
 102 .SH "KNOWN LIMITATIONS"
 103 .sp
 104 The ref format migration has several known limitations in its current form:
 105 .sp
 106 .RS 4
 107 .ie n \{\
 108 \h'-04'\(bu\h'+03'\c
 109 .\}
 110 .el \{\
 111 .sp -1
 112 .IP \(bu 2.3
 113 .\}
 114 It is not possible to migrate repositories that have reflogs\&.
 115 .RE
 116 .sp
 117 .RS 4
 118 .ie n \{\
 119 \h'-04'\(bu\h'+03'\c
 120 .\}
 121 .el \{\
 122 .sp -1
 123 .IP \(bu 2.3
 124 .\}
 125 It is not possible to migrate repositories that have worktrees\&.
 126 .RE
 127 .sp
 128 .RS 4
 129 .ie n \{\
 130 \h'-04'\(bu\h'+03'\c
 131 .\}
 132 .el \{\
 133 .sp -1
 134 .IP \(bu 2.3
 135 .\}
 136 There is no way to block concurrent writes to the repository during an ongoing migration\&. Concurrent writes can lead to an inconsistent migrated state\&. Users are expected to block writes on a higher level\&. If your repository is registered for scheduled maintenance, it is recommended to unregister it first with git\-maintenance(1)\&.
 137 .RE
 138 .sp
 139 These limitations may eventually be lifted\&.
 140 .SH "GIT"
 141 .sp
 142 Part of the \fBgit\fR(1) suite