- Pacman-dev - lists.archlinux.org

[pacman-dev] RFC: pacdiff finding pacnews through libalpm
by John Frazier 02 Jun '13

02 Jun '13

I made up a program to help find pacnews that are in odd locations. It includes a c utility based on vodiks pacrat. It uses libalpm to return the path to pacnews and pacsaves from all active configs in the local db. Then there is a version of pacdiff which has it run in place of find. This is better than the current find or locate used in pacdiff which doesn't look outside of /etc/ by default for performance reasons. With this pacdiff can find syslinux config in /boot, or avahi's db in /usr/lib with no noticeable delay. The only drawback I am aware of with using the local db is cannot find pacsaves unless the package is reinstalled. I think this would be a useful inclusion to the contrib tools, so let me know of what sucks about it and what it can be done to to get that accomplished. it currently is in github, but I can make up patches against pacman.git if wanted. https://github.com/JohnFrazier/pacnewrat John Frazier

4 4

[pacman-dev] [PATCH] repo-add; add option to remove existing package files from disk
by Phillip Smith 31 May '13

31 May '13

From: Phillip Smith <fukawi2(a)gmail.com> ==== Updated this patch to remove the sig file, use awk instead of grep/tail and updated documentation too. ==== When maintaining a custom repo, often it is undesirable to retain older versions of packages. This patch adds the --remove option to remove the current package file and it's signature from disk before adding the new one to the database. Documentation is also updated. This is an optional flag and default behaviour (leaving ondisk files alone) is not changed. Signed-off-by: Phillip Smith <fukawi2(a)gmail.com> --- doc/repo-add.8.txt | 6 ++++++ scripts/repo-add.sh.in | 12 ++++++++++++ 2 files changed, 18 insertions(+) diff --git a/doc/repo-add.8.txt b/doc/repo-add.8.txt index 049195a..b06844b 100644 --- a/doc/repo-add.8.txt +++ b/doc/repo-add.8.txt @@ -75,6 +75,12 @@ repo-add Options Only add packages that are not already in the database. Warnings will be printed upon detection of existing packages, but they will not be re-added. +*-R, \--remove*:: + If an existing package with the same name exists in the database and on + disk, remove it from disk well as updating the database entry for the + package. This is designed to be Used when updating an existing package to + a new version. + See Also -------- linkman:makepkg[8], linkman:pacman[8], linkman:pkgdelta[8] diff --git a/scripts/repo-add.sh.in b/scripts/repo-add.sh.in index 4470dd0..91574b3 100644 --- a/scripts/repo-add.sh.in +++ b/scripts/repo-add.sh.in @@ -31,6 +31,7 @@ declare -r confdir='@sysconfdir@' QUIET=0 DELTA=0 ONLYADDNEW=0 +RMEXISTING=0 WITHFILES=0 SIGN=0 VERIFY=0 @@ -58,6 +59,7 @@ Multiple packages to add can be specified on the command line.\n")" printf -- "$(gettext "Options:\n")" printf -- "$(gettext " -d, --delta generate and add delta for package update\n")" printf -- "$(gettext " -n, --new only add packages that are not already in the database\n")" + printf -- "$(gettext " -R, --remove remove any existing packages with the same name (eg, an older version)\n")" printf -- "$(gettext " -f, --files update database's file list\n")" elif [[ $cmd == "repo-remove" ]] ; then printf -- "$(gettext "Usage: repo-remove [options] <path-to-db> <packagename|delta> ...\n")" @@ -304,6 +306,15 @@ db_write_entry() { local oldfilename=$(grep -A1 FILENAME "$pkgentry/desc" | tail -n1) local oldfile="$(dirname "$1")/$oldfilename" fi + elif (( RMEXISTING )); then + # only remove existing package if we're not doing deltas + pkgentry=$(find_pkgentry "$pkgname") + if [[ -n $pkgentry ]]; then + local oldfilename="$(awk '/%FILENAME%/ {getline; print}' "$pkgentry/desc")" + local oldfile="$(dirname "$1")/$oldfilename" + msg2 "$(gettext "Removing existing package '%s'")" "$oldfilename" + rm -f ${oldfile} ${oldfile}.sig + fi fi fi @@ -611,6 +622,7 @@ while (( $# )); do -q|--quiet) QUIET=1;; -d|--delta) DELTA=1;; -n|--new) ONLYADDNEW=1;; + -R|--remove) RMEXISTING=1;; -f|--files) WITHFILES=1;; --nocolor) USE_COLOR='n';; -s|--sign) -- 1.8.2.3

2 4

[pacman-dev] [PATCH] Add the ability to always build from the repo's HEAD
by Techlive Zheng 31 May '13

31 May '13

--- A task has also been added: https://bugs.archlinux.org/task/35499 scripts/makepkg.sh.in | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/scripts/makepkg.sh.in b/scripts/makepkg.sh.in index c27c74d..cd7ed48 100644 --- a/scripts/makepkg.sh.in +++ b/scripts/makepkg.sh.in @@ -557,6 +557,9 @@ download_git() { if ! git fetch --all -p; then # only warn on failure to allow offline builds warning "$(gettext "Failure while updating %s %s repo")" "${repo}" "git" + else + git fetch origin HEAD + echo "$(git rev-parse FETCH_HEAD)" > HEAD fi fi } @@ -597,6 +600,9 @@ extract_git() { branch) ref=origin/${fragment##*=} ;; + HEAD) + ref=HEAD + ;; *) error "$(gettext "Unrecognized reference: %s")" "${fragment}" plain "$(gettext "Aborting...")" @@ -604,6 +610,8 @@ extract_git() { esac fi + ref=$(git rev-parse "$ref") + if [[ -n $ref ]]; then if ! git checkout -b makepkg $ref; then error "$(gettext "Failure while creating working copy of %s %s repo")" "${repo}" "git" -- 1.8.2.3

3 7

[pacman-dev] optdepends and pacman -Qdt
by 郑文辉(Techlive Zheng) 30 May '13

30 May '13

When packages listed in a package's 'optdepeds' field are installed using `--asdeps` option, as long as the package which list these packages as 'optdepends' exists, these packages should not be listed bu `pacman -Qdt`.

2 1

[pacman-dev] [GIT] The official pacman repository branch, master, updated. v4.1.1-34-g9ca423b
by allan＠archlinux.org 30 May '13

30 May '13

This is an automated email from the git hooks/post-receive script. It was generated because a ref change was pushed to the repository containing the project "The official pacman repository". The branch, master has been updated via 9ca423b981c897c7d3894c5b394c23d786e4ba37 (commit) via 5df5d2c411f34d6a893a83cdc464747374642f75 (commit) via 477fd794a06d8f42c97e6ff1c251736b505d32a0 (commit) via a36d4b2831fdb36a0c8ddaec5a023104932df73d (commit) via cbc25c22fcb8ea12ba98386e1489bf8f02e4e86a (commit) via ce3125196d98baf054e841ea3fb368d81df645e1 (commit) from 7ea58d09f69a9a13b637e7128e7b882ac2bebc64 (commit) Those revisions listed above that are new to this repository have not appeared on any other notification email; so we list those revisions in full, below. - Log ----------------------------------------------------------------- commit 9ca423b981c897c7d3894c5b394c23d786e4ba37 Author: Jason St. John <jstjohn(a)purdue.edu> Date: Wed May 29 14:03:29 2013 +0200 Revise pacman(8) Resolve several grammatical errors and minor formatting consistency issues in pacman(8). Generalize the "FTP servers" and package file extension information. Signed-off-by: Jason St. John <jstjohn(a)purdue.edu> Signed-off-by: Allan McRae <allan(a)archlinux.org> commit 5df5d2c411f34d6a893a83cdc464747374642f75 Author: Jason St. John <jstjohn(a)purdue.edu> Date: Wed May 29 14:26:25 2013 +0200 Revise PKGBUILD(5) Resolve several grammatical errors and minor formatting consistency issues in PKGBUILD(5). Signed-off-by: Jason St. John <jstjohn(a)purdue.edu> Signed-off-by: Allan McRae <allan(a)archlinux.org> commit 477fd794a06d8f42c97e6ff1c251736b505d32a0 Author: Florian Pritz <bluewind(a)xinu.at> Date: Wed May 29 14:51:24 2013 +0200 makepkg-template: add --version and some license info Signed-off-by: Florian Pritz <bluewind(a)xinu.at> Signed-off-by: Allan McRae <allan(a)archlinux.org> commit a36d4b2831fdb36a0c8ddaec5a023104932df73d Author: Florian Pritz <bluewind(a)xinu.at> Date: Wed May 22 16:35:23 2013 +0200 makepkg-template: Stop using given/when given/when has been marked experimental in perl 5.18 because it will change it 5.20. if/else is ugly, but hiding the generated warning is no good solution either, so we us if/else for now. Signed-off-by: Florian Pritz <bluewind(a)xinu.at> Signed-off-by: Allan McRae <allan(a)archlinux.org> commit cbc25c22fcb8ea12ba98386e1489bf8f02e4e86a Author: Florian Pritz <bluewind(a)xinu.at> Date: Sun May 19 12:17:57 2013 +0200 makepkg-template: Add gettext support This also slighty changes the word order in the description for --newest. Signed-off-by: Florian Pritz <bluewind(a)xinu.at> Signed-off-by: Allan McRae <allan(a)archlinux.org> commit ce3125196d98baf054e841ea3fb368d81df645e1 Author: Florian Pritz <bluewind(a)xinu.at> Date: Wed May 1 00:18:17 2013 +0200 Add makepkg-template This allows for somewhat easy templating for PKGBUILDs. Signed-off-by: Florian Pritz <bluewind(a)xinu.at> Signed-off-by: Allan McRae <allan(a)archlinux.org> ----------------------------------------------------------------------- Summary of changes: configure.ac | 19 ++++ doc/.gitignore | 1 + doc/Makefile.am | 4 + doc/PKGBUILD.5.txt | 132 +++++++++++++------------ doc/footer.txt | 2 +- doc/makepkg-template.1.txt | 120 +++++++++++++++++++++++ doc/pacman.8.txt | 146 ++++++++++++++-------------- scripts/.gitignore | 1 + scripts/Makefile.am | 11 +++ scripts/makepkg-template.pl.in | 212 +++++++++++++++++++++++++++++++++++++++++ scripts/po/POTFILES.in | 1 + 11 files changed, 513 insertions(+), 136 deletions(-) create mode 100644 doc/makepkg-template.1.txt create mode 100755 scripts/makepkg-template.pl.in hooks/post-receive -- The official pacman repository

1 0

[pacman-dev] Letter case in pacman output
by Jason St. John 30 May '13

30 May '13

I briefly talked with Allan on IRC about changing letter casing in pacman's output (e.g. when running 'pacman -Qi'), and he stated that I should gather feedback on the mailing list. I would like to change from using title case to using sentence case where appropriate. An example of the change would be the following snippet from 'pacman -Qi'. ** Currently: Depends On : coreutils linux-firmware kmod mkinitcpio>=0.7 Optional Deps : crda: to set the correct wireless channels of your country [installed] Required By : None Optional For : None Conflicts With : kernel26 Replaces : kernel26 Installed Size : 65562.00 KiB ** After the proposed change: Depends on : coreutils linux-firmware kmod mkinitcpio>=0.7 Optional deps : crda: to set the correct wireless channels of your country [installed] Required by : None Optional for : None Conflicts with : kernel26 Replaces : kernel26 Installed size : 65562.00 KiB Pros: I think it looks better aesthetically (although Allan disagrees) and looks more professional. Cons: Increased workload for translators for the next pacman release. Jason

4 4

[pacman-dev] [PATCH] removed duplicate macros SYMEXPORT and SYMHIDDEN from alpm_list.c, using them from util.h
by Paul Barbu Gheorghe 29 May '13

29 May '13

Signed-off-by: Barbu Paul - Gheorghe <barbu.paul.gheorghe(a)gmail.com> --- lib/libalpm/alpm_list.c | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/lib/libalpm/alpm_list.c b/lib/libalpm/alpm_list.c index 39eded1..b9e7cba 100644 --- a/lib/libalpm/alpm_list.c +++ b/lib/libalpm/alpm_list.c @@ -21,13 +21,11 @@ #include <stdlib.h> #include <string.h> +#include "util.h" + /* libalpm */ #include "alpm_list.h" -/* check exported library symbols with: nm -C -D <lib> */ -#define SYMEXPORT __attribute__((visibility("default"))) -#define SYMHIDDEN __attribute__((visibility("internal"))) - /** * @addtogroup alpm_list List Functions * @brief Functions to manipulate alpm_list_t lists. -- Barbu Paul - Gheorghe Common sense is not so common - Voltaire Visit My GitHub profile to see my open-source projects - https://github.com/paullik

6 9

[pacman-dev] [PATCH] makepkg-template: add --version and some license info
by Florian Pritz 29 May '13

29 May '13

Signed-off-by: Florian Pritz <bluewind(a)xinu.at> --- scripts/makepkg-template.pl.in | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) diff --git a/scripts/makepkg-template.pl.in b/scripts/makepkg-template.pl.in index 7e37799..f3eda05 100755 --- a/scripts/makepkg-template.pl.in +++ b/scripts/makepkg-template.pl.in @@ -1,4 +1,22 @@ #!/usr/bin/perl +# makepkg-template - template system for makepkg +# @configure_input@ +# +# Copyright (c) 2013 Pacman Development Team <pacman-dev(a)archlinux.org> +# +# This program is free software; you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation; either version 2 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see <http://www.gnu.org/licenses/>. +# use warnings; use strict; use v5.10.1; @@ -158,14 +176,27 @@ sub usage { print gettext(" (default: use version specified in the template markers)\n"); print gettext(" --template-dir <dir> directory to search for templates\n"); printf(gettext(" (default: %s)\n"), '@TEMPLATE_DIR@'); + print gettext(" --help, -h This help message\n"); + print gettext(" --version Version information\n"); print "\n"; exit($exitstatus); } +sub version { + my ($exitstatus) = @_; + printf(gettext("makepkg-template (pacman) %s\n"), '@PACKAGE_VERSION@'); + print gettext( + 'Copyright (c) 2013 Pacman Development Team <pacman-dev(a)archlinux.org>.'."\n". + 'This is free software; see the source for copying conditions.'."\n". + 'There is NO WARRANTY, to the extent permitted by law.'."\n"); + exit($exitstatus); +} + Getopt::Long::Configure ("bundling"); GetOptions( "help" => sub {usage(0); }, "h" => sub {usage(0); }, + "version" => sub {version(0); }, "input|p=s" => \$opts{input}, "output|o=s" => \$opts{output}, "newest|n" => \$opts{newest}, -- 1.8.2.3

