/[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.1 Revision 1.2
242 242
243<section> 243<section>
244<title>Getting Started With Trac</title> 244<title>Getting Started With Trac</title>
245<body> 245<body>
246<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 246<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
247very popular with open source developers.</p> 247very popular with open source developers.</p>
248 248
249<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> 249<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>
250 250
251<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> 251<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>
252 252
253<p>We have installed several Trac plugins, which we hope will make your wiki even 253<p>We have installed several Trac plugins, which we hope will make your wiki even
254more useful to you. If you come across any additional plugins that you'd like 254more useful to you. If you come across any additional plugins that you'd like
255to see installed, please let us know, and we'll take a look at them.</p> 255to see installed, please let us know, and we'll take a look at them.</p>
256 256
257<impo>more here, including details about each Trac plugin that we have installed</impo> 257<ul>
258<li><e>LayOnTrac</e> - lists the packages from the overlay.</li>
259<li><uri link="http://muness.textdriven.com/trac/wiki/tags/Setup">TracTags</uri> - displays a tag cloud</li>
260<li><uri link="http://trac.edgewall.org/wiki/WebAdmin">TracWebAdmin</uri> - provides web-based admin panel for Trac</li>
261</ul>
262
263<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>
264
265<ul>
266<li><uri link="http://trac-hacks.org/wiki/AddCommentMacro">AddComment</uri> - allows visitors to add comments to the bottom of your pages</li>
267<li><uri link="http://trac-hacks.org/wiki/FootNoteMacro">FootNote</uri> - adds support for adding footnotes to a page</li>
268<li><uri link="http://trac-hacks.org/wiki/TocMacro">TOC</uri> - adds support for publishing a Table of Contents on a page</li>
269</ul>
270
258</body> 271</body>
259</section> 272</section>
260 273
261<section> 274<section>
262<title>Getting Started With Subversion</title> 275<title>Getting Started With Subversion</title>
263<body> 276<body>
264<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> 277<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>
265 278
266<p>If you have never used Subversion before, the <uri link="http://svnbook.red-bean.com/">online book</uri> is an excellent online book for Subversion. You can buy it in dead-tree format too if you 279<p>If you have never used Subversion before, the <uri link="http://svnbook.red-bean.com/">online book</uri> is an excellent online book for Subversion. You can buy it in dead-tree format too if you prefer.</p>
267prefer.</p>
268 280
269<impo>more here, including basic checkout, status, commit and update commands</impo> 281<p>Here are some basic commands to get you started.</p>
282<pre caption="Checking out your overlay">svn co http://overlays.gentoo.org/proj/php</pre>
283<pre caption="Seeing which files need committing">svn status</pre>
284<pre caption="Adding files to your overlay">svn add my.ebuild</pre>
285<pre caption="Committing your changes">svn commit -m 'My changelog entry'</pre>
270 286
271</body> 287</body>
272</section> 288</section>
273 289
274<section> 290<section>
275<title>Layman</title> 291<title>Layman</title>
276<body> 292<body>
277<p>We are telling users to use layman to download and manage your overlay. 293<p>We are telling users to use layman to download and manage your overlay.
278layman 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> 294layman 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>
279 295
280<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> 296<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>
281</body> 297</body>
282</section> 298</section>
283 299
284<section> 300<section>
285<title>Auto-Sync From Portage</title> 301<title>Auto-Sync From Portage</title>
286<body> 302<body>
287<p>Your packages in the Portage tree are always at risk of being changed without 303<p>Your packages in the Portage tree are always at risk of being changed without
288you knowing about it in advance. Arch teams need to be able to keyword 304you knowing about it in advance. Arch teams need to be able to keyword
289packages (and fix arch-specific brokenness), the QA team fix perceived 305packages (and fix arch-specific brokenness), the QA team fix perceived
290standards violations, and occaisionally developers will edit packages that 306standards violations, and occaisionally developers will edit packages that
291they shouldn't.</p> 307they shouldn't.</p>
292 308
293<p>You need to make sure that the changes made in Portage aren't lost the next 309<p>You need to make sure that the changes made in Portage aren't lost the next
294time you copy your packages from your overlay back into Portage.</p> 310time you copy your packages from your overlay back into Portage.</p>
295 311
296<p>The PHP team have solved this problem by automatically copying their packages 312<p>The PHP team have solved this problem by automatically copying their packages
297from Portage back into a 'portage' branch of their overlay every night. They 313from Portage back into a 'portage' branch of their overlay every night. They
298can then use Subversion (or Trac's timeline) to see what has changed every 314can then use Subversion (or Trac's timeline) to see what has changed every
299day.</p>
300
301<p>If you'd like to have this feature added to your overlay, contact CHTEKK.</p> 315day. If you'd like to have this feature added to your overlay, contact CHTEKK.</p>
316
302</body> 317</body>
303</section> 318</section>
304</chapter> 319</chapter>
305 320
306<chapter> 321<chapter>
307<title>Giving Access To Your Overlay To Others</title> 322<title>Giving Access To Your Overlay To Others</title>
308 323
309<section> 324<section>
310<title>Introduction</title> 325<title>Introduction</title>
311<body> 326<body>
312<p>One of the key features of o.g.o is that people who do not have write access 327<p>One of the key features of o.g.o is that people who do not have write access
313to the Gentoo Portage package tree can have write access to one or more 328to the Gentoo Portage package tree can have write access to one or more
314overlays. Several Gentoo projects have found that this is a great way to train 329overlays. Several Gentoo projects have found that this is a great way to train
315and evaluate potential Gentoo developers in a safe environment.</p> 330and evaluate potential Gentoo developers in a safe environment.</p>
316 331

Legend:
Removed from v.1.1  
changed lines
  Added in v.1.2

  ViewVC Help
Powered by ViewVC 1.1.20