1 |
commit: 31553dc80f9ccd39052889dc1327ddb7c22c1f8f |
2 |
Author: Ulrich Müller <ulm <AT> gentoo <DOT> org> |
3 |
AuthorDate: Thu Dec 26 09:00:02 2019 +0000 |
4 |
Commit: Ulrich Müller <ulm <AT> gentoo <DOT> org> |
5 |
CommitDate: Thu Dec 26 17:58:45 2019 +0000 |
6 |
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=31553dc8 |
7 |
|
8 |
Replace <path> by <c> throughout. |
9 |
|
10 |
Signed-off-by: Ulrich Müller <ulm <AT> gentoo.org> |
11 |
|
12 |
appendices/contributing/devbook-guide/text.xml | 2 +- |
13 |
ebuild-maintenance/git/text.xml | 2 +- |
14 |
ebuild-maintenance/maintenance-tasks/text.xml | 50 +++++++++++++------------- |
15 |
ebuild-writing/common-mistakes/text.xml | 6 ++-- |
16 |
ebuild-writing/misc-files/metadata/text.xml | 18 +++++----- |
17 |
general-concepts/manifest/text.xml | 4 +-- |
18 |
general-concepts/projects/text.xml | 2 +- |
19 |
7 files changed, 42 insertions(+), 42 deletions(-) |
20 |
|
21 |
diff --git a/appendices/contributing/devbook-guide/text.xml b/appendices/contributing/devbook-guide/text.xml |
22 |
index 29be787..d39e794 100644 |
23 |
--- a/appendices/contributing/devbook-guide/text.xml |
24 |
+++ b/appendices/contributing/devbook-guide/text.xml |
25 |
@@ -215,7 +215,7 @@ Now, here's how the <c><body></c> element above is rendered: |
26 |
</p> |
27 |
|
28 |
<p> |
29 |
-This is a paragraph. <path>/etc/passwd</path> is a file. |
30 |
+This is a paragraph. <c>/etc/passwd</c> is a file. |
31 |
<uri>https://forums.gentoo.org</uri> is my favorite web site. |
32 |
Type <c>ls</c> if you feel like it. I <e>really</e> want to go to sleep now. |
33 |
</p> |
34 |
|
35 |
diff --git a/ebuild-maintenance/git/text.xml b/ebuild-maintenance/git/text.xml |
36 |
index ba811ac..864036e 100644 |
37 |
--- a/ebuild-maintenance/git/text.xml |
38 |
+++ b/ebuild-maintenance/git/text.xml |
39 |
@@ -175,7 +175,7 @@ do not split relevant or interdependent changes within a single package. |
40 |
<li> |
41 |
Avoid creating commits introducing a temporary breakage. Unless impossible, |
42 |
add packages in dependency install order. Add licenses before the packages |
43 |
-needing them. Commit <path>package.mask</path> and other profile changes before |
44 |
+needing them. Commit <c>package.mask</c> and other profile changes before |
45 |
ebuilds relying on them. Usually it is also acceptable to include those changes |
46 |
along with the commit adding the package. |
47 |
</li> |
48 |
|
49 |
diff --git a/ebuild-maintenance/maintenance-tasks/text.xml b/ebuild-maintenance/maintenance-tasks/text.xml |
50 |
index 1fa67dc..f66d636 100644 |
51 |
--- a/ebuild-maintenance/maintenance-tasks/text.xml |
52 |
+++ b/ebuild-maintenance/maintenance-tasks/text.xml |
53 |
@@ -32,10 +32,10 @@ select all possible fields, then submit the query. For you lazy people, click |
54 |
|
55 |
<p> |
56 |
In general, the Gentoo repository should only be used for storing |
57 |
-<path>.ebuild</path> files, as well as any relatively small companion |
58 |
+<c>.ebuild</c> files, as well as any relatively small companion |
59 |
files, such as patches or sample configuration files. These types of |
60 |
-files should be placed in the <path>mycat/mypkg/files</path> directory |
61 |
-to keep the main <path>mycat/mypkg</path> directory uncluttered. |
62 |
+files should be placed in the <c>mycat/mypkg/files</c> directory |
63 |
+to keep the main <c>mycat/mypkg</c> directory uncluttered. |
64 |
Exceptions to this rule are for larger patch files (we recommend this |
65 |
for patches above 20KB) which should be distributed as tarballs via the |
66 |
<uri link="::general-concepts/mirrors/#suitable-download-hosts">Gentoo |
67 |
@@ -99,23 +99,23 @@ work on those architectures. |
68 |
|
69 |
<p> |
70 |
As noted earlier, under each package subdirectory is |
71 |
-a <path>files/</path> directory. Any patches, configuration files, or |
72 |
+a <c>files/</c> directory. Any patches, configuration files, or |
73 |
other ancillary files your package might require should be added to |
74 |
this directory; any files bigger than 20KB-or-so should go to the |
75 |
mirrors to lower the amount of (unneeded) files our users have to |
76 |
download. You may want to consider naming patches you create yourself |
77 |
just to get your package to build with a version-specific name, such |
78 |
-as <path>mypkg-1.0-gentoo.diff</path>, or more |
79 |
-simply, <path>1.0-gentoo.diff</path>. Also note that the |
80 |
-<path>gentoo</path> extension informs people that this patch was created |
81 |
+as <c>mypkg-1.0-gentoo.diff</c>, or more |
82 |
+simply, <c>1.0-gentoo.diff</c>. Also note that the |
83 |
+<c>gentoo</c> extension informs people that this patch was created |
84 |
by us, the Gentoo Linux developers, rather than having been grabbed from a |
85 |
mailing list or somewhere else. Again, you should not compress these |
86 |
patches. |
87 |
</p> |
88 |
|
89 |
<p> |
90 |
-Consider prefixing or suffixing (such as <path>mypkg-1.0</path>) every file |
91 |
-you put into the <path>files/</path> directory, so that the files used for |
92 |
+Consider prefixing or suffixing (such as <c>mypkg-1.0</c>) every file |
93 |
+you put into the <c>files/</c> directory, so that the files used for |
94 |
each individual version on an ebuild are distinguishable from one another, and |
95 |
so that the changes between different revisions are visible. This is generally |
96 |
a really good idea :). You may want to use a different suffix if you wish to |
97 |
@@ -123,8 +123,8 @@ convey more meaning with the patch name. |
98 |
</p> |
99 |
|
100 |
<p> |
101 |
-If you have many files that should go into the <path>files/</path> directory, |
102 |
-consider creating subdirectories such as <path>files/1.0/</path> and putting the |
103 |
+If you have many files that should go into the <c>files/</c> directory, |
104 |
+consider creating subdirectories such as <c>files/1.0/</c> and putting the |
105 |
relevant files in the appropriate subdirectory. If you use this method, |
106 |
you do not need to add version information to the names of the files, |
107 |
which is often more convenient. |
108 |
@@ -253,7 +253,7 @@ to be in very poor taste and may result in disciplinary action. |
109 |
Moving a package in the tree requires several operations. Firstly, |
110 |
the package directory needs to be moved to the correct category |
111 |
using <c>git mv</c>. After this, a new entry needs to be added to |
112 |
-the latest file in <path>profiles/updates/</path> in the |
113 |
+the latest file in <c>profiles/updates/</c> in the |
114 |
following format: |
115 |
</p> |
116 |
|
117 |
@@ -269,10 +269,10 @@ the package to be moved) need to be updated properly. |
118 |
</p> |
119 |
|
120 |
<p> |
121 |
-Next is checking the files under <path>profiles/</path> such as |
122 |
-<path>profiles/package.mask</path> and update them to reflect the ebuild |
123 |
+Next is checking the files under <c>profiles/</c> such as |
124 |
+<c>profiles/package.mask</c> and update them to reflect the ebuild |
125 |
move. Various eclasses automatically provide some of the dependencies upon |
126 |
-inherit, so the files under <path>eclass/</path> should be checked and updated |
127 |
+inherit, so the files under <c>eclass/</c> should be checked and updated |
128 |
properly. If the package metadata.xml has tags with <c>restrict</c> |
129 |
attribute, they should be updated to reflect the move. The |
130 |
metadata.xml for various packages may contain references to the |
131 |
@@ -283,8 +283,8 @@ related to the package should be updated. |
132 |
|
133 |
<p> |
134 |
Here is an example where the package |
135 |
-<path>net-misc/fwbuilder</path> is transparently moved to |
136 |
-<path>net-firewall/fwbuilder</path>: |
137 |
+<c>net-misc/fwbuilder</c> is transparently moved to |
138 |
+<c>net-firewall/fwbuilder</c>: |
139 |
</p> |
140 |
|
141 |
<ol> |
142 |
@@ -292,14 +292,14 @@ Here is an example where the package |
143 |
<li> |
144 |
<p> |
145 |
Add the following entry to the latest file in |
146 |
- <path>profile/updates/</path>: |
147 |
+ <c>profile/updates/</c>: |
148 |
</p> |
149 |
<p><c>move net-misc/fwbuilder net-firewall/fwbuilder</c></p> |
150 |
</li> |
151 |
<li>Update the reverse dependencies of the package</li> |
152 |
<li> |
153 |
- Update <path>profiles/package.mask</path> and other related files under |
154 |
- <path>profiles/</path> |
155 |
+ Update <c>profiles/package.mask</c> and other related files under |
156 |
+ <c>profiles/</c> |
157 |
</li> |
158 |
<li>Check the eclasses that may be referencing the package</li> |
159 |
<li> |
160 |
@@ -348,7 +348,7 @@ Date: Wed Dec 18 19:56:03 2019 +0100 |
161 |
<p> |
162 |
The process for changing the ebuild's SLOT is very similar to the |
163 |
previous process. Besides changing the SLOT in the ebuild file, you |
164 |
-also need to create a new entry in <path>profiles/updates/</path> in |
165 |
+also need to create a new entry in <c>profiles/updates/</c> in |
166 |
the Gentoo repository in the following format: |
167 |
</p> |
168 |
|
169 |
@@ -358,7 +358,7 @@ slotmove app-text/gtkspell 0 2 |
170 |
|
171 |
<p> |
172 |
Make sure that you have fixed all the reverse dependencies and that |
173 |
-you have updated every file in <path>profiles/</path> directory that |
174 |
+you have updated every file in <c>profiles/</c> directory that |
175 |
happens to contain an entry which may be affected by your change. |
176 |
</p> |
177 |
|
178 |
@@ -421,7 +421,7 @@ When removing packages follow these steps: |
179 |
</ol> |
180 |
|
181 |
<p> |
182 |
-Here is a list of commands that will delete <path>dev-util/pmk</path> |
183 |
+Here is a list of commands that will delete <c>dev-util/pmk</c> |
184 |
from the tree: |
185 |
</p> |
186 |
|
187 |
@@ -459,9 +459,9 @@ already provided by another package (detectable with |
188 |
situation before you can commit the ebuild or, if you encounter this |
189 |
with an existing package, file a bug about that package (see below for |
190 |
a few exceptions). The reason file conflicts are critical is because |
191 |
-if "foo" provides the file <path>/usr/bin/example</path> and "bar" is |
192 |
+if "foo" provides the file <c>/usr/bin/example</c> and "bar" is |
193 |
going to overwrite it, and later "bar" is unmerged, Portage will remove |
194 |
-<path>/usr/bin/example</path> and it is therefore likely it will break |
195 |
+<c>/usr/bin/example</c> and it is therefore likely it will break |
196 |
"foo". |
197 |
</p> |
198 |
|
199 |
|
200 |
diff --git a/ebuild-writing/common-mistakes/text.xml b/ebuild-writing/common-mistakes/text.xml |
201 |
index 6846ed1..12e14c1 100644 |
202 |
--- a/ebuild-writing/common-mistakes/text.xml |
203 |
+++ b/ebuild-writing/common-mistakes/text.xml |
204 |
@@ -317,14 +317,14 @@ Another common mistake users make when submitting ebuilds is supplying an |
205 |
invalid license. For example, <c>GPL</c> is not a valid license. You need to |
206 |
specify <c>GPL-1</c> or <c>GPL-2</c>. Same with <c>LGPL</c>. Make sure the |
207 |
license you use in the <c>LICENSE</c> field is something that exists in |
208 |
-the <path>licenses</path> directory. As a tip, check the <path>COPYING</path> |
209 |
+the <c>licenses</c> directory. As a tip, check the <c>COPYING</c> |
210 |
in a source tarball for the license. If a package does not specify it |
211 |
uses <c>GPL-1</c> or <c>GPL-2</c>, it is very likely it uses <c>GPL-2</c>. |
212 |
</p> |
213 |
|
214 |
<p> |
215 |
If the license for the package you submit is unique and not in |
216 |
-<path>licenses/</path>, then you must submit the new license in a |
217 |
+<c>licenses/</c>, then you must submit the new license in a |
218 |
separate file. |
219 |
</p> |
220 |
|
221 |
@@ -413,7 +413,7 @@ implied already, you should only add it if it is something other than |
222 |
|
223 |
<p> |
224 |
If your package has documentation, make sure you install it using <c>dodoc</c> |
225 |
-or in <path>/usr/share/doc/${PF}</path>. Remember to check for errors when |
226 |
+or in <c>/usr/share/doc/${PF}</c>. Remember to check for errors when |
227 |
running <c>dodoc</c>/<c>doins</c>. |
228 |
</p> |
229 |
|
230 |
|
231 |
diff --git a/ebuild-writing/misc-files/metadata/text.xml b/ebuild-writing/misc-files/metadata/text.xml |
232 |
index a89a512..4d2d7cf 100644 |
233 |
--- a/ebuild-writing/misc-files/metadata/text.xml |
234 |
+++ b/ebuild-writing/misc-files/metadata/text.xml |
235 |
@@ -52,7 +52,7 @@ metadata.xml: |
236 |
<c><catmetadata></c> |
237 |
</ti> |
238 |
<ti> |
239 |
- This is the root element of the <path>metadata.xml</path> file for |
240 |
+ This is the root element of the <c>metadata.xml</c> file for |
241 |
categories. It has no attributes. It contains a number of |
242 |
<c><longdescription></c> tags, each for a different language. |
243 |
</ti> |
244 |
@@ -62,7 +62,7 @@ metadata.xml: |
245 |
<c><pkgmetadata></c> |
246 |
</ti> |
247 |
<ti> |
248 |
- This is the root element of the <path>metadata.xml</path> file for |
249 |
+ This is the root element of the <c>metadata.xml</c> file for |
250 |
packages. It has no attributes. The following subtags are |
251 |
allowed: |
252 |
<c><longdescription></c>, |
253 |
@@ -236,7 +236,7 @@ metadata.xml: |
254 |
<ti><c><cat></c></ti> |
255 |
<ti> |
256 |
This tag contains a valid category name as defined in |
257 |
- <path>profiles/categories</path>. |
258 |
+ <c>profiles/categories</c>. |
259 |
</ti> |
260 |
</tr> |
261 |
</table> |
262 |
@@ -389,8 +389,8 @@ these files verbatim and should be taken as hypothetical examples. |
263 |
|
264 |
<p> |
265 |
For the first example, a package maintained by a single project is |
266 |
-presented. It is a simplified version of <path>metadata.xml</path> for |
267 |
-the package <path>app-office/libreoffice</path>. The package |
268 |
+presented. It is a simplified version of <c>metadata.xml</c> for |
269 |
+the package <c>app-office/libreoffice</c>. The package |
270 |
maintainer is identified by the email address <c>office@g.o</c> |
271 |
with the name <c>Gentoo Office Project</c> as specified in the |
272 |
optional <name> subtag. It also provides a long package |
273 |
@@ -453,8 +453,8 @@ projects listing</uri> available on the Gentoo Wiki: |
274 |
<body> |
275 |
|
276 |
<p> |
277 |
-The second example is formed after the <path>metadata.xml</path> of |
278 |
-<path>sys-apps/portage</path>. It lists multiple maintainers where one |
279 |
+The second example is formed after the <c>metadata.xml</c> of |
280 |
+<c>sys-apps/portage</c>. It lists multiple maintainers where one |
281 |
is a developer and the other is a project. It illustrates how local |
282 |
USE flag descriptions are specified and also contains an upstream |
283 |
element. It is also worth pointing out the use of <c>mailto:</c> |
284 |
@@ -502,7 +502,7 @@ as opposed to a URL. Conversely, email addresses specified in the |
285 |
<p> |
286 |
This example splits the maintainership based on package versions using |
287 |
the attribute <c>restrict</c>. According to the |
288 |
-<path>metadata.xml</path> of <path>sys-boot/grub</path>, the ebuilds |
289 |
+<c>metadata.xml</c> of <c>sys-boot/grub</c>, the ebuilds |
290 |
for version 2 and above are maintained by floppym@g.o whereas |
291 |
earlier versions are maintained by the Gentoo Base System |
292 |
project. Note the use of "&gt;" as opposed to ">" in |
293 |
@@ -571,7 +571,7 @@ is demonstrated. |
294 |
<p> |
295 |
The main focus of this example is to demonstrate how slots and |
296 |
subslots are specified, by examining the metadata of |
297 |
-<path>media-libs/libpng</path>. There may be multiple reasons for |
298 |
+<c>media-libs/libpng</c>. There may be multiple reasons for |
299 |
slotting depending on the nature of the package. For this particular |
300 |
package, it can be seen that the slots are used to provide different |
301 |
versions of the library with varying binary compatibility and that |
302 |
|
303 |
diff --git a/general-concepts/manifest/text.xml b/general-concepts/manifest/text.xml |
304 |
index 1b8120b..ace785d 100644 |
305 |
--- a/general-concepts/manifest/text.xml |
306 |
+++ b/general-concepts/manifest/text.xml |
307 |
@@ -56,10 +56,10 @@ Portage Configuration: |
308 |
|
309 |
<ul> |
310 |
<li> |
311 |
- Set <path>PORTAGE_GPG_DIR</path> to your <path>~/.gnupg/</path> directory |
312 |
+ Set <c>PORTAGE_GPG_DIR</c> to your <c>~/.gnupg/</c> directory |
313 |
(or the directory where the keyring with your new key is). |
314 |
</li> |
315 |
- <li>Set <path>PORTAGE_GPG_KEY</path> to the key id of your new key.</li> |
316 |
+ <li>Set <c>PORTAGE_GPG_KEY</c> to the key id of your new key.</li> |
317 |
<li>Set FEATURES="sign".</li> |
318 |
</ul> |
319 |
|
320 |
|
321 |
diff --git a/general-concepts/projects/text.xml b/general-concepts/projects/text.xml |
322 |
index ee501b9..c0a28ca 100644 |
323 |
--- a/general-concepts/projects/text.xml |
324 |
+++ b/general-concepts/projects/text.xml |
325 |
@@ -77,7 +77,7 @@ modifying the member list. |
326 |
|
327 |
<p> |
328 |
Developers should remember to add themselves to the alias by editing |
329 |
-<c><path>/var/mail/alias/misc/<alias name></path></c> on |
330 |
+<c>/var/mail/alias/misc/<alias name></c> on |
331 |
dev.gentoo.org. For example, the alias for the Devmanual project is |
332 |
located at <c>/var/mail/alias/misc/devmanual</c>, which corresponds to |
333 |
the project's email address <c>devmanual@g.o</c>. |