[aur-dev] [PATCH 1/2] doc/git-interface: Fix configuration strings mangled by asciidoc
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(-) 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 -- 2.15.0
Signed-off-by: Eli Schwartz <eschwartz@archlinux.org> --- doc/Makefile | 2 +- web/html/git-interface.php | 3 +++ web/lib/routing.inc.php | 1 + 3 files changed, 5 insertions(+), 1 deletion(-) create mode 100644 web/html/git-interface.php diff --git a/doc/Makefile b/doc/Makefile index df54c5d..d8617c4 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -1,4 +1,4 @@ -all: rpc.html +all: rpc.html git-interface.html clean: rm -rf *.html diff --git a/web/html/git-interface.php b/web/html/git-interface.php new file mode 100644 index 0000000..d4bfef2 --- /dev/null +++ b/web/html/git-interface.php @@ -0,0 +1,3 @@ +<?php +echo file_get_contents('../../doc/git-interface.html'); +?> diff --git a/web/lib/routing.inc.php b/web/lib/routing.inc.php index 7d9750a..b5466d8 100644 --- a/web/lib/routing.inc.php +++ b/web/lib/routing.inc.php @@ -14,6 +14,7 @@ $ROUTES = array( '/login' => 'login.php', '/logout' => 'logout.php', '/passreset' => 'passreset.php', + '/git-interface' => 'git-interface.php', '/rpc' => 'rpc.php', '/rss' => 'rss.php', '/tos' => 'tos.php', -- 2.15.0
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
participants (2)
-
Eli Schwartz
-
Lukas Fleischer