chiark / gitweb /
start effort to split out common entities
authoraph <aph@313b444b-1b9f-4f58-a734-7bb04f332e8d>
Sun, 15 Aug 1999 23:24:04 +0000 (23:24 +0000)
committeraph <aph@313b444b-1b9f-4f58-a734-7bb04f332e8d>
Sun, 15 Aug 1999 23:24:04 +0000 (23:24 +0000)
git-svn-id: svn://anonscm.debian.org/ddp/manuals/trunk/developers-reference@833 313b444b-1b9f-4f58-a734-7bb04f332e8d

developers-reference.sgml

index 06b20ed..13f2368 100644 (file)
@@ -2,8 +2,16 @@
   <!-- include version information so we don't have to hard code it
        within the document -->
   <!entity % versiondata SYSTEM "version.ent"> %versiondata;
   <!-- include version information so we don't have to hard code it
        within the document -->
   <!entity % versiondata SYSTEM "version.ent"> %versiondata;
-  <!entity number-of-pkgs "2250">
-  <!entity number-of-maintainers "400">
+  <!-- common, language independant entities -->
+  <!entity % commondata  SYSTEM "common.ent" > %commondata;
+  <!-- CVS revision of this document -->
+  <!entity cvs-rev "$Revision: 1.34 $">
+
+  <!-- if you are translating this document, please notate the RCS
+       revision of the developers reference here -->
+  <!--
+    <!entity cvs-en-rev "X.YY">
+    -->
 ]>
 <debiandoc>
 <!--
 ]>
 <debiandoc>
 <!--
@@ -44,8 +52,7 @@ A copy of the GNU General Public License is available as
 <file>/usr/doc/copyright/GPL</file> in the Debian GNU/Linux
 distribution or on the World Wide Web at <url
 id="http://www.gnu.org/copyleft/gpl.html" name="the GNU website">.
 <file>/usr/doc/copyright/GPL</file> in the Debian GNU/Linux
 distribution or on the World Wide Web at <url
 id="http://www.gnu.org/copyleft/gpl.html" name="the GNU website">.
-You can also obtain it by writing to the Free Software Foundation,
-Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+You can also obtain it by writing to the &fsf-addr;.
 
     <toc detail="sect2">
 
 
     <toc detail="sect2">
 
@@ -71,12 +78,11 @@ their packages (<ref id="tools">).
       <p>
 It should be clear that this reference does not discuss the technical
 details of the Debian package nor how to generate Debian packages;
       <p>
 It should be clear that this reference does not discuss the technical
 details of the Debian package nor how to generate Debian packages;
-that information is discussed in the <url
-id="http://www.debian.org/doc/packaging-manuals/packaging.html/"
+that information is discussed in the <url id="&url-pkg-manual;"
 name="Debian Packaging Manual">.  Nor does this reference detail the
 standards to which Debian software must comply; that information can
 name="Debian Packaging Manual">.  Nor does this reference detail the
 standards to which Debian software must comply; that information can
-be found in the <url id="http://www.debian.org/doc/debian-policy/"
-name="Debian Policy Manual">.
+be found in the <url id="&url-debian-policy;" name="Debian Policy
+Manual">.
       <p>
 Furthermore, this document is <em>not an expression of formal
 policy</em>.  It contains documentation for the Debian system, and
       <p>
 Furthermore, this document is <em>not an expression of formal
 policy</em>.  It contains documentation for the Debian system, and
@@ -115,13 +121,12 @@ helpful.
       <sect id="registering">Registering as a Debian developer
        <p>
 Before you decide to register with the Debian Project, you will need
       <sect id="registering">Registering as a Debian developer
        <p>
 Before you decide to register with the Debian Project, you will need
-to read the <url id="http://www.debian.org/social_contract"
-name="Debian Social Contract">.  Registering as a developer means that
-you agree with and pledge to uphold the Debian Social Contract; it is
-very important that maintainers are in accord with the essential ideas
-behind Debian GNU/Linux.  Reading the <url
-id="http://www.gnu.org/gnu/manifesto.html" name="GNU Manifesto"> would
-also be a good idea.
+to read the <url id="&url-social-contract;" name="Debian Social
+Contract">.  Registering as a developer means that you agree with and
+pledge to uphold the Debian Social Contract; it is very important that
+maintainers are in accord with the essential ideas behind Debian
+GNU/Linux.  Reading the <url id="&url-gnu-manifesto;" name="GNU
+Manifesto"> would also be a good idea.
        <p>
 The process of registering as a developer is a process of verifying
 your identity and intentions.  As the number of people working on
        <p>
 The process of registering as a developer is a process of verifying
 your identity and intentions.  As the number of people working on
@@ -197,7 +202,7 @@ tampering.  You can do it by executing <tt>pgp -ks
 <var>your_userid</var></tt>.
        <p>
 If your PGP key isn't on public key servers such as
 <var>your_userid</var></tt>.
        <p>
 If your PGP key isn't on public key servers such as
