various language issues fixed, based on a patch from Romain FRANCOISE

[developers-reference.git] / developers-reference.sgml

diff --git a/developers-reference.sgml b/developers-reference.sgml
index 4d2bd169bb9ef2bb8de570891096f1950b070365..e3ea90eb698216b50a2d586ef724845b685777be 100644 (file)
--- a/developers-reference.sgml
+++ b/developers-reference.sgml
@@ -6,7 +6,7 @@
   <!ENTITY % commondata  SYSTEM "common.ent" > %commondata;
 
   <!-- CVS revision of this document -->
   <!ENTITY % commondata  SYSTEM "common.ent" > %commondata;
 
   <!-- CVS revision of this document -->

-  <!ENTITY cvs-rev "$Revision: 1.210 $">
+  <!ENTITY cvs-rev "$Revision: 1.211 $">

   <!-- if you are translating this document, please notate the CVS
        revision of the developers reference here -->
   <!--
   <!-- if you are translating this document, please notate the CVS
        revision of the developers reference here -->
   <!--


@@ -1221,12 +1221,13 @@ recompiled on most of the architectures.
 
     <sect id="pkg-tracking-system">The Package Tracking System
        <p>
 
     <sect id="pkg-tracking-system">The Package Tracking System
        <p>

-The Package Tracking System (PTS) is basically a tool to track by mail
-the activity of a source package. You just have to subscribe
-to a source package to start getting the mails related to it. 
-You get the same mails as the maintainer. Each mail
-sent through the PTS is classified and associated to one of
-the keyword listed below. This will let you select the mails that
+The Package Tracking System (PTS) is an email-based tool to track
+the activity of a source package. This really means that you can
+get the same emails that the package maintainer gets, simply by
+subscribing to the package in the PTS.
+       <p>
+Each email sent through the PTS is classified and associated to one of
+the keywords listed below. This will let you select the mails that

 you want to receive.
        <p>
 By default you will get:
 you want to receive.
        <p>
 By default you will get:


@@ -1237,46 +1238,48 @@ All the bug reports and following discussions.
 
     <tag><tt>bts-control</tt>
     <item>
 
     <tag><tt>bts-control</tt>
     <item>

-The control mails notifying a status change in one of the bugs.
+The email notifications from <email>control@bugs.debian.org</email>
+about bug report status changes.

     
     <tag><tt>upload-source</tt>
     <item>
     
     <tag><tt>upload-source</tt>
     <item>

-The confirmation mail from <prgn>katie</prgn> when an uploaded source
+The email notification from <prgn>katie</prgn> when an uploaded source

 package is accepted.
 
     <tag><tt>katie-other</tt>
     <item>
 package is accepted.
 
     <tag><tt>katie-other</tt>
     <item>

-Other warning and error mails from <prgn>katie</prgn> (like the
-override disparity for the section or priority field).
+Other warning and error emails from <prgn>katie</prgn> (such as an
+override disparity for the section and/or the priority field).

 
     <tag><tt>default</tt>
     <item>
 
     <tag><tt>default</tt>
     <item>

-Any non-automatic mail sent to the PTS by people who wanted to
+Any non-automatic email sent to the PTS by people who wanted to

 contact the subscribers of the package. This can be done by sending mail
 contact the subscribers of the package. This can be done by sending mail

-to <tt><var>srcpackage</var>@&pts-host;</tt>. In order to prevent spam,
-mails sent to these addresses must contain the header "X-PTS-Approved"
-with a non-empty string.
-
+to <tt><var>sourcepackage</var>@&pts-host;</tt>. In order to prevent spam,
+all messages sent to these addresses must contain the <tt>X-PTS-Approved</tt>
+header with a non-empty value.

 
     <tag><tt>summary</tt>
     <item>
 
     <tag><tt>summary</tt>
     <item>

-In the future, you may receive regular summary mails to keep you
-informed of the package's status (bug statistics, porting overview,
-progression in <em>testing</em>, ...).
+(This is a planned expansion.)
+The regular summary emails about the package's status (bug statistics,
+porting overview, progression in <em>testing</em>, ...).

 </taglist>
 </taglist>

+

        <p>
        <p>

-You can also decide to receive some more information:
+You can also decide to receive additional information:

 <taglist>
     <tag><tt>upload-binary</tt>
     <item>
 <taglist>
     <tag><tt>upload-binary</tt>
     <item>

-The confirmation mail from <prgn>katie</prgn> when an uploaded binary
-package is accepted (to check that your package is recompiled for all
-architectures).
+The email notification from <prgn>katie</prgn> when an uploaded binary
+package is accepted. In other words, whenever a build daemon or a porter
+uploads your package for another architecture, you can get an email to
+track how your package gets recompiled for all architectures.

 
     <tag><tt>cvs</tt>
     <item>
 
     <tag><tt>cvs</tt>
     <item>

