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-01
   6 .\"    Manual: Git Manual
   7 .\"    Source: Git 2.46.0.46.g406f326d27
   8 .\"  Language: English
   9 .\"
  10 .TH "GIT\-REFS" "1" "2024-08-01" "Git 2\&.46\&.0\&.46\&.g406f326" "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 .fi
  37 .SH "DESCRIPTION"
  38 .sp
  39 This command provides low\-level access to refs\&.
  40 .SH "COMMANDS"
  41 .PP
  42 migrate
  43 .RS 4
  44 Migrate ref store between different formats\&.
  45 .RE
  46 .SH "OPTIONS"
  47 .sp
  48 The following options are specific to \fIgit refs migrate\fR:
  49 .PP
  50 \-\-ref\-format=<format>
  51 .RS 4
  52 The ref format to migrate the ref store to\&. Can be one of:
  53 .sp
  54 .RS 4
  55 .ie n \{\
  56 \h'-04'\(bu\h'+03'\c
  57 .\}
  58 .el \{\
  59 .sp -1
  60 .IP \(bu 2.3
  61 .\}
  62 \fBfiles\fR
  63 for loose files with packed\-refs\&. This is the default\&.
  64 .RE
  65 .sp
  66 .RS 4
  67 .ie n \{\
  68 \h'-04'\(bu\h'+03'\c
  69 .\}
  70 .el \{\
  71 .sp -1
  72 .IP \(bu 2.3
  73 .\}
  74 \fBreftable\fR
  75 for the reftable format\&. This format is experimental and its internals are subject to change\&.
  76 .RE
  77 .RE
  78 .PP
  79 \-\-dry\-run
  80 .RS 4
  81 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\&.
  82 .RE
  83 .SH "KNOWN LIMITATIONS"
  84 .sp
  85 The ref format migration has several known limitations in its current form:
  86 .sp
  87 .RS 4
  88 .ie n \{\
  89 \h'-04'\(bu\h'+03'\c
  90 .\}
  91 .el \{\
  92 .sp -1
  93 .IP \(bu 2.3
  94 .\}
  95 It is not possible to migrate repositories that have reflogs\&.
  96 .RE
  97 .sp
  98 .RS 4
  99 .ie n \{\
 100 \h'-04'\(bu\h'+03'\c
 101 .\}
 102 .el \{\
 103 .sp -1
 104 .IP \(bu 2.3
 105 .\}
 106 It is not possible to migrate repositories that have worktrees\&.
 107 .RE
 108 .sp
 109 .RS 4
 110 .ie n \{\
 111 \h'-04'\(bu\h'+03'\c
 112 .\}
 113 .el \{\
 114 .sp -1
 115 .IP \(bu 2.3
 116 .\}
 117 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)\&.
 118 .RE
 119 .sp
 120 These limitations may eventually be lifted\&.
 121 .SH "GIT"
 122 .sp
 123 Part of the \fBgit\fR(1) suite