git/Documentation/git-daemon.adoc, branch jchMirror of https://git.kernel.org/pub/scm/git/git.git/
https://git.shady.money/git/atom?h=jch2025-05-12T16:25:26Zgit-daemon doc: update mark-up of synopsis option descriptions2025-05-12T16:25:26ZJunio C Hamanogitster@pobox.com2025-05-10T12:33:14Zurn:sha1:88ce8dfe2924f2a0c75bd3ec5c52fae02f73ba19
To unify mark-up used in our documentation to a newer convention,
started by 22293895 (doc: apply synopsis simplification on git-clone
and git-init, 2024-09-24), update the documentation of 'git daemon'
to
* use [synopsis], not [verse] in the SYNOPSIS section
* enclose `--option=<value>` in backquotes
Also, split '--[no-]option' into '--option' and '--no-option'
to make it easier to grep for them.
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Helped-by: Jean-Noël Avila <jn.avila@free.fr>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
doc: use .adoc extension for AsciiDoc files2025-01-21T20:56:06Zbrian m. carlsonsandals@crustytoothpaste.net2025-01-20T01:56:02Zurn:sha1:1f010d6bdf756129db13d1367c888aa4153f6d87
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>