[pacman-dev] [PATCH] doc: Fix asciidoc warnings and errors.
Signed-off-by: Loui Chang <louipc.ist@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(-) 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 found in '/usr/share/licenses/common', then you should include the license - in the package itself and set `$$license=('custom')$$` or - `$$license=('custom:LicenseName')$$`. The license should be placed in + in the package itself and set $$license=('custom')$$ or + $$license=('custom:LicenseName')$$. The license should be placed in '$pkgdir/usr/share/licenses/$pkgname' when building the package. If multiple licenses are applicable for a package, list all of them: - `$$license=('GPL' 'FDL')$$`. + $$license=('GPL' 'FDL')$$. *install*:: Specifies a special install script that is to be included in the package. This file should reside in the same directory as the PKGBUILD, and will be copied into the package by makepkg. It does not need to be included - in the source array (e.g. `$$install=pkgname.install$$`). + in the source array (e.g. $$install=pkgname.install$$). *source (array)*:: An array of source files required to build the package. Source files @@ -90,7 +90,7 @@ similar to `$_basekernver`. + It is also possible to specify an optional filename, which is helpful with weird URLs and for handling multiple source files with the same -name. The syntax is: `$$source=('filename::url')$$` +name. The syntax is: $$source=('filename::url')$$ *noextract (array)*:: An array of filenames corresponding to those from the source array. Files @@ -118,7 +118,7 @@ name. The syntax is: `$$source=('filename::url')$$` *arch (array)*:: Defines on which architectures the given package is available (e.g. - `$$arch=('i686' 'x86_64')$$`). + $$arch=('i686' 'x86_64')$$). *backup (array)*:: A space-delimited array of filenames, without preceding slashes, that diff --git a/doc/makepkg.8.txt b/doc/makepkg.8.txt index 4bb3780..5bc4ce4 100644 --- a/doc/makepkg.8.txt +++ b/doc/makepkg.8.txt @@ -43,7 +43,7 @@ Options *-A, \--ignorearch*:: Ignore a missing or incomplete arch field in the build script. This is for rebuilding packages from source when the PKGBUILD may be slightly - outdated and not updated with an `$$arch=('yourarch')$$` field. + outdated and not updated with an $$arch=('yourarch')$$ field. *-c, \--clean*:: Clean up leftover work files and directories after a successful build. diff --git a/doc/repo-add.8.txt b/doc/repo-add.8.txt index b9956e9..30fb8ae 100644 --- a/doc/repo-add.8.txt +++ b/doc/repo-add.8.txt @@ -6,13 +6,7 @@ repo-add(8) 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 Synopsis -------- -- 1.6.2.2
Loui Chang wrote:
Signed-off-by: Loui Chang <louipc.ist@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
participants (2)
-
Allan McRae
-
Loui Chang