-CVS commits if the maintainer has setup a system to forward commit
-notification to the PTS.
+CVS commit notifications, if the package has a CVS repository and the
+maintainer has set up forwarding commit notifications to the PTS.

 
     <tag><tt>ddtp</tt>
     <item>
 
     <tag><tt>ddtp</tt>
     <item>


@@ -1291,17 +1294,17 @@ various commands to <email>pts@qa.debian.org</email>.
 
 <taglist>
 
 
 <taglist>
 

-<tag><tt>subscribe &lt;srcpackage&gt; [&lt;email&gt;]</tt>
+<tag><tt>subscribe &lt;sourcepackage&gt; [&lt;email&gt;]</tt>

 <item>
   Subscribes <var>email</var> to communications related to the source package
 <item>
   Subscribes <var>email</var> to communications related to the source package

-  <var>srcpackage</var>. Sender address is used if the second argument is
-  not present. If <var>srcpackage</var> is not a valid source package,
+  <var>sourcepackage</var>. Sender address is used if the second argument is
+  not present. If <var>sourcepackage</var> is not a valid source package,

   you'll get a warning. However if it's a valid binary package, the PTS
   will subscribe you to the corresponding source package.
 
   you'll get a warning. However if it's a valid binary package, the PTS
   will subscribe you to the corresponding source package.
 

-<tag><tt>unsubscribe &lt;srcpackage&gt; [&lt;email&gt;]</tt>
+<tag><tt>unsubscribe &lt;sourcepackage&gt; [&lt;email&gt;]</tt>

 <item>
 <item>

-  Removes a previous subscription to the source package <var>srcpackage</var>
+  Removes a previous subscription to the source package <var>sourcepackage</var>

   using the specified email address or the sender address if the second
   argument is left out. 
 
   using the specified email address or the sender address if the second
   argument is left out. 
 


@@ -1312,10 +1315,9 @@ various commands to <email>pts@qa.debian.org</email>.
 
 <tag><tt>keyword [&lt;email&gt;]</tt>
 <item>
 
 <tag><tt>keyword [&lt;email&gt;]</tt>
 <item>

-  Tells you the keywords that you are accepting. Each mail sent through
-  the Package Tracking System is associated to a keyword and you receive
-  only the mails associated to keywords that you are accepting. Here is
-  the list of available keywords:
+  Tells you the keywords that you are accepting.
+  For an explanation of keywords, <qref id="pkg-tracking-system">see
+  above</a>. Here's a quick summary:

   <list>
   <item><tt>bts</tt>: mails coming from the Debian Bug Tracking System
   <item><tt>bts-control</tt>: reply to mails sent to &email-bts-control;
   <list>
   <item><tt>bts</tt>: mails coming from the Debian Bug Tracking System
   <item><tt>bts-control</tt>: reply to mails sent to &email-bts-control;