-<tt>pgp5.ai.mit.edu</tt>, please read the documentation available
+&pgp-keyserv;, please read the documentation available
 locally <tt>/usr/doc/pgp/keyserv.doc</tt>.  That document contains
 instructions on how to put your key on the public key servers.  The
 New Maintainer Group will put your public key on the servers if it
 locally <tt>/usr/doc/pgp/keyserv.doc</tt>.  That document contains
 instructions on how to put your key on the public key servers.  The
 New Maintainer Group will put your public key on the servers if it
@@ -300,10 +305,9 @@ The mailing list server is at <tt>lists.debian.org</tt>.  Mail
 <tt>subscribe</tt> in the <em>Subject</em> to subscribe to the list or
 <tt>unsubscribe</tt> to unsubscribe.  More detailed instructions on
 how to subscribe and unsubscribe to the mailing lists can be found at
 <tt>subscribe</tt> in the <em>Subject</em> to subscribe to the list or
 <tt>unsubscribe</tt> to unsubscribe.  More detailed instructions on
 how to subscribe and unsubscribe to the mailing lists can be found at
-<url id="http://www.debian.org/MailingLists/subscribe">, <url
-id="ftp://ftp.debian.org/debian/doc/mailing-lists.txt"> or locally in
-<file>/usr/doc/debian/mailing-lists.txt</file> if you have the
-<package>doc-debian</package> package installed.
+<url id="&url-debian-lists-subscribe;">, <url id="&url-debian-lists;">
+or locally in <file>/usr/doc/debian/mailing-lists.txt</file> if you
+have the <package>doc-debian</package> package installed.
        <p>
 When replying to messages on the mailing list, please do not send a
 carbon copy (<tt>CC</tt>) to the original poster unless they explicitly
        <p>
 When replying to messages on the mailing list, please do not send a
 carbon copy (<tt>CC</tt>) to the original poster unless they explicitly
@@ -317,7 +321,7 @@ following mailing lists: <email>debian-devel@lists.debian.org</email>,
 <email>debian-announce@lists.debian.org</email>, or
 <email>debian-devel-announce@lists.debian.org</email>.  Additional
 mailing lists are available for special purposes; see <url
 <email>debian-announce@lists.debian.org</email>, or
 <email>debian-devel-announce@lists.debian.org</email>.  Additional
 mailing lists are available for special purposes; see <url
-id="http://www.debian.org/MailingLists/subscribe">.  Cross-posting
+id="&url-debian-lists-subscribe;">.  Cross-posting
 (sending the same message to multiple lists) is discouraged.
        <p>
 <email>debian-private@lists.debian.org</email> is a special mailing
 (sending the same message to multiple lists) is discouraged.
        <p>
 <email>debian-private@lists.debian.org</email> is a special mailing
@@ -333,7 +337,7 @@ replying to.  In general, please adhere to the usual conventions for
 posting messages.
        <p>
 Online archives of mailing lists are available at <url
 posting messages.
        <p>
 Online archives of mailing lists are available at <url
-id="http://www.debian.org/Lists-Archives/">.
+id="&url-debian-list-archives;">.
 
       <sect id="server-machines">Debian servers
        <p>
 
       <sect id="server-machines">Debian servers
        <p>
@@ -344,11 +348,10 @@ are and what they do.
 If you have a problem with the operation of Debian server, and you
 think that the system operators need to be notified of this problem,
 please find the contact address for the particular role at <url
 If you have a problem with the operation of Debian server, and you
 think that the system operators need to be notified of this problem,
 please find the contact address for the particular role at <url
-id="http://www.debian.org/devel/maintainer_contacts">.  If you have a
-non-operating problems (such as packages to be remove, suggestions for
-the web site, etc.), generally you'll report a bug against a
-``pseudo-package''.  See <ref id="submit-bug"> for information on how
-to submit bugs.
+id="&url-debian-contacts;">.  If you have a non-operating problems
+(such as packages to be remove, suggestions for the web site, etc.),
+generally you'll report a bug against a ``pseudo-package''.  See <ref
+id="submit-bug"> for information on how to submit bugs.
 
       <sect1 id="servers-master">The master server
        <p>
 
       <sect1 id="servers-master">The master server
        <p>
@@ -402,8 +405,7 @@ If you find a problem with the Debian web server, you should generally
 submit a bug against the pseudo-package,
 <package>www.debian.org</package>.  First check whether or not someone
 else has already reported the problem on the <url
 submit a bug against the pseudo-package,
 <package>www.debian.org</package>.  First check whether or not someone
 else has already reported the problem on the <url
-id="http://www.debian.org/Bugs/db/pa/lwww.debian.org.html" name="Bug
-Tracking System">.
+id="&url-bts;db/pa/lwww.debian.org.html" name="Bug Tracking System">.
 
 
       <sect1 id="servers-cvs">The CVS server
 
 
       <sect1 id="servers-cvs">The CVS server
@@ -437,9 +439,9 @@ up-to-date as they can be.
        <p>
 The main web page listing the available public FTP (and, usually,
 HTTP) servers can be found at <url
        <p>
 The main web page listing the available public FTP (and, usually,
 HTTP) servers can be found at <url
