chiark / gitweb /
[DR] Consistent use of <literal> tag
[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 XML materials
7
8   make or make all (optional: VERSION=x.y.z PUBDATE=2007-07-01)
9         build all languages in all formats
10
11   make index.html
12         build the English manual in HTML format
13
14   make fr/developers-reference.pdf
15         build the French manual in PDF format
16
17   make ja/developers-reference.txt
18         build the Japanese manual in text format
19
20   make pot
21         generate .pot files from .dbk sources
22
23   make updatepo LINGUA=xx (with xx=language code)
24         update .po files for language xx
25
26
27 * Contacting
28
29 To contain the maintainers of this package, email
30 <developers-reference@packages.debian.org>.
31
32
33 * Contributing
34
35 If you want to contribute to the Developer's Reference, it's best to
36 first submit a few patches as bug reports.  Writing patches for
37 existing bugs are also always appreciated.  You may wish to make
38 patches against the SVN sources, about which see below.
39
40 When making changes, please try to use short lines of text (< 64
41 characters). This makes it easier to use 'diff' to see the
42 differences. (See discussion in <http://bugs.debian.org/278267>)
43
44 Do not commit patches to the developers reference yourself unless
45 authorized to do so. Patches need to be finalized and common opinion
46 before they are applied. This is even true if you happen to have
47 SVN access for other reasons.
48
49
50 * Writing style
51
52 Please use gender-neutral formulations. This means avoiding
53 pronouns like he/she when referring to a role (like "maintainer")
54 whose gender is unknown. Instead of you should use the
55 plural form (singular they [1]).
56
57 [1] http://en.wikipedia.org/wiki/Singular_they
58
59
60 * SVN
61
62 If you're interested in ongoing maintenance, once you've shown that
63 you've mastered the style of the manual with a couple accepted
64 patches, you can be given SVN access. If you already have
65 access to the SVN server for other reasons, do not use it unless
66 authorized to do so.
67
68 This manual is a part of the Debian Documentation Project (DDP).
69 Information about SVN access for DDP can be found at
70 <http://www.debian.org/doc/cvs>.
71
72 If you just want to check out the current SVN version of this
73 manual to create patches against, you can use the following
74 command to do so:
75
76 svn co svn://svn.debian.org/ddp/manuals/trunk/developers-reference
77
78
79 * Translators
80
81 We have tried to keep language-independant bits of text in common.ent.
82 Feel free to truck stuff out of the English manual into common.ent if
83 it's useful, or else report the problem.
84
85 The translation PO files are in po4a/po/, we hope very much for more
86 translations.