From b5faeb6549c12af60265b3fb01f657a7ce1a8d0b Mon Sep 17 00:00:00 2001 From: W-Mark Kubacki Date: Sat, 29 Sep 2012 13:22:26 +0200 Subject: [PATCH] README has more hints and instructions for contributors --- README.rst | 51 ++++++++++++++++++++++++++++++++++++++++++--------- 1 file changed, 42 insertions(+), 9 deletions(-) diff --git a/README.rst b/README.rst index 672d7a4..55eb987 100644 --- a/README.rst +++ b/README.rst @@ -6,8 +6,8 @@ OSSDL overlay for Gentoo :primary source: http://git.ossdl.de/ :mirror: http://github.com/wmark/ossdl-overlay -Installation -============ +Installation and Usage +====================== To install:: mkdir -p /var/portage/overlays @@ -17,7 +17,40 @@ To install:: nano /etc/portage/make.conf || nano /etc/make.conf PORTDIR_OVERLAY="/var/portage/overlays/ossdl" -By the next ``emerge --sync`` or ``eix-sync -u`` the new packages should be available for search. +After the next ``emerge --sync`` or ``eix-sync -u`` the new packages should be available for search. + +Packages +-------- +Some packages are masked in Gentoo's main tree. If you want to unmask only the tested ones of this +overlay you can do so by adding to your ``/etc/portage/package.unmask``:: + + # category/package::overlay-name + + www-servers/apache::OSSDL + app-admin/apache-tools::OSSDL + +Policies +-------- + +If a package has been "keyworded" by the Gentoo devs and I don't encounter any errors anddeem it +stable/sufficient enough for production use then the keyword is stripped in this overlay (thus +marking the package as 'stable'). That tests are limited to the following systems/architectures: + +- Intel — 2nd and 3rd generation Core/Xeons +- AMD — Phenom II and Istanbul (sorry, cannot test on K8) +- ARM — SheevaPlug (ARM9) and Cortex-A15 multicore server (cannot disclose more due to NDA) + +If you want to include an ebuild into this overlay then please fork it, add your ebuild, and finally +email me the link. Whenever I write 'me' in this README indeed 'us' is meant. ;-) +You can get commit-access to this git repository if you're willing to keep that package up-to-date. + +You — and that includes Gentoo developers — are not allowed to strip any Copyright lines. Whenever +you add something non-trivial just add your name to any existing list with a matching year or in +a separate line, should such list not already exist. + +Remove any values between dollar-signs retaining the key, for example: # $Header: $, and remove +changelog-files — we're not using Subversion. Remove any VI, VIM and similar lines from ebuilds +and files. Use tabs for indentation whenever possible. Optional ======== @@ -26,7 +59,7 @@ Portage configurations ---------------------- You can find ready portage configuration files - (un)maskings, keywordings and package.use - online -at http://git.ossdl.de/ . You will have to pick an appropriate branch, though. +at http://git.ossdl.de/portage-configurations . You will have to pick an appropriate branch, though. For example, for latest AMD processors of the *amdfam10* [1]_ family:: @@ -35,11 +68,11 @@ For example, for latest AMD processors of the *amdfam10* [1]_ family:: git clone -b amdfam10 https://bitbucket.org/wmark/portage-configurations.git ln -s portage/make.conf -Binhosts --------- +Binhost +------- Gentoo is not about compiling everything, don't waste your time on that. It is about customization. -If you want to stick to the standards for 90% of all packages and if you are only interested about +If you want to stick to the standards for 90% of all packages and if you are only interested in changing *USE flags* for the 10% where it matters - excellent. That is what the **binhosts** are for. Find pre-compiled Gentoo packages for your architecture [1]_ here: @@ -53,8 +86,8 @@ Obviously you will have to point Gentoo's *Portage* to these overlays. Modify yo FEATURES="parallel-fetch getbinpkg" PORTAGE_BINHOST="http://binhost.ossdl.de/AMD64/Intel/CoreIx/x86_64-pc-linux-gnu/" --- W-Mark Kubacki, 2012-08-01 +-- W-Mark Kubacki, 2012-08-01, 2012-09-29 .. [1] The *architectures* correspond with GCC's ``--march`` flag (modern Xeon, Core iX --> nocona; Phenom, Opteron (including Istanbul) --> amdfam10). - ARM9 is meant for and tested on SheevaPlugs, but should work on Iphone, too. + ARM9 is meant for and tested on SheevaPlugs with Marvell's Feroceon SoC.