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

[Lukas Fleischer]

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 at 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