minor doc patch for cogito
From: Sebastian Kuzminsky <hidden>
Date: 2016-06-15 22:41:59
Subsystem:
documentation, the rest · Maintainers:
Jonathan Corbet, Linus Torvalds
Here are some minor changes to the Cogito docs, to add the manpage section to the asciidoc links. It also adds a 'txt' target to Documentation/Makefile, so we can make the Cogito .txt docs if we want. Makefile | 4 +++- make-cg-asciidoc | 4 ++-- make-cogito-asciidoc | 15 +++++++++++---- 3 files changed, 16 insertions(+), 7 deletions(-)
diff --git a/Documentation/Makefile b/Documentation/Makefile
--- a/Documentation/Makefile
+++ b/Documentation/Makefile@@ -18,7 +18,9 @@ DOC_MAN7=$(patsubst %.txt,%.7,$(MAN7_TXT # yourself - yes, all 6 characters of it! # -all: html man +all: txt html man + +txt: $(MAN1_TXT) $(MAN7_TXT) html: $(DOC_HTML)
diff --git a/Documentation/make-cg-asciidoc b/Documentation/make-cg-asciidoc
--- a/Documentation/make-cg-asciidoc
+++ b/Documentation/make-cg-asciidoc@@ -40,7 +40,7 @@ CAPTION=$(echo "$HEADER" | head -n 1 | t # were referenced as "`cg-command`". This way references from cg-* combos in # code listings will be ignored. BODY=$(echo "$HEADER" | sed '0,/^$/d' \ - | sed 's/`\(cg-[a-z-]\+\)`/link:\1.html[\1]/') + | sed 's/`\(cg-[a-z-]\+\)`/link:\1.html[\1(1)]/') DESCRIPTION= OPTIONS=
@@ -109,5 +109,5 @@ $COPYRIGHT SEE ALSO -------- $COMMAND command is part of link:cogito.html[cogito(7)], -a toolkit for managing link:git.html[git(1)] trees. +a toolkit for managing link:git.html[git(7)] trees. __END__
diff --git a/Documentation/make-cogito-asciidoc b/Documentation/make-cogito-asciidoc
--- a/Documentation/make-cogito-asciidoc
+++ b/Documentation/make-cogito-asciidoc@@ -11,7 +11,14 @@ HELPER_COMMANDS="$(ls ../cg-X*) $(ls ../ link() { command="$1" - echo "link:$command.html['$command']" + + if [ ! -z "$2" ]; then + section="($2)" + else + section="" + fi + + echo "link:$command.html['$command$section']" } # Print description list entry.
@@ -62,7 +69,7 @@ storage system. Amongst some of the note for branching, tagging and multiple backends for distributing repositories (local files, rsync, HTTP, ssh). -'Cogito' is implemented as a series of 'bash(1)' scripts on top of $(link git) +'Cogito' is implemented as a series of 'bash(1)' scripts on top of $(link git 7) (a content-tracking filesystem) with the goal of providing an interface for working with the 'GIT' database in a manner similar to other SCM tools (like 'CVS', 'BitKeeper' or 'Monotone').
@@ -107,13 +114,13 @@ $(print_command_listing $HELPER_COMMANDS Command Identifiers ------------------- BRANCH_NAME:: - Indicates a branch name added with the $(link cg-branch-add) command. + Indicates a branch name added with the $(link cg-branch-add 1) command. COMMAND:: Indicates a 'Cogito' command. The \`cg-\` prefix is optional. LOCATION:: - Indicates a local file path or a URI. See $(link cg-branch-add) for a + Indicates a local file path or a URI. See $(link cg-branch-add 1) for a list of supported URI schemes. COMMIT_ID, FROM_ID, TO_ID, BASE_COMMIT::
--
Sebastian Kuzminsky
--
Sebastian Kuzminsky