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

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

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

Revision 1.10 Revision 1.11
3 3
4<guide link="/proj/en/overlays/devguide.xml"> 4<guide link="/proj/en/overlays/devguide.xml">
5<title>Gentoo Overlays: Developers' Guide</title> 5<title>Gentoo Overlays: Developers' Guide</title>
6 6
7<author title="Author"> 7<author title="Author">
8 <mail link="stuart@gentoo.org">Stuart Herbert</mail> 8 <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>
9</author> 15</author>
10 16
11<abstract>This guide helps developers understand how to use the Gentoo 17<abstract>This guide helps developers understand how to use the Gentoo
12Overlays service.</abstract> 18Overlays service.</abstract>
13 19
14<license/> 20<license/>
15 21
16<version>1.0</version> 22<version>2.0</version>
17<date>2006-07-29</date> 23<date>2008-10-12</date>
18 24
19<chapter> 25<chapter>
20<title>Introduction</title> 26<title>Introduction</title>
21 27
22<section> 28<section>
49<title>What Does overlays.gentoo.org Give Me?</title> 55<title>What Does overlays.gentoo.org Give Me?</title>
50<body> 56<body>
51<p>The overlays.gentoo.org service currently provides:</p> 57<p>The overlays.gentoo.org service currently provides:</p>
52<ul> 58<ul>
53<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> 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>
54<li><uri link="http://subversion.tigris.org">Subversion</uri> - a centralised version control system (distributed version control systems will be supported in future)</li> 60<li><uri link="http://subversion.tigris.org">Subversion</uri> - a centralised version control system</li>
55<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> 61<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<li><uri link="http://git.or.cz">Git</uri> - Fast Version Control System</li>
56</ul> 63</ul>
57 64
58<p>... all hosted on secure, backed-up Gentoo infrastructure, administered by 65<p>... all hosted on secure, backed-up Gentoo infrastructure, administered by
59<uri link="/proj/en/infrastructure">the Gentoo Infrastructure team</uri> (hardware / base OS) and <uri link="/proj/en/overlays">the Gentoo Overlays team</uri> 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>
60(wiki / VCS / ACLs).</p> 67(wiki / VCS / ACLs).</p>
61 68
62<p>Each overlay has separate authentication lists for Trac and for Subversion. 69<p>Each overlay has separate authentication lists for Trac, Subversion and Git.
63It's no problem at all to give someone write access to just Trac (e.g. for 70It's no problem at all to give someone write access to just Trac (e.g. for
64writing documentation) without giving them write access to Subversion.</p> 71writing documentation) without giving them write access to Subversion.</p>
65</body> 72</body>
66</section> 73</section>
67 74
138www.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 145www.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
139metastructure document</uri>, which is Gentoo's governing document). The project 146metastructure document</uri>, which is Gentoo's governing document). The project
140lead(s) are responsible for the project overlay, including its contents, and 147lead(s) are responsible for the project overlay, including its contents, and
141any problems it causes other Gentoo projects and developers.</p> 148any problems it causes other Gentoo projects and developers.</p>
142 149
143<p>To request a project overlay, the project's lead just needs to pop into 150<p>To request a SVN project overlay, the project's lead just needs to pop into
144#gentoo-overlays on IRC and ask for an overlay to be created. Or, if he/she 151#gentoo-overlays on IRC and ask for an overlay to be created. Or, if he/she
145prefers, drop an email to overlays@gentoo.org. We'll take care of the rest, 152prefers, drop an email to overlays@gentoo.org. We'll take care of the rest,
146including granting write access to all the members of your project (as listed 153including granting write access to all the members of your project (as listed
147on your project page).</p> 154on your project page).</p>
148 155
149<p>We will:</p> 156<p>To request a Git project overlay, just visit the <uri
157link="http://git.overlays.gentoo.org">git.overlays</uri> site, and follow the
158setup instructions, emailing the completed template as directed.</p>
159
160<p>For an SVN request, we will:</p>
150<ul> 161<ul>
151<li>create your overlay (trac site + svn)</li> 162<li>create your overlay (trac site + svn)</li>
152<li>add your overlay's RSS feed to the o.g.o homepage</li> 163<li>add your overlay's RSS feed to the o.g.o homepage</li>
153<li>create an o.g.o account for you if you don't already have one</li> 164<li>create an o.g.o account for you if you don't already have one</li>
154<li>give you write access to your overlay's Trac wiki and Subversion 165<li>give you write access to your overlay's Trac wiki and Subversion
155repository</li> 166repository</li>
156<li>give write access to all project members who already have an o.g.o 167<li>give write access to all project members who already have an o.g.o
157account</li> 168account</li>
158<li>contact all of the other project members, and sort out their access</li> 169<li>contact all of the other project members, and sort out their access</li>
159</ul> 170</ul>
171
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
160</body> 183</body>
161</section> 184</section>
162 185
163<section> 186<section>
164<title>Developer Overlays</title> 187<title>Developer Overlays</title>
168example is <uri link="http://overlays.gentoo.org/dev/tcort">tcort's overlay</uri>.</p> 191example is <uri link="http://overlays.gentoo.org/dev/tcort">tcort's overlay</uri>.</p>
169 192
170<p>If you have an @gentoo.org email address, and you've passed the ebuild quiz, 193<p>If you have an @gentoo.org email address, and you've passed the ebuild quiz,
171then you can have your own developer overlay on o.g.o.</p> 194then you can have your own developer overlay on o.g.o.</p>
172 195
173<p>To request a developer overlay, just pop into #gentoo-overlays on IRC and ask 196<p>To request a SVN developer overlay, just pop into #gentoo-overlays on IRC
174for an overlay to be created for you. Or, if you prefer, drop an email to 197and ask for an overlay to be created for you. Or, if you prefer, drop an email
175overlays@gentoo.org.</p> 198to overlays@gentoo.org.</p>
176 199
177<p>We will:</p> 200<p>To request a Git developer overlay, just visit the <uri
201link="http://git.overlays.gentoo.org">git.overlays</uri> site, and follow the
202setup instructions, emailing the completed template as directed.</p>
203
204<p>For an SVN request, we will:</p>
178<ul> 205<ul>
179<li>create your overlay (trac site + svn)</li> 206<li>create your overlay (trac site + svn)</li>
180<li>add your overlay's RSS feed to the o.g.o homepage</li> 207<li>add your overlay's RSS feed to the o.g.o homepage</li>
181<li>create an o.g.o account for you if you don't have one already</li> 208<li>create an o.g.o account for you if you don't have one already</li>
182<li>give you write access to your overlay's Trac wiki and Subversion 209<li>give you write access to your overlay's Trac wiki and Subversion
183repository</li> 210repository</li>
184</ul> 211</ul>
212
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>
185</body> 220</body>
186</section> 221</section>
187 222
188<section> 223<section>
189<title>A Word About Accounts</title> 224<title>A Word About Accounts</title>
327 362
328<chapter> 363<chapter>
329<title>Using git on overlays</title> 364<title>Using git on overlays</title>
330 365
331<section> 366<section>
332<title>Setting up git for committing with webdav</title>
333<body>
334<pre caption="add to your ~/.netrc">
335machine overlays.gentoo.org
336login (your-username)
337password (your-password)
338</pre>
339<p>Source: http://www.kernel.org/pub/software/scm/git/docs/howto/setup-git-server-over-http.txt</p>
340</body>
341</section>
342<section>
343<title>Initializing your overlay</title> 367<title>Initializing your overlay</title>
344<body> 368<body>
345<p>Before uploading you need to locally create a git repository and add all items:</p> 369<p>Before uploading you need to locally create a git repository and add all items:</p>
346<pre caption="go to your overlay">cd ~/my-overlay</pre> 370<pre caption="go to your overlay">cd ~/my-overlay</pre>
347<pre caption="create a new git repo">git init 371<pre caption="create a new git repo">git init
348git add . 372git add .
349git commit -m "populate overlay"</pre> 373git commit -m "populate overlay"</pre>
350<p>Note that this commit was only locally, now we get the server into the game. Be sure to add the trailing /</p> 374<p>Note that this commit was only locally, now we get the server into the game.</p>
351<pre caption="tell git the url">git-config remote.upload.url http://(your-username)@overlays.gentoo.org/git/(proj or dev)/(name)/</pre> 375<pre caption="tell git the url">git remote add origin git+ssh://git@git.overlays.gentoo.org/(proj or dev)/(name)</pre>
352<pre caption="finally get it up there">git push upload master</pre> 376<pre caption="finally get it up there">git push origin master</pre>
353<p>Source: http://www.kernel.org/pub/software/scm/git/docs/tutorial.html</p> 377<p>Source: http://www.kernel.org/pub/software/scm/git/docs/tutorial.html</p>
354</body></section> 378</body></section>
355 379
356<section> 380<section>
357<title>Checking out the overlay with git</title> 381<title>Checking out the overlay with git</title>
358<body> 382<body>
359<pre caption="clone it!">git clone http://overlays.gentoo.org/git/(proj or dev)/(name)/</pre> 383<pre caption="clone it!">git clone git://git@git.overlays.gentoo.org/(proj or dev)/(name)/</pre>
360</body> 384</body>
361</section> 385</section>
362</chapter> 386</chapter>
363 387
364<chapter> 388<chapter>
517<ul> 541<ul>
518<li>A: You can pop into #gentoo-overlays on IRC, and talk to us there. The 542<li>A: You can pop into #gentoo-overlays on IRC, and talk to us there. The
519 current staff are mostly in European timezones.</li> 543 current staff are mostly in European timezones.</li>
520<li>A: You can send an email to overlays@gentoo.org. Someone will answer you as 544<li>A: You can send an email to overlays@gentoo.org. Someone will answer you as
521 soon as possible.</li> 545 soon as possible.</li>
522<li>A: You can contact Stuart Herbert (the project leader) directly, via his
523 email address: stuart@gentoo.org.</li>
524</ul> 546</ul>
525 547
526<p>Q: Why can't I edit the access control list directly?</p> 548<p>Q: Why can't I edit the access control list directly?</p>
527<ul> 549<ul>
528<li>A: The access control list currently lives in htpasswd / htgroup files used 550<li>A: (SVN) The access control list currently lives in htpasswd / htgroup files used
529 by Apache. Only o.g.o admin staff have ssh access into the o.g.o box.</li> 551 by Apache. Only o.g.o admin staff have ssh access into the o.g.o box.</li>
552<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>
530</ul> 554</ul>
531</body> 555</body>
532</section> 556</section>
533 557
534<section> 558<section>

Legend:
Removed from v.1.10  
changed lines
  Added in v.1.11

  ViewVC Help
Powered by ViewVC 1.1.20