Difference between revisions of "Talk:Arch packaging standards"

From ArchWiki
Jump to: navigation, search
(License installing: new section)
(applied changes)
Line 7: Line 7:
  
 
==Proposed revision (shouldn't this already be added...?)==
 
==Proposed revision (shouldn't this already be added...?)==
 
===Packaging Standards===
 
The submitted PKGBUILDs <b>must not</b> build applications already in any of the official binary repositories under any circumstances. Exception to this strict rule may only be packages being newer or having extra features enabled and/or patches in compar<b>ison with the</b> official ones. In such occasions, the pkgname array should be different <s>to express that difference</s>.
 
 
When building packages for <b>the AUR</b>, <s>you should </s> adhere to the package guidelines below, especially if <s>you would like</s> <b>the intention is</b> to contribute <b>a</b> <s>your new</s> package to Arch Linux.
 
  
 
...
 
...
Line 97: Line 92:
  
 
...
 
...
 +
 
===Additional Guidelines===
 
===Additional Guidelines===
 
Be sure to read the above guidelines first'''--''' important points are listed on this page that will not be repeated in the following guideline pages...
 
Be sure to read the above guidelines first'''--''' important points are listed on this page that will not be repeated in the following guideline pages...

Revision as of 02:31, 3 January 2011

Comments

  • What encoding (ascii ? UTF-8 ?) should be used for text files in submitted packages ? --Airbag 13:43, 15 August 2006 (PDT)

Suggestions

  • Shouldn't we suggest using SHA1 hash and not the already broken one (MD5)? Tomato 15:47, 25 August 2010 (EDT)
  • The section about custom variables ("_blah=blah") is misleading. Nowadays custom variables are a common practice since they can simplify and/or modularize the PKGBUILD a great deal. The parts where they are recommended to not to be used should be modified. --Det 13:13, 14 September 2010 (EDT)

Proposed revision (shouldn't this already be added...?)

...

PKGBUILD Prototype

Should really tell the user that prototypes are in /usr/share/pacman from the pacman and abs packages. Maybe also a newpkg (pkgtools) mention.


# Contributor: Your Name email at domain dot com> (disguise your email...

Package Etiquette

...
Do not introduce new variables into your PKGBUILD build scripts ...

The AUR cannot detect the use of custom variables and so canno ... This can most often be seen in the source array, e.g.:

...
file, or alternatively by exporting the PACKAGER environment variable before building packages with makepkg:

$ export PACKAGER="John Doe@email"

...
The above example is taken from the wine package in extra. The optdepends information will automatically be printed out on installation/upgrade. from pacman 3.2.1, so one should not keep this kind of information in .install files any longer.

...

Package Naming

...
Version tags may not include hyphens. Letters, numbers, and periods only.

...
the package will be re-released to the AL (???) public and

...

Directories

...
Use /etc/{pkgname}/ where {pkgname} is the name of the package

...

Makepkg Duties

...
When makepkg is used to build a package for you, it does the following automatically:

...

Architectures

...
depending on which architectures it can be built on. You can also use State 'any' for architecture independent packages.

...

Licenses

...
The license array is being implemented little by little in the official repos, and it should be used in AUR packages as well. You can Use it as follows:

  • If the source tarball does not contain the license details and the license is only displayed on a website for example, then you need to copy the licen...
  • Add 'custom' to the licenses array. Optionally, you can replace 'custom' with 'custom:"name of license"'.

...
When pacman gets the ability to filter on licenses (i.e., make pacman download only GPL and BSD licensed software") dual (or more) licenses will be treated by pacman using 'or', rather than 'and' logic, thus pacman will consider ...

Submitting Packages to the AUR

The submitted PKGBUILDs MUST NOT build applications already in any of the official binary repositories under any circumstances. Exception to this strict rule may only be packages having extra features enabled and/or patches in compare to the official ones. In such an occasion the pkgname array should be different to express that difference. This gets repeated word for word in #Packaging Standards

...
To ensure the security of pkgs submitted to the AUR please ensure that the md5sum values have been correctly filled. The md5sum's can b...

...
Please add a comment line to the top of the PKGBUILD file that follows this format. Remembe...

...

# Contributor: Your Name <address at domain dot com></pre>

recommend the use of the namcap package, written by Jason Chu (jason@archlinux.org), to analyze the sanity of your packages. namcap will tell you warn about bad permissions, missing dependencies, un-needed dependencies, and other common mistakes. You can install the namcap package by...

...
Don't use replaces in a PKGBUILD unless the package is to be renamed, for example when Ethereal became Wireshark. If the package is an alternate version of an already existing package, use conflicts (and provides if that package is required by others). The main difference is: after syncing (-Sy) pacman immediately wants to replace an installed, 'offending' package upon encountering a package with the matching replaces anywhere in its repositories; conflicts on the other hand is only evaluated when actually installing the package, which is usually the desired behavior because it is less invasive.

...
One can easily build a tarball containing all the required files by using makepkg --source. This makes a tarball named $pkgname-$pkgver-$pkgrel.src.tar.gz, which you can then be uploaded to the AUR.

...

Additional Guidelines

Be sure to read the above guidelines first-- important points are listed on this page that will not be repeated in the following guideline pages...

License installing

It would be helpful if the wiki gave explicit instructions on how to do this, eg

  install -D -m644 LICENSE $pkgdir/usr/share/licenses/${pkgname}/LICENSE