Commit Graph

126 Commits

Author SHA1 Message Date
Chantry Xavier 6eee9e987a Update cachedir documentation (FS#9204).
Signed-off-by: Chantry Xavier <shiningxc@gmail.com>
Signed-off-by: Dan McGee <dan@archlinux.org>
2008-01-14 21:43:41 -06:00
Chantry Xavier 6ee95afe7e doc: update documentation for --recursive and --cascade
This addresses some of the issues in FS#9192. Attempt to clarify the -Rc
and -Rs options in the man page.

Signed-off-by: Chantry Xavier <shiningxc@gmail.com>
Signed-off-by: Dan McGee <dan@archlinux.org>
2008-01-13 18:42:26 -06:00
Dan McGee e93b0a2f37 doc: update makepkg options
Add documentation for --holdver (from Scott) and --forcever (saying this
is an internal option that should not be used by most end users), and
re-alphabetize the --asroot option.

Signed-off-by: Dan McGee <dan@archlinux.org>
2008-01-13 18:42:26 -06:00
Chantry Xavier 3de2147376 Fix cvsmod typo in PKGBUILD man page.
Fixes FS#9175.

Signed-off-by: Chantry Xavier <shiningxc@gmail.com>
2008-01-13 12:19:10 -06:00
Dan McGee 887ad59eb6 doc: add note to pacman.conf manpage explaining $repo
Fixes FS#9142.

Signed-off-by: Dan McGee <dan@archlinux.org>
2008-01-10 22:58:48 -06:00
Dan McGee 71ca587f2a doc: add info about optdepends
Signed-off-by: Dan McGee <dan@archlinux.org>
2008-01-10 22:58:20 -06:00
Chantry Xavier aec7c13648 Rename -t --orphans to -t --unrequired (FS#9144).
It turns out the orphan name was misleading. Real orphans are packages
installed as dependency no longer required by any others (-Qtd).
The -t option only shows package not required by any others, so --unrequired
describes it better.

Signed-off-by: Chantry Xavier <shiningxc@gmail.com>
Signed-off-by: Dan McGee <dan@archlinux.org>
2008-01-10 22:58:19 -06:00
Nathan Jones 3ddbdc4c1d Documentation updates
Document the following:

* -R can take a group
* -S can take a group and provision

I also split up the -S description into multiple paragraphs because it
was getting too large.

Signed-off-by: Nathan Jones <nathanj@insightbb.com>
[Dan: added some feedback from the ML, rewrapped lines]
Signed-off-by: Dan McGee <dan@archlinux.org>
2008-01-08 16:05:01 -06:00
Dan McGee f438f7a8ff Documentation updates
Update description of path specifiers for both pacman and pacman.conf in
their respective manpages. Ensure it is obvious that they are absolute and
not relative paths.

Signed-off-by: Dan McGee <dan@archlinux.org>
2008-01-06 22:20:44 -06:00
Dan McGee 6f86f46c96 Remove makeworld from pacman package
This is an Arch-specific tool (although others could find use in it), so
off to the standalone ABS package it goes.

Signed-off-by: Dan McGee <dan@archlinux.org>
2008-01-06 10:42:35 -06:00
Dan McGee 00c57ddae7 Remove stuff that was a little too Arch-specific from manpage footer
Signed-off-by: Dan McGee <dan@archlinux.org>
2008-01-06 10:26:21 -06:00
Dan McGee f35a5cf174 doc: remove --ask option from pacman manpage
Signed-off-by: Dan McGee <dan@archlinux.org>
2008-01-05 14:37:36 -06:00
Dan McGee 7417d9d81c doc: add symlink for repo-remove manpage on install
Signed-off-by: Dan McGee <dan@archlinux.org>
2008-01-05 14:37:24 -06:00
Dan McGee c26039240d Remove mentions of ABS from makepkg
Kill off some of the $ABSROOT stuff that was still hanging around in there.

Signed-off-by: Dan McGee <dan@archlinux.org>
2008-01-05 14:35:40 -06:00
Dan McGee b3c6bdda38 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<name>\w(\w|-)*?):(?P<target>\S*?)(\[(?P<attrlist>.*?)\])=
+
+# Explicit so they can be nested.
+(?su)[\\]?(?P<name>(http|https|ftp|file|mailto|callto|image|link)):(?P<target>\S*?)(\[(?P<attrlist>.*?)\])=
+
 # Anchor: [[[id]]]. Bibliographic anchor.
 (?su)[\\]?\[\[\[(?P<attrlist>[\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 <dan@archlinux.org>
2007-12-29 00:24:15 -06:00
Dan McGee 26c05b1c8c Ensure that manpages are always distributed and installed
Commit 012f793978 was a bit misguided in its
thinking, and resulted in a package built without asciidoc enabled not
installing the manpages to the system on a 'make install' operation. Fix
this behavior by making manpages required in a normal build, and in order to
disable their existence, the '--disable-doc' option must be used.

Hopefully this solves manpage issues for both developers and package
builders while allowing as much flexibility as possible.

Signed-off-by: Dan McGee <dan@archlinux.org>
2007-12-28 20:06:58 -06:00
Dan McGee 8e53cea8f8 Update PKGBUILD manpage to give info on scriptlet arguments
Signed-off-by: Dan McGee <dan@archlinux.org>
2007-12-19 23:41:17 -06:00
Nagy Gabor b06ce1e8ad Add PM_DEP_MOD_GT and PM_DEP_MOD_LT to documentation
Signed-off-by: Nagy Gabor <ngaba@bibl.u-szeged.hu>
Signed-off-by: Dan McGee <dan@archlinux.org>
2007-12-19 14:48:10 -06:00
Dan McGee bd83a1fd85 Updates to PKGBUILD manpage
Make the manpage a little more distro agnostic by referring to ABS in the
context of Arch Linux, and saying that prototype files are also available
with the pacman source.

Signed-off-by: Dan McGee <dan@archlinux.org>
2007-12-10 21:14:55 -06:00
Dan McGee f0664fbd93 Update pacman manpage with description of --clean option
Signed-off-by: Dan McGee <dan@archlinux.org>
2007-12-05 20:34:38 -06:00
Chantry Xavier 250331a636 Add new --needed option for -S.
During a pacman operation such as a group install, pacman can ask several
questions such as "local version is up to date. Upgrade anyway?". They are
usually all answered either by yes or by no:
* yes when you want to reinstall all the targets.
* no when you only want to install the missing ones (either because you are
installing a group, or because you are copying a pacman -S line from wiki or
whatever).

So instead of asking this question for each target, it is now now configured
with a flag.  Yes will be the default -S behavior, No will be achieved with
the --needed flag.

Signed-off-by: Chantry Xavier <shiningxc@gmail.com>
Signed-off-by: Dan McGee <dan@archlinux.org>
2007-12-02 11:14:13 -06:00
Dan McGee f5d2150e9d Remove -F/--freshen operation
This operation made sense in the days before sync DBs existed, but it no
longer has the same usefulness it once did.

Signed-off-by: Dan McGee <dan@archlinux.org>
Signed-off-by: Chantry Xavier <shiningxc@gmail.com>
Signed-off-by: Nagy Gabor <ngaba@bibl.u-szeged.hu>
Signed-off-by: Aaron Griffin <aaronmgriffin@gmail.com>
2007-11-21 11:51:17 -06:00
Dan McGee 3e9c590480 doc: use source highlighter on PKGBUILD guide, update wrong example text
Note that if you are building manpages with asciidoc now, you must also
have source-highlight installed for it to correctly generate everything.

Signed-off-by: Dan McGee <dan@archlinux.org>
2007-11-20 23:40:20 -06:00
Chantry Xavier 967a78f5e4 Update PKGBUILD manpage with versioned conflicts.
As the b96922679e commit showed with two
pactests (which were renamed to depconflict110/111), versioned conflicts are
now possible.

Signed-off-by: Chantry Xavier <shiningxc@gmail.com>
Signed-off-by: Dan McGee <dan@archlinux.org>
2007-11-20 23:31:40 -06:00
Nagy Gabor 84ebf82319 Versioned provisions.
This patch introduces versioned provisions in "provision 1.0-1" format.
_alpm_db_whatprovides was modified accordingly (added sync500.py),
alpm_depcmp was modified accordingly (add043.py passes now; added add044.py
and add045.py).

Notes:
alpm_db_search now uses the whole versioned %PROVIDES% string in its search.
debug logging was simplified in alpm_depcmp.

Signed-off-by: Nagy Gabor <ngaba@bibl.u-szeged.hu>
[Xavier: fixed a few typos, duplicate const strings with strdup before
modifying them, put some debugging back in alpm_depcmp, minor code cleanups
(var/function renaming), added a note in PKGBUILD man page.]
Signed-off-by: Chantry Xavier <shiningxc@gmail.com>
[Dan: made strcmp checks clearer, added a comment]
Signed-off-by: Dan McGee <dan@archlinux.org>
2007-11-18 20:05:51 -06:00
Nathan Jones 46ec9e3548 Make it easier to ignore multiple packages.
This makes --ignore and --ignoregroup able to accept multiple
packages/groups by separating each with a comma.

For instance: pacman -Su --ignore kernel26,udev,glibc

This was requested in the comments of FS#8054.

Signed-off-by: Nathan Jones <nathanj@insightbb.com>
Signed-off-by: Dan McGee <dan@archlinux.org>
2007-11-13 20:59:02 -06:00
Nathan Jones 70a91cbb22 Add help for --ignoregroup.
Signed-off-by: Nathan Jones <nathanj@insightbb.com>
[Dan: split usage line into two lines for clarity]
Signed-off-by: Dan McGee <dan@archlinux.org>
2007-11-13 20:58:45 -06:00
Dan McGee 103c3ac5a7 configure: Doxygen is disabled by default; manpages are included in dist
Signed-off-by: Dan McGee <dan@archlinux.org>
2007-11-13 00:13:05 -06:00
Nathan Jones b206af78e0 Add TotalDownload option.
This will be used in the next commit.

Signed-off-by: Nathan Jones <nathanj@insightbb.com>
Signed-off-by: Dan McGee <dan@archlinux.org>
2007-11-11 09:46:09 -06:00
Nathan Jones 5c58b3d500 Add IgnoreGroup and --ignoregroup option.
This will be used in the next commit.

Signed-off-by: Nathan Jones <nathanj@insightbb.com>
Signed-off-by: Dan McGee <dan@archlinux.org>
2007-11-11 09:44:26 -06:00
Dan McGee 889fccd55f Small manpage updates
Signed-off-by: Dan McGee <dan@archlinux.org>
2007-11-08 23:38:32 -06:00
Dan McGee 5b4b4df4c9 Get rid of the footnotes section in generated manpages
We really don't need it since it is just links. However, we do need to figure
out how to get our old links to show up right.

Signed-off-by: Dan McGee <dan@archlinux.org>
2007-11-08 21:56:53 -06:00
Dan McGee 9407baaaa6 doc: update links in footer.txt so they are actual links
Signed-off-by: Dan McGee <dan@archlinux.org>
2007-11-08 21:17:59 -06:00
Dan McGee f3e8343c7e Update PKGBUILD.5 with missing devel variable descriptions
The lack of descriptions on some of the variables was causing issues with
documentation generation. Adding text to them fixes this.

Signed-off-by: Dan McGee <dan@archlinux.org>
2007-11-08 09:33:05 -06:00
Dan McGee 9fdb15b4b5 Sync asciidoc.conf with GIT repository changes
We got our file from the GIT repository originally, so keep it up to date.

Signed-off-by: Dan McGee <dan@archlinux.org>
2007-11-08 09:31:58 -06:00
Dan McGee 23745a7bf2 Update the PKGBUILD example in the manpages
The old one was old. Use something a bit more recent and a bit simpler as
well so it actually looks OK in the manpage.

Signed-off-by: Dan McGee <dan@archlinux.org>
2007-11-07 19:03:58 -06:00
Scott Horowitz aea45a8b20 Small updates to documentation.
Signed-off-by: Scott Horowitz <stonecrest@gmail.com>
Signed-off-by: Dan McGee <dan@archlinux.org>
2007-10-29 22:47:48 -05:00
Dan McGee c50a7c6026 doxygen: preprocess SYMHIDDEN/SYMEXPORT macros so they don't show in docs
Signed-off-by: Dan McGee <dan@archlinux.org>
2007-10-29 07:13:58 -05:00
Nathan Jones e472e80c08 Download delta files if UseDelta is set.
Delta files will be used if the size is smaller than a percent
(MAX_DELTA_RATIO) of the package size.

Signed-off-by: Nathan Jones <nathanj@insightbb.com>
Signed-off-by: Dan McGee <dan@archlinux.org>
2007-10-19 19:29:17 -05:00
Dan McGee 0adedc536f Updates to fix Doxygen documentation generation
We had way too much going on with the Doxygen manpage generation. Clean it
up quite a bit by removing directory manpages, using relative paths, not
having a manpage for every single alpm function, and ensuring internal
functions are not documented publicly.

Signed-off-by: Dan McGee <dan@archlinux.org>
2007-10-14 17:29:32 -05:00
Chantry Xavier a6b58638d1 document the -Qii option.
I suppose -Qii could be used for other things than displaying
the list of backup files, but currently, it's the only one,
so that's how I documented it..

Signed-off-by: Chantry Xavier <shiningxc@gmail.com>
Signed-off-by: Dan McGee <dan@archlinux.org>
2007-09-27 22:00:57 -05:00
Dan McGee 012f793978 Allow a normal 'make' to compile without asciidoc installed
If we don't have asciidoc installed or enabled, we should still have a
successful make. However, we want to ensure 'make dist' fails without
asciidoc. This commit should ensure this.

Signed-off-by: Dan McGee <dan@archlinux.org>
2007-09-23 21:19:06 -05:00
Dan McGee 1860ab8980 Update NEWS, -S testing/qt example, and mirrorlist change
Signed-off-by: Dan McGee <dan@archlinux.org>
2007-09-18 13:40:19 -05:00
Dan McGee 7325ebbc22 Refine pacman manpage, clarify -S repo/package possibility, remove --test
Signed-off-by: Dan McGee <dan@archlinux.org>
2007-09-17 23:01:01 -05:00
Dan McGee 708488f6fe Merge branch 'asciidoc' into working
We're getting close to release, so might as well do this now so people can
actually update some of our documentation.
2007-09-16 21:10:44 -05:00
Chantry Xavier 046c8a6819 Remove the DB consistency check from pacman and libalpm.
This reverts commit dfc85cb5f5
and b6f3fe6957.
This DB check is already in testdb (among others).

Also testdb now uses the db path set at make time by default,
so specifying the db path is optional.

Signed-off-by: Chantry Xavier <shiningxc@gmail.com>
Signed-off-by: Dan McGee <dan@archlinux.org>
2007-09-16 20:10:18 -05:00
Chantry Xavier f131ee9c56 Update manpage with new query options.
Dan: did a bit more updating and clarifying.

Signed-off-by: Chantry Xavier <shiningxc@gmail.com>
Signed-off-by: Dan McGee <dan@archlinux.org>
2007-08-16 11:05:36 -04:00
Dan McGee 466d289e6a Remove unnecessary entries from .gitignore files
.gitignore works recursively, so we don't need Makefile and Makefile.in
in all of the subdirectory .gitignore files.

Signed-off-by: Dan McGee <dan@archlinux.org>
2007-07-16 16:49:28 -04:00
Dan McGee c9189f54cd Man page revision time
Spruce up the asciidoc formatting, fix a few issues that we had. Formatting
now looks pretty good in both the manpage output and the XHTML output.

Also added some options that we have changed since 3.0, and a few wording
updates, etc.

Signed-off-by: Dan McGee <dan@archlinux.org>
2007-07-16 12:57:02 -04:00
Dan McGee d2613b97fa Add asciidoc checking to configure.ac, make manpage generation optional
Include manpages when we ship a package tarball, and allow them to be
generated by the end user if they want by using the --enable-asciidoc option
to ./configure. This will allow us to maintain manpages in an easier to modify
format while still keeping the make dependencies to a minimum.

Signed-off-by: Dan McGee <dan@archlinux.org>
2007-07-09 14:38:02 -04:00