2 3

[pacman-dev] [PATCH] Revise PKGBUILD(5)
by Jason St. John 29 May '13

29 May '13

From: "Jason St. John" <jstjohn(a)purdue.edu> Resolve several grammatical errors and minor formatting consistency issues in PKGBUILD(5). Signed-off-by: Jason St. John <jstjohn(a)purdue.edu> --- This is the third (and hopefully final) version of this patch. This is a resubmission of a previous patch based on Allan's feedback, which can be found here: https://mailman.archlinux.org/pipermail/pacman-dev/2013-April/016968.html There are some additional changes, but they should be relatively benign. doc/PKGBUILD.5.txt | 132 ++++++++++++++++++++++++++++------------------------- doc/footer.txt | 2 +- 2 files changed, 70 insertions(+), 64 deletions(-) diff --git a/doc/PKGBUILD.5.txt b/doc/PKGBUILD.5.txt index ea280a0..35633f6 100644 --- a/doc/PKGBUILD.5.txt +++ b/doc/PKGBUILD.5.txt @@ -48,10 +48,12 @@ similar to `$_basekernver`. The version of the software as released from the author (e.g., '2.7.1'). The variable is not allowed to contain colons or hyphens. + -The `pkgver` variable can be automatically updated by providing a `pkgver()` function -in the PKGBUILD that outputs the new package version. This is run after downloading -and extracting the sources so can use those files in determining the new `pkgver`. -This is most useful when used with sources from version control systems (see below). +The `pkgver` variable can be automatically updated by providing a `pkgver()` +function in the PKGBUILD that outputs the new package version. +This is run after downloading and extracting the sources so it can use those +files in determining the new `pkgver`. +This is most useful when used with sources from version control systems (see +below). *pkgrel*:: This is the release number specific to the Arch Linux release. This @@ -62,7 +64,8 @@ This is most useful when used with sources from version control systems (see bel *pkgdesc*:: This should be a brief description of the package and its functionality. - Try to keep the description to one line of text and not use the package's name. + Try to keep the description to one line of text and to not use the package's + name. *epoch*:: Used to force the package to be seen as newer than any previous versions @@ -75,7 +78,7 @@ This is most useful when used with sources from version control systems (see bel *url*:: This field contains a URL that is associated with the software being - packaged. Typically the project's website. + packaged. This is typically the project's web site. *license (array)*:: This field specifies the license(s) that apply to the package. @@ -91,13 +94,13 @@ This is most useful when used with sources from version control systems (see bel *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 + 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`). *changelog*:: Specifies a changelog file that is to be included in the package. - This file should reside in the same directory as the PKGBUILD, and will + 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., `changelog=$pkgname.changelog`). @@ -105,10 +108,10 @@ This is most useful when used with sources from version control systems (see bel An array of source files required to build the package. Source files must either reside in the same directory as the PKGBUILD, or be a fully-qualified URL that makepkg can use to download the file. - To make the PKGBUILD as useful as possible, use the `$pkgname` and `$pkgver` - variables if possible when specifying the download location. Compressed files - will be extracted automatically unless found in - the noextract array described below. + To simplify the maintenance of PKGBUILDs, use the `$pkgname` and `$pkgver` + variables when specifying the download location, if possible. + Compressed files will be extracted automatically unless found in the + noextract array described below. + It is also possible to change the name of the downloaded file, which is helpful with weird URLs and for handling multiple source files with the same @@ -118,12 +121,12 @@ makepkg also supports building developmental versions of packages using sources downloaded from version control systems (VCS). For more information, see <<VCS,Using VCS Sources>> below. + -Files in the source array with extensions `.sig`, `.sign` or `.asc` are recognized by -makepkg as PGP signatures and will be automatically used to verify the integrity -of the corresponding source file. +Files in the source array with extensions `.sig`, `.sign` or, `.asc` are +recognized by makepkg as PGP signatures and will be automatically used to verify +the integrity of the corresponding source file. *noextract (array)*:: - An array of filenames corresponding to those from the source array. Files + An array of file names corresponding to those from the source array. Files listed here will not be extracted with the rest of the source files. This is useful for packages that use compressed data directly. @@ -152,10 +155,10 @@ of the corresponding source file. files should use `arch=('any')`. *backup (array)*:: - An array of filenames, without preceding slashes, that + An array of file names, without preceding slashes, that should be backed up if the package is removed or upgraded. This is - commonly used for packages placing configuration files in /etc. See - Handling Config Files in linkman:pacman[8] for more information. + commonly used for packages placing configuration files in '/etc'. See + `"Handling Config Files"` in linkman:pacman[8] for more information. *depends (array)*:: An array of packages this package depends on to run. Entries in @@ -168,7 +171,7 @@ of the corresponding source file. If the dependency name appears to be a library (ends with .so), makepkg will try to find a binary that depends on the library in the built package and append the version needed by the binary. Appending the version yourself -disables auto detection. +disables automatic detection. *makedepends (array)*:: An array of packages this package depends on to build but are not @@ -209,7 +212,7 @@ only specific versions of a package may be provided. + If the provision name appears to be a library (ends with .so), makepkg will try to find the library in the built package and append the correct -version. Appending the version yourself disables auto detection. +version. Appending the version yourself disables automatic detection. *replaces (array)*:: An array of packages this package should replace. This can be used @@ -289,13 +292,13 @@ Packaging Functions ------------------- In addition to the above directives, PKGBUILDs require a set of functions that -provide instructions to build and install the package. As a minimum, the PKGBUILD -must contain a package() function which installs all the package's files into the -packaging directory, with optional prepare(), build() and check() being used to -create those files from source. +provide instructions to build and install the package. As a minimum, the +PKGBUILD must contain a `package()` function which installs all the package's +files into the packaging directory, with optional `prepare()`, `build()`, and +`check()` functions being used to create those files from source. *package() Function*:: - The package() function is used to install files into the directory that + The `package()` function is used to install files into the directory that will become the root directory of the built package and is run after all the optional functions listed below. When specified in combination with the fakeroot BUILDENV option in linkman:makepkg.conf[5], fakeroot usage @@ -303,41 +306,41 @@ create those files from source. be run as the user calling makepkg. *prepare() Function*:: - An optional prepare() function can be specified in which operations that - are to be run in order to prepare the sources for building (such as - patching) are performed. This function is run after the source extraction - and before the build() function and is skipped when source extraction is - skipped. + An optional `prepare()` function can be specified in which operations to + prepare the sources for building, such as patching, are performed. This + function is run after the source extraction and before the `build()` + function. The `prepare()` function is skipped when source extraction + is skipped. *build() Function*:: - The optional build() function is use to compile and/or adjust the source - files in preparation to be installed by the package() function. This is - directly sourced and executed by makepkg, so anything that bash or the + The optional `build()` function is use to compile and/or adjust the source + files in preparation to be installed by the `package()` function. This is + directly sourced and executed by makepkg, so anything that Bash or the system has available is available for use here. Be sure any exotic - commands used are covered by `makedepends`. + commands used are covered by the `makedepends` array. + -If you create any variables of your own in the build function, it is -recommended to use the bash `local` keyword to scope the variable to inside -the build function. +If you create any variables of your own in the `build()` function, it is +recommended to use the Bash `local` keyword to scope the variable to inside +the `build()` function. *check() Function*:: - An optional check() function can be specified in which a package's - test-suite may be run. This function is run between the build() and - package() functions. Be sure any exotic commands used are covered by - `checkdepends`. + An optional `check()` function can be specified in which a package's + test-suite may be run. This function is run between the `build()` and + `package()` functions. Be sure any exotic commands used are covered by the + `checkdepends` array. -All of the above variables such as `$pkgname` and `$pkgver` are available for use -in the build function. In addition, makepkg defines the following variables for use -during the build and install process: +All of the above variables such as `$pkgname` and `$pkgver` are available for +use in the `build()` function. In addition, makepkg defines the following +variables for use during the build and install process: *srcdir*:: - This contains the directory where makepkg extracts, or copies, all source - files. + This contains the directory where makepkg extracts, or copies, all source + files. *pkgdir*:: - This contains the directory where makepkg bundles the installed package - (this directory will become the root directory of your built package). - This variable should only be used in the package() function. + This contains the directory where makepkg bundles the installed package. + This directory will become the root directory of your built package. This + variable should only be used in the `package()` function. *startdir*:: This contains the absolute path to the directory where the PKGBUILD is @@ -362,8 +365,8 @@ An optional global directive is available when building a split package: *pkgbase*:: The name used to refer to the group of packages in the output of makepkg - and in the naming of source-only tarballs. If not specified, the first - element in the `pkgname` array is used. The variable is not allowed to + and in the naming of source-only tarballs. If not specified, the first + element in the `pkgname` array is used. The variable is not allowed to begin with a hyphen. Install/Upgrade/Remove Scripting @@ -377,7 +380,7 @@ self-explanatory. Note that during an upgrade operation, none of the install or remove scripts will be called. Scripts are passed either one or two ``full version strings'', where a full -version string is either 'pkgver-pkgrel' or 'epoch:pkgver-pkgrel' if epoch is +version string is either 'pkgver-pkgrel' or 'epoch:pkgver-pkgrel', if epoch is non-zero. *pre_install*:: @@ -415,10 +418,12 @@ reference with all of the available functions defined. Using VCS Sources[[VCS]] ------------------------ -Building a developmental version of a package using sources from a version control -system (VCS) is enabled by specifying the source in the form -`source=('folder::url#fragment')`. Currently makepkg supports the `bzr`, `git`, `hg` and -`svn` protocols. +Building a developmental version of a package using sources from a version +control system (VCS) is enabled by specifying the source in the form +`source=('folder::url#fragment')`. Currently makepkg supports the Bazaar, Git, +Subversion, and Mercurial version control systems. For other version control +systems, manual cloning of upstream repositories must be done in the `prepare()` +function. The source URL is divided into three components: @@ -427,11 +432,12 @@ The source URL is divided into three components: source into. *url*:: - The url to the VCS repo. This must include the the vcs in the URL protocol for - makepkg to recognize this as a VCS source. If the protocol does not include - the VCS name, it can be added by prefixing the URL with `vcs+`. For example, - using a git repository over `http` would have a source URL in the form - `git+http://...`. + The URL to the VCS repository. This must include the VCS in the URL protocol + for makepkg to recognize this as a VCS source. If the protocol does not + include the VCS name, it can be added by prefixing the URL with `vcs+`. For + example, using a Git repository over HTTPS would have a source URL in the + form: + `git+https://...`. *fragment*:: (optional) Allows specifying a revision number or branch for makepkg to checkout @@ -455,7 +461,7 @@ Example ------- The following is an example PKGBUILD for the 'patch' package. For more examples, look through the build files of your distribution's packages. For -those using Arch Linux, consult the ABS tree. +those using Arch Linux, consult the Arch Build System (ABS) tree. [source,sh] ------------------------------- diff --git a/doc/footer.txt b/doc/footer.txt index ccb931c..af19304 100644 --- a/doc/footer.txt +++ b/doc/footer.txt @@ -8,7 +8,7 @@ information on pacman and its related tools. Bugs ---- -Bugs? You must be kidding, there are no bugs in this software. But if we +Bugs? You must be kidding; there are no bugs in this software. But if we happen to be wrong, send us an email with as much detail as possible to mailto:pacman-dev@archlinux.org[]. -- 1.8.3

