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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.8 - (hide annotations) (download) (as text)
Sun Jun 13 20:04:10 2010 UTC (4 years, 2 months ago) by sping
Branch: MAIN
Changes since 1.7: +4 -1 lines
File MIME type: application/xml
Fix "source [..]/make.conf" Layman intergration for Layman 1.3.x, patch by Shawn Baker

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/userguide.xml">
5     <title>Gentoo Overlays: Users' Guide</title>
6    
7     <author title="Author">
8 jokey 1.5 <mail link="stuart">Stuart Herbert</mail>
9     </author>
10    
11     <author title="Author">
12     <mail link="jokey">Markus Ullmann</mail>
13 stuart 1.1 </author>
14    
15     <abstract>This guide helps users understand how to use the Gentoo Overlays service</abstract>
16    
17     <license/>
18    
19 jokey 1.5 <version>1.1</version>
20     <date>2008-10-30</date>
21 stuart 1.1
22     <chapter>
23     <title>Introduction</title>
24     <section>
25     <title>Audience</title>
26     <body>
27     <p>This document has been written for all users of Gentoo. If you are a Gentoo
28     developer or Gentoo staff member, and you want to be able to manage your own
29     overlay, please see the <uri link="/proj/en/overlays/devguide.xml">Developers' Guide</uri>.</p>
30     </body>
31     </section>
32    
33     <section>
34     <title>What Are Overlays?</title>
35     <body>
36 jokey 1.5 <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>
37 stuart 1.1 </body>
38     </section>
39    
40     <section>
41     <title>Why Use Overlays?</title>
42     <body>
43     <p>People create overlays for all sorts of reasons. Here are a few of the main
44     ones:</p>
45     <ul>
46     <li>If you modify an ebuild in /usr/portage, your change will be lost the next time you emerge --sync. But, if you put your modified ebuild into an overlay, your change is safe from emerge --sync.</li>
47     <li>Because overlays are not the main Gentoo Portage package tree, they're a great place to develop and test an ebuild without fear of breaking the main Gentoo Portage package tree.</li>
48     <li>Not every ebuild belongs in the Gentoo Portage package tree. An overlay is a great place to store an ebuild until it is ready to go into the Gentoo Portage package tree.</li>
49     </ul>
50     </body>
51     </section>
52    
53     <section>
54 jokey 1.5 <title>What is the Gentoo Overlays Project?</title>
55 stuart 1.1 <body>
56 jokey 1.5 <p>Gentoo Overlays provide social workspaces to allow Gentoo projects,
57 stuart 1.1 developers and users to collaborate together on tomorrow's Gentoo packages.
58 jokey 1.5 We do this by hosting overlays for Gentoo projects and developers.</p>
59 stuart 1.1 </body>
60     </section>
61    
62     <section>
63     <title>Are All Official Overlays Hosted On overlays.gentoo.org?</title>
64     <body>
65     <p>No. Gentoo developers are free to put their overlay wherever suits them best; they don't have to use overlays.gentoo.org if they don't want to.</p>
66     </body>
67     </section>
68     </chapter>
69    
70     <chapter>
71     <title>Getting Started With Overlays</title>
72     <section>
73     <body>
74 jokey 1.6 <p>Use Gunnar Wrobel's layman to easily install and update overlays over time.</p>
75 stuart 1.1 </body>
76     </section>
77    
78     <section>
79     <title>Installing Layman</title>
80     <body>
81     <p>To install layman, follow these steps:</p>
82     <pre caption="Installing layman">
83     <i>emerge layman</i>
84 jokey 1.6 </pre>
85     <pre caption="Telling Portage about layman-fetched repositories">
86     <comment>(for layman 1.1)</comment>
87     <i># echo "source /usr/portage/local/layman/make.conf" >> /etc/make.conf</i>
88    
89 sping 1.8 <comment>(for layman 1.2)</comment>
90 jokey 1.6 <i># echo "source /usr/local/portage/layman/make.conf" >> /etc/make.conf</i>
91 sping 1.8
92     <comment>(for layman 1.3)</comment>
93     <i># echo "source /var/lib/layman/make.conf" >> /etc/make.conf</i>
94 stuart 1.1 </pre>
95 wrobel 1.2 <note>
96 jokey 1.5 Layman will create "/usr/local/portage/layman/make.conf" once you add
97 wrobel 1.4 your first overlay. But if you do not plan to install an overlay
98     immediately you should ensure that this file actually exists and
99     contains the empty variable "PORTDIR_OVERLAY". Otherwise portage will
100     complain. You can run "echo PORTDIR_OVERLAY=\"\" >
101     /usr/portage/local/layman/make.conf" in order to have the file created
102     correctly.
103 wrobel 1.2 </note>
104 stuart 1.1 </body>
105     </section>
106    
107     <section>
108 jokey 1.5 <title>Listing The Available Overlays</title>
109 stuart 1.1 <body>
110     <p>To see the list of overlays available, run:</p>
111     <pre caption="Listing the available overlays">layman -L</pre>
112     </body>
113     </section>
114    
115     <section>
116     <title>Installing An Overlay</title>
117     <body>
118     <p>To install an overlay on your computer, run:</p>
119     <pre caption="Adding an overlay">
120     layman -a &lt;overlay-name&gt;
121     </pre>
122     <p>For example, to install <uri link="http://overlays.gentoo.org/proj/php">the PHP overlay</uri>, run:</p>
123     <pre caption="Adding the PHP overlay">
124     layman -a php
125     </pre>
126     </body>
127     </section>
128    
129     <section>
130     <title>Installing Packages From An Overlay</title>
131     <body>
132     <p>After installing an overlay, you can install packages from it by running:</p>
133     <pre caption="Installing A Package From An Overlay">
134     emerge -av &lt;category&gt;/&lt;package&gt;
135     </pre>
136     <p>Portage automatically searches your main Portage tree (in /usr/portage), and
137     all of the overlays that you've installed, and picks the latest version of the
138     package that it can find.</p>
139    
140     <p>If Portage isn't picking up the package from the overlay, that's normally
141     because the package is marked ~arch, where "arch" is the architecture of your
142     computer (normally x86).</p>
143     </body>
144     </section>
145    
146     <section>
147     <title>Updating An Overlay</title>
148     <body>
149     <p>To keep your installed overlays up to date, run:</p>
150     <pre caption="Updating All Installed Overlays">
151 jokey 1.5 layman -S
152 stuart 1.1 </pre>
153     <p>Please don't run this more than once a day, or you'll put too much strain on
154     Gentoo's infrastructure.</p>
155     </body>
156     </section>
157     </chapter>
158    
159     <chapter>
160     <title>How To Get More Involved</title>
161    
162     <section>
163     <title>Introduction</title>
164     <body>
165 jokey 1.5 <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>
166 stuart 1.1
167     <p>If you start contributing to a project, we'll give you write access to the
168     project's overlay, and we'll provide mentors to help you contribute.
169     Eventually, if we like what you do and the way you do it, we'll invite you to
170 jokey 1.5 go the whole hog and become a full Gentoo developer.</p>
171 stuart 1.1 </body>
172     </section>
173    
174     <section>
175     <title>How To Get Started</title>
176     <body>
177     <p>If you want to contribute to an overlay, the best approach is to build a good
178     working relationship with the Gentoo developers who are responsible for the
179     overlay. You can find out who is responsible for each overlay by going to
180     <uri link="http://overlays.gentoo.org">overlays.gentoo.org's homepage</uri>, and clicking on the link for the overlay in question.</p>
181    
182     <p>Different developers preferred to be contacted in different ways. Some hang
183     out on IRC, and may have their own channels for their projects. Examples of
184     these include the PHP project (#gentoo-php), and the Webapps project
185     (#gentoo-web). Others prefer to be contacted by email only. The only way
186 jokey 1.5 you'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>
187 stuart 1.1 </body>
188     </section>
189    
190     <section>
191     <title>Working With Subversion</title>
192     <body>
193 jokey 1.5 <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.
194     </p>
195     </body>
196     </section>
197    
198     <section>
199     <title>Working With Git</title>
200     <body>
201     <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>
202 stuart 1.1 </body>
203     </section>
204    
205     <section>
206     <title>Further Information</title>
207     <body>
208     <p>The Gentoo project (or developer) you're working with should be able to
209     provide you with any further help and assistance that you need.</p>
210     </body>
211     </section>
212     </chapter>
213    
214     <chapter>
215     <title>Frequently Asked Questions</title>
216     <section>
217     <body>
218     <p>Q: Do you host overlays for users?</p>
219     <ul>
220 sping 1.7 <!--<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>-->
221     <li>A: Yes, we do. Please see <uri link="http://blog.hartwork.org/?p=843">this post</uri> for instructions to get hosted.</li>
222 stuart 1.1 </ul>
223     </body>
224     </section>
225     </chapter>
226     </guide>

  ViewVC Help
Powered by ViewVC 1.1.20