@@ -1330,9 +1332,9 @@ various commands to <email>pts@qa.debian.org</email>.
   <item><tt>default</tt>: all the other mails (those which aren't "automatic")
   </list>
 
   <item><tt>default</tt>: all the other mails (those which aren't "automatic")
   </list>
 

-<tag><tt>keyword &lt;srcpackage&gt; [&lt;email&gt;]</tt>
+<tag><tt>keyword &lt;sourcepackage&gt; [&lt;email&gt;]</tt>

 <item>
 <item>

-  Same as previous item but for the given source package since
+  Same as the previous item but for the given source package, since

   you may select a different set of keywords for each source package.
 
 <tag><tt>keyword [&lt;email&gt;] {+|-|=} &lt;list of keywords&gt;</tt>
   you may select a different set of keywords for each source package.
 
 <tag><tt>keyword [&lt;email&gt;] {+|-|=} &lt;list of keywords&gt;</tt>


@@ -1340,7 +1342,7 @@ various commands to <email>pts@qa.debian.org</email>.
   Accept (+) or refuse (-) mails associated to the given keyword(s).
   Define the list (=) of accepted keywords.
 
   Accept (+) or refuse (-) mails associated to the given keyword(s).
   Define the list (=) of accepted keywords.
 

-<tag><tt>keyword &lt;srcpackage&gt; [&lt;email&gt;] {+|-|=} &lt;list of keywords&gt;</tt>
+<tag><tt>keyword &lt;sourcepackage&gt; [&lt;email&gt;] {+|-|=} &lt;list of keywords&gt;</tt>

 <item>
   Same as previous item but overrides the keywords list for the
   indicated source package.
 <item>
   Same as previous item but overrides the keywords list for the
   indicated source package.


@@ -1354,9 +1356,9 @@ various commands to <email>pts@qa.debian.org</email>.
        <sect1 id="pts-mail-filtering">Filtering PTS mails
        <p>
 Once you are subscribed to a package, you will get the mails sent to
        <sect1 id="pts-mail-filtering">Filtering PTS mails
        <p>
 Once you are subscribed to a package, you will get the mails sent to

-<tt><var>srcpackage</var>@packages.qa.debian.org</tt>. Those mails
+<tt><var>sourcepackage</var>@packages.qa.debian.org</tt>. Those mails

 have special headers appended to let you filter them in a special
 have special headers appended to let you filter them in a special

-mailbox with <prgn>procmail</prgn>. The added headers are
+mailbox (e.g. with <prgn>procmail</prgn>). The added headers are

 <tt>X-Loop</tt>, <tt>X-PTS-Package</tt>, <tt>X-PTS-Keyword</tt> and
 <tt>X-Unsubscribe</tt>.
        <p>
 <tt>X-Loop</tt>, <tt>X-PTS-Package</tt>, <tt>X-PTS-Keyword</tt> and
 <tt>X-Unsubscribe</tt>.
        <p>


@@ -1373,64 +1375,64 @@ X-Unsubscribe: echo 'unsubscribe dpkg' | mail pts@qa.debian.org
        <p>
 If you use a publicly accessible CVS repository for maintaining
 your Debian package you may want to forward the commit notification
        <p>
 If you use a publicly accessible CVS repository for maintaining
 your Debian package you may want to forward the commit notification

-to the PTS so that the subscribers (possible co-maintainers) can
+to the PTS so that the subscribers (and possible co-maintainers) can

 closely follow the package's evolution.
        <p>
 closely follow the package's evolution.
        <p>

-It's very easy to setup. Once your CVS repository generates commit
-notifications, you just have to make sure it sends a copy of those mails
-to <tt><var>srcpackage</var>_cvs@&pts-host;</tt>. Only people who
-accepts the <em>cvs</em> keyword will receive the notifications.
+Once you set up the CVS repository to generate commit notifications,
+you just have to make sure it sends a copy of those mails
+to <tt><var>sourcepackage</var>_cvs@&pts-host;</tt>. Only the people
+who accept the <em>cvs</em> keyword will receive these notifications.

 
        <sect1 id="pts-web">The PTS web interface
        <p>
 
        <sect1 id="pts-web">The PTS web interface
        <p>

-The PTS has been extended with a web interface that puts together
-many information about each source package. It features many useful
+The PTS has a web interface at <url id="http://&pts-host;/"> that puts
+together a lot of information about each source package. It features many useful

 links (BTS, QA stats, contact information, DDTP translation status,
 links (BTS, QA stats, contact information, DDTP translation status,

-buildd logs) and gathers many more information from various places
+buildd logs) and gathers much more information from various places

 (30 latest changelog entries, testing status, ...). It's a very useful
 tool if you want to know what's going on with a specific source
 (30 latest changelog entries, testing status, ...). It's a very useful
 tool if you want to know what's going on with a specific source

-package. Furthermore there's a form that let you easily subscribe to
-the mail service offered by the PTS.
+package. Furthermore there's a form that allows easy subscription to
+the PTS via email.

        <p>
 You can jump directly to the web page concerning a specific source package
        <p>
 You can jump directly to the web page concerning a specific source package

-with an url like <tt>http://&pts-host;/<var>srcpackage</var></tt>. Otherwise
-you can go through the <url id="http://&pts-host;" name="main page">.
+with a URL like <tt>http://&pts-host;/<var>sourcepackage</var></tt>.

        <p>
 This web interface has been designed like a portal for the development of
        <p>
 This web interface has been designed like a portal for the development of

-packages: you can add custom content on the pages of your packages. You can
-add "static information" (news item that are meant to stay available
+packages: you can add custom content on your packages' pages. You can
+add "static information" (news items that are meant to stay available

 indefinitely) and news items in the "latest news" section.
        <p>
 indefinitely) and news items in the "latest news" section.
        <p>

-Static news can be used to indicate:
+Static news items can be used to indicate:

 <list>
 <item>the availability of a project hosted on alioth.debian.org for co-maintaining the package
 <list>
 <item>the availability of a project hosted on alioth.debian.org for co-maintaining the package

-<item>a link to the upstream website
-<item>a link to the upstream bugtracker
+<item>a link to the upstream web site
+<item>a link to the upstream bug tracker

 <item>the existence of an IRC channel dedicated to the software
 <item>any other available resource that could be useful in the maintenance of the package
 </list>
 <item>the existence of an IRC channel dedicated to the software
 <item>any other available resource that could be useful in the maintenance of the package
 </list>

-Usual news item may be used to announce that:
+Usual news items may be used to announce that:

 <list>
 <list>

-<item>beta packages are available for test
+<item>beta packages are available for testing

 <item>final packages are expected for next week
 <item>the packaging is about to be redone from scratch
 <item>backports are available
 <item>final packages are expected for next week
 <item>the packaging is about to be redone from scratch
 <item>backports are available

-<item>the maintainer is on vacation (if he wishes to publish this information)
+<item>the maintainer is on vacation (if they wish to publish this information)

 <item>a NMU is being worked on
 <item>something important will affect the package
 </list>
        <p>
 <item>a NMU is being worked on
 <item>something important will affect the package
 </list>
        <p>

-Both kind of news are generated in a similar manner: you just have to send a mail
-either to <email>pts-static-news@qa.debian.org</email> or to
-<email>pts-news@qa.debian.org</email>. The mail should indicate which package is
-concerned by the news by giving the name of the source package in a
+Both kind of news are generated in a similar manner: you just have to send
+an email either to <email>pts-static-news@qa.debian.org</email> or to
+<email>pts-news@qa.debian.org</email>. The mail should indicate which
+package is concerned by having the name of the source package in a

 <tt>X-PTS-Package</tt> mail header or in a <tt>Package</tt> pseudo-header (like the
 <tt>X-PTS-Package</tt> mail header or in a <tt>Package</tt> pseudo-header (like the

-BTS reports). If an URL is available in the <tt>X-PTS-Url</tt> mail header or in
+BTS reports). If a URL is available in the <tt>X-PTS-Url</tt> mail header or in

 the <tt>Url</tt> pseudo-header, then the result is a link to that URL instead
 of a complete news item.
        <p>
 the <tt>Url</tt> pseudo-header, then the result is a link to that URL instead
 of a complete news item.
        <p>

-Some examples of valid mails used to generate news item in the PTS are following. The first one
-adds a link to the cvsweb interface of debian-cd in the "Static information" section.
+Here are a few examples of valid mails used to generate news items in
+the PTS. The first one adds a link to the cvsweb interface of debian-cd
+in the "Static information" section:

 <example>
 From: Raphael Hertzog &lt;hertzog@debian.org&gt;
 To: pts-static-news@qa.debian.org
 <example>
 From: Raphael Hertzog &lt;hertzog@debian.org&gt;
 To: pts-static-news@qa.debian.org


@@ -1439,9 +1441,10 @@ Subject: Browse debian-cd CVS repository with cvsweb
 Package: debian-cd
 Url: http://cvs.debian.org/debian-cd/
 </example>
 Package: debian-cd
 Url: http://cvs.debian.org/debian-cd/
 </example>

-The second one is an announce sent to a mailing list which is also sent
+       <p>
+The second one is an announcement sent to a mailing list which is also sent

 to the PTS so that it is published on the PTS web page of the package. Note the
 to the PTS so that it is published on the PTS web page of the package. Note the

-use of the BCC field to avoid answers sent to the PTS by mistake ...
+use of the BCC field to avoid answers sent to the PTS by mistake.

 <example>
 From: Raphael Hertzog &lt;hertzog@debian.org&gt;
 To: debian-gtk-gnome@lists.debian.org
 <example>
 From: Raphael Hertzog &lt;hertzog@debian.org&gt;
 To: debian-gtk-gnome@lists.debian.org


@@ -1449,17 +1452,17 @@ Bcc: pts-news@qa.debian.org
 Subject: Galeon 2.0 backported for woody
 X-PTS-Package: galeon
 
 Subject: Galeon 2.0 backported for woody
 X-PTS-Package: galeon
 

-Hello gnomers !
+Hello gnomers!

 
 I'm glad to announce that galeon has been backported for woody. You'll find
 everything here:
 ...
 </example>
        <p>
 
 I'm glad to announce that galeon has been backported for woody. You'll find
 everything here:
 ...
 </example>
        <p>

-Think twice before adding a news to the PTS because you won't be able to
-remove it later and you wan't be able to edit it either. The only thing that you
-can do is send a second news that will deprecate the information contained in
-the first news.
+Think twice before adding a news item to the PTS because you won't be able
+to remove it later and you wan't be able to edit it either. The only thing
+that you can do is send a second news item that will deprecate the
+information contained in the previous one.

 
     <sect id="ddpo">Developer's packages overview
        <p>
 
     <sect id="ddpo">Developer's packages overview
        <p>