← Back to branch summary

~ubuntu-branches/ubuntu/karmic/sbuild/karmic-proposed

« back to all changes in this revision

Viewing changes to HACKING

  • Committer: Bazaar Package Importer
  • Author(s): Roger Leigh, Roger Leigh
  • Date: 2009-05-19 22:16:46 UTC
  • mfrom: (8.1.8 upstream)
  • Revision ID: james.westby@ubuntu.com-20090519221646-iyxt2sohtaxtwgjr
Tags: 0.58.4-1
http://bugs.debian.org/528312
http://bugs.debian.org/529470
http://bugs.debian.org/509133
[ Roger Leigh ]
* New release. 
* sbuild:
  - A $purge_build_deps configuration option, and --purge-deps
    command-line option have been added to control build-dependency
    removal (Closes: #528312).
  - Use the isin function from the Sbuild module (Closes: #529470).
    Thanks to Gustavo Noronha Silva for spotting this.
* Sbuild:
  - Use Filesys::Df (libfilesys-df-perl) in place of invoking /bin/df
    and parsing its output.  This is more robust and efficient, and
    works whatever the user environment (Closes: #509133).

Show diffs side-by-side

added added

removed removed

Lines of Context:
HACKING
 
1
Working on sbuild                                                   -*- text -*-
 
2
═════════════════
 
3
 
 
4
This document is a short guide to the conventions used in the
 
5
buildd-tools sbuild project.
 
6
 
 
7
 
 
8
Coding
 
9
──────
 
10
 
 
11
The style should be apparent from the source.  It is the default Emacs
 
12
perl-mode style.
 
13
 
 
14
 
 
15
Documentation
 
16
─────────────
 
17
 
 
18
All the documentation is in UNIX manual page format.  GNU roff
 
19
extensions are permitted, as is use of tbl.  Make sure the printed
 
20
output is as good as terminal display.  Run "make ps" or "make pdf" to
 
21
build the printed documentation.
 
22
 
 
23
 
 
24
The following styles are used:
 
25
 
 
26
  Style                  Formatting                Syntax
 
27
  --------------------------------------------------------------------
 
28
  New term               Bold                      .B or \fB
 
29
  Option definition      Bold, args in italic      .BR and \fI
 
30
  Option reference       Italic                    .I or \fI
 
31
  File definition        Bold italic               \f[BI]
 
32
  File reference         Italic                    .I or \fI
 
33
  Config key definition  Courier bold italic       \f[CBI]
 
34
  Config key reference   Courier italic            \f[CI]
 
35
  Values                 Single quotes             \[oq] and \[cq]
 
36
  Example text           Double quotes             \[lq] and \[rq]
 
37
  Cross references       Italics in double quotes  \[lq]\fI...\fP\[rq]
 
38
  Verbatim examples      Courier                   \f[CR]
 
39
  Verbatim user input    Courier bold              \f[CB]
 
40
 
 
41
 
 
42
Releasing
 
43
─────────
 
44
 
 
45
New upstream releases:
 
46
 
 
47
• The code must pass the testsuite (make check).
 
48
 
 
49
• The NEWS file must be up to date, and have the current version
 
50
  number present on the line starting with "Welcome to sbuild
 
51
  <version>.".
 
52
 
 
53
• Run scripts/git-tag-release which will tag the git repository and
 
54
  prompt for a GPG passphrase to sign the tag with your GPG public
 
55
  key.  This is essential to get a correct version number in the
 
56
  release in the next step, and can not be skipped.
 
57
 
 
58
• Run ./bootstrap to create the VERSION file and regenerate the
 
59
  configure script with the new version number.  This uses the last
 
60
  release tag (generated with git-tag-release) to get the package name
 
61
  and version number.
 
62
 
 
63
• Run ./configure --enable-maintainer-mode and then "make distcheck"
 
64
  to test and package up the release
 
65
 
 
66
New Debian releases:
 
67
 
 
68
• Run debian/git-tag-debian to tag the release.