-id="http://www.debian.org/distrib/ftplist">.  More information
+id="&url-debian-mirrors">.  More information
 concerning Debian mirrors can be found at <url
 concerning Debian mirrors can be found at <url
-id="http://www.debian.org/mirror">.  This useful page includes
+id="&url-debian-mirroring">.  This useful page includes
 information and tools which can be helpful if you are interested in
 setting up your own mirror, either for internal or public access.
        <p>
 information and tools which can be helpful if you are interested in
 setting up your own mirror, either for internal or public access.
        <p>
@@ -525,44 +527,7 @@ additional files (documentation, installation disk images, etc.).
        <p>
 Here is an example directory tree of a complete Debian distribution:
        <p>
        <p>
 Here is an example directory tree of a complete Debian distribution:
        <p>
-<example>
-main/
-main/binary-all/
-main/binary-all/admin/
-main/binary-all/base/
-main/binary-all/comm/
-main/binary-all/devel/
-     ...
-main/binary-i386/
-main/binary-i386/admin/
-main/binary-i386/base/
-     ...
-main/binary-m68k
-main/binary-m68k/admin/
-main/binary-m68k/base/
-     ...
-main/source/
-main/source/admin/
-main/source/base/
-     ...
-main/disks-i386/
-main/disks-m68k/
-     ...
-
-contrib/
-contrib/binary-all/
-contrib/binary-i386/
-contrib/binary-m68k/
-     ...
-contrib/source/
-
-non-free/
-non-free/binary-all/
-non-free/binary-i386/
-non-free/binary-m68k/
-         ...
-non-free/source/
-</example>
+&sample-dist-dirtree;
        <p>
 As you can see, the top-level directory of the distribution contains
 three directories, namely <em>main</em>, <em>contrib</em>, and
        <p>
 As you can see, the top-level directory of the distribution contains
 three directories, namely <em>main</em>, <em>contrib</em>, and
@@ -590,15 +555,12 @@ because it fully complies with all our guidelines.  The other two
 sections do not, to different degrees; as such, they are not
 officially part of Debian.
        <p>
 sections do not, to different degrees; as such, they are not
 officially part of Debian.
        <p>
-Every package in the main section must fully comply with the <!-- work
-around quoting of fragment idendifiers bug <url
-id="http://www.debian.org/social_contract#guidelines" name="Debian
-Free Software Guidelines"> --> <url
-id="http://www.debian.org/social_contract" name="Debian Free Software
-Guidelines"> (DFSG) and with all other policy requirements as
-described in the <url id="http://www.debian.org/doc/debian-policy/"
-name="Debian Policy Manual">.  The DFSG is our definition of ``free
-software.'' Check out the Debian Policy Manual for details.
+Every package in the main section must fully comply with the <url
+id="&url-dfsg;" name="Debian Free Software Guidelines"> (DFSG) and
+with all other policy requirements as described in the <url
+id="&url-debian-policy;" name="Debian Policy Manual">.  The DFSG is
+our definition of ``free software.'' Check out the Debian Policy
+Manual for details.
        <p>
 The packages which do not apply to the DFSG are placed in the
 <em>non-free</em> section. These packages are not considered as part
        <p>
 The packages which do not apply to the DFSG are placed in the
 <em>non-free</em> section. These packages are not considered as part
@@ -610,9 +572,9 @@ Packages in the <em>contrib</em> section have to comply with the DFSG,
 but may fail other requirements.  For instance, they may depend on
 non-free packages.
        <p>
 but may fail other requirements.  For instance, they may depend on
 non-free packages.
        <p>
-The <url id="http://www.debian.org/doc/debian-policy/" name="Debian
-Policy Manual"> contains a more exact definition of the three
-sections. The above discussion is just an introduction.
+The <url id="&url-debian-policy;" name="Debian Policy Manual">
+contains a more exact definition of the three sections. The above
+discussion is just an introduction.
        <p>
 The separation of the three sections at the top-level of the archive
 is important for all people who want to distribute Debian, either via
        <p>
 The separation of the three sections at the top-level of the archive
 is important for all people who want to distribute Debian, either via
@@ -751,8 +713,8 @@ Note that development under <em>unstable</em> is continued during the
 created when the older <em>unstable</em> is moved to <em>frozen</em>.
 Another wrinkle is that when the <em>frozen</em> distribution is
 offically released, the old stable distribution is completely removed
 created when the older <em>unstable</em> is moved to <em>frozen</em>.
 Another wrinkle is that when the <em>frozen</em> distribution is
 offically released, the old stable distribution is completely removed
-from the Debian archives (although you can still find it from servers
-which serve up older, obsolete distributions).
+from the Debian archives (although they do live on at
+<tt>archive-host;</tt>).
        <p>
 In summary, there is always a <em>stable</em> and an <em>unstable</em>
 distribution available, and the <em>frozen</em> distribution shows up
        <p>
 In summary, there is always a <em>stable</em> and an <em>unstable</em>
 distribution available, and the <em>frozen</em> distribution shows up