chiark / gitweb /
Documentation: Rename remaining link macros
authorKarl Wiberg <kha@virtutech.com>
Wed, 19 Aug 2009 20:02:50 +0000 (22:02 +0200)
committerKarl Wiberg <kha@treskal.com>
Wed, 19 Aug 2009 20:05:08 +0000 (22:05 +0200)
The link macro rename in 760a7cfc ("Documentation: Rename link
macros") missed the htmllink and manlink macros, resulting in broken
links in the docs if built with AsciiDoc 8.2.3 or later. This patch
renames manlink to linkman, and replaces htmllink with just link
(which is built-in).

Signed-off-by: Karl Wiberg <kha@treskal.com>
Documentation/asciidoc.conf
Documentation/stg.txt
Documentation/tutorial.txt
stgit/argparse.py

index d40b4a825c592c54b9535db7ad495edd198848b5..3e37c7fea1fd9ec03a96870fb3d1ee534b7a2ad7 100644 (file)
@@ -44,23 +44,9 @@ template::[header-declarations]
 endif::backend-docbook[]
 endif::doctype-manpage[]
 
-## htmllink: macro
+## linkman: macro
 #
-# Usage: htmllink:url[text]
-
-ifdef::backend-docbook[]
-[htmllink-inlinemacro]
-{0}
-endif::backend-docbook[]
-
-ifdef::backend-xhtml11[]
-[htmllink-inlinemacro]
-<a href="{target}">{0}</a>
-endif::backend-xhtml11[]
-
-## manlink: macro
-#
-# Usage: manlink:command[manpage-section]
+# Usage: linkman:command[manpage-section]
 #
 # Note, {0} is the manpage section, while {target} is the command.
 #
@@ -68,7 +54,7 @@ endif::backend-xhtml11[]
 # show the command.
 
 ifdef::backend-docbook[]
-[manlink-inlinemacro]
+[linkman-inlinemacro]
 {0%{target}}
 {0#<citerefentry>}
 {0#<refentrytitle>{target}</refentrytitle><manvolnum>{0}</manvolnum>}
@@ -76,7 +62,7 @@ ifdef::backend-docbook[]
 endif::backend-docbook[]
 
 ifdef::backend-xhtml11[]
-[manlink-inlinemacro]
+[linkman-inlinemacro]
 <a href="{target}.html">{target}{0?({0})}</a>
 endif::backend-xhtml11[]
 
index 4cdff53c1d126a2e1d1353e9bee6fe629b7d1c2a..eefd6b8d035317bec744a12e42b7dd5b621ce65f 100644 (file)
@@ -82,7 +82,7 @@ which can be used to move the patch stack base downwards -- i.e., turn
 Git commits into StGit patches after the fact -- and
 linkstgsub:commit[], its inverse.
 
-For more information, see htmllink:tutorial.html[the tutorial].
+For more information, see link:tutorial.html[the tutorial].
 
 Specifying patches
 ~~~~~~~~~~~~~~~~~~
@@ -144,7 +144,7 @@ include::command-list.txt[]
 CONFIGURATION MECHANISM
 -----------------------
 
-StGit uses the same configuration mechanism as Git. See manlink:git[7]
+StGit uses the same configuration mechanism as Git. See linkman:git[7]
 for more details.
 
 TEMPLATES
index 4aa7629b4954039166bfaf21dc9907ca7f4da309..b418a774ed41b1c8b8018a986a8cd030dbb29315 100644 (file)
@@ -2,7 +2,7 @@ StGit tutorial
 ##############
 
 StGit is a command-line application that provides functionality
-similar to htmllink:http://savannah.nongnu.org/projects/quilt/[Quilt]
+similar to link:http://savannah.nongnu.org/projects/quilt/[Quilt]
 (i.e. pushing/popping patches to/from a stack), but using Git instead
 of +diff+ and +patch+. StGit stores its patches in a Git repository as
 normal Git commits, and provides a number of commands to manipulate
@@ -10,7 +10,7 @@ them in various ways.
 
 This tutorial assumes you are already familiar with the basics of Git
 (for example, branches, commits, and conflicts). For more information
-on Git, see manlink:git[1] or htmllink:http://git.or.cz/[the Git home
+on Git, see linkman:git[1] or link:http://git.or.cz/[the Git home
 page].
 
 
@@ -29,7 +29,7 @@ For more extensive help on a subcommand:
 
   $ man stg-<cmd>
 
-(The documentation is also available in htmllink:stg.html[HTML
+(The documentation is also available in link:stg.html[HTML
 format].)
 
 
@@ -104,13 +104,13 @@ And voilĂ  -- the patch is no longer empty:
        finally:
 
 (I'm assuming you're already familiar with
-htmllink:http://en.wikipedia.org/wiki/Diff#Unified_format[unified
+link:http://en.wikipedia.org/wiki/Diff#Unified_format[unified
 diff] patches like this from Git, but it's really quite simple; in
 this example, I've added the +$$print 'My first patch!'$$+ line to the
 file +stgit/main.py+, at around line 171.)
 
 Since the patch is also a regular Git commit, you can also look at it
-with regular Git tools such as manlink:gitk[].
+with regular Git tools such as linkman:gitk[].
 
 Creating another patch
 ----------------------
@@ -156,7 +156,7 @@ make.
 The minus sign says that +credit+ is 'unapplied' -- this means that
 it's been temporarily put aside. If you look at the +AUTHORS+ file,
 you'll see that our change to it is gone; and tools such as
-manlink:gitk[] will not show it, because it's been edited out of the
+linkman:gitk[] will not show it, because it's been edited out of the
 Git history. But it's just one linkstg:push[] command away from being
 restored:
 
index 765579ccb03085ba92f119aba4ade9267469250a..db008d08aa6a47fe8f141ec5d20fc9143e3dc682 100644 (file)
@@ -103,7 +103,7 @@ def write_asciidoc(cmd, f):
             o.write_asciidoc(f)
             f.write('\n')
     _write_underlined('StGit', '-', f)
-    f.write('Part of the StGit suite - see manlink:stg[1]\n')
+    f.write('Part of the StGit suite - see linkman:stg[1]\n')
 
 def sign_options():
     def callback(option, opt_str, value, parser, sign_str):