chiark / gitweb /
git-svn-id: svn://anonscm.debian.org/ddp/developers-reference/trunk@4908 313b444b...
[developers-reference.git] / README-contrib
1 * Useful Makefile targets
2
3 The following 'make' targets exist for your convenience:
4
5   make validate
6         validate the well-formedness of all SGML materials
7
8   make all
9         build all languages in all formats
10
11   make developers-reference.sgml.validate
12         validate the well-formedness of the English manual
13
14   make developers-reference.html
15         build the English manual
16
17
18 * Contacting
19
20 To contain the maintainers of this package, email
21 <developers-reference@packages.debian.org>.
22
23
24 * Contributing
25
26 If you want to contribute to the Developer's Reference, it's best to
27 first submit a few patches as bug reports.  Writing patches for
28 existing bugs are also always appreciated.  You may wish to make
29 patches against the CVS sources, about which see below.
30
31 Do not commit patches to the developers reference yourself unless
32 authorized to do so. Patches need to be finalized and common opinion
33 before they are applied. This is even true if you happen to have
34 cvs access for other reasons.
35
36
37 * CVS
38
39 If you're interested in ongoing maintenance, once you've shown that
40 you've mastered the style of the manual with a couple accepted
41 patches, you can be given CVS pserver access. If you have already
42 access to the CVS server for other reasons, do not use it unless
43 authorized to do so.
44
45 Instructions on how to get the CVS version of this software, including
46 how to get CVS access, can be found at
47 <URL:http://www.debian.org/doc/cvs>.
48
49
50 * Translators
51
52 We have tried to keep language-independant bits of text in common.ent.
53 Feel free to truck stuff out of the English manual into common.ent if
54 it's useful, or else report the problem.
55
56 You should exploit CVS to see the diffs between when the document was
57 last translated and the latest version.  Be sure to set the cvs-en-rev
58 entity as appropriate when you do update a translation.
59
60 We have provided commands to help with this.  To see the difference in
61 numbers between the latest translated version and the latest version,
62 do, for instance:
63
64   ./translation-status fr
65
66 To get the diff between the latest translated version and the latest
67 version:
68
69   ./translation-status -d fr
70
71