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

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

[Jonas Fonseca]

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

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

[Jonas Fonseca]

Jonas Fonseca <fonseca@diku.dk> wrote Sat, May 28, 2005:
> Just a minor issue but still.

Another issue: `--' gets replaced with `&#8212;'. The debian cogito
package mentions this. Seems it can be fixed by overwriting the default
replacement rule using the following in asciidoc.conf:

	[replacements]
	(^|[^-])--($|[^-])=\1--\2

Maybe it can be done smarter.

-- 
Jonas Fonseca

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

[Petr Baudis]

Dear diary, on Sat, May 28, 2005 at 12:58:50AM CEST, I got a letter
where Jonas Fonseca <fonseca@diku.dk> told me that...
> Hello,

Hi,

> What do you think?

so, what do people think? It sounds as a good thing, but I miss any
discussion. I assume that means everyone likes it? ;-)

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

So wasn't the point that this would rather be

	+gitlink:git-checkout-cache::

than to what you change it to now?

-- 
				Petr "Pasky" Baudis
Stuff: http://pasky.or.cz/
C++: an octopus made by nailing extra legs onto a dog. -- Steve Taylor

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

[David Greaves]

Petr Baudis wrote:

>Dear diary, on Sat, May 28, 2005 at 12:58:50AM CEST, I got a letter
>where Jonas Fonseca <fonseca@diku.dk> told me that...
>  
>
>>Hello,
>>    
>>
>
>Hi,
>
>  
>
>>What do you think?
>>    
>>
>
>so, what do people think? It sounds as a good thing, but I miss any
>discussion. I assume that means everyone likes it? ;-)
>  
>

I certainly like it :)

Although I'm moving house at the moment so I'm somewhat behind...

David