/[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.12 - (hide annotations) (download) (as text)
Sun Oct 12 09:42:42 2008 UTC (10 years, 4 months ago) by robbat2
Branch: MAIN
Changes since 1.11: +3 -2 lines
File MIME type: application/xml
Add mention of gitweb.

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

  ViewVC Help
Powered by ViewVC 1.1.20