[1/2] doc/git-interface: Fix configuration strings mangled by asciidoc

Message ID 20171113144914.8217-1-eschwartz@archlinux.org
State New
Headers show
Series
  • [1/2] doc/git-interface: Fix configuration strings mangled by asciidoc
Related show

Commit Message

Eli Schwartz Nov. 13, 2017, 2:49 p.m. UTC
Double-quoted "strings" were surrounded by the <sup> tag, but what we
actually want is fenced-in `strings` to create the <code> tag.

Signed-off-by: Eli Schwartz <eschwartz@archlinux.org>
---
 doc/git-interface.txt | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

Comments

Lukas Fleischer Nov. 15, 2017, 5:54 a.m. UTC | #1
Hi Eli,

On Mon, 13 Nov 2017 at 15:49:13, Eli Schwartz wrote:
> Double-quoted "strings" were surrounded by the <sup> tag, but what we
> actually want is fenced-in `strings` to create the <code> tag.
> 
> Signed-off-by: Eli Schwartz <eschwartz@archlinux.org>
> ---
>  doc/git-interface.txt | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)

The purpose of this document is to outline internals, implementation
details and administration instructions for the Git/SSH interface and
was not designed to be a documentation of the user interface. I also did
not intend to make it AsciiDoc-compatible, even though it happens to
have a similar syntax. If we want to provide such a document via the
user interface, we should probably split this into two documents.

I suggest to keep the user interface documentation in place and move the
technical stuff to doc/internals/git-interface.txt -- the original
document under doc/git-interface.txt could then be converted to a proper
AsciiDoc source file and added to the public web interface as you
suggested in the second patch of this series. Opinions?

Regards,
Lukas

Patch

diff --git a/doc/git-interface.txt b/doc/git-interface.txt
index f940961..a029400 100644
--- a/doc/git-interface.txt
+++ b/doc/git-interface.txt
@@ -100,9 +100,9 @@  opposite effect in the case of aurweb: Most of the refs transferred to the
 client during `git push` operations belong to branches of other package bases
 and are essentially useless.
 
-In order to omit these advertisements, one can add the strings "^refs/",
-"!refs/" and "!HEAD" to the transfer.hideRefs configuration setting. Note that
-the order of these patterns is important ("^refs/" must come first) and that
+In order to omit these advertisements, one can add the strings `^refs/`,
+`!refs/` and `!HEAD` to the transfer.hideRefs configuration setting. Note that
+the order of these patterns is important (`^refs/` must come first) and that
 Git 2.7 or newer is required for them to work.
 
 Since garbage collection always affects all objects (from all namespaces), it