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

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

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

Revision 1.4 Revision 1.5
3 3
4<guide link="/proj/en/overlays/userguide.xml"> 4<guide link="/proj/en/overlays/userguide.xml">
5<title>Gentoo Overlays: Users' Guide</title> 5<title>Gentoo Overlays: Users' 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> 9</author>
10 10
11<author title="Author">
12 <mail link="jokey">Markus Ullmann</mail>
13</author>
14
11<abstract>This guide helps users understand how to use the Gentoo Overlays service</abstract> 15<abstract>This guide helps users understand how to use the Gentoo Overlays service</abstract>
12 16
13<license/> 17<license/>
14 18
15<version>1.0</version> 19<version>1.1</version>
16<date>2006-07-30</date> 20<date>2008-10-30</date>
17 21
18<chapter> 22<chapter>
19<title>Introduction</title> 23<title>Introduction</title>
20<section> 24<section>
21<title>Audience</title> 25<title>Audience</title>
27</section> 31</section>
28 32
29<section> 33<section>
30<title>What Are Overlays?</title> 34<title>What Are Overlays?</title>
31<body> 35<body>
32<p>"Overlays" are package trees for Portage. They contain additional ebuilds for Gentoo. They are maintained by Gentoo developers, but are distributed separately from the main Portage tree.</p> 36<p>"Overlays" are package trees for Portage. They contain additional ebuilds for Gentoo. They are maintained by Gentoo developers and projects but distributed separately from the main Portage tree.</p>
33</body> 37</body>
34</section> 38</section>
35 39
36<section> 40<section>
37<title>Why Use Overlays?</title> 41<title>Why Use Overlays?</title>
45</ul> 49</ul>
46</body> 50</body>
47</section> 51</section>
48 52
49<section> 53<section>
50<title>What Is overlays.gentoo.org?</title> 54<title>What is the Gentoo Overlays Project?</title>
51<body> 55<body>
52<p><uri link="http://overlays.gentoo.org">overlays.gentoo.org</uri> provides social workspaces to allow Gentoo projects, 56<p>Gentoo Overlays provide social workspaces to allow Gentoo projects,
53developers and users to collaborate together on tomorrow's Gentoo packages. 57developers and users to collaborate together on tomorrow's Gentoo packages.
54We do this by host overlays for Gentoo projects, and overlays for Gentoo 58We do this by hosting overlays for Gentoo projects and developers.</p>
55developers.</p>
56</body> 59</body>
57</section> 60</section>
58 61
59<section> 62<section>
60<title>Are All Official Overlays Hosted On overlays.gentoo.org?</title> 63<title>Are All Official Overlays Hosted On overlays.gentoo.org?</title>
77<title>Installing Layman</title> 80<title>Installing Layman</title>
78<body> 81<body>
79<p>To install layman, follow these steps:</p> 82<p>To install layman, follow these steps:</p>
80<pre caption="Installing layman"> 83<pre caption="Installing layman">
81<i>emerge layman</i> 84<i>emerge layman</i>
82<i>echo "source /usr/portage/local/layman/make.conf" >> /etc/make.conf</i> 85<i>echo "source /usr/local/portage/layman/make.conf" >> /etc/make.conf</i>
83</pre> 86</pre>
84<note> 87<note>
85Layman will create "/usr/portage/local/layman/make.conf" once you add 88Layman will create "/usr/local/portage/layman/make.conf" once you add
86your first overlay. But if you do not plan to install an overlay 89your first overlay. But if you do not plan to install an overlay
87immediately you should ensure that this file actually exists and 90immediately you should ensure that this file actually exists and
88contains the empty variable "PORTDIR_OVERLAY". Otherwise portage will 91contains the empty variable "PORTDIR_OVERLAY". Otherwise portage will
89complain. You can run "echo PORTDIR_OVERLAY=\"\" > 92complain. You can run "echo PORTDIR_OVERLAY=\"\" >
90/usr/portage/local/layman/make.conf" in order to have the file created 93/usr/portage/local/layman/make.conf" in order to have the file created
92</note> 95</note>
93</body> 96</body>
94</section> 97</section>
95 98
96<section> 99<section>
97<title>Listing The Overlays Available</title> 100<title>Listing The Available Overlays</title>
98<body> 101<body>
99<p>To see the list of overlays available, run:</p> 102<p>To see the list of overlays available, run:</p>
100<pre caption="Listing the available overlays">layman -L</pre> 103<pre caption="Listing the available overlays">layman -L</pre>
101</body> 104</body>
102</section> 105</section>
135<section> 138<section>
136<title>Updating An Overlay</title> 139<title>Updating An Overlay</title>
137<body> 140<body>
138<p>To keep your installed overlays up to date, run:</p> 141<p>To keep your installed overlays up to date, run:</p>
139<pre caption="Updating All Installed Overlays"> 142<pre caption="Updating All Installed Overlays">
140layman --sync ALL 143layman -S
141</pre> 144</pre>
142<p>Please don't run this more than once a day, or you'll put too much strain on 145<p>Please don't run this more than once a day, or you'll put too much strain on
143Gentoo's infrastructure.</p> 146Gentoo's infrastructure.</p>
144</body> 147</body>
145</section> 148</section>
149<title>How To Get More Involved</title> 152<title>How To Get More Involved</title>
150 153
151<section> 154<section>
152<title>Introduction</title> 155<title>Introduction</title>
153<body> 156<body>
154<p>All Gentoo developers were users of Gentoo before they became developers. Our users aren't just the reason Gentoo exists today; they're our future volunteers too.</p> 157<p>All Gentoo developers were users of Gentoo before they became developers and still are users. Our users aren't just the reason Gentoo exists today; they're our future volunteers too.</p>
155 158
156<p>If you start contributing to a project, we'll give you write access to the 159<p>If you start contributing to a project, we'll give you write access to the
157project's overlay, and we'll provide mentors to help you contribute. 160project's overlay, and we'll provide mentors to help you contribute.
158Eventually, if we like what you do and the way you do it, we'll invite you to 161Eventually, if we like what you do and the way you do it, we'll invite you to
159go the whole hog and become a full Gentoo developer, with a nice shiny 162go the whole hog and become a full Gentoo developer.</p>
160@gentoo.org email address.</p>
161</body> 163</body>
162</section> 164</section>
163 165
164<section> 166<section>
165<title>How To Get Started</title> 167<title>How To Get Started</title>
171 173
172<p>Different developers preferred to be contacted in different ways. Some hang 174<p>Different developers preferred to be contacted in different ways. Some hang
173out on IRC, and may have their own channels for their projects. Examples of 175out on IRC, and may have their own channels for their projects. Examples of
174these include the PHP project (#gentoo-php), and the Webapps project 176these include the PHP project (#gentoo-php), and the Webapps project
175(#gentoo-web). Others prefer to be contacted by email only. The only way 177(#gentoo-web). Others prefer to be contacted by email only. The only way
176you'll find out is to try and make contact, and take it from there.</p> 178you'll find out is to try and make contact, and take it from there. Commonly people in #gentoo-bugs on freenode IRC know where to find the people in question.</p>
177</body> 179</body>
178</section> 180</section>
179 181
180<section> 182<section>
181<title>Working With Subversion</title> 183<title>Working With Subversion</title>
182<body> 184<body>
183<p>You'll need to get comfortable working with Subversion. Subversion is the 185<p>Subversion is one version control software we use to manage the contents of our overlays. If you have never used Subversion before, the Subversion book is an excellent way to learn Subversion. You can buy it in dead-tree format if you prefer or read it online for free.
184version control software we use to manage the contents of our overlays. 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> 186</p>
187</body>
188</section>
189
190<section>
191<title>Working With Git</title>
192<body>
193<p>Git is another version control software we use to manage the contents of our overlays. To get in touch with it, see the tutorial provided on the homepage.</p>
185</body> 194</body>
186</section> 195</section>
187 196
188<section> 197<section>
189<title>Further Information</title> 198<title>Further Information</title>
198<title>Frequently Asked Questions</title> 207<title>Frequently Asked Questions</title>
199<section> 208<section>
200<body> 209<body>
201<p>Q: Do you host overlays for users?</p> 210<p>Q: Do you host overlays for users?</p>
202<ul> 211<ul>
203<li>A: No, we do not. If you want an overlay of your own on o.g.o, you must first become a Gentoo developer.</li> 212<li>A: No, we do not. If you want an overlay of your own on (git.)overlays.gentoo.org, you must first become a Gentoo developer.</li>
204</ul> 213</ul>
205</body> 214</body>
206</section> 215</section>
207</chapter> 216</chapter>
208</guide> 217</guide>

Legend:
Removed from v.1.4  
changed lines
  Added in v.1.5

  ViewVC Help
Powered by ViewVC 1.1.20