diff options
author | Sergey Poznyakoff <gray@gnu.org.ua> | 2009-02-06 12:27:26 +0200 |
---|---|---|
committer | Sergey Poznyakoff <gray@gnu.org.ua> | 2009-02-06 12:27:26 +0200 |
commit | cf07f316b773f552dbebeeac4a1220e8e7c968d0 (patch) | |
tree | 315fcca66bffaf598a421cd96e523814e365d964 | |
parent | 2777861e30fd2dab6bd5d8745b08091052f90677 (diff) | |
download | cflow-cf07f316b773f552dbebeeac4a1220e8e7c968d0.tar.gz cflow-cf07f316b773f552dbebeeac4a1220e8e7c968d0.tar.bz2 |
Update docs
-rw-r--r-- | .gitignore | 2 | ||||
-rw-r--r-- | Makefile.am | 1 | ||||
-rw-r--r-- | NEWS | 9 | ||||
-rw-r--r-- | README-alpha | 66 | ||||
-rw-r--r-- | README-hacking | 66 | ||||
-rw-r--r-- | configure.ac | 18 | ||||
-rw-r--r-- | gnulib.modules | 2 | ||||
-rw-r--r-- | po/.gitignore | 3 | ||||
-rw-r--r-- | src/Makefile.am | 4 |
9 files changed, 78 insertions, 93 deletions
@@ -10,8 +10,8 @@ | |||
10 | .deps | 10 | .deps |
11 | .emacs.desktop | 11 | .emacs.desktop |
12 | ABOUT-NLS | 12 | ABOUT-NLS |
13 | INSTALL | ||
14 | ChangeLog | 13 | ChangeLog |
14 | INSTALL | ||
15 | Makefile | 15 | Makefile |
16 | Makefile.in | 16 | Makefile.in |
17 | aclocal.m4 | 17 | aclocal.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 | ||
21 | AUTOMAKE_OPTIONS = gnits 1.8 dist-bzip2 | ||
22 | ACLOCAL_AMFLAGS = -I m4 | 21 | ACLOCAL_AMFLAGS = -I m4 |
23 | 22 | ||
24 | SUBDIRS = lib src elisp po doc tests | 23 | SUBDIRS = lib src elisp po doc tests |
@@ -1,8 +1,11 @@ | |||
1 | GNU cflow NEWS -- history of user-visible changes. 2007-06-29 | 1 | GNU cflow NEWS -- history of user-visible changes. 2009-02-06 |
2 | Copyright (C) 2005, 2006, 2007 Sergey Poznyakoff | 2 | Copyright (C) 2005, 2006, 2007, 2009 Sergey Poznyakoff |
3 | See the end of file for copying conditions. | 3 | See the end of file for copying conditions. |
4 | 4 | ||
5 | Please send cflow bug reports to <bug-cflow@gnu.org>. | 5 | Please send cflow bug reports to <bug-cflow@gnu.org>. |
6 | |||
7 | |||
8 | Version 1.2.90 (Git) | ||
6 | 9 | ||
7 | Version 1.2: | 10 | Version 1.2: |
8 | 11 | ||
@@ -55,7 +58,7 @@ Initial version restored from 1997 snapshots. | |||
55 | ---------------------------------------------------------------------- | 58 | ---------------------------------------------------------------------- |
56 | * Copyright information: | 59 | * Copyright information: |
57 | 60 | ||
58 | Copyright (C) 2005, 2006 Sergey Poznyakoff | 61 | Copyright (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 @@ | |||
1 | This is the GNU cflow package. | 1 | This is the GNU cflow package. |
2 | This document describes the actions needed to build the pre-release | 2 | This document describes the actions needed to build the pre-release |
3 | or CVS version of the package. See end of file for copying conditions. | 3 | or GIT version of the package. See end of file for copying conditions. |
4 | 4 | ||
5 | * Introduction | 5 | * Introduction |
6 | 6 | ||
7 | This is a *pre-release* version, and not ready for production use yet. If you | 7 | This is a *pre-release* version, and not ready for production use yet. |
8 | are taking source from CVS, you will need to have automake, and | 8 | If you are taking source from Git, you will need to have several |
9 | autoconf installed to bootstrap the package. See the chapter `Building' for | 9 | special tools to help contribute. See the file README-hacking for more |
10 | the detailed instructions. After bootstrapping, there should be a file | 10 | information. See chapter `Building' for the detailed instructions on |
11 | 'INSTALL' with generic installation instructions. Package-specific | 11 | how to build the package. |
12 | installation instructions are set forth in the file README. | ||
13 | 12 | ||
14 | Please, note that the accompanying documentation may be inaccurate or | 13 | Please, note that the accompanying documentation may be inaccurate |
15 | incomplete (well, to say the truth it is absent. See TODO for more info). | 14 | or incomplete. The git lot is the authoritative documentation of |
16 | The ChangeLog file is the authoritative documentation for all recent changes. | 15 | all recent changes. You may convert it to a traditional ChangeLog by |
16 | running `make ChangeLog'. | ||
17 | 17 | ||
18 | Report bugs to <bug-cflow@gnu.org> | 18 | Report bugs to <bug-cflow@gnu.org> |
19 | 19 | ||
20 | * Checking Out the Sources | 20 | * Checking Out the Sources |
21 | 21 | ||
22 | The following instructions apply if you wish to obtain sources from | 22 | The following instructions apply if you wish to obtain sources from |
23 | the CVS repository: | 23 | the GIT repository: |
24 | 24 | ||
25 | To checkout the source tree from CVS issue the following command: | 25 | To clone the GNU cflow repository, issue the following command: |
26 | 26 | ||
27 | CVS_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 | ||
30 | Make sure SSHv2 is used. | 29 | or |
30 | |||
31 | git clone http://git.sv.gnu.org/r/cflow.git | ||
31 | 32 | ||
32 | This will give you read-only access. If you think you need write access, | 33 | This will give you read-only access. If you think you need write access, |
33 | contact the mailing list. | 34 | contact the mailing list. |
34 | 35 | ||
35 | The CVS repository is also available via HTTP from | 36 | For more information about Git access, visit |
37 | http://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 | ||
41 | If you have taken the sources from CVS you will need the following | 41 | Usual procedures apply: |
42 | packages to build cflow. I don't make any extra effort to accommodate | ||
43 | older versions of these packages, so please make sure that you have the | ||
44 | latest 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 | |||
55 | To prepare the package for building run `build-aux/bootstrap' utility. | ||
56 | For example: | ||
57 | 42 | ||
58 | $ cd cflow | 43 | ./configure |
59 | $ build-aux/bootstrap | 44 | make |
45 | make install | ||
60 | 46 | ||
61 | If you have already checked out gnulib sources, use --gnulib-srcdir | 47 | See INSTALL and README for the detailed instructions. |
62 | to 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 | ||
69 | To enable additional debugging information, configure the package with | 51 | To 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 | ||
92 | Copyright (C) 2005, 2007 Sergey Poznyakoff | 74 | Copyright (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 @@ | |||
1 | These notes intend to help people working on the CVS version of | 1 | These notes intend to help people working on the GIT version of |
2 | this package. | 2 | GNU cflow. |
3 | 3 | ||
4 | * Requirements | 4 | * Requirements |
5 | 5 | ||
6 | Only the sources are installed in the CVS repository (to ease the | 6 | Only the sources are installed in the GIT repository (to ease the |
7 | maintenance, merges etc.), therefore you will have to get the latest | 7 | maintenance, merges etc.), therefore you will need the following |
8 | stable versions of the maintainer tools we depend upon, including: | 8 | packages to build GNU cflow. I don't make any extra effort to |
9 | accommodate older versions of these packages, so please make sure that | ||
10 | you 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 | ||
19 | Only building the initial full source tree will be a bit painful, | 21 | * Bootstrapping |
20 | later, a plain `cvs update -P && make' should be sufficient. | ||
21 | |||
22 | * First CVS checkout | ||
23 | 22 | ||
24 | Obviously, if you are reading these notes, you did manage to check out | 23 | Obviously, if you are reading these notes, you did manage to check out |
25 | this package from CVS. The next step is to get other files needed to | 24 | the project from GIT. The next step is to get other files needed to build, |
26 | build, which are extracted from other source packages: | 25 | which are extracted from other source packages: |
26 | |||
27 | 1. Change to the source tree directory | ||
28 | |||
29 | cd cflow | ||
27 | 30 | ||
28 | $ build-aux/bootstrap | 31 | 2. Run |
29 | 32 | ||
30 | If you already have checked out the gnulib sources, you can speed up | 33 | ./bootstrap |
31 | the process by specifying their location using --gnulib-srcdir command | ||
32 | line option: | ||
33 | 34 | ||
34 | $ build-aux/bootstrap --gnulib-srcdir=$HOME/gnu/gnulib | 35 | Once done, proceed as described in the file README (section |
36 | INSTALLATION). | ||
35 | 37 | ||
36 | If you plan to be hacking on cflow, it is probably that you will need | 38 | Normally you will have to run bootstrap only once. However, if you |
37 | to re-run bootstrap from time to time, for example after updating your | 39 | intend to hack on GNU cflow, you might need to run it again later. In |
38 | gnulib copy in order to propagate the changes into cflow tree. In | 40 | this case, you will probably want to save some time and bandwidth by |
39 | these case we recommend to store bootstrap options in a file named | 41 | avoiding 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 | 42 | root directory a file named `.bootstrap' with the following |
41 |