[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

Bug#368046: marked as done (developers-reference: Use sgml features for emphasis, <em>not</em> captitalisation)

Your message dated Sat, 16 Dec 2006 16:17:02 +0000
with message-id <E1GvcDe-0003dD-QT@ries.debian.org>
and subject line Bug#368046: fixed in developers-reference 3.3.8
has caused the attached Bug report to be marked as done.

This means that you claim that the problem has been dealt with.
If this is not the case it is now your responsibility to reopen the
Bug report if necessary, and/or fix the problem forthwith.

(NB: If you are a system administrator and have no idea what I am
talking about this indicates a serious mail system misconfiguration
somewhere.  Please contact me immediately.)

Debian bug tracking system administrator
(administrator, Debian Bugs database)
--- Begin Message --- 
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/&lt;packagename&gt;_&lt;upstream-version&gt;.orig.tar.gz | tar xf -                                                                                 +</example>
+zcat path/to/&lt;packagename&gt;_&lt;upstream-version&gt;.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>&lt;packagename&gt;-&lt;upstream-version&gt;.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>

--- End Message ---
--- Begin Message --- 
Source: developers-reference
Source-Version: 3.3.8

We believe that the bug you reported is fixed in the latest version of
developers-reference, which is due to be installed in the Debian FTP archive:

developers-reference-fr_3.3.8_all.deb
  to pool/main/d/developers-reference/developers-reference-fr_3.3.8_all.deb
developers-reference_3.3.8.dsc
  to pool/main/d/developers-reference/developers-reference_3.3.8.dsc
developers-reference_3.3.8.tar.gz
  to pool/main/d/developers-reference/developers-reference_3.3.8.tar.gz
developers-reference_3.3.8_all.deb
  to pool/main/d/developers-reference/developers-reference_3.3.8_all.deb



A summary of the changes between this version and the previous one is
attached.

Thank you for reporting the bug, which will now be closed.  If you
have further comments please address them to 368046@bugs.debian.org,
and the maintainer will reopen the bug report if appropriate.

Debian distribution maintenance software
pp.
Andreas Barth <aba@not.so.argh.org> (supplier of updated developers-reference package)

(This message was generated automatically at their request; if you
believe that there is a problem with it please contact the archive
administrators by mailing ftpmaster@debian.org)


-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Format: 1.7
Date: Sat, 11 Nov 2006 10:55:44 -0700
Source: developers-reference
Binary: developers-reference-fr developers-reference
Architecture: source all
Version: 3.3.8
Distribution: unstable
Urgency: low
Maintainer: Debian Documentation Project <debian-doc@lists.debian.org>
Changed-By: Andreas Barth <aba@not.so.argh.org>
Description: 
 developers-reference - guidelines and information for Debian developers
 developers-reference-fr - guidelines and information for Debian developers, in French
Closes: 324967 339552 350792 353447 353874 355725 356643 361311 361744 365993 365994 368046 374738 376199 376411 376961 378929 380458 382477 382721 387108 387154 394033 397786 397907
Changes: 
 developers-reference (3.3.8) unstable; urgency=low
 .
   * mia-history is replaced by mia-query. Thanks, Christoph Berg.
     Closes: #350792
   * fix missing quite. Thanks, Frank Küster. Closes: #365994
   * use gnugp instead of gpg. Thanks, Justin Pryzby, Jon Dowland.
     Closes: #376411
   * better destinction between maintainer and developer. Thanks for
     the suggestion to Colin Tuckley. Closes: #380458
   * irc.d.o points to oftc. Thanks, Christoph Biedl, Jon Dowland.
     Closes: #382721
   * Bugs are now always closed thanks to version tracking.
     Closes: #339552, #353447, #376199
   * Clarify what "a conflicts b" means in testing migration.
     Closes: #361311
   * Packages in testing disappear if they're removed from unstable.
     Thanks, Frank Küster, Al Stone. Closes: #365993
   * Document only the most recent changelog entry is used. Thanks
     to Kevin Glynn to the suggestion. Closes: #374738
   * Add more tools for reverse depends. Close: #376582
   * delayed-queue on gluck is uploaded more often now. Closes: #397907
   * stop using capitals, minor fixes, language fixes.
     Thanks, Thijs Kinkhorst, Colin Tuckley, Russ Allbery.
     Closes: #368046, #378929, #361744
   * add CVE Ids to your changelog. Closes: #376961
   * add reasoning why debconf questions shouldn't be longer than
     20 lines. Thanks, Thijs Kinkhorst, Christian Perrier, Russ Allbery.
     Closes: #382477
   * section changing needs re-uploading orig.tar.gz.
     Thanks, Adam D. Barratt. Closes: #387154
   * binary files in diffs could be en/decoded with perl.
     Thanks, Frank Küster. Closes: #397786
   * Add pointer to new-reject-FAQ. Closes: #324967
   * Hint to dd-list/whodepends. Closes: #353874
   * Don't use too generic mail ids. Closes: #355725
   * pts/summary is actually used. Thanks, Holger Levsen. Closes: #387108
   * clarify that one should append the NMU-diff to a bug. Closes: #394033
   * more detailed instructions on binary package removals.
     Closes: #356643
 .
   * Frédéric Bothamy
     - French translation updated to version 3.3.8
Files: 
 740caa3ef23ddbd373d282f4797b62f1 687 doc optional developers-reference_3.3.8.dsc
 50b9085b9323fc8e219c3655f65715c8 312443 doc optional developers-reference_3.3.8.tar.gz
 f48196881e820868ab7d79a307cb64e4 594492 doc optional developers-reference_3.3.8_all.deb
 ab5744ce44b2fe4d3683ed4d3f4deaf8 233884 doc optional developers-reference-fr_3.3.8_all.deb

-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.1 (GNU/Linux)

iD8DBQFFhBlEmdOZoew2oYURAnnMAJ9RZU18fQiFAoJFhsJJ6/cvyGvMegCfTRXX
5+O4tSnqpxvZWDOQ3/QZPjo=
=qlGM
-----END PGP SIGNATURE-----

--- End Message ---
Reply to: