Bug#368046: developers-reference: Use sgml features for emphasis, <em>not</em> captitalisation
Package: developers-reference
Version: 3.3.7
Severity: minor
Tags: patch
Hello,
The developers reference uses capitalisation at some points to EMPHASIZE
things. It's better to use the SGML tags <strong> and <em> for that.
The attached patch fixes that.
I've also attached a patch to remove two stray '+' characters in the
source.
Thijs
diff -wur developers-reference-3.3.7.orig/developers-reference.sgml developers-reference-3.3.7/developers-reference.sgml
--- developers-reference-3.3.7.orig/developers-reference.sgml 2006-04-04 23:41:26.000000000 +0200
+++ developers-reference-3.3.7/developers-reference.sgml 2006-05-19 15:18:17.000000000 +0200
@@ -1876,11 +1876,11 @@
<sect1>Security uploads
<p>
-Do NOT upload a package to the security upload queue (oldstable-security,
-stable-security, etc.) without prior authorization from the security
-team. If the package does not exactly meet the team's requirements, it
-will cause many problems and delays in dealing with the unwanted upload.
-For details, please see section <ref id="bug-security">.
+Do <strong>not</strong> upload a package to the security upload queue
+(oldstable-security, stable-security, etc.) without prior authorization
+from the security team. If the package does not exactly meet the team's
+requirements, it will cause many problems and delays in dealing with the
+unwanted upload. For details, please see section <ref id="bug-security">.
<sect1>Other upload queues
<p>
@@ -2202,7 +2202,7 @@
When you become aware of a security-related bug in a Debian package,
whether or not you are the maintainer, collect pertinent information
about the problem, and promptly contact the security team at
-&email-security-team; as soon as possible. <strong>DO NOT UPLOAD</strong> any
+&email-security-team; as soon as possible. <strong>Do not upload</strong> any
packages for stable; the security team will do that.
Useful information includes, for example:
@@ -2349,7 +2349,7 @@
package. Test other, normal actions as well, as sometimes a security
fix can break seemingly unrelated features in subtle ways.
<p>
-Do <strong>NOT</strong> include any changes in your package which are
+Do <strong>not</strong> include any changes in your package which are
not directly related to fixing the vulnerability. These will only
need to be reverted, and this wastes time. If there are other bugs in
your package that you would like to fix, make an upload to
@@ -2422,13 +2422,13 @@
<sect2 id="bug-security-upload">Uploading the fixed package
<p>
-Do <strong>NOT</strong> upload a package to the security upload queue
+Do <strong>not</strong> upload a package to the security upload queue
(oldstable-security, stable-security, etc.) without
prior authorization from the security team. If the package does not
exactly meet the team's requirements, it will cause many problems and
delays in dealing with the unwanted upload.
<p>
-Do <strong>NOT</strong> upload your fix to proposed-updates without
+Do <strong>not</strong> upload your fix to proposed-updates without
coordinating with the security team. Packages from
security.debian.org will be copied into the proposed-updates directory
automatically. If a package with the same or a higher version number
@@ -4293,7 +4293,7 @@
<sect3>boolean:
<p>
-A true/false choice. Remember: true/false, NOT YES/NO...
+A true/false choice. Remember: true/false, <stong>not yes/no</strong>...
<sect3>select:
<p>
@@ -4400,8 +4400,8 @@
<sect3>String/password templates
<p>
<list>
-<item> The short description is a prompt and NOT a title. Avoid
- question style prompts ("IP Address?") in favour of
+<item> The short description is a prompt and <strong>not</strong> a
+ title. Avoid question style prompts ("IP Address?") in favour of
"opened" prompts ("IP address:").
The use of colons is recommended.
@@ -4420,7 +4420,7 @@
question is rather long (remember that translations are often longer
than original versions)
-<item> The extended description should NOT include a question.
+<item> The extended description should <strong>not</strong> include a question.
<item> Again, please avoid referring to specific interface widgets. A common
mistake for such templates is "if you answer Yes"-type
@@ -4430,9 +4430,9 @@
<sect3>Select/Multiselect
<p>
<list>
-<item> The short description is a prompt and NOT a title. Do NOT use useless
- "Please choose..." constructions. Users are clever enough to figure
- out they have to choose something...:)
+<item> The short description is a prompt and <strong>not</strong> a title.
+ Do <strong>not</strong> use useless "Please choose..." constructions.
+ Users are clever enough to figure out they have to choose something...:)
<item> The extended description will complete the short description. It may
refer to the available choices. It may also mention that the user
@@ -4449,9 +4449,9 @@
<item> The extended description is what will be displayed as a more detailed
explanation of the note. Phrases, no terse writing style.
-<item> DO NOT ABUSE DEBCONF. Notes are the most common way to abuse
- debconf. As written in debconf-devel manual page: it's best to use them
- only for warning about very serious problems. The NEWS.Debian or
+<item> <strong>Do not abuse debconf.</strong> Notes are the most common way to
+ abuse debconf. As written in debconf-devel manual page: it's best to use
+ them only for warning about very serious problems. The NEWS.Debian or
README.Debian files are the appropriate location for a lot of notes.
If, by reading this, you consider converting your Note type templates
to entries in NEWS/Debian or README.Debian, plus consider keeping existing
@@ -4499,10 +4499,10 @@
<sect2>Default field
<p>
-Do NOT use empty default field. If you don't want to use default
+Do <strong>not</strong> use empty default field. If you don't want to use default
values, do not use Default at all.
<p>
-If you use po-debconf (and you SHOULD, see 2.2), consider making this
+If you use po-debconf (and you <em>should</em>, see 2.2), consider making this
field translatable, if you think it may be translated.
<p>
If the default value may vary depending on language/country (for
diff -wur developers-reference-3.3.7.orig/developers-reference.sgml developers-reference-3.3.7/developers-reference.sgml
--- developers-reference-3.3.7.orig/developers-reference.sgml 2006-04-04 23:41:26.000000000 +0200
+++ developers-reference-3.3.7/developers-reference.sgml 2006-05-19 15:23:07.000000000 +0200
@@ -4790,7 +4790,7 @@
It unpacks the tarball in an empty temporary directory by doing
<example>
-zcat path/to/<packagename>_<upstream-version>.orig.tar.gz | tar xf - +</example>
+zcat path/to/<packagename>_<upstream-version>.orig.tar.gz | tar xf - </example>
</item>
<item>
If, after this, the temporary directory contains nothing but one
@@ -4890,7 +4890,7 @@
<strong>should</strong> use
<tt><packagename>-<upstream-version>.orig</tt> as the name
of the top-level directory in its tarball. This makes it possible to
-distinguish pristine tarballs from repackaged ones. + </item>
+distinguish pristine tarballs from repackaged ones. </item>
<item>
<strong>should</strong> be gzipped with maximal compression.
</item>
Reply to: