Difference between revisions of "AUR Metadata"

From ArchWiki
Jump to: navigation, search
(How it works: Updated information)
m (Working with makepkg --source: remove bad information about including .AURINFO in the "source" array. just use "mkaurball" instead... that's why it is there.)
Line 25: Line 25:
  
 
== Working with makepkg --source ==
 
== Working with makepkg --source ==
Note that {{ic|makepkg --source}} will not automatically include an .AURINFO file that you've created in the src tarball. You can fix this by adding {{ic|.AURINFO}} to the {{ic|source}} array in your {{ic|PKGBUILD}}.
+
Note that {{ic|makepkg --source}} will not automatically include an .AURINFO file in the source tarball. To include the .AURINFO file in the source tarball, use {{ic|mkaurball}} from the package {{Pkg|pkgbuild-introspection}} instead of {{ic|makepkg --source}}.
 
 
  source=(.AURINFO ...)
 
  md5sums=(SKIP ...)
 
  
 
== What does not work ==
 
== What does not work ==

Revision as of 07:34, 22 October 2014

In order to display information in the AUR web interface, the AUR's back-end code attempts to parse PKGBUILD files and salvage package name, version, and other information from it. PKGBUILDs are Bash scripts, and correctly parsing Bash scripts without executing them is a huge challenge, which is why makepkg is a Bash script itself: it includes the PKGBUILD of the package being built via the source directive. AUR metadata files were created to get rid of some hacks, used by AUR package maintainers to work around incorrect parsing in the web interface. See also FS#25210, FS#15043, and FS#16394.

How it works

By adding a metadata file called ".AURINFO" to source tarballs to overwrite specific PKGBUILD fields. The format of this file is described in the AUR 2.1.0 release announcement. .AURINFO files are parsed line-by-line. The syntax for each line is key = value (yes, spaces around = are important, and do not include quotes around the values), where key is any of the following field names:

  • pkgbase: This is required by AUR 3, otherwise the infamous “only lowercase letters are allowed” error is reported. (Pacman uses the first pkgname if pkgbase is omitted.) Repeat pkgname if unsure.
  • pkgname
  • pkgver: package version, formatted as [epoch:]pkgver
  • pkgrel: release number of the package specific to Arch Linux
  • pkgdesc
  • url
  • license: in case of multiple licenses separate them by a space
  • depends: dependencies, one per line

Fields with other names are ignored. Multiple depends lines can be specified to add multiple dependencies. This format closely matches the .PKGINFO format that is used for binary packages in pacman/libalpm. It can be extended by field name prefixes or sections to support split packages later.

Working with makepkg --source

Note that makepkg --source will not automatically include an .AURINFO file in the source tarball. To include the .AURINFO file in the source tarball, use mkaurball from the package pkgbuild-introspection instead of makepkg --source.

What does not work

  • Multiple architectures (x86_64 dependencies tend to be more numerous, so just put them)

pkgbuild-introspection and mkaurball

pkgbuild-introspection is a set of tools for generating .AURINFO files. One of the provided tools is mkaurball, which is a script that runs makepkg --source, generates an .AURINFO file, and inserts it into the resulting source package.

Tip: mkaurball is a wrapper for makepkg --source. When creating source packages for inclusion in the AUR, use mkaurball instead of running makepkg --source directly.

Install the package pkgbuild-introspection from the official repositories.

See also