The following 'make' targets exist for your convenience:
make validate
- validate the well-formedness of all SGML materials
+ validate the well-formedness of all XML materials
- make all
+ make or make all (optional: VERSION=x.y.z PUBDATE=2007-07-01)
build all languages in all formats
- make developers-reference.sgml.validate
- validate the well-formedness of the English manual
+ make index.html
+ build the English manual in HTML format
- make developers-reference.html
- build the English manual
+ make fr/developers-reference.pdf
+ build the French manual in PDF format
+
+ make ja/developers-reference.txt
+ build the Japanese manual in text format
+
+ make pot
+ generate .pot files from .dbk sources
+
+ make updatepo LINGUA=xx (with xx=language code)
+ update .po files for language xx
* Contacting
If you want to contribute to the Developer's Reference, it's best to
first submit a few patches as bug reports. Writing patches for
existing bugs are also always appreciated. You may wish to make
-patches against the CVS sources, about which see below.
+patches against the SVN sources, about which see below.
+
+When making changes, please try to use short lines of text (< 64
+characters). This makes it easier to use 'diff' to see the
+differences. (See discussion in <http://bugs.debian.org/278267>)
Do not commit patches to the developers reference yourself unless
authorized to do so. Patches need to be finalized and common opinion
before they are applied. This is even true if you happen to have
-cvs access for other reasons.
+SVN access for other reasons.
+
+
+* Writing style
+
+Please use gender-neutral formulations. This means avoiding
+pronouns like he/she when referring to a role (like "maintainer")
+whose gender is unknown. Instead of you should use the
+plural form (singular they [1]).
+
+[1] http://en.wikipedia.org/wiki/Singular_they
-* CVS
+* SVN
If you're interested in ongoing maintenance, once you've shown that
you've mastered the style of the manual with a couple accepted
-patches, you can be given CVS pserver access. If you have already
-access to the CVS server for other reasons, do not use it unless
+patches, you can be given SVN access. If you already have
+access to the SVN server for other reasons, do not use it unless
authorized to do so.
-Instructions on how to get the CVS version of this software, including
-how to get CVS access, can be found at
-<URL:http://www.debian.org/doc/cvs>.
+This manual is a part of the Debian Documentation Project (DDP).
+Information about SVN access for DDP can be found at
+<http://www.debian.org/doc/cvs>.
+
+If you just want to check out the current SVN version of this
+manual to create patches against, you can use the following
+command to do so:
+
+svn co svn://svn.debian.org/ddp/manuals/trunk/developers-reference
* Translators
Feel free to truck stuff out of the English manual into common.ent if
it's useful, or else report the problem.
-You should exploit CVS to see the diffs between when the document was
-last translated and the latest version. Be sure to set the cvs-en-rev
-entity as appropriate when you do update a translation.
-
-We have provided commands to help with this. To see the difference in
-numbers between the latest translated version and the latest version,
-do, for instance:
-
- ./translation-status fr
-
-To get the diff between the latest translated version and the latest
-version:
-
- ./translation-status -d fr
-
-
+The translation PO files are in po4a/po/, we hope very much for more
+translations.
~ianmdlvl / developers-reference.git / blobdiff