/[gentoo]/xml/htdocs/proj/en/overlays/devguide.xml
Gentoo

Contents of /xml/htdocs/proj/en/overlays/devguide.xml

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.11 - (hide annotations) (download) (as text)
Sun Oct 12 09:40:34 2008 UTC (9 years, 8 months ago) by robbat2
Branch: MAIN
Changes since 1.10: +53 -29 lines
File MIME type: application/xml
Update devguide to elevate Git to a first-class overlays SCM, with new instructions similar to git.overlays.gentoo.org. Remove the mention of Stu as project leader, since he retired long ago.

1 stuart 1.1 <?xml version="1.0" encoding="UTF-8"?>
2     <!DOCTYPE guide SYSTEM "/dtd/guide.dtd">
3    
4     <guide link="/proj/en/overlays/devguide.xml">
5     <title>Gentoo Overlays: Developers' Guide</title>
6    
7     <author title="Author">
8 robbat2 1.11 <mail link="stuart">Stuart Herbert</mail>
9     </author>
10     <author title="Author">
11     <mail link="jokey">Markus Ullmann</mail>
12     </author>
13     <author title="Author">
14     <mail link="robbat2">Robin H. Johnson</mail>
15 stuart 1.1 </author>
16    
17     <abstract>This guide helps developers understand how to use the Gentoo
18     Overlays service.</abstract>
19    
20     <license/>
21    
22 robbat2 1.11 <version>2.0</version>
23     <date>2008-10-12</date>
24 stuart 1.1
25     <chapter>
26     <title>Introduction</title>
27    
28     <section>
29     <title>Audience</title>
30     <body>
31     <p>This document has been written for Gentoo developers and Gentoo staff members. If you are a Gentoo user, or you just want to start downloading and using overlays, please see <uri link="/proj/en/overlays/userguide.xml">the Gentoo Overlays User Guide</uri> instead.</p>
32     </body>
33     </section>
34    
35     <section>
36     <title>What is overlays.gentoo.org?</title>
37     <body>
38     <p><uri link="http://overlays.gentoo.org">overlays.gentoo.org</uri> provides social workspaces to allow Gentoo projects, developers and users to collaborate together on tomorrow's Gentoo packages. We do this by hosting overlays for Gentoo projects, and overlays for Gentoo developers.</p>
39     </body>
40     </section>
41    
42     <section>
43     <title>Who Can Use overlays.gentoo.org?</title>
44     <body>
45     <p>Any Gentoo project, or Gentoo developer, can have their own overlay hosted on overlays.gentoo.org, with the RSS feed from the changelog included on <uri link="http://overlays.gentoo.org">the overlays.gentoo.org homepage</uri>.</p>
46    
47     <p>Any Gentoo staff member or user (ie, anyone who doesn't have write access to
48     the main Portage package tree) can download and use the contents of any hosted
49     overlay. If you choose, you can also give users write access to your
50     overlay.</p>
51     </body>
52     </section>
53    
54     <section>
55     <title>What Does overlays.gentoo.org Give Me?</title>
56     <body>
57     <p>The overlays.gentoo.org service currently provides:</p>
58     <ul>
59     <li><uri link="http://trac.edgewall.com">Trac</uri> (a wiki w/ integrated subversion browser), for quickly creating and maintaining documentation about your overlay</li>
60 robbat2 1.11 <li><uri link="http://subversion.tigris.org">Subversion</uri> - a centralised version control system</li>
61 stuart 1.1 <li>Publishing the changelog for your overlay on <uri link="http://overlays.gentoo.org/">the o.g.o homepage</uri>, so that everyone who's interested can see what's going on</li>
62 robbat2 1.11 <li><uri link="http://git.or.cz">Git</uri> - Fast Version Control System</li>
63 stuart 1.1 </ul>
64    
65     <p>... all hosted on secure, backed-up Gentoo infrastructure, administered by
66     <uri link="/proj/en/infrastructure">the Gentoo Infrastructure team</uri> (hardware / base OS) and <uri link="/proj/en/overlays">the Gentoo Overlays team</uri>
67     (wiki / VCS / ACLs).</p>
68    
69 robbat2 1.11 <p>Each overlay has separate authentication lists for Trac, Subversion and Git.
70 stuart 1.1 It's no problem at all to give someone write access to just Trac (e.g. for
71     writing documentation) without giving them write access to Subversion.</p>
72     </body>
73     </section>
74    
75     <section>
76     <title>Why Should We Use overlays.gentoo.org?</title>
77     <body>
78     <p>You don't have to. You don't have to have an overlay at all, and if you do
79     have one, you are absolutely free to host your own overlay somewhere else.
80     You don't have to host an overlay on o.g.o for it to be considered
81     "official".</p>
82    
83     <p>The advantage of using overlays.gentoo.org is that we already have everything
84     setup for you. You don't need to admin your own server, or worry about
85     software upgrades. We take care of all of that for you.</p>
86     </body>
87     </section>
88    
89     <section>
90     <title>When Should We Not Use overlays.gentoo.org?</title>
91     <body>
92     <p>The purpose of o.g.o is to help bridge the gap between developers and users.
93     Gentoo is a community-based distribution, and we believe that our users are
94     just as important a part of that community as developers are.</p>
95    
96     <p>All of the overlays hosted on o.g.o are there for all users to download and
97     use. It's for users to make their own decision about what software they
98     install on their computers - and that includes choosing to use your overlay.
99     Some users will make bad decisions, and end up breaking their computer. They
100     may even end up blaming Gentoo as a result. That's okay; these people
101     probably go around blaming everyone but themselves for their own
102     mistakes anyway, and there's probably nothing you can do to change that.
103     But that still doesn't give any of us the right to choose for them.</p>
104    
105     <p>Users are free (in fact, they are encouraged) to provide constructive
106     feedback about anything to do with Gentoo - including all of the overlays
107     hosted on o.g.o. That feedback can come via bugs.g.o, via email to your
108     project team or directly to you, via the forums, or via IRC. We're not
109     talking about genuinely abusive users; we have no time for those, and no-one
110     expects you to have any time for them either.</p>
111    
112     <warn>If you're not happy with users using your overlay, and / or if you don't want
113     users bothering you about your overlay, then don't use o.g.o to host your
114     overlay.</warn>
115    
116     <p>The other thing we need to say is that o.g.o is for hosting overlays. You
117     can't use it to be $UPSTREAM for your packages. If that's the kind of hosting
118     you need, you can use services such as <uri link="http://www.sourceforge.net/">SourceForge.net</uri>, <uri link="http://www.berlios.de">Berlios</uri>, or
119     Patrick's <uri link="http://www.gentooexperimental.org">GentooExperimental.org</uri>.</p>
120     </body>
121     </section>
122     </chapter>
123    
124     <chapter>
125     <title>Requesting An Overlay</title>
126    
127     <section>
128     <title>Introduction</title>
129     <body>
130     <p>There are two types of overlay - "project" overlays, and "developer"
131     overlays. The only difference between them is responsibility and
132     accountability.</p>
133    
134     <impo>Before requesting an overlay, please make sure that you have read our <uri link="/proj/en/overlays/policy.xml">Policy Document</uri>. It clearly sets out what's allowed and what is not, and what your responsibilities will be.</impo>
135     </body>
136     </section>
137    
138     <section>
139     <title>Project Overlays</title>
140     <body>
141     <p>"Project" overlays are overlays for official Gentoo projects. A good
142     example is <uri link="http://overlays.gentoo.org/proj/php">the PHP Overlay</uri>.</p>
143    
144     <p>An official Gentoo project is a project that has a project page on
145     www.gentoo.org, and that has an elected lead. (This definition comes from <uri link="http://www.gentoo.org/proj/en/glep/glep-0039.html">the
146     metastructure document</uri>, which is Gentoo's governing document). The project
147     lead(s) are responsible for the project overlay, including its contents, and
148     any problems it causes other Gentoo projects and developers.</p>
149    
150 robbat2 1.11 <p>To request a SVN project overlay, the project's lead just needs to pop into
151 stuart 1.1 #gentoo-overlays on IRC and ask for an overlay to be created. Or, if he/she
152     prefers, drop an email to overlays@gentoo.org. We'll take care of the rest,
153     including granting write access to all the members of your project (as listed
154     on your project page).</p>
155    
156 robbat2 1.11 <p>To request a Git project overlay, just visit the <uri
157     link="http://git.overlays.gentoo.org">git.overlays</uri> site, and follow the
158     setup instructions, emailing the completed template as directed.</p>
159    
160     <p>For an SVN request, we will:</p>
161 stuart 1.1 <ul>
162     <li>create your overlay (trac site + svn)</li>
163     <li>add your overlay's RSS feed to the o.g.o homepage</li>
164     <li>create an o.g.o account for you if you don't already have one</li>
165     <li>give you write access to your overlay's Trac wiki and Subversion
166     repository</li>
167     <li>give write access to all project members who already have an o.g.o
168     account</li>
169     <li>contact all of the other project members, and sort out their access</li>
170     </ul>
171 robbat2 1.11
172     <p>For an Git request, we will:</p>
173     <ul>
174     <li>create your overlay (git, no trac)</li>
175     <li>add your overlay's RSS feed to the o.g.o homepage</li>
176     <li>create an git.o.g.o account for you if you don't already have one</li>
177     <li>give you write access to your overlays Git repository</li>
178     <li>give write access to all project members who already have an o.g.o account</li>
179     <li>contact all of the other project members, and sort out their access</li>
180     </ul>
181    
182    
183 stuart 1.1 </body>
184     </section>
185    
186     <section>
187     <title>Developer Overlays</title>
188     <body>
189    
190     <p>"Developer" overlays are overlays owned by individual Gentoo developers. One
191     example is <uri link="http://overlays.gentoo.org/dev/tcort">tcort's overlay</uri>.</p>
192    
193     <p>If you have an @gentoo.org email address, and you've passed the ebuild quiz,
194     then you can have your own developer overlay on o.g.o.</p>
195    
196 robbat2 1.11 <p>To request a SVN developer overlay, just pop into #gentoo-overlays on IRC
197     and ask for an overlay to be created for you. Or, if you prefer, drop an email
198     to overlays@gentoo.org.</p>
199    
200     <p>To request a Git developer overlay, just visit the <uri
201     link="http://git.overlays.gentoo.org">git.overlays</uri> site, and follow the
202     setup instructions, emailing the completed template as directed.</p>
203 stuart 1.1
204 robbat2 1.11 <p>For an SVN request, we will:</p>
205 stuart 1.1 <ul>
206     <li>create your overlay (trac site + svn)</li>
207     <li>add your overlay's RSS feed to the o.g.o homepage</li>
208     <li>create an o.g.o account for you if you don't have one already</li>
209     <li>give you write access to your overlay's Trac wiki and Subversion
210     repository</li>
211     </ul>
212 robbat2 1.11
213     <p>For an Git request, we will:</p>
214     <ul>
215     <li>create your overlay (git, no trac)</li>
216     <li>add your overlay's RSS feed to the o.g.o homepage</li>
217     <li>create an git.o.g.o account for you if you don't already have one</li>
218     <li>give you write access to your overlays Git repository</li>
219     </ul>
220 stuart 1.1 </body>
221     </section>
222    
223     <section>
224     <title>A Word About Accounts</title>
225     <body>
226     <p>Because o.g.o is designed to support a blend of both Gentoo developers and
227     Gentoo users, we don't create 'real' system-level accounts on the o.g.o host.
228     All access is currently through Apache, and is managed by Apache htpasswd and
229     htgroup files.</p>
230    
231     <impo>You do *not* have SSH access to o.g.o.</impo>
232     </body>
233     </section>
234     </chapter>
235    
236     <chapter>
237     <title>Working With Your Overlay</title>
238    
239     <section>
240     <title>Introduction</title>
241     <body>
242     <p>You can access your overlay as soon as it has been created. Project and
243     developer overlays have different URLs, so that everyone can tell one from the
244     other, but otherwise they are identical in every way.</p>
245    
246     <p>There are *no* read restrictions on overlays or wikis. Everyone has full
247     read access to all overlays and wikis. If you need a 'secret' overlay of some
248     kind, then o.g.o is not for you.</p>
249     </body>
250     </section>
251    
252     <section>
253     <title>Accessing Project Overlays</title>
254     <body>
255     <p>If your project overlay is called 'foo', your Trac wiki site will be
256     here: http://overlays.gentoo.org/proj/foo/</p>
257    
258     <p>To checkout your Subversion repository, use:</p>
259 robbat2 1.10 <pre caption="Checkout your project overlay">svn co https://overlays.gentoo.org/svn/proj/foo/</pre>
260    
261     <p>While you may perform read-only actions via unsecure HTTP, you must perform
262     all commits via HTTPS. If you need to switch between modes, use:</p>
263     <pre caption="Switching your project overlay from HTTP to HTTPS">svn sw --relocate http://overlays.gentoo.org/svn/proj/foo/ https://overlays.gentoo.org/svn/proj/foo/</pre>
264 stuart 1.1
265     <p>We maintain <uri link="http://overlays.gentoo.org/proj/">a full list of project overlays hosted on overlays.gentoo.org</uri>.</p>
266     </body>
267     </section>
268    
269     <section>
270     <title>Accessing Developer Overlays</title>
271     <body>
272     <p>If your Gentoo email address is 'foo@gentoo.org', your Trac wiki site will be
273     here: http://overlays.gentoo.org/dev/foo/</p>
274    
275     <p>To checkout your Subversion repository, use:</p>
276 robbat2 1.10 <pre caption="Checkout your developer overlay">svn co https://overlays.gentoo.org/svn/dev/foo/</pre>
277    
278     <p>While you may perform read-only actions via unsecure HTTP, you must perform
279     all commits via HTTPS. If you need to switch between modes, use:</p>
280     <pre caption="Switching your developer overlay from HTTP to HTTPS">svn sw --relocate http://overlays.gentoo.org/svn/dev/foo/ https://overlays.gentoo.org/svn/dev/foo/</pre>
281 stuart 1.1
282     <p>We maintain <uri link="http://overlays.gentoo.org/dev/">a full list of developer overlays hosted on overlays.gentoo.org</uri>.</p>
283     </body>
284     </section>
285    
286     <section>
287     <title>Getting Started With Trac</title>
288     <body>
289     <p>Your overlay comes with <uri link="http://trac.edgewall.com">Trac</uri>. Trac is a wiki, a subversion repository browser, and a bug tracking system that's
290     very popular with open source developers.</p>
291    
292     <p>We have disabled the bug tracking system in Trac. Use <uri link="http://bugs.gentoo.org">Gentoo's bugzilla</uri> for bug tracking your overlay.</p>
293    
294     <p>Your overlay's RSS feed - the one that is shown on <uri link="http://overlays.gentoo.org">the o.g.o homepage</uri> - comes from Trac's Timeline page.</p>
295    
296     <p>We have installed several Trac plugins, which we hope will make your wiki even
297     more useful to you. If you come across any additional plugins that you'd like
298     to see installed, please let us know, and we'll take a look at them.</p>
299    
300 stuart 1.2 <ul>
301     <li><e>LayOnTrac</e> - lists the packages from the overlay.</li>
302     <li><uri link="http://muness.textdriven.com/trac/wiki/tags/Setup">TracTags</uri> - displays a tag cloud</li>
303     <li><uri link="http://trac.edgewall.org/wiki/WebAdmin">TracWebAdmin</uri> - provides web-based admin panel for Trac</li>
304     </ul>
305    
306     <p>We have installed several Trac macros, which we hope will make your wiki even more useful to you. If you come across any additional macros that you'd like to see installed, please let us know, and we'll take a look at them.</p>
307    
308     <ul>
309     <li><uri link="http://trac-hacks.org/wiki/AddCommentMacro">AddComment</uri> - allows visitors to add comments to the bottom of your pages</li>
310     <li><uri link="http://trac-hacks.org/wiki/FootNoteMacro">FootNote</uri> - adds support for adding footnotes to a page</li>
311     <li><uri link="http://trac-hacks.org/wiki/TocMacro">TOC</uri> - adds support for publishing a Table of Contents on a page</li>
312     </ul>
313    
314 stuart 1.1 </body>
315     </section>
316    
317     <section>
318     <title>Getting Started With Subversion</title>
319     <body>
320     <p>Your overlay comes with <uri link="http://subversion.tigris.org">Subversion</uri>, a modern alternative to CVS. The advantages of Subversion over CVS include real versioning of directories, full changeset support, and it's much easier to do branching if you need to. The main disadvantage of Subversion is that it is slower than CVS, and that a local Subversion checkout requires more disk space.</p>
321    
322 stuart 1.3 <p>If you have never used Subversion before, the <uri link="http://svnbook.red-bean.com/">online book</uri> is an excellent way to learn Subversion. You can buy it in dead-tree format too if you prefer.</p>
323 stuart 1.1
324 stuart 1.2 <p>Here are some basic commands to get you started.</p>
325 robbat2 1.10 <pre caption="Checking out your overlay">svn co https://overlays.gentoo.org/proj/php</pre>
326 stuart 1.2 <pre caption="Seeing which files need committing">svn status</pre>
327     <pre caption="Adding files to your overlay">svn add my.ebuild</pre>
328     <pre caption="Committing your changes">svn commit -m 'My changelog entry'</pre>
329 stuart 1.1
330     </body>
331     </section>
332    
333     <section>
334     <title>Layman</title>
335     <body>
336     <p>We are telling users to use layman to download and manage your overlay.
337     layman is a utility written by <mail link="wrobel@gentoo.org">Gunnar Wrobel</mail> which makes it very easy for users to work with overlays.</p>
338    
339     <p>To get started with using layman, see <uri link="http://www.gentoo.org/news/en/gwn/20060522-newsletter.xml">Gentoo Weekly News for 22nd May</uri>, <uri link="http://gentoo-wiki.com/TIP_Overlays#layman">this article on Gentoo-Wiki.com</uri>, or the man page that comes with layman.</p>
340     </body>
341     </section>
342    
343     <section>
344     <title>Auto-Sync From Portage</title>
345     <body>
346     <p>Your packages in the Portage tree are always at risk of being changed without
347     you knowing about it in advance. Arch teams need to be able to keyword
348     packages (and fix arch-specific brokenness), the QA team fix perceived
349     standards violations, and occaisionally developers will edit packages that
350     they shouldn't.</p>
351    
352     <p>You need to make sure that the changes made in Portage aren't lost the next
353     time you copy your packages from your overlay back into Portage.</p>
354    
355     <p>The PHP team have solved this problem by automatically copying their packages
356     from Portage back into a 'portage' branch of their overlay every night. They
357 chtekk 1.9 can then use Subversion (or Trac's timeline) to see what has changed every day.</p>
358 stuart 1.1
359     </body>
360     </section>
361     </chapter>
362    
363     <chapter>
364 genstef 1.8 <title>Using git on overlays</title>
365    
366     <section>
367     <title>Initializing your overlay</title>
368     <body>
369     <p>Before uploading you need to locally create a git repository and add all items:</p>
370     <pre caption="go to your overlay">cd ~/my-overlay</pre>
371     <pre caption="create a new git repo">git init
372     git add .
373     git commit -m "populate overlay"</pre>
374 robbat2 1.11 <p>Note that this commit was only locally, now we get the server into the game.</p>
375     <pre caption="tell git the url">git remote add origin git+ssh://git@git.overlays.gentoo.org/(proj or dev)/(name)</pre>
376     <pre caption="finally get it up there">git push origin master</pre>
377 genstef 1.8 <p>Source: http://www.kernel.org/pub/software/scm/git/docs/tutorial.html</p>
378     </body></section>
379    
380     <section>
381     <title>Checking out the overlay with git</title>
382     <body>
383 robbat2 1.11 <pre caption="clone it!">git clone git://git@git.overlays.gentoo.org/(proj or dev)/(name)/</pre>
384 genstef 1.8 </body>
385     </section>
386     </chapter>
387    
388     <chapter>
389 stuart 1.1 <title>Giving Access To Your Overlay To Others</title>
390    
391     <section>
392     <title>Introduction</title>
393     <body>
394     <p>One of the key features of o.g.o is that people who do not have write access
395     to the Gentoo Portage package tree can have write access to one or more
396     overlays. Several Gentoo projects have found that this is a great way to train
397     and evaluate potential Gentoo developers in a safe environment.</p>
398    
399     <p>At the moment, only the Overlays team can update the access control lists for
400     overlays.gentoo.org. We will provide a web-based tool for managing the access
401     control lists at a later date. But, for now, if you need a change made,
402     please drop by #gentoo-overlays on IRC for assistance.</p>
403     </body>
404     </section>
405    
406     <section>
407     <title>Project Overlays: Giving Write Access To Team Members</title>
408     <body>
409     <p>Any developer listed on a team's project page on www.g.o can have write
410     access to the team's overlay. The project lead can ask on their behalf, or
411     the developer can come and ask for access themselves.</p>
412    
413     <p>If the developer doesn't have an o.g.o account yet, he/she will need to drop
414     by #gentoo-overlays so that we can create an account for them.</p>
415     </body>
416     </section>
417    
418     <section>
419     <title>Project Overlays: Giving Write Access To Other Gentoo
420     Developers</title>
421     <body>
422    
423     <p>Any Gentoo developer *not* listed on a team's project page on www.g.o can
424     have write access to the team's overlay. The request for write access must
425     come from a member of the team. It doesn't have to come from the project
426     lead.</p>
427    
428     <p>If the developer doesn't have an o.g.o account yet, he/she will need to drop
429     by #gentoo-overlays so that we can create an account for them.</p>
430     </body>
431     </section>
432    
433     <section>
434     <title>Project Overlays: Giving Write Access To Gentoo Users</title>
435     <body>
436     <p>Any Gentoo user can have write access to the team's overlay. The request for
437     write access must come from one of the project's leads. You can request that
438     we give the user write access to Trac, to Subversion, or to both. (We will
439     assume that the request is for write access to both, unless you say
440     otherwise).</p>
441    
442     <p>We cannot accept these requests from anyone other than a project lead. If
443     your project only has the one lead, we recommend electing a second lead. If
444     your one and only lead is AWOL, consider electing a replacement :)</p>
445    
446     <p>If the user doesn't have an o.g.o account yet, he/she will need to drop by
447     #gentoo-overlays so that we can create an account for them.</p>
448     </body>
449     </section>
450    
451     <section>
452     <title>Developer Overlays: Giving Write Access To Gentoo Developers</title>
453     <body>
454     <p>Any Gentoo developer can have write access to your developer overlay. The
455     developer can ask us directly; we will not give access until we've checked
456     with you. You can also ask us to give write access to any named
457     developer.</p>
458    
459     <p>If the developer doesn't have an o.g.o account yet, he/she will need to drop
460     by #gentoo-overlays so that we can create an account for them.</p>
461     </body>
462     </section>
463    
464     <section>
465     <title>Developer Overlays: Giving Write Access To Gentoo Users</title>
466     <body>
467     <p>Any Gentoo user can have write access to your developer's overlay. The
468     request for write access must come from you. You can request that we give
469     the user write access just to Trac, just to Subversion, or to both. (We will
470     assume that the request is for write access to both unless you say
471     otherwise).</p>
472    
473     <p>We cannot accept these requests from anyone else other than you. If you find
474     yourself giving access to a lot of other people, it might be that you should
475     consider setting up a new project, and transfering your work there
476     instead.</p>
477    
478     <p>If the user doesn't have an o.g.o account yet, he/she will need to drop by
479     #gentoo-overlays so that we can create an account for them.</p>
480     </body>
481     </section>
482     </chapter>
483    
484     <chapter>
485     <title>Accessing Someone Else's Overlay</title>
486    
487     <section>
488     <title>Using An Overlay</title>
489     <body>
490     <p>Everyone has full read access to every overlay. We recommend that you
491     use</p>
492     <pre caption="Install layman">
493     emerge layman
494     echo 'source /usr/portage/local/layman/layman.conf' &gt;&gt; /etc/make.conf
495     </pre>
496    
497 wrobel 1.6 <note>
498 wrobel 1.7 Layman will create "/usr/portage/local/layman/make.conf" once you add
499     your first overlay. But if you do not plan to install an overlay
500     immediately you should ensure that this file actually exists and
501     contains the empty variable "PORTDIR_OVERLAY". Otherwise portage will
502     complain. You can run "echo PORTDIR_OVERLAY=\"\" >
503     /usr/portage/local/layman/make.conf" in order to have the file created
504     correctly.
505 wrobel 1.6 </note>
506    
507 stuart 1.1 <p>After that, to view the list of overlays, use</p>
508    
509     <pre caption="List overlays that layman knows about">layman -L</pre>
510    
511     <p>To install an overlay, use</p>
512     <pre caption="Install an overlay">layman -a &lt;overlay-name&gt;</pre>
513    
514     <p>You can now install packages from the overlay.</p>
515     </body>
516     </section>
517    
518     <section>
519     <title>Requesting Write Access</title>
520     <body>
521     <p>If you want write access to a project overlay, contact a member of the
522     project team, and ask them for access. If they approve your request, they
523     will arrange for you to have write access, by contacting the Overlays
524     team.</p>
525    
526     <p>If you want write access to a developer's overlay, contact the developer
527     directly, and ask them for access. If they approve your request, they will
528     arrange for you to have write access, by contacting the Overlays team.</p>
529     </body>
530     </section>
531     </chapter>
532    
533     <chapter>
534     <title>Frequently Asked Questions</title>
535    
536     <section>
537     <title>o.g.o Administration</title>
538     <body>
539    
540     <p>Q: How do I contact the o.g.o admin staff?</p>
541     <ul>
542     <li>A: You can pop into #gentoo-overlays on IRC, and talk to us there. The
543     current staff are mostly in European timezones.</li>
544     <li>A: You can send an email to overlays@gentoo.org. Someone will answer you as
545     soon as possible.</li>
546     </ul>
547    
548     <p>Q: Why can't I edit the access control list directly?</p>
549     <ul>
550 robbat2 1.11 <li>A: (SVN) The access control list currently lives in htpasswd / htgroup files used
551 stuart 1.1 by Apache. Only o.g.o admin staff have ssh access into the o.g.o box.</li>
552 robbat2 1.11 <li>A: (Git) The access control list currently lives in the gitosis-admin repository,
553     which is writable only by the o.g.o staff.</li>
554 stuart 1.1 </ul>
555     </body>
556     </section>
557    
558     <section>
559     <title>Security</title>
560     <body>
561     <p>Q: Is my overlay available via https?</p>
562     <ul>
563 stuart 1.4 <li>A: Yes, it is.</li>
564 stuart 1.1 </ul>
565     </body>
566     </section>
567    
568     <section>
569     <title>Multiple Overlays</title>
570     <body>
571    
572     <p>Q: Can I have multiple overlays?</p>
573     <ul>
574     <li>A: Yes, in a fashion. Inside your overlay, you can create
575     sub-directories, and put separate package trees inside those sub-directories.
576     Please take a look at the PHP project overlay for an example.</li>
577     </ul>
578     </body>
579     </section>
580    
581     <section>
582     <title>Importing Existing Overlays</title>
583     <body>
584     <p>Q: I already have an overlay, and I'd like to move it to o.g.o. How do I
585     go about doing that?</p>
586     <ul>
587     <li>A: Create a tarball of your subversion repository, and put it somewhere
588     where it can be downloaded via http. We'll download it and install it onto
589     o.g.o for you.</li>
590     </ul>
591     <note>Make sure you tar up your repository, and not a checkout!</note>
592    
593     <p>Q: I have an overlay, but it doesn't use Subversion. How do I go about
594     moving it to o.g.o?</p>
595     <ul>
596     <li>A: Ask us to create a new, empty overlay for you. You can then use 'svn
597     import' to import your files into the new overlay. You'll lose your history,
598     but that can't be helped.</li>
599     <li>A: Search the Internet, and see if there is a tool to convert from your
600     existing version control software to Subversion. If there is, use that, and
601     then we can help you move it to o.g.o.</li>
602     <li>A: If your version control software is used by Trac, and it can be used
603     over HTTP, come and help us add
604     support for your version control software on o.g.o.</li>
605     </ul>
606     </body>
607     </section>
608    
609     <section>
610     <title>"Official" Overlays</title>
611     <body>
612     <p>Q: When is an overlay considered "official"?</p>
613     <ul>
614     <li>A: An "official" overlay is an overlay managed by a Gentoo project (for
615     project overlays) or a Gentoo developer (for developer overlays).</li>
616     </ul>
617    
618     <p>Q: Does an overlay have to be on o.g.o to be "official"?</p>
619     <ul>
620     <li>A: No.</li>
621     </ul>
622     </body>
623     </section>
624     </chapter>
625     </guide>

  ViewVC Help
Powered by ViewVC 1.1.20