summaryrefslogtreecommitdiffstats
path: root/doc/PKGBUILD.5.txt
AgeCommit message (Collapse)AuthorFilesLines
2009-10-12Introduce new PKGBUILD variable `changelog`Cedric Staniewski1-1/+7
Currently, a changelog is added to a package if a specific file with a hardcoded name exists in the PKGBUILD's directory. This approach is not pretty and also inconsistent with the handling of install files, but it works. With the introduction of split PKGBUILDs, however, a drawback in this old behavior has arisen: you only have the possibility to include one specific changelog file in either every package defined in the PKGBUILD or in none. The use of an additional variable, `changelog`, works around this issue and makes it possible to include a changelog in only some of the packages, and besides, each package of the PKGBUILD can have its own changelog file. 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-09-07Merge branch 'maint'Dan McGee1-1/+2
2009-09-07Update doc and vim syntax for arch=anyXavier Chantry1-1/+2
This fixes FS#15870 Signed-off-by: Xavier Chantry <shiningxc@gmail.com> Signed-off-by: Dan McGee <dan@archlinux.org>
2009-09-06sanity check for optdepends syntaxXavier Chantry1-1/+1
only allow optdepends like: pkgname: description some (real) examples of invalid optdepends: 'tcl, python and/or ruby: to use corresponding binding' 'xorg-fonts-75dpi : X bitmap fonts needed for the interface' 'ruby-htmlentities (AUR): for one provider named Deastore' 'xpdf - for pdf' Signed-off-by: Xavier Chantry <shiningxc@gmail.com> [Allan: rebase off de39a1f6 and adjust man page] Signed-off-by: Allan McRae <allan@archlinux.org> Signed-off-by: Dan McGee <dan@archlinux.org>
2009-06-21Fix typos in PKGBUILD man pageAllan McRae1-2/+2
Original-patch-by: Jason Ribeiro Signed-off-by: Allan McRae <allan@archlinux.org>
2009-05-14makepkg: Document package splittingAllan McRae1-6/+21
Signed-off-by: Allan McRae <allan@archlinux.org>
2009-04-11Fix asciidoc formatting warnings and issuesDan McGee1-9/+9
Signed-off-by: Dan McGee <dan@archlinux.org>
2009-02-19Merge branch 'maint'Dan McGee1-5/+5
2009-02-17Rework optdepends documentation for clarityDan McGee1-5/+5
Signed-off-by: Dan McGee <dan@archlinux.org>
2009-01-16makepkg: add optional package functionAllan McRae1-0/+8
This patch allows us to split the building and packaging stages of a PKGBUILD and minimize fakeroot usage. This can be done with less code duplication (run_build and run_package look quite similiar) but the run_package function will be where the package splitting logic is implemented in the future. Signed-off-by: Allan McRae <allan@archlinux.org>
2009-01-03Merge branch 'maint'Dan McGee1-5/+6
Conflicts: lib/libalpm/dload.c po/it.po scripts/makepkg.sh.in
2009-01-03Fix asciidoc manpage creation.Xavier Chantry1-4/+3
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>
2009-01-03makepkg: detect incorrect usage of provides arrayAllan McRae1-1/+3
Using > or < in the provides array is wrong so make it cause an error. Fixes FS#12540. Also, use bash substitution rather than spawning new processes where possible in the error checking. Move split package detection to a better position. Signed-off-by: Allan McRae <allan@archlinux.org> [Dan: backport to maint] Signed-off-by: Dan McGee <dan@archlinux.org>
2008-12-08Merge branch 'maint'Dan McGee1-1/+1
2008-12-08Small documentation updates for clarityDan McGee1-1/+1
Signed-off-by: Dan McGee <dan@archlinux.org>
2008-08-27Merge branch 'maint'Dan McGee1-0/+4
2008-08-26makepkg : allow to specify a download filenameXavier Chantry1-0/+4
A source entry can now have the following form, to specify a different filename : "filename::http://path/to/file" Of course, the old syntax is still supported : "http://path/to/file" And as before, in the second case, the filename used is simply "file". This fixes FS#11292, because handling multiple source files with the same name is now possible (just choose a different filename). But it will also allow to deal much more nicely with funny url like this by using a sane filename (and unfortunately, there are quite a few) : http://www.vim.org/scripts/download_script.php?src_id=6992 Signed-off-by: Xavier Chantry <shiningxc@gmail.com> Signed-off-by: Dan McGee <dan@archlinux.org>
2008-08-23Treat info pages like man pagesAllan McRae1-3/+3
As far a package building is concerned, info pages need to be treated in the same fashion as man pages in that they both can be compressed. This separates them from other forms of documentation and so it makes sense to make that distinction within makepkg. Signed-off-by: Allan McRae <allan@archlinux.org> Signed-off-by: Dan McGee <dan@archlinux.org>
2008-06-20Add information on version comparison to manpagesDan McGee1-1/+2
Signed-off-by: Dan McGee <dan@archlinux.org>
2008-06-19Merge branch 'maint'Dan McGee1-1/+43
2008-06-14Expand PKGBUILD documentationDan McGee1-1/+43
Add documentation for $startdir, $srcdir, and $pkgdir variables, as well as general information about the build() function and about custom variables in PKGBUILDs. This addresses FS#10634. Signed-off-by: Dan McGee <dan@archlinux.org>
2008-06-08Various updates needed prior to a new releaseDan McGee1-8/+7
Signed-off-by: Dan McGee <dan@archlinux.org>
2008-03-16Add zipman makepkg option.Chantry Xavier1-0/+3
All other steps in tidy_install function were already controlled by an option in makepkg.conf, so this patch adds an option for the man page compression step too. This will allow to keep man pages uncompressed, which is required for some special meta man page, like the zshall one (see FS#4580). Ref: http://www.archlinux.org/pipermail/pacman-dev/2008-March/011472.html Signed-off-by: Chantry Xavier <shiningxc@gmail.com>
2008-01-15Change the versioned provision format.Chantry Xavier1-2/+3
Change the 'provname provver' format to 'provname=provver'. In .PKGINFO, the provisions are copied from the PKGBUILD without quotes. So the provision version was actually handled as a different provision... See FS#9171. Dan: Unfortunately we have to change our original specification for versioned provisions with this patch, but it ends up being the simpler and cleaner solution in the long run, and if there is any time to change it the time is now before many packages have been built. Keeping the ' ' based format would have required us to do special parsing in repo-add, as well as being susceptible to users not using quotes in their provides array. Hopefully this will resolve the issues we had with our initial plan. Sorry for the confusion. Acked-by: Nagy Gabor <ngaba@bibl.u-szeged.hu> Signed-off-by: Chantry Xavier <shiningxc@gmail.com> Signed-off-by: Dan McGee <dan@archlinux.org>
2008-01-13Fix cvsmod typo in PKGBUILD man page.Chantry Xavier1-1/+1
Fixes FS#9175. Signed-off-by: Chantry Xavier <shiningxc@gmail.com>
2008-01-11doc: add info about optdependsDan McGee1-0/+9
Signed-off-by: Dan McGee <dan@archlinux.org>
2007-12-29doc: rename manlink macro to linkmanDan McGee1-5/+5
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-20Update PKGBUILD manpage to give info on scriptlet argumentsDan McGee1-6/+12
Signed-off-by: Dan McGee <dan@archlinux.org>
2007-12-19Add PM_DEP_MOD_GT and PM_DEP_MOD_LT to documentationNagy Gabor1-2/+3
Signed-off-by: Nagy Gabor <ngaba@bibl.u-szeged.hu> Signed-off-by: Dan McGee <dan@archlinux.org>
2007-12-11Updates to PKGBUILD manpageDan McGee1-6/+11
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-11-21doc: use source highlighter on PKGBUILD guide, update wrong example textDan McGee1-4/+5
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-21Update PKGBUILD manpage with versioned conflicts.Chantry Xavier1-1/+1
As the b96922679e4ed14aa687bf194b766d82a1d10577 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-19Versioned provisions.Nagy Gabor1-0/+2
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-08Update PKGBUILD.5 with missing devel variable descriptionsDan McGee1-0/+7
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-10-30Small updates to documentation.Scott Horowitz1-8/+68
Signed-off-by: Scott Horowitz <stonecrest@gmail.com> Signed-off-by: Dan McGee <dan@archlinux.org>
2007-07-16Man page revision timeDan McGee1-27/+28
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-09Asciidoc updates- make it pretty, fix build, etc.Dan McGee1-11/+14
* 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>
2007-07-09Update PKGBUILD example.Andrew Fyfe1-29/+3
Signed-off-by: Andrew Fyfe <andrew@neptune-one.net>
2007-07-09Add Synopsis section to man 5 pages.Andrew Fyfe1-0/+5
Signed-off-by: Andrew Fyfe <andrew@neptune-one.net>
2007-07-09Convert the remaining man pages to asciidoc.Andrew Fyfe1-0/+256
Signed-off-by: Andrew Fyfe <andrew@neptune-one.net>