aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSergey Poznyakoff <gray@gnu.org.ua>2011-10-11 23:15:45 +0300
committerSergey Poznyakoff <gray@gnu.org.ua>2011-10-11 23:15:45 +0300
commit24a87761b4398c48d554ae44861b33a98c4c39e4 (patch)
treee2c719f29aa2f48afde056c1b1a508738d312520
parent17372c73a7605c1a2815c7389259cab3b8443f3f (diff)
downloadcflow-24a87761b4398c48d554ae44861b33a98c4c39e4.tar.gz
cflow-24a87761b4398c48d554ae44861b33a98c4c39e4.tar.bz2
Final cleanup before the release.release-1_4
* NEWS: Update. * README: Update. * doc/cflow.texi: Update. * src/main.c (symbol_override): pass allocated argument to install. * src/parser.c (yyparse): Return 0.
-rw-r--r--NEWS2
-rw-r--r--README16
-rw-r--r--doc/cflow.texi184
-rw-r--r--src/main.c2
-rw-r--r--src/parser.c4
5 files changed, 115 insertions, 93 deletions
diff --git a/NEWS b/NEWS
index 3e334c2..4bfa96b 100644
--- a/NEWS
+++ b/NEWS
@@ -5,7 +5,7 @@ See the end of file for copying conditions.
5Please send cflow bug reports to <bug-cflow@gnu.org>. 5Please send cflow bug reports to <bug-cflow@gnu.org>.
6 6
7 7
8Version 1.4 (Git) 8Version 1.4, 2011-10-11
9 9
10* Symbol aliases 10* Symbol aliases
11 11
diff --git a/README b/README
index 12adbe7..e4b89ca 100644
--- a/README
+++ b/README
@@ -1,5 +1,5 @@
1GNU cflow README 1GNU cflow README
2Copyright (C) 2005, 2010 Sergey Poznyakoff 2Copyright (C) 2005, 2010, 2011 Sergey Poznyakoff
3See the end of file for copying conditions. 3See the end of file for copying conditions.
4 4
5* Introduction 5* Introduction
@@ -10,10 +10,8 @@ documentation, instead it is provided as a brief reference only.
10Please be sure to read the accompanuing documentation before using the 10Please be sure to read the accompanuing documentation before using the
11utility. See section `Documentation' below. 11utility. See section `Documentation' below.
12 12
13Please read *all* sections of this `README' file before starting 13For the generic configuration options, see the file `INSTALL'.
14configuration. Also make sure you read `INSTALL' if you are not 14Refer to file `ABOUT-NLS' for information regarding internationalization.
15familiar with them already. Refer to file `ABOUT-NLS' for information
16regarding internationalization.
17 15
18* History 16* History
19 17
@@ -54,6 +52,12 @@ cflow.
54 52
55After running `./configure' and `make', run `make install'. 53After running `./configure' and `make', run `make install'.
56 54
55* Configuration File
56
57The file src/cflow.rc provides a working configuration file for use
58with gcc. See the documentation, sections 6.1 "Syntactic classes" and
596.3 "GCC Initialization", for more information.
60
57* Documentation 61* Documentation
58 62
59Complete user manual in texinfo format is provided. After the 63Complete user manual in texinfo format is provided. After the
@@ -70,7 +74,7 @@ Send bug reports and suggestions to <bug-cflow@gnu.org>.
70 74
71* Copyright Information: 75* Copyright Information:
72 76
73Copyright (C) 2005, Sergey Poznyakoff 77Copyright (C) 2005, 2010, 2011 Sergey Poznyakoff
74 78
75 Permission is granted to anyone to make or distribute verbatim copies 79 Permission is granted to anyone to make or distribute verbatim copies
76 of this document as received, in any medium, provided that the 80 of this document as received, in any medium, provided that the
diff --git a/doc/cflow.texi b/doc/cflow.texi
index 82bd028..dfb1fdf 100644
--- a/doc/cflow.texi
+++ b/doc/cflow.texi
@@ -1,5 +1,4 @@
1\input texinfo @c -*-texinfo-*- 1\input texinfo @c -*-texinfo-*-
2@smallbook
3@c %**start of header 2@c %**start of header
4@setfilename cflow.info 3@setfilename cflow.info
5@settitle GNU cflow 4@settitle GNU cflow
@@ -144,14 +143,14 @@ with an example. Suppose you have a simple implementation of
144@command{whoami} command and you wish to obtain a graph of function 143@command{whoami} command and you wish to obtain a graph of function
145dependencies. Here is the program: 144dependencies. Here is the program:
146 145
147@smallexample 146@example
148@verbatiminclude whoami.c 147@verbatiminclude whoami.c
149@end smallexample 148@end example
150 149
151 Running @command{cflow} produces the following output: 150 Running @command{cflow} produces the following output:
152 151
153@cindex GNU Output Format, an example 152@cindex GNU Output Format, an example
154@smallexample 153@example
155@group 154@group
156$ @kbd{cflow whoami.c} 155$ @kbd{cflow whoami.c}
157main() <int main (int argc,char **argv) at whoami.c:26>: 156main() <int main (int argc,char **argv) at whoami.c:26>:
@@ -163,7 +162,7 @@ main() <int main (int argc,char **argv) at whoami.c:26>:
163 fprintf() 162 fprintf()
164 printf() 163 printf()
165@end group 164@end group
166@end smallexample 165@end example
167 166
168@cindex GNU Output Format described 167@cindex GNU Output Format described
169@anchor{GNU Output Format} 168@anchor{GNU Output Format}
@@ -176,9 +175,9 @@ displaying, within a pair of angle brackets, a function
176calls another functions, the line ends with a colon. For example, the 175calls another functions, the line ends with a colon. For example, the
177line 176line
178 177
179@smallexample 178@example
180main() <int main (int argc,char **argv) at whoami.c:25>: 179main() <int main (int argc,char **argv) at whoami.c:25>:
181@end smallexample 180@end example
182 181
183@noindent 182@noindent
184shows that function @code{main} is defined in file @file{whoami.c} 183shows that function @code{main} is defined in file @file{whoami.c}
@@ -186,8 +185,8 @@ at line 25, as @code{int main (int argc, char **argv)}. Terminating
186colon indicates that @code{main} invokes other functions. 185colon indicates that @code{main} invokes other functions.
187 186
188 The lines following this one show which functions are called by 187 The lines following this one show which functions are called by
189@code{main}. Each such line is indented by fixed amount of white space 188@code{main}. Each such line is indented by a fixed amount of white space
190(by default four spaces) for each nesting level. 189(by default, four spaces) for each nesting level.
191 190
192@cindex @option{--omit-symbol-names} option introduced 191@cindex @option{--omit-symbol-names} option introduced
193@cindex @option{--omit-arguments} option introduced 192@cindex @option{--omit-arguments} option introduced
@@ -201,9 +200,9 @@ of reasons, one of them being to make the resulting graph more
201compact. To illustrate their effect, here is how would the first line of the 200compact. To illustrate their effect, here is how would the first line of the
202above graph look if you had used both @option{--omit-} options: 201above graph look if you had used both @option{--omit-} options:
203 202
204@smallexample 203@example
205main() <int () at whoami.c:25>: 204main() <int () at whoami.c:25>:
206@end smallexample 205@end example
207 206
208@cindex start symbol 207@cindex start symbol
209@cindex @option{--main} command line option introduced 208@cindex @option{--main} command line option introduced
@@ -217,14 +216,14 @@ the graph starting on particular function. @command{Cflow}
217allows to select such function using @option{--main} (@option{-m}) 216allows to select such function using @option{--main} (@option{-m})
218command line option. Thus, running 217command line option. Thus, running
219 218
220@smallexample 219@example
221cflow --main who_am_i whoami.c 220cflow --main who_am_i whoami.c
222@end smallexample 221@end example
223 222
224@noindent 223@noindent
225on the above file will produce following graph: 224on the above file will produce following graph:
226 225
227@smallexample 226@example
228@group 227@group
229who_am_i() <int who_am_i (void) at whoami.c:8>: 228who_am_i() <int who_am_i (void) at whoami.c:8>:
230 getpwuid() 229 getpwuid()
@@ -233,7 +232,7 @@ who_am_i() <int who_am_i (void) at whoami.c:8>:
233 fprintf() 232 fprintf()
234 printf() 233 printf()
235@end group 234@end group
236@end smallexample 235@end example
237 236
238@node Direct and Reverse 237@node Direct and Reverse
239@chapter Two Types of Flow Graphs. 238@chapter Two Types of Flow Graphs.
@@ -248,7 +247,7 @@ option. For example, using a sample @file{whoami.c}:
248 247
249@cindex reverse graph, example 248@cindex reverse graph, example
250@cindex reverse tree, example 249@cindex reverse tree, example
251@smallexample 250@example
252@group 251@group
253$ @kbd{cflow --reverse whoami.c} 252$ @kbd{cflow --reverse whoami.c}
254fprintf(): 253fprintf():
@@ -271,7 +270,7 @@ printf():
271who_am_i() <int who_am_i (void) at whoami.c:8>: 270who_am_i() <int who_am_i (void) at whoami.c:8>:
272 main() <int main (int argc,char **argv) at whoami.c:26> 271 main() <int main (int argc,char **argv) at whoami.c:26>
273@end group 272@end group
274@end smallexample 273@end example
275 274
276 This output consists of several subgraphs, each describing callers 275 This output consists of several subgraphs, each describing callers
277for a particular function. Thus, the first subgraph tells that the 276for a particular function. Thus, the first subgraph tells that the
@@ -284,11 +283,11 @@ and @code{main}. First of them is, in turn, also called directly by
284@anchor{--brief} 283@anchor{--brief}
285 The first thing that draws attention in the above output is that 284 The first thing that draws attention in the above output is that
286the subgraph starting with @code{who_am_i} function is repeated several 285the subgraph starting with @code{who_am_i} function is repeated several
287times. This is @dfn{verbose} output. To make it brief, use 286times. This is a @dfn{verbose} output. To make it brief, use
288@option{--brief} (@option{-b}) command line option. For example: 287@option{--brief} (@option{-b}) command line option. For example:
289 288
290@cindex brief output, an example of 289@cindex brief output, an example of
291@smallexample 290@example
292@group 291@group
293$ @kbd{cflow --brief --reverse whoami.c} 292$ @kbd{cflow --brief --reverse whoami.c}
294fprintf(): 293fprintf():
@@ -306,7 +305,7 @@ printf():
306 who_am_i() <int who_am_i (void) at whoami.c:8>: [see 2] 305 who_am_i() <int who_am_i (void) at whoami.c:8>: [see 2]
307who_am_i() <int who_am_i (void) at whoami.c:8>: [see 2] 306who_am_i() <int who_am_i (void) at whoami.c:8>: [see 2]
308@end group 307@end group
309@end smallexample 308@end example
310 309
311@cindex brief output described 310@cindex brief output described
312 In brief output, once a subgraph for a given function is written, 311 In brief output, once a subgraph for a given function is written,
@@ -317,7 +316,7 @@ expanded subgraph can be found.
317@cindex @option{--number} command line option introduced 316@cindex @option{--number} command line option introduced
318@cindex @option{-n} command line option introduced 317@cindex @option{-n} command line option introduced
319@anchor{--number} 318@anchor{--number}
320 If the output graph is large it can be tedious to find out the 319 If the output graph is large, it can be tedious to find out the
321required line number (unless you use @dfn{Emacs cflow-mode},