[pacman-dev] [PATCH] doc: Fix asciidoc warnings and errors.
Allan McRae
allan at archlinux.org
Mon Apr 6 00:56:52 EDT 2009
Loui Chang wrote:
> Signed-off-by: Loui Chang <louipc.ist at gmail.com>
> ---
> doc/PKGBUILD.5.txt | 14 +++++++-------
> doc/makepkg.8.txt | 2 +-
> doc/repo-add.8.txt | 8 +-------
> 3 files changed, 9 insertions(+), 15 deletions(-)
>
This patch along with an asciidoc patch
(http://hg.sharesource.org/asciidoc/rev/1dfa7028bbb3) remove all
warnings for me and I notice no problem with man pages afterwards.
> diff --git a/doc/PKGBUILD.5.txt b/doc/PKGBUILD.5.txt
> index f8ed7f2..9e271af 100644
> --- a/doc/PKGBUILD.5.txt
> +++ b/doc/PKGBUILD.5.txt
> @@ -65,19 +65,19 @@ similar to `$_basekernver`.
> This field specifies the license(s) that apply to the package.
> Commonly-used licenses are found in '/usr/share/licenses/common'. If you
> see the package's license there, simply reference it in the license
> - field (e.g. `$$license=('GPL')$$`). If the package provides a license not
> + field (e.g. $$license=('GPL')$$). If the package provides a license not
>
What were the back-ticks attempting to do in these cases? Are we losing
anything?
<snip>
>
> Name
> ----
> -////
> -* If we use this below line, the manpage name comes out all weird. We also
> -* can't use two separate lines, which is quite annoying. *
> -repo-add, repo-remove - package database maintenance utilities
> -////
> -repo-add - package database maintenance utility
> -
> +repo-add - repo-remove - package database maintenance utilities
>
This looks a bit strange with the dash separating repo-add and
repo-remove. Most other man pages for multiple things use commas to
separate the names then a dash before the description. It would be good
to be consistent...
Allan
More information about the pacman-dev
mailing list