Here are the policies for the overlays.g.o service. If you host an overlay on overlays.g.o, or if you participate in the administration of overlays.g.o, you must follow these policies.
2. What Is The Overlays.g.o Service?
overlays.g.o provides a social workspace, for Gentoo projects and developers to publish their Gentoo package overlays in one location, where it's easy for devs and non-devs alike to collaborate.
overlays.g.o hosts two types of overlay:
"Project overlays" are overlays owned by recognised Gentoo project teams. Such teams are required to meet the definition of a project that you can find in our metastructure document.
"Project overlays" will have the same name as the Gentoo project team. Each project is only allowed a single overlay.
As far as this policy is concerned, project overlays are owned by the elected lead(s) of the project.
"Developer overlays" are overlays owned by individual Gentoo developers. These are the developers who have successfully taken the Gentoo developer quizzes, and who have been given commit access to the main Gentoo package tree.
Each "developer overlay" will have the same name as the developer who owns the overlay. Each developer is only allowed a single overlay.
As far as this policy is concerned, developer overlays are owned by the individual Gentoo developer who asked for the overlay to be hosted.
"Summer of Code overlays" are overlays that were created for the express purpose of hosting the development of a Google Summer of Code (SoC) project for Gentoo.
Each "SoC overlay" will be named for the SoC project. Multiple overlays may exist if required by the project.
As far as this policy is concerned, SoC overlays are owned by the SoC student.
External Gentoo-specific overlays
TODO
Overlays are created at the request of whoever will be the owner of the overlay.
Overlays are optional; no Gentoo developer or project team is required to setup an overlay.
Gentoo developers are free to host their overlays somewhere else.
To be clear:
Project overlays:
Developer overlays:
SoC overlays:
External overlays:
Common Requirements For Non-Devs
Note: With trac + svn, it's possible to give commit access separately to trac (ie, the wiki), and svn. |
We're deliberately trying to keep the rules on overlays to a minimum. Please, don't abuse the service, and force us to add more rules :(
What You Can And Cannot Store On overlays.g.o
overlays.g.o is for hosting package trees, their patchsets, any docs, and any downloadable tarballs that have nowhere else to be hosted.
TODO: Note that $UPSTREAM is allowed for Gentoo-specific/related.
There are no "secret" overlays.
All overlays are listed on the frontpage of overlays.g.o, and anyone is free to download the contents of an overlay.
If you need a secret overlay, we're not the service for you.
bugs.g.o is the OneTrueBugTrackingSystem(tm), even for overlays.
Moving Contributions From Overlays To The Portage Tree
Don't set up anything to automatically commit the contents of an overlay to the main Gentoo package tree. Ever.
Any code you take from an overlay and commit to the main Gentoo package tree needs to be thoroughly reviewed first. As the person committing the code to the main tree, it's your responsibility to ensure that the code meets the required standards.
Only the overlays.g.o administration team (listed on the overlays project page) have shell access into the overlays.g.o box. At the moment, account management (including resetting passwords) has to be done through the overlays administration team.
If you need anything doing to your overlay (adding/removing a user f.ex), please ask in #gentoo-overlays, and someone will help you as soon as possible.
Overlays can be removed at the discretion of the overlays administration team. Except for exceptional circumstances, we'll only remove overlays for the following reasons:
Exceptional circumstances may include:
All exceptional circumstances will be discussed on gentoo-dev before action is taken.
Important: Overlays are places where experimental changes can be made and tested. Please make sure you understand why things are the way they are in an overlay before you make a complaint about what's going on! |
10. Restrictions On New Software
We're always willing to listen to requests for different software we could offer as part of the service. Please bear in mind that we need to keep the amount of software offered to a minimum, to reduce the workload on the overlays administration team.
Any new software added to the service will have to meet the following requirements *as a minimum*. Please don't ask for a piece of software unless you've checked and made sure it meets these requirements.
The only access to overlays.g.o is via these two mechanisms:
The security mechanism for overlays.g.o is via HTTP basic auth, over SSL. We use both htpasswd and htgroup files to manage who can commit where.
A package can have finer-grained control via its own security mechanisms (e.g. trac's permissions list), but the package must be compatible with these access and security restrictions.
If you find a fault with this policy, please file a bug on bugs.g.o, and assign it to overlays@gentoo.org.
All policy changes will first be posted to gentoo-dev for discussion.
The contents of this document are licensed under the Creative Commons - Attribution / Share Alike license.