logo

oasis-root

Compiled tree of Oasis Linux based on own branch at <https://hacktivis.me/git/oasis/> git clone https://anongit.hacktivis.me/git/oasis-root.git

git-refs.1 (3832B)


  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: 2025-03-14
  6. .\" Manual: Git Manual
  7. .\" Source: Git 2.49.0
  8. .\" Language: English
  9. .\"
  10. .TH "GIT\-REFS" "1" "2025-03-14" "Git 2\&.49\&.0" "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. \fBgit\fR \fBrefs\fR \fBmigrate\fR \fB\-\-ref\-format=\fR\fI<format>\fR [\fB\-\-no\-reflog\fR] [\fB\-\-dry\-run\fR]
  36. \fBgit\fR \fBrefs\fR \fBverify\fR [\fB\-\-strict\fR] [\fB\-\-verbose\fR]
  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. .PP
  90. \-\-reflog, \-\-no\-reflog
  91. .RS 4
  92. Choose between migrating the reflog data to the new backend, and discarding them\&. The default is "\-\-reflog", to migrate\&.
  93. .RE
  94. .sp
  95. The following options are specific to \fIgit refs verify\fR:
  96. .PP
  97. \-\-strict
  98. .RS 4
  99. Enable stricter error checking\&. This will cause warnings to be reported as errors\&. See
  100. \fBgit-fsck\fR(1)\&.
  101. .RE
  102. .PP
  103. \-\-verbose
  104. .RS 4
  105. When verifying the reference database consistency, be chatty\&.
  106. .RE
  107. .SH "KNOWN LIMITATIONS"
  108. .sp
  109. The ref format migration has several known limitations in its current form:
  110. .sp
  111. .RS 4
  112. .ie n \{\
  113. \h'-04'\(bu\h'+03'\c
  114. .\}
  115. .el \{\
  116. .sp -1
  117. .IP \(bu 2.3
  118. .\}
  119. It is not possible to migrate repositories that have worktrees\&.
  120. .RE
  121. .sp
  122. .RS 4
  123. .ie n \{\
  124. \h'-04'\(bu\h'+03'\c
  125. .\}
  126. .el \{\
  127. .sp -1
  128. .IP \(bu 2.3
  129. .\}
  130. 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)\&.
  131. .RE
  132. .sp
  133. These limitations may eventually be lifted\&.
  134. .SH "GIT"
  135. .sp
  136. Part of the \fBgit\fR(1) suite