summaryrefslogtreecommitdiffstats
path: root/doc/Makefile.am
AgeCommit message (Collapse)AuthorFilesLines
2018-08-29doc: use more implicit rules to build manpagesDave Reisner1-22/+12
Use implicit dependency rules to translate asciidoc inputs to HTML and manpage outputs. We should only have to declare explicit dependencies for odd cases, e.g. the PKGBUILD documentation has an additional include file and isn't a 1:1 conversion. Signed-off-by: Allan McRae <allan@archlinux.org>
2018-05-14Ensure better text editor automatic filetype detectionEli Schwartz1-34/+34
Since we no longer use vim-specific modelines, use the .asciidoc file extension which is, well, reserved for asciidoc formatted files. This should presumably work everywhere without needing editor-specific workarounds and configuration. Also add a shebang to makepkg.conf to indicate it contains bash content. Signed-off-by: Eli Schwartz <eschwartz@archlinux.org> Signed-off-by: Allan McRae <allan@archlinux.org>
2018-05-14Remove all modelines from the projectEli Schwartz1-2/+0
Many of these are pointless (e.g. there is no need to explicitly turn on spellchecking and language dictionaries for the manpages by default). The only useful modelines are the ones enforcing the project coding standards for indentation style (and "maybe" filetype/syntax, but everything except the asciidoc manpages and makepkg.conf is already autodetected), and indent style can be applied more easily with .editorconfig Signed-off-by: Eli Schwartz <eschwartz@archlinux.org> Signed-off-by: Allan McRae <allan@archlinux.org>
2018-01-19Add BUILDINFO man pageJelle van der Waa1-1/+3
Add a new man page which describes the structure of a BUILDINFO file included in a package produced by makepkg. Signed-off-by: Jelle van der Waa <jelle@vdwaa.nl> Signed-off-by: Allan McRae <allan@archlinux.org>
2016-10-22Remove pactreeAllan McRae1-4/+0
This has been moved to the pacman-contrib project. Signed-off-by: Allan McRae <allan@archlinux.org>
2016-01-27pacman.conf.5: document system hook directoryAllan McRae1-1/+2
Signed-off-by: Allan McRae <allan@archlinux.org>
2015-10-27add alpm-hooks man pageAndrew Gregory1-0/+4
Signed-off-by: Andrew Gregory <andrew.gregory.8@gmail.com> Signed-off-by: Allan McRae <allan@archlinux.org>
2014-08-08remove --destination-dir argument from a2x optionsDave Reisner1-2/+1
This option is only for HTML output, and we're building manpages here. Signed-off-by: Allan McRae <allan@archlinux.org>
2014-01-28Remove ts and sw from vim modeline when noet is setFlorian Pritz1-1/+1
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>
2013-05-29Add makepkg-templateFlorian Pritz1-0/+4
This allows for somewhat easy templating for PKGBUILDs. Signed-off-by: Florian Pritz <bluewind@xinu.at> Signed-off-by: Allan McRae <allan@archlinux.org>
2012-07-10Merge branch 'maint'Dan McGee1-0/+4
Conflicts: etc/makepkg.conf.in
2012-07-10Add man page for pactreeRam Bhamidipaty1-0/+4
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>
2012-04-25Split check steps in Makefile into multiple targetsDan McGee1-0/+2
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>
2012-01-03Merge branch 'maint'Dan McGee1-3/+3
Conflicts: doc/Makefile.am
2012-01-03Prevent rebuild of man pages when using release tarballsAllan McRae1-3/+3
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>
2011-12-08Use automake verbose helpers in custom make rulesDan McGee1-7/+9
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>
2011-10-13doc: update .gitignore, add CSS override for new tables usageDan McGee1-5/+7
* 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>
2011-09-15buildsys: remove existing symlinks before installingDave Reisner1-0/+1
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>
2011-08-15build-sys: always use $(RM) instead of rm -fDave Reisner1-1/+1
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>
2011-08-15dist: preserve symlinks on installationDave Reisner1-1/+10
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>
2011-06-15Merge branch 'maint'Dan McGee1-3/+4
2011-06-15Fix man page generation for out of tree buildAllan McRae1-3/+4
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>
2011-06-01Merge branch 'maint'Dan McGee1-2/+2
2011-06-01doc: update Makefile for new asciidoc resource locationDan McGee1-2/+2
Signed-off-by: Dan McGee <dan@archlinux.org>
2011-03-28Add manpage for pkgdeltaRay Kohler1-0/+4
Signed-off-by: Ray Kohler <ataraxia937@gmail.com> Signed-off-by: Dan McGee <dan@archlinux.org>
2011-03-23Add man-page for pacman-keyGuillaume Alaux1-0/+4
Signed-off-by: Allan McRae <allan@archlinux.org>
2011-01-22Merge branch 'epoch-work'Dan McGee1-0/+4
2011-01-22Makefile: Use git describe --dirty for GIT VERSIONXavier Chantry1-1/+1
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>
2011-01-22doc: add a vercmp manpageDan McGee1-0/+4
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>
2010-12-30Merge branch 'maint'Dan McGee1-1/+1
Conflicts: lib/libalpm/sync.c test/pacman/tests/ignore007.py
2010-12-30doc: add website zip to clean filesDan McGee1-1/+1
Signed-off-by: Dan McGee <dan@archlinux.org>
2010-10-12Use sysconfdir, localstatedir, BASH instead of hardcoded valuesNezmer1-0/+1
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>
2010-07-03docs: Add a 'website' targetDan McGee1-2/+12
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>
2010-06-17Fix distcheck invocation in doc/ directoryv3.4.0Dan McGee1-11/+2
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>
2010-05-14doc: fix up description of where example PKGBUILD is locatedDan McGee1-0/+3
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>
2010-03-15makepkg: make strip options configurableCedric Staniewski1-2/+11
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>
2009-10-11Merge branch 'maint'Dan McGee1-1/+6
2009-10-04doc: Add HACKING to html targetDan McGee1-1/+6
Signed-off-by: Dan McGee <dan@archlinux.org>
2009-08-08Pass all xsltproc-opts in one argumentDan McGee1-2/+2
Signed-off-by: Dan McGee <dan@archlinux.org>
2009-05-19Add repo-remove.8 to list of cleanup in doc/Makefile.amGerardo Exequiel Pozzi1-1/+1
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>
2009-04-11doc: move files around for consistencyDan McGee1-1/+5
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>
2009-04-11doc: add 'html' target to Makefile.amDan McGee1-8/+39
Signed-off-by: Dan McGee <dan@archlinux.org>
2009-01-03Fix asciidoc manpage creation.Xavier Chantry1-0/+1
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>
2008-10-13Attempt to idiot-proof making and refreshing docsDan McGee1-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>
2008-06-09Allow use of GIT_VERSION in documentation dirDan McGee1-1/+9
Signed-off-by: Dan McGee <dan@archlinux.org>
2008-01-05doc: add symlink for repo-remove manpage on installDan McGee1-1/+4
Signed-off-by: Dan McGee <dan@archlinux.org>
2007-12-29doc: rename manlink macro to linkmanDan McGee1-1/+1
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-29Ensure that manpages are always distributed and installedDan McGee1-10/+7
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>
2007-11-13configure: Doxygen is disabled by default; manpages are included in distDan McGee1-7/+9
Signed-off-by: Dan McGee <dan@archlinux.org>
2007-11-09Get rid of the footnotes section in generated manpagesDan McGee1-1/+6
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>
generated by cgit v1.2.3-24-g4f1b (git 2.32.0) at 2024-11-16 15:56:56 +0100