From b3c6bdda38f7e370e1f80f02a61f1d3f08c1b57d Mon Sep 17 00:00:00 2001 From: Dan McGee Date: Sat, 29 Dec 2007 00:24:15 -0600 Subject: doc: rename manlink macro to linkman Between AsciiDoc 8.2.2 and 8.2.3, the following change was made to the stock Asciidoc configuration: @@ -149,7 +153,10 @@ # Inline macros. # Backslash prefix required for escape processing. # (?s) re flag for line spanning. -(?su)[\\]?(?P\w(\w|-)*?):(?P\S*?)(\[(?P.*?)\])= + +# Explicit so they can be nested. +(?su)[\\]?(?P(http|https|ftp|file|mailto|callto|image|link)):(?P\S*?)(\[(?P.*?)\])= + # Anchor: [[[id]]]. Bibliographic anchor. (?su)[\\]?\[\[\[(?P[\w][\w-]*?)\]\]\]=anchor3 # Anchor: [[id,xreflabel]] This default regex now matches explicit values, and unfortunately in this case manlink was being matched by just 'link', causing the wrong inline macro template to be applied. By renaming the macro, we can avoid being matched by the wrong regex. Signed-off-by: Dan McGee --- doc/Makefile.am | 2 +- doc/PKGBUILD.5.txt | 10 +++++----- doc/asciidoc.conf | 14 +++++++------- doc/libalpm.3.txt | 4 ++-- doc/makepkg.8.txt | 18 +++++++++--------- doc/makepkg.conf.5.txt | 6 +++--- doc/pacman.8.txt | 10 +++++----- doc/pacman.conf.5.txt | 6 +++--- doc/repo-add.8.txt | 4 ++-- 9 files changed, 37 insertions(+), 37 deletions(-) (limited to 'doc') diff --git a/doc/Makefile.am b/doc/Makefile.am index 3e469294..1cdc6b9c 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -60,7 +60,7 @@ $(ASCIIDOC_MANS): a2x $(A2X_OPTS) --asciidoc-opts="$(ASCIIDOC_OPTS)" $@.txt # These rules are due to the includes and files of the asciidoc text -$(ASCIIDOC_MANS): footer.txt +$(ASCIIDOC_MANS): asciidoc.conf footer.txt pacman.8: pacman.8.txt makepkg.8: makepkg.8.txt repo-add.8: repo-add.8.txt diff --git a/doc/PKGBUILD.5.txt b/doc/PKGBUILD.5.txt index 743453db..e8aa4b01 100644 --- a/doc/PKGBUILD.5.txt +++ b/doc/PKGBUILD.5.txt @@ -111,7 +111,7 @@ Options and Directives A space-delimited array of filenames, without preceding slashes, that should be backed up if the package is removed or upgraded. This is commonly used for packages placing configuration files in /etc. See - Handling Config Files in manlink:pacman[8] for more information. + Handling Config Files in linkman:pacman[8] for more information. *depends (array)*:: An array of packages that this package depends on to run. Packages in @@ -152,8 +152,8 @@ Options and Directives when building packages. To set an option, just include the option name in the options array. To reverse the default behavior, place an ``!'' at the front of the option. Only specify the options you specifically want - to override, the rest will be taken from manlink:makepkg.conf[5]. - *NOTE:* 'force' is a special option only used in a manlink:PKGBUILD[5], + to override, the rest will be taken from linkman:makepkg.conf[5]. + *NOTE:* 'force' is a special option only used in a linkman:PKGBUILD[5], do not use it unless you know what you are doing. *strip*;; @@ -184,7 +184,7 @@ Options and Directives *makeflags*;; Allow the use of user-specific makeflags during build as specified - in manlink:makepkg.conf[5]. More useful in its negative form + in linkman:makepkg.conf[5]. More useful in its negative form `!makeflags` with select packages that have problems building with custom makeflags such as `-j2` (or higher). @@ -316,6 +316,6 @@ source~~~~~ See Also -------- -manlink:makepkg[8], manlink:pacman[8], manlink:makepkg.conf[5] +linkman:makepkg[8], linkman:pacman[8], linkman:makepkg.conf[5] include::footer.txt[] diff --git a/doc/asciidoc.conf b/doc/asciidoc.conf index 98308f53..f92a3eab 100644 --- a/doc/asciidoc.conf +++ b/doc/asciidoc.conf @@ -1,10 +1,7 @@ -# +## linkman: macro # Inspired by/borrowed from the GIT source tree at Documentation/asciidoc.conf # - -## manlink: macro -# -# Usage: manlink:command[manpage-section] +# Usage: linkman:command[manpage-section] # # Note, {0} is the manpage section, while {target} is the command. # @@ -19,7 +16,7 @@ endsb=] tilde=~ ifdef::backend-docbook[] -[manlink-inlinemacro] +[linkman-inlinemacro] {0%{target}} {0#} {0#{target}{0}} @@ -27,7 +24,9 @@ ifdef::backend-docbook[] endif::backend-docbook[] ifdef::backend-docbook[] +ifndef::docbook-xsl-172[] # "unbreak" docbook-xsl v1.68 for manpages. v1.69 works with or without this. +# v1.72 breaks with this because it replaces dots not in roff requests. [listingblock] {title} @@ -40,6 +39,7 @@ ifdef::doctype-manpage[] endif::doctype-manpage[] {title#} +endif::docbook-xsl-172[] endif::backend-docbook[] ifdef::doctype-manpage[] @@ -65,6 +65,6 @@ endif::backend-docbook[] endif::doctype-manpage[] ifdef::backend-xhtml11[] -[manlink-inlinemacro] +[linkman-inlinemacro] {target}{0?({0})} endif::backend-xhtml11[] diff --git a/doc/libalpm.3.txt b/doc/libalpm.3.txt index d8fb58e8..b7a892c7 100644 --- a/doc/libalpm.3.txt +++ b/doc/libalpm.3.txt @@ -28,12 +28,12 @@ good Doxygen documentation, it will improve. We promise. Configuration ------------- -See manlink:pacman.conf[5] for more details on configuring libalpm using the +See linkman:pacman.conf[5] for more details on configuring libalpm using the 'pacman.conf' file. See Also -------- -manlink:pacman[8], manlink:makepkg[8], manlink:pacman.conf[5] +linkman:pacman[8], linkman:makepkg[8], linkman:pacman.conf[5] include::footer.txt[] diff --git a/doc/makepkg.8.txt b/doc/makepkg.8.txt index 9da52c79..d341fc9f 100644 --- a/doc/makepkg.8.txt +++ b/doc/makepkg.8.txt @@ -19,7 +19,7 @@ Description makepkg is a script to automate the building of packages. The requirements for using the script are a build-capable \*nix platform and a custom build script for each package you wish to build (known as a PKGBUILD). See -manlink:PKGBUILD[5] for details on creating your own build scripts. +linkman:PKGBUILD[5] for details on creating your own build scripts. The advantage to a script-based build is that the work is only done once. Once you have the build script for a package, makepkg will do the rest: download and @@ -50,7 +50,7 @@ Options *-C, \--cleancache*:: Removes all cached source files from the directory specified in SRCDEST - in manlink:makepkg.conf[5]. + in linkman:makepkg.conf[5]. *-d, \--nodeps*:: Do not perform any dependency checks. This will let you override and @@ -67,7 +67,7 @@ Options *-f, \--force*:: makepkg will not build a package if a built package already exists in - the PKGDEST (set in manlink:makepkg.conf[5]) directory, which may + the PKGDEST (set in linkman:makepkg.conf[5]) directory, which may default to the current directory. This allows the built package to be overwritten. @@ -75,7 +75,7 @@ Options For each source file in the source array of PKGBUILD, download the file if required and generate integrity checks. The integrity checks generated are determined by the value of the INTEGRITY_CHECK array in - manlink:makepkg.conf[5]. This output can be redirected into your + linkman:makepkg.conf[5]. This output can be redirected into your PKGBUILD for source validation (`makepkg -g >> PKGBUILD`). *-h, \--help*:: @@ -83,7 +83,7 @@ Options *-i, \--install*:: Install or upgrade the package after a successful build using - manlink:pacman[8]. + linkman:pacman[8]. *-m, \--nocolor*:: Disable color in output messages. @@ -95,7 +95,7 @@ Options *-p* <`buildscript`>:: Read the package script `buildscript` instead of the `PKGBUILD` default; - see manlink:PKGBUILD[5]. + see linkman:PKGBUILD[5]. *-r, \--rmdeps*:: Upon successful build, remove any dependencies installed by makepkg @@ -134,18 +134,18 @@ Additional Features ------------------- makepkg supports building development versions of packages without having to manually update the pkgver in the PKGBUILD. This was formerly done using the -separate utility 'versionpkg'. See manlink:PKGBUILD[5] for details on how to +separate utility 'versionpkg'. See linkman:PKGBUILD[5] for details on how to set up a development PKGBUILD. Configuration ------------- -See manlink:makepkg.conf[5] for more details on configuring makepkg using the +See linkman:makepkg.conf[5] for more details on configuring makepkg using the 'makepkg.conf' file. See Also -------- -manlink:makepkg.conf[5], manlink:PKGBUILD[5], manlink:pacman[8] +linkman:makepkg.conf[5], linkman:PKGBUILD[5], linkman:pacman[8] include::footer.txt[] diff --git a/doc/makepkg.conf.5.txt b/doc/makepkg.conf.5.txt index 17e4bd87..f6e4b382 100644 --- a/doc/makepkg.conf.5.txt +++ b/doc/makepkg.conf.5.txt @@ -33,7 +33,7 @@ Options ------- **DLAGENTS=(**\'protocol::/path/to/command [options]' ...**)**:: Sets the download agents used to fetch source files specified with a URL in - the manlink:PKGBUILD[5] file. Options can be specified for each command as + the linkman:PKGBUILD[5] file. Options can be specified for each command as well; the download URL is placed on the end of the command. This is more flexible than the former `FTPAGENT` variable, as any protocol can have a download agent. Several examples are provided in the default makepkg.conf. @@ -130,7 +130,7 @@ Options **PKGDEST=**"/path/to/folder":: If this value is not set, packages will by default be placed in the - current directory (location of the manlink:PKGBUILD[5]). Many people + current directory (location of the linkman:PKGBUILD[5]). Many people like to keep all their packages in one place so this option allows this behavior. A common location is ``/home/packages''. @@ -149,6 +149,6 @@ Options See Also -------- -manlink:makepkg[8], manlink:pacman[8], manlink:PKGBUILD[5] +linkman:makepkg[8], linkman:pacman[8], linkman:PKGBUILD[5] include::footer.txt[] diff --git a/doc/pacman.8.txt b/doc/pacman.8.txt index 85561b60..9dbf76d2 100644 --- a/doc/pacman.8.txt +++ b/doc/pacman.8.txt @@ -21,7 +21,7 @@ system. It features dependency support, package groups, install and uninstall hooks, and the ability to sync your local machine with a remote ftp server to automatically upgrade packages. Pacman packages are a zipped tar format. -Since version 3.0.0, pacman has been the frontend to manlink:libalpm[3], the +Since version 3.0.0, pacman has been the frontend to linkman:libalpm[3], the "Arch Linux Package Management" library. This library allows alternative front ends to be written (for instance, a GUI front end). @@ -216,7 +216,7 @@ Sync Options[[SO]] free up disk space. When pacman downloads packages, it saves them in a cache directory. In addition, databases are saved for every sync DB you download from, and are not deleted even if they are removed from the - configuration file manlink:pacman.conf[5]. Use one '\--clean' switch to + configuration file linkman:pacman.conf[5]. Use one '\--clean' switch to only remove old packages; use two to remove all packages from the cache. In both cases, you will have a yes or no option to remove packages and/or unused downloaded databases. @@ -261,7 +261,7 @@ Sync Options[[SO]] *-y, \--refresh*:: Download a fresh copy of the master package list from the server(s) - defined in manlink:pacman.conf[5]. This should typically be used each time + defined in linkman:pacman.conf[5]. This should typically be used each time you use '\--sysupgrade' or '-u'. Passing two '\--refresh' or '-y' flags will force a refresh of all package lists even if they are thought to be up to date. @@ -313,12 +313,12 @@ original=X, current=Y, new=Z:: Configuration ------------- -See manlink:pacman.conf[5] for more details on configuring pacman using the +See linkman:pacman.conf[5] for more details on configuring pacman using the 'pacman.conf' file. See Also -------- -manlink:pacman.conf[5], manlink:makepkg[8], manlink:libalpm[3] +linkman:pacman.conf[5], linkman:makepkg[8], linkman:libalpm[3] include::footer.txt[] diff --git a/doc/pacman.conf.5.txt b/doc/pacman.conf.5.txt index 2a0f88ac..958f6f71 100644 --- a/doc/pacman.conf.5.txt +++ b/doc/pacman.conf.5.txt @@ -16,7 +16,7 @@ Synopsis Description ----------- -Pacman, using manlink:libalpm[3], will attempt to read pacman.conf each time it +Pacman, using linkman:libalpm[3], will attempt to read pacman.conf each time it is invoked. This configuration file is divided into sections or repositories. Each section defines a package repository that pacman can use when searching for packages in '\--sync' mode. The exception to this is the options section, @@ -150,11 +150,11 @@ package repository. If you add new packages to the repository, remember to re-generate the database and use pacman's '\--refresh' option. For more information on the repo-add command, see ``repo-add \--help'' or -manlink:repo-add[8]. +linkman:repo-add[8]. See Also -------- -manlink:pacman[8], manlink:libalpm[3] +linkman:pacman[8], linkman:libalpm[3] include::footer.txt[] diff --git a/doc/repo-add.8.txt b/doc/repo-add.8.txt index 27e0e93f..5664949f 100644 --- a/doc/repo-add.8.txt +++ b/doc/repo-add.8.txt @@ -24,7 +24,7 @@ repo-remove ... Description ----------- repo-add and repo-remove are two scripts to help build a package database for -packages built with manlink:makepkg[8] and installed with manlink:pacman[8]. +packages built with linkman:makepkg[8] and installed with linkman:pacman[8]. repo-add will update a package database by reading a built package file. Multiple packages to add can be specified on the command line. @@ -46,6 +46,6 @@ Options See Also -------- -manlink:makepkg[8], manlink:pacman[8] +linkman:makepkg[8], linkman:pacman[8] include::footer.txt[] -- cgit v1.2.3-70-g09d2