1 0

[pacman-dev] [PATCH] Revise PKGBUILD(5)
by Jason St. John 29 May '13

29 May '13

From: "Jason St. John" <jstjohn(a)purdue.edu> Several grammatical errors and minor formatting consistency issues have been resolved in PKGBUILD(5). --- Ignore the patch I submitted just a few minutes ago, and use this patch instead. I just noticed a quoting problem introduced in that patch. This is a resubmission of a previous patch based on Allan's feedback, which can be found here: https://mailman.archlinux.org/pipermail/pacman-dev/2013-April/016968.html There are some additional changes, but they should be relatively benign. doc/PKGBUILD.5.txt | 132 ++++++++++++++++++++++++++++------------------------- doc/footer.txt | 2 +- 2 files changed, 70 insertions(+), 64 deletions(-) diff --git a/doc/PKGBUILD.5.txt b/doc/PKGBUILD.5.txt index ea280a0..2b94477 100644 --- a/doc/PKGBUILD.5.txt +++ b/doc/PKGBUILD.5.txt @@ -48,10 +48,12 @@ similar to `$_basekernver`. The version of the software as released from the author (e.g., '2.7.1'). The variable is not allowed to contain colons or hyphens. + -The `pkgver` variable can be automatically updated by providing a `pkgver()` function -in the PKGBUILD that outputs the new package version. This is run after downloading -and extracting the sources so can use those files in determining the new `pkgver`. -This is most useful when used with sources from version control systems (see below). +The `pkgver` variable can be automatically updated by providing a `pkgver()` +function in the PKGBUILD that outputs the new package version. +This is run after downloading and extracting the sources so it can use those +files in determining the new `pkgver`. +This is most useful when used with sources from version control systems (see +below). *pkgrel*:: This is the release number specific to the Arch Linux release. This @@ -62,7 +64,8 @@ This is most useful when used with sources from version control systems (see bel *pkgdesc*:: This should be a brief description of the package and its functionality. - Try to keep the description to one line of text and not use the package's name. + Try to keep the description to one line of text and to not use the package's + name. *epoch*:: Used to force the package to be seen as newer than any previous versions @@ -75,7 +78,7 @@ This is most useful when used with sources from version control systems (see bel *url*:: This field contains a URL that is associated with the software being - packaged. Typically the project's website. + packaged. This is typically the project's web site. *license (array)*:: This field specifies the license(s) that apply to the package. @@ -91,13 +94,13 @@ This is most useful when used with sources from version control systems (see bel *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 + 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`). *changelog*:: Specifies a changelog file that is to be included in the package. - This file should reside in the same directory as the PKGBUILD, and will + 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., `changelog=$pkgname.changelog`). @@ -105,10 +108,10 @@ This is most useful when used with sources from version control systems (see bel An array of source files required to build the package. Source files must either reside in the same directory as the PKGBUILD, or be a fully-qualified URL that makepkg can use to download the file. - To make the PKGBUILD as useful as possible, use the `$pkgname` and `$pkgver` - variables if possible when specifying the download location. Compressed files - will be extracted automatically unless found in - the noextract array described below. + To simplify the maintenance of PKGBUILDs, use the `$pkgname` and `$pkgver` + variables when specifying the download location, if possible. + Compressed files will be extracted automatically unless found in the + noextract array described below. + It is also possible to change the name of the downloaded file, which is helpful with weird URLs and for handling multiple source files with the same @@ -118,12 +121,12 @@ makepkg also supports building developmental versions of packages using sources downloaded from version control systems (VCS). For more information, see <<VCS,Using VCS Sources>> below. + -Files in the source array with extensions `.sig`, `.sign` or `.asc` are recognized by -makepkg as PGP signatures and will be automatically used to verify the integrity -of the corresponding source file. +Files in the source array with extensions `.sig`, `.sign` or, `.asc` are +recognized by makepkg as PGP signatures and will be automatically used to verify +the integrity of the corresponding source file. *noextract (array)*:: - An array of filenames corresponding to those from the source array. Files + An array of file names corresponding to those from the source array. Files listed here will not be extracted with the rest of the source files. This is useful for packages that use compressed data directly. @@ -152,10 +155,10 @@ of the corresponding source file. files should use `arch=('any')`. *backup (array)*:: - An array of filenames, without preceding slashes, that + An array of file names, without preceding slashes, that should be backed up if the package is removed or upgraded. This is - commonly used for packages placing configuration files in /etc. See - Handling Config Files in linkman:pacman[8] for more information. + commonly used for packages placing configuration files in '/etc'. See + ``Handling Config Files'' in linkman:pacman[8] for more information. *depends (array)*:: An array of packages this package depends on to run. Entries in @@ -168,7 +171,7 @@ of the corresponding source file. If the dependency name appears to be a library (ends with .so), makepkg will try to find a binary that depends on the library in the built package and append the version needed by the binary. Appending the version yourself -disables auto detection. +disables automatic detection. *makedepends (array)*:: An array of packages this package depends on to build but are not @@ -209,7 +212,7 @@ only specific versions of a package may be provided. + If the provision name appears to be a library (ends with .so), makepkg will try to find the library in the built package and append the correct -version. Appending the version yourself disables auto detection. +version. Appending the version yourself disables automatic detection. *replaces (array)*:: An array of packages this package should replace. This can be used @@ -289,13 +292,13 @@ Packaging Functions ------------------- In addition to the above directives, PKGBUILDs require a set of functions that -provide instructions to build and install the package. As a minimum, the PKGBUILD -must contain a package() function which installs all the package's files into the -packaging directory, with optional prepare(), build() and check() being used to -create those files from source. +provide instructions to build and install the package. As a minimum, the +PKGBUILD must contain a `package()` function which installs all the package's +files into the packaging directory, with optional `prepare()`, `build()`, and +`check()` functions being used to create those files from source. *package() Function*:: - The package() function is used to install files into the directory that + The `package()` function is used to install files into the directory that will become the root directory of the built package and is run after all the optional functions listed below. When specified in combination with the fakeroot BUILDENV option in linkman:makepkg.conf[5], fakeroot usage @@ -303,41 +306,41 @@ create those files from source. be run as the user calling makepkg. *prepare() Function*:: - An optional prepare() function can be specified in which operations that - are to be run in order to prepare the sources for building (such as - patching) are performed. This function is run after the source extraction - and before the build() function and is skipped when source extraction is - skipped. + An optional `prepare()` function can be specified in which operations to + prepare the sources for building, such as patching, are performed. This + function is run after the source extraction and before the `build()` + function, and the `prepare()` function is skipped when source extraction + is skipped. *build() Function*:: - The optional build() function is use to compile and/or adjust the source - files in preparation to be installed by the package() function. This is - directly sourced and executed by makepkg, so anything that bash or the + The optional `build()` function is use to compile and/or adjust the source + files in preparation to be installed by the `package()` function. This is + directly sourced and executed by makepkg, so anything that Bash or the system has available is available for use here. Be sure any exotic - commands used are covered by `makedepends`. + commands used are covered by the `makedepends` array. + -If you create any variables of your own in the build function, it is -recommended to use the bash `local` keyword to scope the variable to inside -the build function. +If you create any variables of your own in the `build()` function, it is +recommended to use the Bash `local` keyword to scope the variable to inside +the `build()` function. *check() Function*:: - An optional check() function can be specified in which a package's - test-suite may be run. This function is run between the build() and - package() functions. Be sure any exotic commands used are covered by - `checkdepends`. + An optional `check()` function can be specified in which a package's + test-suite may be run. This function is run between the `build()` and + `package()` functions. Be sure any exotic commands used are covered by the + `checkdepends` array. -All of the above variables such as `$pkgname` and `$pkgver` are available for use -in the build function. In addition, makepkg defines the following variables for use -during the build and install process: +All of the above variables such as `$pkgname` and `$pkgver` are available for +use in the `build()` function. In addition, makepkg defines the following +variables for use during the build and install process: *srcdir*:: - This contains the directory where makepkg extracts, or copies, all source - files. + This contains the directory where makepkg extracts, or copies, all source + files. *pkgdir*:: - This contains the directory where makepkg bundles the installed package - (this directory will become the root directory of your built package). - This variable should only be used in the package() function. + This contains the directory where makepkg bundles the installed package. + This directory will become the root directory of your built package. This + variable should only be used in the `package()` function. *startdir*:: This contains the absolute path to the directory where the PKGBUILD is @@ -362,8 +365,8 @@ An optional global directive is available when building a split package: *pkgbase*:: The name used to refer to the group of packages in the output of makepkg - and in the naming of source-only tarballs. If not specified, the first - element in the `pkgname` array is used. The variable is not allowed to + and in the naming of source-only tarballs. If not specified, the first + element in the `pkgname` array is used. The variable is not allowed to begin with a hyphen. Install/Upgrade/Remove Scripting @@ -377,7 +380,7 @@ self-explanatory. Note that during an upgrade operation, none of the install or remove scripts will be called. Scripts are passed either one or two ``full version strings'', where a full -version string is either 'pkgver-pkgrel' or 'epoch:pkgver-pkgrel' if epoch is +version string is either 'pkgver-pkgrel' or 'epoch:pkgver-pkgrel', if epoch is non-zero. *pre_install*:: @@ -415,10 +418,12 @@ reference with all of the available functions defined. Using VCS Sources[[VCS]] ------------------------ -Building a developmental version of a package using sources from a version control -system (VCS) is enabled by specifying the source in the form -`source=('folder::url#fragment')`. Currently makepkg supports the `bzr`, `git`, `hg` and -`svn` protocols. +Building a developmental version of a package using sources from a version +control system (VCS) is enabled by specifying the source in the form +`source=('folder::url#fragment')`. Currently makepkg supports the Bazaar, Git, +Subversion, and Mercurial version control systems. For other version control +systems, manual cloning of upstream repositories must be done in the `prepare()` +function. The source URL is divided into three components: @@ -427,11 +432,12 @@ The source URL is divided into three components: source into. *url*:: - The url to the VCS repo. This must include the the vcs in the URL protocol for - makepkg to recognize this as a VCS source. If the protocol does not include - the VCS name, it can be added by prefixing the URL with `vcs+`. For example, - using a git repository over `http` would have a source URL in the form - `git+http://...`. + The URL to the VCS repository. This must include the VCS in the URL protocol + for makepkg to recognize this as a VCS source. If the protocol does not + include the VCS name, it can be added by prefixing the URL with `vcs+`. For + example, using a Git repository over HTTPS would have a source URL in the + form: + `git+https://...`. *fragment*:: (optional) Allows specifying a revision number or branch for makepkg to checkout @@ -455,7 +461,7 @@ Example ------- The following is an example PKGBUILD for the 'patch' package. For more examples, look through the build files of your distribution's packages. For -those using Arch Linux, consult the ABS tree. +those using Arch Linux, consult the Arch Build System (ABS) tree. [source,sh] ------------------------------- diff --git a/doc/footer.txt b/doc/footer.txt index ccb931c..af19304 100644 --- a/doc/footer.txt +++ b/doc/footer.txt @@ -8,7 +8,7 @@ information on pacman and its related tools. Bugs ---- -Bugs? You must be kidding, there are no bugs in this software. But if we +Bugs? You must be kidding; there are no bugs in this software. But if we happen to be wrong, send us an email with as much detail as possible to mailto:pacman-dev@archlinux.org[]. -- 1.8.3

2 1