blob: 9b6b8c3f3153f2a131842b9208470853ee2c52d8 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
|
Working on sbuild -*- text -*-
═════════════════
This document is a short guide to the conventions used in the
buildd-tools sbuild project.
Coding
──────
The style should be apparent from the source. It is the default Emacs
perl-mode style.
Sbuild can be executed directly from source by running the following from the
top level directory.
$ PERL5LIB=lib bin/sbuild
Documentation
─────────────
All the documentation is in UNIX manual page format. GNU roff
extensions are permitted, as is use of tbl. Make sure the printed
output is as good as terminal display. Run "make ps" or "make pdf" to
build the printed documentation.
The following styles are used:
Style Formatting Syntax
--------------------------------------------------------------------
New term Bold .B or \fB
Option definition Bold, args in italic .BR and \fI
Option reference Italic .I or \fI
File definition Bold italic \f[BI]
File reference Italic .I or \fI
Config key definition Courier bold italic \f[CBI]
Config key reference Courier italic \f[CI]
Values Single quotes \[oq] and \[cq]
Example text Double quotes \[lq] and \[rq]
Cross references Italics in double quotes \[lq]\fI...\fP\[rq]
Verbatim examples Courier \f[CR]
Verbatim user input Courier bold \f[CB]
Releasing
─────────
• The code must pass the testsuite (run 'sudo make check' after
./configure --enable-chroot-checks). This requires a local schroot
called 'unstable' setup. These checks can take some time to
run. Plain "autoreconf -fi && ./configure && make check" runs only the
checks that can be done without schroot, which are very quick.
|
