chiark / gitweb /
Leave a bit of headroom above test port number, since we go at least
[disorder] / README.developers
CommitLineData
91d9a42d 1Dependencies:
2
3 * You'll need, in addition to the packages mentioned in README:
4 Automake 1.10 1.7 is no good; 1.8/9 might work
5 Autoconf 2.61 Slightly older might work too
6 Libtool 1.5.22 1.4 is no good
7 Bazaar (bzr) You might be able to manage without
8 Python 2.4
9
10 * On Debian and derivatives this should work:
11
12 apt-get install gcc libc-dev automake autoconf libtool libgtk2.0-dev \
13 libgc-dev libgcrypt-dev libpcre3-dev libvorbis-dev \
14 libao-dev libmad0-dev libasound2-dev libdb4.3-dev \
6f34d131 15 libflac-dev vorbis-tools wget
91d9a42d 16
50450a00
RK
17 (Use the bzr from backports, the one in etch is obsolete.)
18
db8ab224
RK
19 On lenny use libdb4.5-deb. libdb4.6 does not work (and configure will
20 refuse to use it).
21
42f43a11
RK
22 * On FreeBSD you'll need at least these packages:
23 autotools
24 bash
25 flac
26 mad
27 boehm-gc
28 db43
29 gmake
30 gsed
31 libao
32 libgcrypt
33 wget
34 vorbis-tools
35
91d9a42d 36 * Please report unstated dependencies (here, README or debian/control).
37
b30155e3
RK
38Building:
39
db8ab224
RK
40 * Compiled versions of configure and the makefiles are not included in bzr,
41 so if you didn't use a source tarball, you must start as follows:
b30155e3 42
d558cce2
RK
43 bash ./prepare
44 ./configure -C
b30155e3
RK
45 make
46
47 * On FreeBSD you must use gmake.
48
91d9a42d 49Testing:
50
51 * There is an extensive test suite in lib/test.c and tests/*.py. You can
52 run the tests with 'make check'. If possible please add tests for new
53 code to at least one of these. At the very least the existing tests
54 should continue to pass.
55
56 * The tests will not currently pass in an ASCII locale. This is essentially
57 unavoidable given the need to test Unicode support. ISO 8859-1 or UTF-8
58 locales should be OK for the time being.
59
60APIs And Formats:
61
62 * To support a new sound API:
63 1) Teach configure.ac how to detect any libraries required.
b116feb0
RK
64 2) Create lib/uaudio-<name>.c; see uaudio.h for the interface.
65 3) Update the list in lib/uaudio-apis.c
66 4) Add a new option to clients/playrtp.c and document it in
67 doc/disorder-playrtp.1.in (if appropriate).
91d9a42d 68 5) Update doc/disorder_config.5.in.
91d9a42d 69
70 * To support a new file format:
71 1) Teach configure.ac how to detect any libraries required.
72 2) Add a new section to server/decode.c. NB this file may be split into
73 several bits one day.
74 3) Add a new section to plugins/tracklength.c. Again this file may be
75 split up in a future version.
76 4) Update default_players[] in lib/configuration.c.
77 5) Update doc/disorder_config.5.in.
78
79The Server:
80
81 * The server's command implementations must not block. Waiting for a little
0590cedc
RK
82 disk IO is OK but blocking for extended periods on long-lasting
83 transactions or external resources is not acceptable; it will wedge the
84 server for all other users.
85
86 Long-running subprocesses should use subprograms (rather than forking but
87 not execing) if reasonably possible; see c_stats() for an example.
88 c_reminder() is probably in the grey area.
91d9a42d 89
90 * The server process does not use threads and I would like to keep it that
91 way.
92
93 * The server uses the Boehm garbage collector. This eliminates the need to
94 call free() and similar functions in many cases, though teardown calls to
95 that do more than free GC-allocated memory (such as fclose()) are still
96 required.
97
98 * DisOrder's *printf calls, such as byte_xasprintf(), are mostly preferred
99 within the server to the ones built into libc. An important distinction
100 is that they will always accept UTF-8 strings whereas the built-in ones
101 may reject them in non-UTF-8 locales (for instance Glibc does this) with
102 EILSEQ. Only where the data is guaranteed to be ASCII may the libc
103 functions be used.
104
105 * To add a new configuration directive:
106 1) Add a new entry to the struct in lib/configuration.h
107 2) Add a new table entry to conf[] in lib/configuration.c
108 3) If the directive is entirely unlike existing ones add a new type_
109 to lib/configuration.c
110 4) Set the default if non-0 in config_default(). In some cases
111 config_postdefaults() may be more appropriate.
112 5) Document the new directive in doc/disorder_config.5.in
113
114 * To add a new command:
115 1) Add a new c_ function and table entry in server/server.c
116 2) Document the new command in doc/disorder_protocol.5.in
117 3) Add a new function to lib/client.c
118 4) Add a new function to lib/eclient.c
119 5) Add a new function to python/disorder.py.in
120 6) Add a new command to clients/disorder.c and update doc/disorder.1.in
121 7) Add a new test somewhere in tests/*.py
122 Depending on the purpose of the command it may be acceptable to leave out
123 some of the client side work - for instance commands only ever used by the
124 web interface are not implemented in lib/eclient.c.
125
126 * See disorder_protocol(5) for details of how the status code is
127 constructed, and the existing commands for examples.
128
129 * If the command needs a new right to be defined then update lib/rights.[ch]
130 and doc/disorder_config.5.in. New rights should definitely be mentioned
131 in README.upgrades as existing users will not automatically get new rights
132 even if they are in default_rights. If the new right should not be in
133 default_rights by default then you must update config_postdefaults().
134
135Web Interface:
136
137 * The web interface does not use Javascript or Flash and I would like to
b116feb0
RK
138 keep it that way; Javascript might be acceptable but it must degrade
139 gracefuly if disabled. Clever use of CSS is OK provided it works well on
140 the mainstream browsers.
91d9a42d 141
50450a00 142 * Update templates/help.tmpl for any changes you make.
91d9a42d 143
144Disobedience:
145
146 * Disobedience does not currently use threads and I'd prefer to keep it that
147 way.
148
149 * Disobedience uses the Boehm garbage collector but not for GTK+/GLIB's
150 memory allocation, as they are incompatible with it. So you still have to
151 do somewhat manual memory management for GTK+ objects. Fortunately it has
152 its own refcounting system which does most of the work for you.
153
154 * Lengthy operations must not block. In practice this seems to be a less of
155 a problem for Disobedience than the server. Use the GLIB event loop to
156 deal with long-running operations if you do need any.
157
158 * Update doc/disobedience.1.in for any changes you make.
159
0590cedc
RK
160New Platforms:
161
162 * It is not mandatory to have an entry in configure's 'case $host' section,
163 but may well be convenient.
164
165 * Complete support for a new platform implies updating scripts/setup.in and
166 scripts/teardown.in as well as getting the software to build and work (but
167 this doesn't mean that patches that don't achieve this will be rejected).
168
91d9a42d 169Code And Patches:
170
171 * Please follow the existing layout conventions.
172
173 * Please try to write doc comments for new functions, types, etc using the
174 same syntax as the existing ones. Doxygen can be used to turn this into
0590cedc
RK
175 reference documentation (see http://www.stack.nl/~dimitri/doxygen/) but
176 really the point is to have good inline code documentation, not the
177 Doxygen output as such.
91d9a42d 178
179 * More importantly, new configuration directives, protocol commands,
180 interface features etc should be documented in the relevant places.
181
182 * If you add new dependencies please update README, README.developers and
183 debian/control.
184
185 * New dependencies that are not in Debian stable are likely to be rejected.
186 (But if your new feature only makes sense on a given platform then
187 obviously its new dependencies don't need to be available elsewhere.)
188
1b8ed51f
RK
189 * GCCisms such as typeof and C99isms such as mixed declarations and named
190 structure initializers are used; the configure script asks for -std=gnu99
191 by default. Some supported platforms are still on GCC 4.0.
f0a76a4a 192
91d9a42d 193 * Please submit patches either using 'diff -u', or by publishing a bzr
194 branch somewhere I can get at it.
195
196 * Please make it clear that your changes can be distributed under DisOrder's
7751df38 197 licence (which is "GPL v3 or later").
91d9a42d 198
199Local Variables:
200mode:text
201fill-column:79
202End: