moparisthebest/pacman
1
0
Fork 0
mirror of https://github.com/moparisthebest/pacman synced 2024-12-22 15:58:50 -05:00
Code Issues Releases Wiki Activity

Asciidoc updates- make it pretty, fix build, etc.

Browse Source 
* Fix up the target so we rebuild the manpages when we edit the corresponding
  text file.
* Add vim modelines to all of the asciidoc files ensureing the right syntax
  highlighting is used and we have expandtabs turned off.
* Start making a few small changes to PKGBUILD.5 to make it pretty in both
  HTML and manpage format output.
* Fix the manlink macro to include the manpage section in the link.

Signed-off-by: Dan McGee <dan@archlinux.org>
This commit is contained in:
Dan McGee 2007-07-06 16:54:18 -04:00
parent f1fac6abfb
commit e412ac19f5
9 changed files with 45 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
doc/Makefile.am
View File

@ -1,4 +1,4 @@
man_MANS = \
ASCIIDOC_MANS = \
pacman.8 \
makepkg.8 \
PKGBUILD.5 \
@ -6,6 +6,8 @@ man_MANS = \
pacman.conf.5 \
libalpm.3
man_MANS = $(ASCIIDOC_MANS)
if HAS_DOXYGEN
man_MANS += $(wildcard man3/*.3)
endif
@ -37,9 +39,16 @@ doxygen.in:
doxygen $(srcdir)/Doxyfile
endif
$(man_MANS): footer.txt
$(ASCIIDOC_MANS):
a2x -d manpage -f manpage --asciidoc-opts="$(ASCIIDOC_OPTS)" $@.txt
PKGBUILD.5: PKGBUILD-example.txt
# These rules are due to the includes and files of the asciidoc text
$(ASCIIDOC_MANS): footer.txt
pacman.8: pacman.8.txt
makepkg.8: makepkg.8.txt
PKGBUILD.5: PKGBUILD.5.txt PKGBUILD-example.txt
makepkg.conf.5: makepkg.conf.5.txt
pacman.conf.5: pacman.conf.5.txt
libalpm.3: libalpm.3.txt
# vim:set ts=2 sw=2 noet:

25
doc/PKGBUILD.5.txt
View File

@ -1,3 +1,6 @@
/////
vim:set ts=4 sw=4 syntax=asciidoc noet:
/////
PKGBUILD(5)
===========
@ -30,7 +33,7 @@ Options and Directives
used in the package filename.
*pkgver*::
The version of the software as released from the author (e.g. 2.7.1).
The version of the software as released from the author (e.g. `2.7.1`).
*pkgrel*::
This is the release number specific to the Arch Linuxs release. This
@ -48,21 +51,21 @@ Options and Directives
*license (array)*::
This field specifies the license(s) that apply to the package.
Commonly-used licenses are found in /usr/share/licenses/common. If you
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
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
$pkgdir/usr/share/licenses/$pkgname when building the package. If
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
`$pkgdir/usr/share/licenses/$pkgname` when building the package. If
multiple licenses are applicable for a package, list all of them:
licenses=('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
@ -94,11 +97,11 @@ Options and Directives
*groups (array)*::
An array of symbolic names that represent groups of packages, allowing
you to install multiple packages by requesting a single target. For
example, one could install all KDE packages by installing the 'kde' group.
example, one could install all KDE packages by installing the `kde` group.
*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

2
doc/asciidoc.conf
View File

@ -60,5 +60,5 @@ endif::doctype-manpage[]
ifdef::backend-xhtml11[]
[manlink-inlinemacro]
<a href="{target}.html">{target}{0?({0})}</a>
<a href="{target}.{0}.html">{target}{0?({0})}</a>
endif::backend-xhtml11[]

3
doc/footer.txt
View File

@ -1,3 +1,6 @@
/////
vim:set ts=4 sw=4 syntax=asciidoc noet:
/////
See the Arch Linux website at <http://www.archlinux.org> for more current
information on the distribution and the pacman family of tools, and
<http://wiki.archlinux.org/index.php/Arch_Packaging_Standards> for

3
doc/libalpm.3.txt
View File

@ -1,3 +1,6 @@
/////
vim:set ts=4 sw=4 syntax=asciidoc noet:
/////
libalpm(3)
==========

3
doc/makepkg.8.txt
View File

@ -1,3 +1,6 @@
/////
vim:set ts=4 sw=4 syntax=asciidoc noet:
/////
makepkg(8)
==========

3
doc/makepkg.conf.5.txt
View File

@ -1,3 +1,6 @@
/////
vim:set ts=4 sw=4 syntax=asciidoc noet:
/////
makepkg.conf(5)
===============

3
doc/pacman.8.txt
View File

@ -1,3 +1,6 @@
/////
vim:set ts=4 sw=4 syntax=asciidoc noet:
/////
pacman(8)
=========

3
doc/pacman.conf.5.txt
View File

@ -1,3 +1,6 @@
/////
vim:set ts=4 sw=4 syntax=asciidoc noet:
/////
pacman.conf(5)
==============