summaryrefslogtreecommitdiff
path: root/doc/Makefile.am
Commit message (Collapse)AuthorAge
* pacman.conf.5: document system hook directoryAllan McRae2016-01-27
| | | | Signed-off-by: Allan McRae <allan@archlinux.org>
* add alpm-hooks man pageAndrew Gregory2015-10-27
| | | | | Signed-off-by: Andrew Gregory <andrew.gregory.8@gmail.com> Signed-off-by: Allan McRae <allan@archlinux.org>
* remove --destination-dir argument from a2x optionsDave Reisner2014-08-08
| | | | | | This option is only for HTML output, and we're building manpages here. Signed-off-by: Allan McRae <allan@archlinux.org>
* Remove ts and sw from vim modeline when noet is setFlorian Pritz2014-01-28
| | | | | | | | | | | | Forcing vim users to view files with a tabstop of 2 seems really unnecessary when noet is set. I find it much easier to read code with ts=4 and I dislike having to override the modeline by hand. Command run: find . -type f -exec sed -i '/vim.* noet/s# ts=2 sw=2##' {} + Signed-off-by: Florian Pritz <bluewind@xinu.at> Signed-off-by: Allan McRae <allan@archlinux.org>
* Add makepkg-templateFlorian Pritz2013-05-29
| | | | | | | This allows for somewhat easy templating for PKGBUILDs. Signed-off-by: Florian Pritz <bluewind@xinu.at> Signed-off-by: Allan McRae <allan@archlinux.org>
* Merge branch 'maint'Dan McGee2012-07-10
|\ | | | | | | | | Conflicts: etc/makepkg.conf.in
| * Add man page for pactreeRam Bhamidipaty2012-07-10
| | | | | | | | | | | | | | | | | | Add a man page for the pactree utility. Feedback-from: Allan McRae <allan@archlinux.org> Feedback-from: Andrew Gregory <andrew.gregory.8@gmail.com> Signed-off-by: Ram Bhamidipaty <rambham@gmail.com> Signed-off-by: Dan McGee <dan@archlinux.org>
* | Split check steps in Makefile into multiple targetsDan McGee2012-04-24
| | | | | | | | | | | | | | | | | | | | This allows a `make -j4 check` invocation to actually run in parallel, even though 95% of our test suite time is currently dominated by pactest. It also allows running something like `make test-vercmp`. Also, add some targets to the .PHONY list that belong in it. Signed-off-by: Dan McGee <dan@archlinux.org>
* | Merge branch 'maint'Dan McGee2012-01-02
|\| | | | | | | | | Conflicts: doc/Makefile.am
| * Prevent rebuild of man pages when using release tarballsAllan McRae2012-01-02
| | | | | | | | | | | | | | | | | | | | | | | | | | Commit 43cad9c8 made the building of all docs depend on the Makefile. However, the Makefile is generated after running ./configure so is always newer than any pregenerated docs. This means that people building from released pacman tarballs are forced to rebuild the docs (and thus have asciidoc installed). That defeats the purpose of prebuilding the documentation. Have the documentatin depends on Makefile.am instead as this is probably what was intended. Signed-off-by: Allan McRae <allan@archlinux.org> Signed-off-by: Dan McGee <dan@archlinux.org>
* | Use automake verbose helpers in custom make rulesDan McGee2011-12-08
|/ | | | | | | | | | | | | | | | | | This converts our script generation to use the built-in AM_V_GEN macro, which honors the V= setting passed to make and allows one to see the full command if they truly desire. The AM_V_at macro is also used in place of an explicit @ so verbose-mode compiles show all commands being run. We can also use these two macros in doc generation to quiet it down to the level we expect. Other minor changes: * a pointless test call is removed in test/pacman/tests/ * sed is used instead of dos2unix as we depend on it anyway * consecutive chmod calls are reduced to a single call (e.g., '+x,a-x') Signed-off-by: Dan McGee <dan@archlinux.org>
* doc: update .gitignore, add CSS override for new tables usageDan McGee2011-10-13
| | | | | | | | | | | * Make all docs depend on Makefile; if we change flags here we want them rebuilt. * Add explicit filenames to .gitignore so we can add our own CSS override file, and add an asciidoc-override.css resource. * Adjust a few asciidoc options when generating HTML. * Remove asciidoc-manpage.css; apparantly this doesn't exist anymore. Signed-off-by: Dan McGee <dan@archlinux.org>
* buildsys: remove existing symlinks before installingDave Reisner2011-09-14
| | | | | | | | | This fixes build errors when performing a manual install straight to a filesystem where the files already exist. Reported-by: Sergej Pupykin <ml@sergej.pp.ru> Signed-off-by: Dave Reisner <dreisner@archlinux.org> Signed-off-by: Dan McGee <dan@archlinux.org>
* build-sys: always use $(RM) instead of rm -fDave Reisner2011-08-15
| | | | | | | These are equivalent. Use the autoconf macro for consistency. Signed-off-by: Dave Reisner <dreisner@archlinux.org> Signed-off-by: Dan McGee <dan@archlinux.org>
* dist: preserve symlinks on installationDave Reisner2011-08-15
| | | | | | | | | This applies to the repo-remove man page as well as the script itself. Yes Dan, I ran distcheck afterwards. Signed-off-by: Dave Reisner <dreisner@archlinux.org> Signed-off-by: Dan McGee <dan@archlinux.org>
* Merge branch 'maint'Dan McGee2011-06-15
|\
| * Fix man page generation for out of tree buildAllan McRae2011-06-15
| | | | | | | | | | | | | | | | Fix failure at man page generation when building outside the source tree. There may still be issues with other documentation types... Signed-off-by: Allan McRae <allan@archlinux.org> Signed-off-by: Dan McGee <dan@archlinux.org>
* | Merge branch 'maint'Dan McGee2011-06-01
|\|
| * doc: update Makefile for new asciidoc resource locationDan McGee2011-06-01
| | | | | | | | Signed-off-by: Dan McGee <dan@archlinux.org>
* | Add manpage for pkgdeltaRay Kohler2011-03-27
| | | | | | | | | | Signed-off-by: Ray Kohler <ataraxia937@gmail.com> Signed-off-by: Dan McGee <dan@archlinux.org>
* | Add man-page for pacman-keyGuillaume Alaux2011-03-23
|/ | | | Signed-off-by: Allan McRae <allan@archlinux.org>
* Merge branch 'epoch-work'Dan McGee2011-01-22
|\
| * doc: add a vercmp manpageDan McGee2011-01-22
| | | | | | | | | | | | | | | | | | | | This includes info on version comparison that is very similar to the stuff in the pacman manpage, but also a few vercmp examples, the return values, and other fun stuff. Also update the version comparison stuff in the pacman manpage. Signed-off-by: Dan McGee <dan@archlinux.org>
* | Makefile: Use git describe --dirty for GIT VERSIONXavier Chantry2011-01-22
|/ | | | | | | | dirty indicates if the repo has uncommited changes or not when building, so dont hardcode this info. Signed-off-by: Xavier Chantry <chantry.xavier@gmail.com> Signed-off-by: Dan McGee <dan@archlinux.org>
* Merge branch 'maint'Dan McGee2010-12-30
|\ | | | | | | | | | | Conflicts: lib/libalpm/sync.c test/pacman/tests/ignore007.py
| * doc: add website zip to clean filesDan McGee2010-12-29
| | | | | | | | Signed-off-by: Dan McGee <dan@archlinux.org>
* | Use sysconfdir, localstatedir, BASH instead of hardcoded valuesNezmer2010-10-11
|/ | | | | | | | | This applies to contrib/ files, our scripts, and the documentation. Dan: fix 'make clean' in contrib/ directory. Signed-off-by: Nezmer <git@nezmer.info> Signed-off-by: Dan McGee <dan@archlinux.org>
* docs: Add a 'website' targetDan McGee2010-07-02
| | | | | | | | This will allow me to be not quite as lazy in getting website changes out to the Arch Linux server by making it trivial to get everything packaged up and working correctly. Signed-off-by: Dan McGee <dan@archlinux.org>
* Fix distcheck invocation in doc/ directoryDan McGee2010-06-16
| | | | | | | | | | Commit 5fe41df8 broke `make distcheck` pretty badly for the doc directory. Looking at what this commit was trying to accomplish, it make sense to revert a lot of the build system changes and just simplify what we are showing in the man page anyway- an example, not exactly how it is configured on your system. Signed-off-by: Dan McGee <dan@archlinux.org>
* doc: fix up description of where example PKGBUILD is locatedDan McGee2010-05-13
| | | | | | | | As Allan pointed out, this actually ships with pacman (at least with Arch) and not necessarily with ABS or any other package. Also fix the language dealing with the prototype install files. Signed-off-by: Dan McGee <dan@archlinux.org>
* makepkg: make strip options configurableCedric Staniewski2010-03-14
| | | | | | | | | | | | | The newly added variables STRIP_BINARIES, STRIP_SHARED and STRIP_STATIC, that are set in makepkg.conf, specify the strip options used on binaries and shared and static libraries. In addition, files are now stripped more aggressively by default. Implements FS#13592 the way it was suggested by Allan in the comments. Signed-off-by: Cedric Staniewski <cedric@gmx.ca> Signed-off-by: Allan McRae <allan@archlinux.org> Signed-off-by: Dan McGee <dan@archlinux.org>
* Merge branch 'maint'Dan McGee2009-10-11
|\
| * doc: Add HACKING to html targetDan McGee2009-10-04
| | | | | | | | Signed-off-by: Dan McGee <dan@archlinux.org>
* | Pass all xsltproc-opts in one argumentDan McGee2009-08-08
|/ | | | Signed-off-by: Dan McGee <dan@archlinux.org>
* Add repo-remove.8 to list of cleanup in doc/Makefile.amGerardo Exequiel Pozzi2009-05-18
| | | | | | | | repo-remove.8 is generated with Makefile but is not removed on clean. This patch add it to list of untracked autoconf files. Signed-off-by: Gerardo Exequiel Pozzi <vmlinuz386@yahoo.com.ar> Signed-off-by: Dan McGee <dan@archlinux.org>
* doc: move files around for consistencyDan McGee2009-04-11
| | | | | | | Move some of our documentation files, even though they aren't manpages, to the doc/ directory. This allows the new 'html' make target to manage them. Signed-off-by: Dan McGee <dan@archlinux.org>
* doc: add 'html' target to Makefile.amDan McGee2009-04-11
| | | | Signed-off-by: Dan McGee <dan@archlinux.org>
* Fix asciidoc manpage creation.Xavier Chantry2009-01-02
| | | | | | | | | | | | | | | | As reported here, man pages could no longer be built : http://archlinux.org/pipermail/pacman-dev/2008-December/007726.html I found the explanation here : http://www.methods.co.nz/asciidoc/source-highlight-filter.html "If you use a2x(1) to generate PDF you need to include the --no-xmllint option to suppress xmllint(1) checking — the programlisting language attribute (required by the dblatex source highlighter) is not part of the DocBook 4 specification (but it is in the newer DocBook 5 specification)." Signed-off-by: Xavier Chantry <shiningxc@gmail.com> Signed-off-by: Dan McGee <dan@archlinux.org>
* Attempt to idiot-proof making and refreshing docsDan McGee2008-10-12
| | | | | | | | | | | | | | I mess this up more often than not, and maybe this will do the trick. Remove the --enable-asciidoc option as it has been superseded by the --disable-doc option in usefulness. If you want to skip building docs, you skip building all docs which is much easier when it comes to ensuring the make 'dist' and 'distcheck' targets will always build the manpages and always build the most up to date manpages. Developers shouldn't be affected in their normal builds, nor should end users of the source tarball. Signed-off-by: Dan McGee <dan@archlinux.org>
* Allow use of GIT_VERSION in documentation dirDan McGee2008-06-08
| | | | Signed-off-by: Dan McGee <dan@archlinux.org>
* doc: add symlink for repo-remove manpage on installDan McGee2008-01-05
| | | | Signed-off-by: Dan McGee <dan@archlinux.org>
* doc: rename manlink macro to linkmanDan McGee2007-12-29
| | | | | | | | | | | | | | | | | | | | | | | | | 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>
* Ensure that manpages are always distributed and installedDan McGee2007-12-28
| | | | | | | | | | | | | Commit 012f7939784358b02726c169543aa99436439335 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>
* configure: Doxygen is disabled by default; manpages are included in distDan McGee2007-11-13
| | | | Signed-off-by: Dan McGee <dan@archlinux.org>
* Get rid of the footnotes section in generated manpagesDan McGee2007-11-08
| | | | | | | 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>
* Updates to fix Doxygen documentation generationDan McGee2007-10-14
| | | | | | | | | 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>
* Allow a normal 'make' to compile without asciidoc installedDan McGee2007-09-23
| | | | | | | | 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>
* Add asciidoc checking to configure.ac, make manpage generation optionalDan McGee2007-07-09
| | | | | | | | | 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>
* Add a manpage for repo-addDan McGee2007-07-09
| | | | | | | | We still need some work here- we should have a repo-remove manpage link to this one, and we should not have to struggle with asciidoc formatting to get it to work like any other multiple-command manpage works. Signed-off-by: Dan McGee <dan@archlinux.org>
* Asciidoc updates- make it pretty, fix build, etc.Dan McGee2007-07-09
| | | | | | | | | | | | * 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>