aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSergey Poznyakoff <gray@gnu.org.ua>2009-02-06 12:27:26 +0200
committerSergey Poznyakoff <gray@gnu.org.ua>2009-02-06 12:27:26 +0200
commitcf07f316b773f552dbebeeac4a1220e8e7c968d0 (patch)
tree315fcca66bffaf598a421cd96e523814e365d964
parent2777861e30fd2dab6bd5d8745b08091052f90677 (diff)
downloadcflow-cf07f316b773f552dbebeeac4a1220e8e7c968d0.tar.gz
cflow-cf07f316b773f552dbebeeac4a1220e8e7c968d0.tar.bz2
Update docs
-rw-r--r--.gitignore2
-rw-r--r--Makefile.am1
-rw-r--r--NEWS9
-rw-r--r--README-alpha66
-rw-r--r--README-hacking66
-rw-r--r--configure.ac18
-rw-r--r--gnulib.modules2
-rw-r--r--po/.gitignore3
-rw-r--r--src/Makefile.am4
9 files changed, 78 insertions, 93 deletions
diff --git a/.gitignore b/.gitignore
index 196d4d9..e5d7fda 100644
--- a/.gitignore
+++ b/.gitignore
@@ -10,8 +10,8 @@
10.deps 10.deps
11.emacs.desktop 11.emacs.desktop
12ABOUT-NLS 12ABOUT-NLS
13INSTALL
14ChangeLog 13ChangeLog
14INSTALL
15Makefile 15Makefile
16Makefile.in 16Makefile.in
17aclocal.m4 17aclocal.m4
diff --git a/Makefile.am b/Makefile.am
index b491182..ce24bbd 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -18,7 +18,6 @@
18# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 18# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
19# 02110-1301 USA. 19# 02110-1301 USA.
20 20
21AUTOMAKE_OPTIONS = gnits 1.8 dist-bzip2
22ACLOCAL_AMFLAGS = -I m4 21ACLOCAL_AMFLAGS = -I m4
23 22
24SUBDIRS = lib src elisp po doc tests 23SUBDIRS = lib src elisp po doc tests
diff --git a/NEWS b/NEWS
index a086366..5ee74e5 100644
--- a/NEWS
+++ b/NEWS
@@ -1,8 +1,11 @@
1GNU cflow NEWS -- history of user-visible changes. 2007-06-29 1GNU cflow NEWS -- history of user-visible changes. 2009-02-06
2Copyright (C) 2005, 2006, 2007 Sergey Poznyakoff 2Copyright (C) 2005, 2006, 2007, 2009 Sergey Poznyakoff
3See the end of file for copying conditions. 3See the end of file for copying conditions.
4 4
5Please send cflow bug reports to <bug-cflow@gnu.org>. 5Please send cflow bug reports to <bug-cflow@gnu.org>.
6
7
8Version 1.2.90 (Git)
6 9
7Version 1.2: 10Version 1.2:
8 11
@@ -55,7 +58,7 @@ Initial version restored from 1997 snapshots.
55---------------------------------------------------------------------- 58----------------------------------------------------------------------
56* Copyright information: 59* Copyright information:
57 60
58Copyright (C) 2005, 2006 Sergey Poznyakoff 61Copyright (C) 2005, 2006, 2007, 2009 Sergey Poznyakoff
59 62
60 Permission is granted to anyone to make or distribute verbatim copies 63 Permission is granted to anyone to make or distribute verbatim copies
61 of this document as received, in any medium, provided that the 64 of this document as received, in any medium, provided that the
diff --git a/README-alpha b/README-alpha
index 46c3a00..8abeae8 100644
--- a/README-alpha
+++ b/README-alpha
@@ -1,69 +1,51 @@
1This is the GNU cflow package. 1This is the GNU cflow package.
2This document describes the actions needed to build the pre-release 2This document describes the actions needed to build the pre-release
3or CVS version of the package. See end of file for copying conditions. 3or GIT version of the package. See end of file for copying conditions.
4 4
5* Introduction 5* Introduction
6 6
7This is a *pre-release* version, and not ready for production use yet. If you 7This is a *pre-release* version, and not ready for production use yet.
8are taking source from CVS, you will need to have automake, and 8If you are taking source from Git, you will need to have several
9autoconf installed to bootstrap the package. See the chapter `Building' for 9special tools to help contribute. See the file README-hacking for more
10the detailed instructions. After bootstrapping, there should be a file 10information. See chapter `Building' for the detailed instructions on
11'INSTALL' with generic installation instructions. Package-specific 11how to build the package.
12installation instructions are set forth in the file README.
13 12
14Please, note that the accompanying documentation may be inaccurate or 13Please, note that the accompanying documentation may be inaccurate
15incomplete (well, to say the truth it is absent. See TODO for more info). 14or incomplete. The git lot is the authoritative documentation of
16The ChangeLog file is the authoritative documentation for all recent changes. 15all recent changes. You may convert it to a traditional ChangeLog by
16running `make ChangeLog'.
17 17
18Report bugs to <bug-cflow@gnu.org> 18Report bugs to <bug-cflow@gnu.org>
19 19
20* Checking Out the Sources 20* Checking Out the Sources
21 21
22The following instructions apply if you wish to obtain sources from 22The following instructions apply if you wish to obtain sources from
23the CVS repository: 23the GIT repository:
24 24
25To checkout the source tree from CVS issue the following command: 25To clone the GNU cflow repository, issue the following command:
26 26
27CVS_RSH=ssh \ 27 git clone git://git.savannah.gnu.org/cflow.git
28 cvs -d :ext:anoncvs@cvs.savannah.gnu.org:/cvsroot/cflow checkout cflow
29 28
30Make sure SSHv2 is used. 29or
30
31 git clone http://git.sv.gnu.org/r/cflow.git
31 32
32This will give you read-only access. If you think you need write access, 33This will give you read-only access. If you think you need write access,
33contact the mailing list. 34contact the mailing list.
34 35
35The CVS repository is also available via HTTP from 36For more information about Git access, visit
37http://savannah.gnu.org/git/?group=cflow
36 38
37 http://cvs.savannah.gnu.org/cgi-bin/viewcvs/cflow/cflow/
38
39* Building 39* Building
40 40
41If you have taken the sources from CVS you will need the following 41Usual procedures apply:
42packages to build cflow. I don't make any extra effort to accommodate
43older versions of these packages, so please make sure that you have the
44latest stable version.
45
46- Automake <http://www.gnu.org/software/automake/>
47- Autoconf <http://www.gnu.org/software/autoconf/>
48- Flex <http://flex.sourceforge.net/>
49- Gettext <http://www.gnu.org/software/gettext/>
50- Gnulib <http://www.gnu.org/software/gnulib/>
51- M4 <http://www.gnu.org/software/m4/>
52- Texinfo <http://www.gnu.org/software/texinfo>
53- Wget <http://www.gnu.org/software/wget/>
54
55To prepare the package for building run `build-aux/bootstrap' utility.
56For example:
57 42
58 $ cd cflow 43 ./configure
59 $ build-aux/bootstrap 44 make
45 make install
60 46
61If you have already checked out gnulib sources, use --gnulib-srcdir 47See INSTALL and README for the detailed instructions.
62to specify their location, this will spare you time and bandwidth:
63 48
64 $ cd cflow
65 $ build-aux/bootstrap --gnulib-srcdir=$HOME/gnu/gnulib
66
67* Debugging 49* Debugging
68 50
69To enable additional debugging information, configure the package with 51To enable additional debugging information, configure the package with
@@ -89,7 +71,7 @@ Now set your breakpoints and proceed as usual.
89 71
90* Copyright information: 72* Copyright information:
91 73
92Copyright (C) 2005, 2007 Sergey Poznyakoff 74Copyright (C) 2005, 2007, 2009 Sergey Poznyakoff
93 75
94 Permission is granted to anyone to make or distribute verbatim copies 76 Permission is granted to anyone to make or distribute verbatim copies
95 of this document as received, in any medium, provided that the 77 of this document as received, in any medium, provided that the
diff --git a/README-hacking b/README-hacking
index 8fd130a..5307d93 100644
--- a/README-hacking
+++ b/README-hacking
@@ -1,11 +1,13 @@
1These notes intend to help people working on the CVS version of 1These notes intend to help people working on the GIT version of
2this package. 2GNU cflow.
3 3
4* Requirements 4* Requirements
5 5
6Only the sources are installed in the CVS repository (to ease the 6Only the sources are installed in the GIT repository (to ease the
7maintenance, merges etc.), therefore you will have to get the latest 7maintenance, merges etc.), therefore you will need the following
8stable versions of the maintainer tools we depend upon, including: 8packages to build GNU cflow. I don't make any extra effort to
9accommodate older versions of these packages, so please make sure that
10you have the latest stable version.
9 11
10- Automake <http://www.gnu.org/software/automake/> 12- Automake <http://www.gnu.org/software/automake/>
11- Autoconf <http://www.gnu.org/software/autoconf/> 13- Autoconf <http://www.gnu.org/software/autoconf/>
@@ -16,51 +18,43 @@ stable versions of the maintainer tools we depend upon, including:
16- Texinfo <http://www.gnu.org/software/texinfo> 18- Texinfo <http://www.gnu.org/software/texinfo>
17- Wget <http://www.gnu.org/software/wget/> 19- Wget <http://www.gnu.org/software/wget/>
18 20
19Only building the initial full source tree will be a bit painful, 21* Bootstrapping
20later, a plain `cvs update -P && make' should be sufficient.
21
22* First CVS checkout
23 22
24Obviously, if you are reading these notes, you did manage to check out 23Obviously, if you are reading these notes, you did manage to check out
25this package from CVS. The next step is to get other files needed to 24the project from GIT. The next step is to get other files needed to build,
26build, which are extracted from other source packages: 25which are extracted from other source packages:
26
271. Change to the source tree directory
28
29 cd cflow
27 30
28 $ build-aux/bootstrap 312. Run
29 32
30If you already have checked out the gnulib sources, you can speed up 33 ./bootstrap
31the process by specifying their location using --gnulib-srcdir command
32line option:
33 34
34 $ build-aux/bootstrap --gnulib-srcdir=$HOME/gnu/gnulib 35Once done, proceed as described in the file README (section
36INSTALLATION).
35 37
36If you plan to be hacking on cflow, it is probably that you will need 38Normally you will have to run bootstrap only once. However, if you
37to re-run bootstrap from time to time, for example after updating your 39intend to hack on GNU cflow, you might need to run it again later. In
38gnulib copy in order to propagate the changes into cflow tree. In 40this case, you will probably want to save some time and bandwidth by
39these case we recommend to store bootstrap options in a file named 41avoiding downloading the same files again. If so, create in the project's
40.bootstrap, in the cflow root directory. The format of this file is 42root directory a file named `.bootstrap' with the following
41