summaryrefslogtreecommitdiff
path: root/Documentation/ref-storage-format.adoc
AgeCommit message (Collapse)AuthorFilesLines
2026-04-08docs: correct information about reftablebrian m. carlson1-3/+8
Our description of the reftable format is that it is experimental and subject to change, but that is no longer true. Remove this statement so as not to mislead users. In addition, the documentation says that the files format is the default, but that is not true if breaking changes mode is on. Correct this information with a conditional. Signed-off-by: brian m. carlson <sandals@crustytoothpaste.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2026-02-05doc: fix some style issues in git-clone and for-each-ref-optionsJean-Noël Avila1-2/+2
* spell out all forms of --[no-]reject-shallow in git-clone * use imperative mood for the first line of options * Use asciidoc NOTE macro * fix markups Reviewed-by: Kristoffer Haugsbakk <kristofferhaugsbakk@fastmail.com> Signed-off-by: Jean-Noël Avila <jn.avila@free.fr> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2025-01-21doc: use .adoc extension for AsciiDoc filesbrian m. carlson1-0/+3
We presently use the ".txt" extension for our AsciiDoc files. While not wrong, most editors do not associate this extension with AsciiDoc, meaning that contributors don't get automatic editor functionality that could be useful, such as syntax highlighting and prose linting. It is much more common to use the ".adoc" extension for AsciiDoc files, since this helps editors automatically detect files and also allows various forges to provide rich (HTML-like) rendering. Let's do that here, renaming all of the files and updating the includes where relevant. Adjust the various build scripts and makefiles to use the new extension as well. Note that this should not result in any user-visible changes to the documentation. Signed-off-by: brian m. carlson <sandals@crustytoothpaste.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>