summaryrefslogtreecommitdiffabout
path: root/README-hacking
Unidiff
Diffstat (limited to 'README-hacking') (more/less context) (show whitespace changes)
-rw-r--r--README-hacking83
1 files changed, 83 insertions, 0 deletions
diff --git a/README-hacking b/README-hacking
new file mode 100644
index 0000000..2b3e889
--- a/dev/null
+++ b/README-hacking
@@ -0,0 +1,83 @@
1These notes intend to help people working on the CVS version of
2this package.
3
4* Requirements
5
6Only the sources are installed in the CVS repository (to ease the
7maintenance, merges etc.), therefore you will have to get the latest
8stable versions of the maintainer tools we depend upon, including:
9
10- Automake <http://www.gnu.org/software/automake/>
11- Autoconf <http://www.gnu.org/software/autoconf/>
12- Gettext <http://www.gnu.org/software/gettext/>
13- Gnulib <http://www.gnu.org/software/gnulib/>
14- M4 <http://www.gnu.org/software/m4/>
15- Texinfo <http://www.gnu.org/software/texinfo>
16- Wget <http://www.gnu.org/software/wget/>
17
18Only building the initial full source tree will be a bit painful,
19later, a plain `cvs update -P && make' should be sufficient.
20
21* First CVS checkout
22
23Obviously, if you are reading these notes, you did manage to check out
24this package from CVS. The next step is to get other files needed to
25build, which are extracted from other source packages:
26
27 $ build-aux/bootstrap
28
29If you already have checked out the gnulib sources, you can speed up
30the process by specifying their location using --gnulib-srcdir command
31line option:
32
33 $ build-aux/bootstrap --gnulib-srcdir=$HOME/gnu/gnulib
34
35If you plan to be hacking on cflow, it is probably that you will need
36to re-run bootstrap from time to time, for example after updating your
37gnulib copy in order to propagate the changes into cflow tree. In
38these case we recommend to store bootstrap options in a file named
39.bootstrap, in the cflow root directory. The format of this file is
40very simple: it contains bootstrap command line options separated by
41any amount of whitespace characters (i.e. spaces, tabs and newlines).
42Any line starting with a comment character `#' is ignored as well as
43are empty lines. For example, if you plan to always use the same gnulib
44directory and to copy gnulib files instead of creating symbolic links
45to them, then your .bootstrap file would contain:
46
47 # Sample .bootstrap file
48 --gnulib-srcdir=$HOME/gnu/gnulib
49 --copy
50
51Once you have bootstrapped the source tree, run:
52
53 $ ./configure
54 $ make
55 $ make check
56
57Enjoy!
58
59-----
60
61Copyright (C) 2002, 2003, 2004, 2005, 2006, 2007 Free Software Foundation,
62Inc.
63
64This program is free software; you can redistribute it and/or modify
65it under the terms of the GNU General Public License as published by
66the Free Software Foundation; either version 2, or (at your option)
67any later version.
68
69This program is distributed in the hope that it will be useful,
70but WITHOUT ANY WARRANTY; without even the implied warranty of
71MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
72GNU General Public License for more details.
73
74You should have received a copy of the GNU General Public License
75along with this program; if not, write to the Free Software
76Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
7702110-1301, USA.
78
79
80Local variables:
81mode: outline
82 paragraph-separate: "[ ]*$"
83end:

Return to:

Send suggestions and report system problems to the System administrator.