[RFC] Removing git-*.html references from manpages

From: Jonas Fonseca <fonseca@diku.dk>
Date: May 27, 2005, 22:58 UTC
Message-ID: <20050527225850.GA25491@diku.dk>

Hello,

Just a minor issue but still. Currently the manpages contains the following:

	git-export: git-export.html

I'd like to have the interlinking references removed from the manpages so it becomes just:

	git-export

or what ever was put between the square brackets of the link: macro.

The fix requires the introduction of an asciidoc.conf file and a new link macro which I've called gitlink: but it could be shorter (and also smarter so link:git-CMD.html[git-CMD] could become man:git-CMD[]).

Below is a small patch probe to show the basic idea.

What do you think?

--- a/Documentation/Makefile  (mode:100644)
+++ b/Documentation/Makefile  (mode:100644)
@@ -32,10 +32,10 @@
 	rm -f *.xml *.html *.1 *.7
 
 %.html : %.txt
-	asciidoc -b css-embedded -d manpage $<
+	asciidoc -b css-embedded -d manpage -f asciidoc.conf $<
 
 %.1 %.7 : %.xml
 	xmlto man $<
 
 %.xml : %.txt
-	asciidoc -b docbook -d manpage $<
+	asciidoc -b docbook -d manpage -f asciidoc.conf $<
--- /dev/null  (tree:f6db9be9d431080d9e7f61edb616b8bac8c9618f)
+++ b/Documentation/asciidoc.conf  (mode:100644)
@@ -0,0 +1,14 @@
+ifdef::backend-docbook[]
+
+# Don't show the link target to git-*.html pages in the man page
+[gitlink-inlinemacro]
+<emphasis>{attrlist}</emphasis>
+
+endif::backend-docbook[]
+
+ifdef::backend-css-embedded[]
+
+[gitlink-inlinemacro]
+<a href="{target}">{0={target}}</a>
+
+endif::backend-css-embedded[]
--- a/Documentation/git.txt  (mode:100644)
+++ b/Documentation/git.txt  (mode:100644)
@@ -39,34 +39,34 @@
 
 Manipulation commands
 ~~~~~~~~~~~~~~~~~~~~~
-link:git-checkout-cache.html[git-checkout-cache]::
+gitlink:git-checkout-cache.html[git-checkout-cache]::
 	Copy files from the cache to the working directory
 
-link:git-commit-tree.html[git-commit-tree]::
+gitlink:git-commit-tree.html[git-commit-tree]::
 	Creates a new commit object
 
-link:git-init-db.html[git-init-db]::
+gitlink:git-init-db.html[git-init-db]::
 	Creates an empty git object database
 
-link:git-merge-base.html[git-merge-base]::
+gitlink:git-merge-base.html[git-merge-base]::
 	Finds as good a common ancestor as possible for a merge
 
-link:git-mkdelta.html[git-mkdelta]::
+gitlink:git-mkdelta.html[git-mkdelta]::
 	Creates a delta object
 
-link:git-mktag.html[git-mktag]::
+gitlink:git-mktag.html[git-mktag]::
 	Creates a tag object
 
-link:git-read-tree.html[git-read-tree]::
+gitlink:git-read-tree.html[git-read-tree]::
 	Reads tree information into the directory cache
 
-link:git-update-cache.html[git-update-cache]::
+gitlink:git-update-cache.html[git-update-cache]::
 	Modifies the index or directory cache
 
-link:git-write-blob.html[git-write-blob]::
+gitlink:git-write-blob.html[git-write-blob]::
 	Creates a blob from a file
 
-link:git-write-tree.html[git-write-tree]::
+gitlink:git-write-tree.html[git-write-tree]::
 	Creates a tree from the current cache
 
 Interrogation commands

-- 
Jonas Fonseca