1 |
commit: 143db50760758ca340cc88f41f44955d4d16e1e7 |
2 |
Author: Ulrich Müller <ulm <AT> gentoo <DOT> org> |
3 |
AuthorDate: Thu Dec 26 19:27:30 2019 +0000 |
4 |
Commit: Ulrich Müller <ulm <AT> gentoo <DOT> org> |
5 |
CommitDate: Thu Dec 26 20:40:27 2019 +0000 |
6 |
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=143db507 |
7 |
|
8 |
Remove all p elements below dd. |
9 |
|
10 |
Where necessary, use multiple dd elements instead. |
11 |
|
12 |
Signed-off-by: Ulrich Müller <ulm <AT> gentoo.org> |
13 |
|
14 |
appendices/common-problems/text.xml | 6 ------ |
15 |
appendices/contributing/text.xml | 31 +++++++++++++------------------ |
16 |
appendices/further-reading/text.xml | 6 ------ |
17 |
archs/amd64/text.xml | 12 +++--------- |
18 |
ebuild-writing/eapi/text.xml | 12 ++++++------ |
19 |
general-concepts/tree/text.xml | 25 ++++--------------------- |
20 |
keywording/text.xml | 8 -------- |
21 |
tools-reference/tr/text.xml | 16 +++++----------- |
22 |
8 files changed, 31 insertions(+), 85 deletions(-) |
23 |
|
24 |
diff --git a/appendices/common-problems/text.xml b/appendices/common-problems/text.xml |
25 |
index 3af479b..430e74b 100644 |
26 |
--- a/appendices/common-problems/text.xml |
27 |
+++ b/appendices/common-problems/text.xml |
28 |
@@ -56,36 +56,30 @@ in use, there are various alternatives: |
29 |
<c>sed</c>, <c>awk</c>, <c>grep</c>, <c>egrep</c>, <c>cut</c> etc |
30 |
</dt> |
31 |
<dd> |
32 |
- <p> |
33 |
Usually when any of the above are used in global scope, it is to manipulate |
34 |
a version or program name string. These should be avoided in favour of |
35 |
pure <c>bash</c> constructs. The <c>eapi7-ver</c> eclass is often of use here. |
36 |
See <uri link="::ebuild-writing/variables/#Version and Name Formatting Issues"/>, |
37 |
<c>man eapi7-ver.eclass</c> and <uri |
38 |
link="::tools-reference/bash/#Bash Variable Manipulation"/>. |
39 |
- </p> |
40 |
</dd> |
41 |
<dt> |
42 |
<c>has_version</c>, <c>best_version</c> |
43 |
</dt> |
44 |
<dd> |
45 |
- <p> |
46 |
Calls to either of these globally indicates a serious problem. You must <b>not</b> |
47 |
have metadata varying based upon system-dependent information <d/> see |
48 |
<uri link="::general-concepts/portage-cache/"/>. You should rewrite your ebuilds |
49 |
to correctly use dependencies. |
50 |
- </p> |
51 |
</dd> |
52 |
<dt> |
53 |
<c>python</c>, <c>perl</c> etc |
54 |
</dt> |
55 |
<dd> |
56 |
- <p> |
57 |
Ebuilds are <c>bash</c> scripts. Offloading anything you don't know how to do |
58 |
in <c>bash</c> onto another language is not acceptable <d/> if nothing else, |
59 |
because not all users will always have a full system when ebuilds are |
60 |
sourced. |
61 |
- </p> |
62 |
</dd> |
63 |
</dl> |
64 |
|
65 |
|
66 |
diff --git a/appendices/contributing/text.xml b/appendices/contributing/text.xml |
67 |
index 4b65c41..d17205a 100644 |
68 |
--- a/appendices/contributing/text.xml |
69 |
+++ b/appendices/contributing/text.xml |
70 |
@@ -81,34 +81,29 @@ really should first examine the GuideXML guide in a reasonable amount of depth. |
71 |
Indentation |
72 |
</dt> |
73 |
<dd> |
74 |
- <p> |
75 |
- Indent when needed <d/> you should not indent any section flow elements such as |
76 |
- <c><subsection></c> but do indent tables, lists and definition lists. |
77 |
- Do <e>not</e> indent text in ordinary paragraph blocks. |
78 |
- </p> |
79 |
+ Indent when needed <d/> you should not indent any section flow elements |
80 |
+ such as <c><subsection></c> but do indent tables, lists and |
81 |
+ definition lists. Do <e>not</e> indent text in ordinary paragraph blocks. |
82 |
</dd> |
83 |
<dt> |
84 |
Code Samples |
85 |
</dt> |
86 |
<dd> |
87 |
- <p> |
88 |
- You can use the normal GuideXML tag <c><pre></c> when you need no syntax |
89 |
- highlighting. When you need syntax highlighting use the <c><codesample></c> |
90 |
- tag along with a <c>lang</c> attribute <d/> usually you want this to be set to |
91 |
- <c>ebuild</c> to syntax highlight ebuild code snippets. |
92 |
- </p> |
93 |
+ You can use the normal GuideXML tag <c><pre></c> when you need |
94 |
+ no syntax highlighting. When you need syntax highlighting use the |
95 |
+ <c><codesample></c> tag along with a <c>lang</c> attribute <d/> |
96 |
+ usually you want this to be set to <c>ebuild</c> to syntax highlight ebuild |
97 |
+ code snippets. |
98 |
</dd> |
99 |
<dt> |
100 |
Hierarchy |
101 |
</dt> |
102 |
<dd> |
103 |
- <p> |
104 |
- The whole document is organized as a tree. Each directory can contain one |
105 |
- document. Each document can inherit multiple sub-documents using the |
106 |
- <c><include></c> flag. You <b>must</b> ensure that the <c>self</c> tag |
107 |
- in each document correctly points to the relative path of the document from |
108 |
- the root node so that the tree-walking algorithms work correctly. |
109 |
- </p> |
110 |
+ The whole document is organized as a tree. Each directory can contain |
111 |
+ one document. Each document can inherit multiple sub-documents using the |
112 |
+ <c><include></c> flag. You <b>must</b> ensure that the <c>self</c> |
113 |
+ tag in each document correctly points to the relative path of the document |
114 |
+ from the root node so that the tree-walking algorithms work correctly. |
115 |
</dd> |
116 |
</dl> |
117 |
|
118 |
|
119 |
diff --git a/appendices/further-reading/text.xml b/appendices/further-reading/text.xml |
120 |
index d48277c..0a658f6 100644 |
121 |
--- a/appendices/further-reading/text.xml |
122 |
+++ b/appendices/further-reading/text.xml |
123 |
@@ -19,12 +19,10 @@ recommendations, not padding designed to make this document look important. |
124 |
Mastering Regular Expressions |
125 |
</dt> |
126 |
<dd> |
127 |
- <p> |
128 |
"Mastering Regular Expressions" by Jeffrey E. F. Friedl (O'Reilly, |
129 |
ISBN 0-596-00289-0) is <b>the</b> book on regular expressions. Very readable and |
130 |
devoid of the usual mathematical jargon that tends to fill up these kinds of |
131 |
books. <uri link="http://www.oreilly.com/catalog/regex2/">Publisher's page</uri> |
132 |
- </p> |
133 |
</dd> |
134 |
</dl> |
135 |
|
136 |
@@ -40,21 +38,17 @@ recommendations, not padding designed to make this document look important. |
137 |
Making Packager-Friendly Software |
138 |
</dt> |
139 |
<dd> |
140 |
- <p> |
141 |
<uri link="http://www.onlamp.com/pub/a/onlamp/2005/03/31/packaging.html">Making |
142 |
Packager-Friendly Software</uri> by Julio M. Merino Vidal describes various things |
143 |
that can be done by upstream software providers to make life easy for the |
144 |
distribution people (that means you). |
145 |
- </p> |
146 |
</dd> |
147 |
<dt> |
148 |
How to Report Bugs Effectively |
149 |
</dt> |
150 |
<dd> |
151 |
- <p> |
152 |
<uri link="https://www.chiark.greenend.org.uk/~sgtatham/bugs.html">How to Report Bugs |
153 |
Effectively</uri> by Simon Tatham is a good overview of effective bug reporting. |
154 |
- </p> |
155 |
</dd> |
156 |
</dl> |
157 |
|
158 |
|
159 |
diff --git a/archs/amd64/text.xml b/archs/amd64/text.xml |
160 |
index 392999b..0f75426 100644 |
161 |
--- a/archs/amd64/text.xml |
162 |
+++ b/archs/amd64/text.xml |
163 |
@@ -269,25 +269,19 @@ configurations. |
164 |
d |
165 |
</dt> |
166 |
<dd> |
167 |
- <p> |
168 |
- Directory containing mixed-bit objects |
169 |
- </p> |
170 |
+ Directory containing mixed-bit objects |
171 |
</dd> |
172 |
<dt> |
173 |
dXX |
174 |
</dt> |
175 |
<dd> |
176 |
- <p> |
177 |
- Directory containing XXbit objects |
178 |
- </p> |
179 |
+ Directory containing XXbit objects |
180 |
</dd> |
181 |
<dt> |
182 |
l->foo |
183 |
</dt> |
184 |
<dd> |
185 |
- <p> |
186 |
- Link to foo |
187 |
- </p> |
188 |
+ Link to foo |
189 |
</dd> |
190 |
</dl> |
191 |
|
192 |
|
193 |
diff --git a/ebuild-writing/eapi/text.xml b/ebuild-writing/eapi/text.xml |
194 |
index 3f9590d..cb49e35 100644 |
195 |
--- a/ebuild-writing/eapi/text.xml |
196 |
+++ b/ebuild-writing/eapi/text.xml |
197 |
@@ -624,17 +624,17 @@ src_install() { |
198 |
</p> |
199 |
<dl> |
200 |
<dt><c>source</c></dt> |
201 |
- <dd><p> |
202 |
+ <dd> |
203 |
if building and installing a package from source, |
204 |
- </p></dd> |
205 |
+ </dd> |
206 |
<dt><c>binary</c></dt> |
207 |
- <dd><p> |
208 |
+ <dd> |
209 |
if installing a binary package, |
210 |
- </p></dd> |
211 |
+ </dd> |
212 |
<dt><c>buildonly</c></dt> |
213 |
- <dd><p> |
214 |
+ <dd> |
215 |
if building a binary package without installing it. |
216 |
- </p></dd> |
217 |
+ </dd> |
218 |
</dl> |
219 |
</li> |
220 |
<li> |
221 |
|
222 |
diff --git a/general-concepts/tree/text.xml b/general-concepts/tree/text.xml |
223 |
index 4afd8d5..4d2bf64 100644 |
224 |
--- a/general-concepts/tree/text.xml |
225 |
+++ b/general-concepts/tree/text.xml |
226 |
@@ -113,87 +113,70 @@ Software-wise, in general all of the following should be met in order for a pack |
227 |
<dl> |
228 |
<dt>Active, Cooperative Upstream</dt> |
229 |
<dd> |
230 |
- <p> |
231 |
If a package is undeveloped or unmaintained upstream, it can be extremely |
232 |
difficult to get problems fixed. If a package does not have an active |
233 |
upstream, the developers who add the package to the tree must ensure that |
234 |
they are able to fix any issues which may arise. |
235 |
- </p> |
236 |
- <p> |
237 |
+</dd> |
238 |
+<dd> |
239 |
Sometimes upstream may have a reason for not wanting their package included |
240 |
in the tree. This should be respected. |
241 |
- </p> |
242 |
</dd> |
243 |
|
244 |
<dt>Reasonably Stable</dt> |
245 |
<dd> |
246 |
- <p> |
247 |
Keep super-experimental things out of the tree. If you must commit them, |
248 |
consider using <c>package.mask</c> until things calm down, or better yet make |
249 |
them available as overlay ebuilds. |
250 |
- </p> |
251 |
</dd> |
252 |
|
253 |
<dt>Reasonably Useful</dt> |
254 |
<dd> |
255 |
- <p> |
256 |
Don't feel obliged to include "Joe's '1337 XMMS Skinz Collection" or "Hans' |
257 |
Super Cool Fast File System" in the tree just because a few users ask for |
258 |
it. Stick to things that might actually be of use. |
259 |
- </p> |
260 |
</dd> |
261 |
|
262 |
<dt>Properly Packaged</dt> |
263 |
<dd> |
264 |
- <p> |
265 |
If something is only available in live CVS or dodgy autopackage format, |
266 |
don't include it until upstream can come up with a decent source package. |
267 |
Similarly, avoid things that don't have a proper build system (where |
268 |
relevant) <d/> these are very tricky to maintain. |
269 |
- </p> |
270 |
</dd> |
271 |
|
272 |
<dt>Patching and Distribution Permitted</dt> |
273 |
<dd> |
274 |
- <p> |
275 |
If we can't patch packages as necessary ourselves, we end up relying |
276 |
entirely upon upstream for support. This can be problematic, especially if |
277 |
upstream are slow at fixing things. We don't want to be in the situation |
278 |
where we can't stable a critical package because we're still waiting for a |
279 |
closed-source vendor to get their act together. |
280 |
- </p> |
281 |
- |
282 |
- <p> |
283 |
+</dd> |
284 |
+<dd> |
285 |
Similarly, not being able to mirror and distribute tarballs ourselves makes |
286 |
us rely entirely upon upstream mirrors. Experience has shown that these are |
287 |
often extremely unreliable, with files changing, moving or vanishing at |
288 |
random. |
289 |
- </p> |
290 |
</dd> |
291 |
|
292 |
<dt>Working Ebuilds</dt> |
293 |
<dd> |
294 |
- <p> |
295 |
If you don't have a <e>working</e> ebuild, don't include it. |
296 |
- </p> |
297 |
</dd> |
298 |
|
299 |
<dt>Portable</dt> |
300 |
<dd> |
301 |
- <p> |
302 |
If software is unportable, it's generally because it's badly written. |
303 |
Remember that although x86 has a market majority <e>now</e>, it probably won't in |
304 |
the not too distant future once x86-64 catches on. |
305 |
- </p> |
306 |
</dd> |
307 |
|
308 |
<dt>Reasonable Security Record</dt> |
309 |
<dd> |
310 |
- <p> |
311 |
Don't include software that has a terrible security record. Each |
312 |
vulnerability is a <e>lot</e> of work for a lot of people (security teams, arch |
313 |
teams and package maintainers). |
314 |
- </p> |
315 |
</dd> |
316 |
</dl> |
317 |
|
318 |
|
319 |
diff --git a/keywording/text.xml b/keywording/text.xml |
320 |
index 2149f2d..a1dbed1 100644 |
321 |
--- a/keywording/text.xml |
322 |
+++ b/keywording/text.xml |
323 |
@@ -41,41 +41,33 @@ The different levels of keyword are: |
324 |
<c>arch</c> (<c>x86</c>, <c>ppc-macos</c>) |
325 |
</dt> |
326 |
<dd> |
327 |
- <p> |
328 |
Both the package version <e>and</e> the ebuild are widely tested, known to work |
329 |
and not have any serious issues on the indicated platform. |
330 |
- </p> |
331 |
</dd> |
332 |
<dt> |
333 |
<c>~arch</c> (<c>~x86</c>, <c>~ppc-macos</c>) |
334 |
</dt> |
335 |
<dd> |
336 |
- <p> |
337 |
The package version and the ebuild are believed to work and do not have any |
338 |
known serious bugs, but more testing is required before the package version |
339 |
is considered suitable for <c>arch</c>. |
340 |
- </p> |
341 |
</dd> |
342 |
<dt> |
343 |
No keyword |
344 |
</dt> |
345 |
<dd> |
346 |
- <p> |
347 |
If a package has no keyword for a given arch, it means it is not known |
348 |
whether the package will work, or that insufficient testing has occurred for |
349 |
<c>~arch</c>. |
350 |
- </p> |
351 |
</dd> |
352 |
<dt> |
353 |
<c>-arch</c> (<c>-x86</c>, <c>-ppc-macos</c>) |
354 |
</dt> |
355 |
<dd> |
356 |
- <p> |
357 |
The package version will not work on the arch. This could be caused by badly |
358 |
written code (for example, non-64-bit or endian clean code), relying upon |
359 |
particular hardware (for example, a BIOS querying tool would not work on |
360 |
non-BIOS architectures) or binary only packages. |
361 |
- </p> |
362 |
</dd> |
363 |
</dl> |
364 |
|
365 |
|
366 |
diff --git a/tools-reference/tr/text.xml b/tools-reference/tr/text.xml |
367 |
index e7002e1..8a1a236 100644 |
368 |
--- a/tools-reference/tr/text.xml |
369 |
+++ b/tools-reference/tr/text.xml |
370 |
@@ -26,27 +26,21 @@ and only writes to standard output. Therefore, you will have to use |
371 |
Deleting characters |
372 |
</dt> |
373 |
<dd> |
374 |
- <p> |
375 |
- To delete all occurrences of certain characters, use <c>tr -d asdf</c>. |
376 |
- </p> |
377 |
+ To delete all occurrences of certain characters, use <c>tr -d asdf</c>. |
378 |
</dd> |
379 |
<dt> |
380 |
Deleting repeated characters |
381 |
</dt> |
382 |
<dd> |
383 |
- <p> |
384 |
- To replace repeated characters with a single character ('squeeze'), use |
385 |
- <c>tr -s asdf</c>. |
386 |
- </p> |
387 |
+ To replace repeated characters with a single character ('squeeze'), use |
388 |
+ <c>tr -s asdf</c>. |
389 |
</dd> |
390 |
<dt> |
391 |
Transliterating characters |
392 |
</dt> |
393 |
<dd> |
394 |
- <p> |
395 |
- To replace all 'a' characters with '1', all 'b' with '2' and all 'c' with |
396 |
- '3', use <c>tr abc 123</c>. |
397 |
- </p> |
398 |
+ To replace all 'a' characters with '1', all 'b' with '2' and all 'c' with |
399 |
+ '3', use <c>tr abc 123</c>. |
400 |
</dd> |
401 |
</dl> |