diff options
| -rw-r--r-- | ChangeLog | 4 | ||||
| -rw-r--r-- | README | 61 | ||||
| -rw-r--r-- | TODO | 40 |
3 files changed, 75 insertions, 30 deletions
@@ -1,5 +1,9 @@ 2005-09-25 Sergey Poznyakoff <gray@gnu.org.ua> + * README: Updated + * TODO: Updated + * doc/cflow.txt: Removed + * doc/cflow.texi: Finished! Some @FIXMEs left, though. * elisp/cflow-mode.el (cflow-find-function): Change binding to @key{s}, for compatibility with po-mode. @@ -1,5 +1,22 @@ +GNU cflow README +Copyright (C) 2005 Sergey Poznyakoff +See the end of file for copying conditions. + * Introduction +This file contains brief information about configuring, and installing +GNU cflow. It is *not* intended as a replacement for the +documentation, instead it is provided as a brief reference only. +Please be sure to read the accompanuing documentation before using the +utility. See section `Documentation' below. + +Please read *all* sections of this `README' file before starting +configuration. Also make sure you read `INSTALL' if you are not +familiar with them already. Refer to file `ABOUT-NLS' for information +regarding internationalization. + +* History + The GNU cflow was initially written in 1997, when I needed a utility that could display the control flow in a C program. The latest updates date back to 1999. Then, as I no longer needed the package, it fell into @@ -7,7 +24,8 @@ oblivion. A recent thread in gnu-devel mailing list has shown that there is a kind of demand for that sort of utility, so I decided to resurrect -it and make a full-fledged package of it. See TODO for the details. +it and make a full-fledged package of it. On 2005-04-12 it was dubbed +a GNU package. * Current Status @@ -17,28 +35,41 @@ ones. It is able to produce output two formats: default output format (which I call GNU cflow format and which is the default) and in POSIX format. +Currently the utility is only able to process C sources. It is the +only deviation from POSIX specs, that require the ability to process +YACC and LEX sources as well as binary object files. This support will +appear in future versions. + Emacs module cflow-mode.el works wit files in GNU cflow format (as opposed to POSIX format). It has been tested with Emacs 21.3. -* Planned Status +* Compilation + +Please see the INSTALL file in this directory for the generic instructions +on how to use configure. There is currently only one package-specific +configuration option: --enable-debug, which compiles the package with +-g (or -ggdb if appropriate) option. Use it if you plan debugging +cflow. + +* Installation + +After running `./configure' and `make', run `make install'. + +* Documentation -The planned utility shall fully conform to POSIX specification of a -cflow utility. See doc/cflow.txt for the exact description. +Complete user manual in texinfo format is provided. After the +installation, it will be accessible by running `info cflow'. To read it +before installing the package, run `info -f doc/cflow' from the +package source root directory. -The package shall have modular architecture: the `cflow' utility itself -shall invoke an external program (a back-end) to perform a lexical analisys -of input sources. This will allow to use `cflow' to analize source files -written in languages other than C. +If you don't have GNU texinfo installed, see +http://www.gnu.org/software/texinfo for information on where to obtain it. -The output format of the utility shall conform to the POSIX specification. -The program shall also be able to optionally pipe its output to an -external program (a front-end). This will allow for creating reports in -various formats (e.g. graph, html, etc.) +* Bug reporting. -An Emacs interface shall be provided that will facilitate source file -navigation from Emacs. +Send bug reports to <bug-cflow@gnu.org>. -* Copyright information: +* Copyright Information: Copyright (C) 2005, Sergey Poznyakoff @@ -1,24 +1,36 @@ -GNU cflow TODO list. 2005-03-22 +GNU cflow TODO list. 2005-11-25 Copyright (C) 2005, Sergey Poznyakoff * Introduction -This document specifies the roadmap for converting cflow into a -package conforming to GNU standards and providing full functionality -of POSIX cflow utility plus useful extensions. It is subdivided into -three main sections: High Priority Issues, Medium Priority Issues and -Low Priority Issues. The entries within each section are placed in -order of decreasing priority, the most urgent ones being the first. +This document specifies the roadmap for further modification of +cflow. It is subdivided into four main sections: Planned Status +Overview, and three priority sections: High Priority Issues, Medium +Priority Issues and Low Priority Issues. The entries within each +priority section are placed in order of decreasing priority, the +most urgent ones being the first. -* High Priority Issues +* Planned Status Overview + +The planned utility shall fully conform to POSIX specification of a +cflow utility. +See http://www.opengroup.org/onlinepubs/009695399/utilities/cflow.html -** Record function arguments as automatic variables +The package shall have modular architecture: the `cflow' utility itself +shall invoke an external program (a back-end) to perform a lexical analisys +of input sources. This will allow to use `cflow' to analize source files +written in languages other than C. + +The output format of the utility shall conform to the POSIX specification. +The program shall also be able to optionally pipe its output to an +external program (a front-end). This will allow for creating reports in +various formats (e.g. graph, html, etc.) + +* High Priority Issues ** Divide and conquer: separate main cflow code (/src) and C lexical analizer (/back-ends/C) -** Write proper documentation - * Medium Priority Issues ** Implement front-end support. @@ -26,13 +38,11 @@ order of decreasing priority, the most urgent ones being the first. ** Provide front ends for: ASCII tree representation (~ current output look), XML/HTML output. -** Update and debug Emacs interface (cflow.el) +** Add new back-ends: Yacc, Lex and object files. These are required by POSIX. * Low Priority Issues -** Internationalization - -** Add new back-ends: C++, Scheme, Lisp... +** Add new back-ends: C++, Scheme, Lisp... * Copyright information: |