diff options
| -rw-r--r-- | web/html/guidelines.html | 169 |
1 files changed, 169 insertions, 0 deletions
diff --git a/web/html/guidelines.html b/web/html/guidelines.html new file mode 100644 index 0000000..1d8977e --- /dev/null +++ b/web/html/guidelines.html @@ -0,0 +1,169 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> + +<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> + <head> + <title>AUR Guidelines</title> + <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> + <link rel="stylesheet" type="text/css" + href="http://www.archlinux.org/docs/css/arch-styles.css" /> + </head> + + <body> + <h1>AUR Guidelines</h1> + + <div class="date">April 10, 2005</div> + <div class="version">1.0.0</div> + + <address> + Ben Mazer + <a class="email" href="mailto:blm@groknil.org">blm@groknil.org</a> + </address> + <address> + The Trusted Users + <a class="email" href="mailto:tur-users@archlinux.org">tur-users@archlinux.org</a> + </address> + + <h2 id="summary">Summary</h2> + <p> + Basic guidelines for the Arch User Repository. + </p> + + <h2 id="toc">Table Of Contents</h2> + <div class="toc"> + <ol> + <li><a href="#purpose">Purpose</a></li> + <li><a href="#user">The User</a> + <ol> + <li><a href="#usersub">Submitting Packages</a></li> + + </ol> + </li> + <li><a href="#tu">The TU</a> + <ol> + <li><a href="#tuaddition">Adding a TU</a></li> + <li><a href="#turemoval">Removing a TU</a></li> + <li><a href="#otherduties">Other Duties</a></li> + </ol> </li> + <li><a href="#tuguidelines">Guidelines for Package Maintenance</a> + <ol> + <li><a href="#accessing">Accessing the Repo</a></li> + <li><a href="#adopting">Adopting a package</a></li> + <li><a href="#disowning">Disowning a package</a></li> + <li><a href="#pkgguidelines">Packaging Etiquette</a></li> + </ol> + </li> + + </ol> + </div> + + <h2 id="purpose">Purpose</h2> + <p> + The <acronym title="Arch User Repository">AUR</acronym> is a community of Arch users, where packages outside of the core Arch distribution are maintained. The AUR Community Repo is a supplement to the EXTRA and CURRENT repositories; less popular packages will be maintained as a service to the general Arch-using population. Packages in the AUR will depend on EXTRA and CURRENT. <br /><br /> + The AUR was created to lift the burden on the developers. They should be allowed to focus on adding new features, rather than doing the mundane job of package maintenance. Therefore, all packages start inside the AUR, and as developers consider them crucial to the distribution, they will be adopted into EXTRA/CURRENT. The AUR was also created to allow easy participation. Arch is completely volunteer-based, and needs help from its users. Lastly, the AUR helps to further the Arch philosophy of KISS. The Arch Core (EXTRA/CURRENT/UNSTABLE) is a complete distribution, but it does not attempt to provide every single package. The AUR helps by maintaining less popular packages; but the AUR also follows KISS, and only popular packages from UNSUPPORTED will make it into the official AUR repository. + </p> + <h2 id="user">The User</h2> + <p> + Users of the AUR can do many things, the main function being to download and use packages. One can access the AUR by adding this to their pacman.conf file:<br /><br /> + <code>[community]<br />Server = ftp://ftp.archlinux.org/community/os/i686/</code><br /><br /> + + But a user can also help with package maintenance, by: submitting packages (and then maintaining them while they remain in UNSUPPORTED), filing bug reports, reporting out-of-date packages, helping with other user-submitted PKGBUILDs, and voting for packages that should be maintained by the TUs. Once a user account has been created, all functions can be performed inside the web interface. + <h3 id="usersub">Submitting Packages</h3> + <p> + Inside the web interface, a user can submit a tarball (tar.gz) of a directory containing build files for a package. The directory inside the tarball should contain a PKGBUILD, any .install files, patches, etc (<b>no binaries</b>). Examples of what a directory looks like can be seen inside /var/abs. <br /><br /> + When submitting a package, observe the following rules: + <ul> + <li>Check EXTRA, CURRENT, UNSTABLE, UNSUPPORTED, and AUR for the package. If it is inside any of those repositories in any form, do not submit the package (if the package is broken in some way, file a bug report). </li> + <li>Verify carefully that what you are uploading is correct. Follow the TU/Developer Package Building Guidelines exactly. Broken packages make the AUR messy, and prevent the TUs from doing their other duties. </li> + <li>If you are unsure about the package (or the build/submission process) in any way, submit the PKGBUILD to the AUR Mailing List for public review before adding it to the AUR.</li> + <li>Make sure the package is useful. Will anyone else want to use this package? Is it extremely specialized? If more than a few people would find this package useful, it is appropriate for submission. </li> + <li>Gain some experience before submitting packages. Build a few packages to learn the process and then submit. </li> + <li>Do not abandon packages. While in UNSUPPORTED, it is the user's job to maintain the package. If you do not want to maintain the package for some reason, post a message to the AUR Mailing List. </li> + </ul> + </p> + </p> + <h2 id="tu">The TU</h2> + <p> + The TU -or Trusted User- is a member of the community charged with keeping the AUR in working order. He maintains popular packages, and votes in administrative matters. A TU is elected from active community members by current TUs in a democratic process. TUs are the only members who have a final say in the direction of the AUR. + </p> + <h3 id="tuaddition">Adding a TU</h3> + <p> + TUs are only added as needed, and applications will only be accepted at certain times. Check the AUR website for details on whether applications are being accepted. <br /><br /> + TUs are elected democratically. If you would like to become a TU, a sponsor (another TU) is needed. After this is received, a request must be made on the AUR Mailing List by the sponsor. Ideally, a TU should have a specific subset of packages he wishes to maintain. <br /><br /> + + Four other votes must be received from other TUs for an applicant to be accepted. Once these have been received, the user will be given the proper passwords, and a TU will upgrade the user's status on the web interface. + <br /> + + </p> + <h3 id="turemoval">Sanctioning/Removing a TU</h3> + <p> + There is a basic sanctioning system for TUs. If a TU breaks a rule, either official or through "community standards" when he was already aware of this rule, one can request a sanction. If two other votes from TUs are received, a sanction will be added. After two sanctions, the TU will automatically come up for a removal vote. + <br /><br /> + If a TU is not working out, for any reason, one can request him to be expelled. Someone requesting a removal of a TU must state a valid reason, and why immediate removal is necessary. Almost always, previous sanctions will be needed. With four additional votes, that TU will be immediately removed and his packages will have to be adopted by a different TU. + + </p> + <h3 id="otherduties">Other Duties</h3> + <p> + All other duties (changing rules, adding new regulations, new features, etc) should be discussed openly on the AUR Mailing List and voted on. Various pieces of documentation and code can have specified "maintainers" that can perform basic updates (typo/bug fixes) without a vote, but any changes should be reported on the mailing list. Any major changes should receive a simple majority vote. + </p> + <h2 id="tuguidelines">Guidelines for Package Maintenance</h2> + <p> + </p> + <h3 id="accessing">Accessing the Repo</h3> + <p> + Follow these instructions for uploading/modifying packages: + <ol> + <li>Install the "tupkg" package.</li> + <li>Email Jason (<a class='email' href="mailto:jason@archlinux.org">jason@archlinux.org</a>) for a CVS account.</li> + <li>Run the following commands to checkout the AUR CVS:<br /> + <kbd> + export CVSROOT=":pserver:<userid>@cvs.archlinux.org:/home/cvs-community"<br /> + cvs login<br /> + cvs co community</kbd></li> + <li>To add a PKGBUILD and other build files:<br /> + <kbd> + cvs add <directory><br /> + cd <directory><br /> + cvs add PKGBUILD<br /> + .<br /> + .<br /> + cvs commit</kbd></li> + <li>To upload a binary package: + <kbd>tupkg --user <userid> --password <password> <packagefile.pkg.tar.gz></kbd></li> + <li>After uploading a package and committing the build files, tag the files with this command: + <kbd>cvs tag -cFR CURRENT <newpackagebuilddir></kbd></li> + <li>Package changes should be available within 10 minutes. Verify everything was uploaded properly, then select the newly added or updated package in the web interface and set yourself as the maintainer.</li> + </ol> + </p> + <h3 id="adopting">Adopting Packages</h3> + <p> + A TU may adopt any package at any time. But because the TU's time is limited, he should try to only adopt popular packages. The voting mechanism in the AUR allows a TU to quickly gage which packages users want. <br /><br /> + + If a package receives 25 votes, it may be adopted by a TU. A maintainer should adopt it via the web interface. That maintainer is then responsible for bug fixes and new version updates. Packages must be properly cleaned and fixed after adoption. + </p> + + <h3 id='disowning'>Disowning packages</h3> + <p> + If a TU can't or doesn't want to maintain a package any longer, a notice should be posted to the AUR Mailing List, so another TU can maintain it. A package can still be disowned even if no other TU wants to maintain it, but the TUs should try not to drop many packages (they shouldn't take on more than they have time for). If a package has become obsolete or isn't used any longer, it can be removed completely as well. + </p> + <h3 id="pkgguidelines">Packaging Etiquette</h3> + <p> + Adhere to the following rules when building/maintaining packages: + <br /> + <ul> + <li>Follow all rules in the <a href="http://www.archlinux.org/docs/en/guide/install/arch-install-guide.html#build">Arch Packaging Guidelines</a>.</li> + <li>Always run Namcap on all packages and PKGBUILDs.</li> + <li>All important messages should be echoed inside the .install file. For example, if a package needs extra setup to work, directions should be echoed. </li> + <li>Any optional dependencies that aren't needed to run the package or have it generally function shouldn't be included, but a warning message inside the .install file should echo something like: "To enable SMB support, download the Samba package."</li> + + <li>Always look at current packages for ideas on how various problems should be handled. Most problems have already been solved. </li> + <li>Dependencies are the most common packaging error. Namcap can help detect them, but it is not always correct. Verify dependencies by looking at source documentation and the program website. </li> + <li>All packages should be buildable as a user, under fakeroot. </li> + <li>New user creation should only be done when absolutely necessary. </li> + <li>Always fill out all applicable fields in the PKGBUILD (never forget a URL, md5sum, etc). The LICENSE variable is not currently used, but will be very shortly. </li> + <li>All custom variables should begin with an underscore (_). </li> + <li>A PKGBUILD should never modify any files outside of the build directory. </li> + </ul> + </p> + </body> +</html> |