Recent changes to Home

Home modified by Fabio Visonà

Fabio Visonà — Fri, 29 Aug 2014 20:03:23 -0000

--- v15
+++ v16
@@ -52,7 +52,7 @@
 __-r <root>__     | Root function of tree: default is main. This option may occur more than once for multiple roots (max 5).
 __-s <style>__    | Style for highlight call path: 0 = red color (default); 1 = blue color; 2 = green color; 3 = bold; 4 = dashed; 5 = dotted.
 __-v__            | Print version.
-__-V__            | Verbose output.
+__-V__            | Verbose output (_mainly for debugging purposes_).
 __-x <function>__ | Function to be excluded from tree. This option may occur more than once for multiple functions (max 20). -x LIBRARY is a special case for excluding all library functions, i.e. not found defined in any file. _All the functions, called (calling) directly or indirectly from the excluded one(s) only, will be excluded too._

 tceetree can be called with no option at all: default options will be used.

Home modified by Fabio Visonà

Fabio Visonà — Fri, 29 Aug 2014 20:00:05 -0000

--- v14
+++ v15
@@ -21,7 +21,7 @@

 * you may modify layout from left to right instead of top to bottom: _dot -Grankdir=LR -Tpng -O tceetree.out_;

-* you may modify graph, nodes and edges font: _dot -Gfontname=Helvetica -Nfontname=Helvetica -Efontname=Helvetica -Tpng -O tceetree.out_
+* you may modify graph, nodes and edges font: _dot -Gfontname=Helvetica -Nfontname=Helvetica -Efontname=Helvetica -Tpng -O tceetree.out_;

 * see _dot.1.pdf_ and _dotguide.pdf_ within [Graphviz](http://www.graphviz.org/) documentation for many other options.

Home modified by Fabio Visonà

Fabio Visonà — Fri, 29 Aug 2014 19:56:53 -0000

--- v13
+++ v14
@@ -35,13 +35,14 @@

-__tceetree \[-c <depth>\] \[-C <depth>\] \[-f\] \[-F\] \[-h\] \[-i <file>\] \[-o <file>\] \[-p <function>\] \[-r <root>\] \[-s <style>\] \[-v\] \[-x <function>\]__
+__tceetree \[-c <depth>\] \[-C <depth>\] \[-d <file>\] \[-f\] \[-F\] \[-h\] \[-i <file>\] \[-o <file>\] \[-p <function>\] \[-r <root>\] \[-s <style>\] \[-v\] \[-V\] \[-x <function>\]__

 Option        | Description
 ------------- | --------------
 __-c <depth>__    | Depth of tree for called functions: default is max. _Depth is measured starting from root(s) function(s)._
 __-C <depth>__    | Depth of tree for calling functions: default is 0. _Depth is measured starting from root(s) function(s) in backward direction._
+__-d <file>__     | Output a shortened cscope output file: default is no output. The shortened file includes only function information and can be used as input (-i) for following calls to tceetree to increase speed on big projects.
 __-f__            | Print the file name where the call is near to branch.
 __-F__            | Group functions into one cluster for each source file.
 __-h__            | Print help.
@@ -51,6 +52,12 @@
 __-r <root>__     | Root function of tree: default is main. This option may occur more than once for multiple roots (max 5).
 __-s <style>__    | Style for highlight call path: 0 = red color (default); 1 = blue color; 2 = green color; 3 = bold; 4 = dashed; 5 = dotted.
 __-v__            | Print version.
+__-V__            | Verbose output.
 __-x <function>__ | Function to be excluded from tree. This option may occur more than once for multiple functions (max 20). -x LIBRARY is a special case for excluding all library functions, i.e. not found defined in any file. _All the functions, called (calling) directly or indirectly from the excluded one(s) only, will be excluded too._

 tceetree can be called with no option at all: default options will be used.
+
+__Examples:__
+
+* Screenshot #1 was done with _tceetree -F -x LIBRARY_;
+* screenshot #2 was done with _tceetree -C max -r gettree -p ttreefindnode_.

Home modified by Fabio Visonà

Fabio Visonà — Sat, 23 Aug 2014 09:19:01 -0000

--- v12
+++ v13
@@ -35,9 +35,7 @@

-__tceetree \[-c <depth>\] \[-C <depth>\] \[-f\] \[-F\] \[-h\] \[-i <file>\]
- \[-o <file>\] \[-p <function>\] \[-r <root>\] \[-s <style>\]
- \[-v\] \[-x <function>\]__
+__tceetree \[-c <depth>\] \[-C <depth>\] \[-f\] \[-F\] \[-h\] \[-i <file>\] \[-o <file>\] \[-p <function>\] \[-r <root>\] \[-s <style>\] \[-v\] \[-x <function>\]__

 Option        | Description

Home modified by Fabio Visonà

Fabio Visonà — Sat, 23 Aug 2014 09:16:51 -0000

--- v11
+++ v12
@@ -53,6 +53,6 @@
 __-r <root>__     | Root function of tree: default is main. This option may occur more than once for multiple roots (max 5).
 __-s <style>__    | Style for highlight call path: 0 = red color (default); 1 = blue color; 2 = green color; 3 = bold; 4 = dashed; 5 = dotted.
 __-v__            | Print version.
-__-x <function>__ | Function to be excluded from tree. This option may occur more than once for multiple functions (max 20). -x LIBRARY is a special case for excluding all library functions, i.e. not found defined in any file. _All the functions, called directly or indirectly from the excluded one(s) only, will be excluded too._
+__-x <function>__ | Function to be excluded from tree. This option may occur more than once for multiple functions (max 20). -x LIBRARY is a special case for excluding all library functions, i.e. not found defined in any file. _All the functions, called (calling) directly or indirectly from the excluded one(s) only, will be excluded too._

 tceetree can be called with no option at all: default options will be used.

Home modified by Fabio Visonà

Fabio Visonà — Thu, 21 Aug 2014 20:01:24 -0000

--- v10
+++ v11
@@ -5,7 +5,7 @@

 If this is what you are looking for, follow these steps:

-1. Install [CScope](http://cscope.sourceforge.net/). A compiled Windows executable can be found [here](http://code.google.com/p/cscope-win32/).
+1. Install (and compile) [CScope](http://cscope.sourceforge.net/). A compiled Windows executable can be found [here](http://code.google.com/p/cscope-win32/). For a compiled Linux executable search the Web e.g. for a cscope RPM or Debian package.
 2. Install [Graphviz](http://www.graphviz.org/).
 3. Go to your sources root directory and do:
     * under Windows: ___dir /B /S *.c > cscope.files___ (/B = bare format, no extra info);

Home modified by Fabio Visonà

Fabio Visonà — Thu, 21 Aug 2014 19:57:23 -0000

--- v9
+++ v10
@@ -35,23 +35,24 @@

-__tceetree [-c <depth>] [-C <depth>] [-f] [-F] [-h] [-i <file>]
- [-o <file>] [-p <function>] [-r <root>] [-s <style>]
- [-v] [-x <function>]__
+__tceetree \[-c <depth>\] \[-C <depth>\] \[-f\] \[-F\] \[-h\] \[-i <file>\]
+ \[-o <file>\] \[-p <function>\] \[-r <root>\] \[-s <style>\]
+ \[-v\] \[-x <function>\]__

 Option        | Description
 ------------- | --------------
-__-c <depth>__    | Depth of tree for called functions: default is max. _Depth is measured starting from root(s) function(s)_
-__-C <depth>__    | Depth of tree for calling functions: default is 0. _Depth is measured starting from root(s) function(s) in backward direction_
+__-c <depth>__    | Depth of tree for called functions: default is max. _Depth is measured starting from root(s) function(s)._
+__-C <depth>__    | Depth of tree for calling functions: default is 0. _Depth is measured starting from root(s) function(s) in backward direction._
 __-f__            | Print the file name where the call is near to branch.
 __-F__            | Group functions into one cluster for each source file.
-__-h__            | Print this help.
+__-h__            | Print help.
 __-i <file>__     | Input cscope output file: default is cscope.out.
 __-o <file>__     | Output file for graphviz: default is tceetree.out.
-__-p <function>__ | Highlight call path till function. _Path starts from root(s) till the specified function (only one), in backward or forward direction_
+__-p <function>__ | Highlight call path till function. _Path starts from root(s) till the specified function (only one), in backward or forward direction._
 __-r <root>__     | Root function of tree: default is main. This option may occur more than once for multiple roots (max 5).
-__-s <style>__    | Style for highlight call path: * 0 = red color (default); * 1 = blue color; * 2 = green color; * 3 = bold; * 4 = dashed; * 5 = dotted.
+__-s <style>__    | Style for highlight call path: 0 = red color (default); 1 = blue color; 2 = green color; 3 = bold; 4 = dashed; 5 = dotted.
 __-v__            | Print version.
-__-x <function>__ | Function to be excluded from tree. This option may occur more than once for multiple functions (max 20). -x LIBRARY is a special case for excluding all library functions, i.e. not found defined in any file. _All the functions, called directly or indirectly from the excluded one(s) only, will be excluded too_
+__-x <function>__ | Function to be excluded from tree. This option may occur more than once for multiple functions (max 20). -x LIBRARY is a special case for excluding all library functions, i.e. not found defined in any file. _All the functions, called directly or indirectly from the excluded one(s) only, will be excluded too._

+tceetree can be called with no option at all: default options will be used.

Home modified by Fabio Visonà

Fabio Visonà — Thu, 21 Aug 2014 19:49:25 -0000

--- v8
+++ v9
@@ -23,11 +23,11 @@

 * you may modify graph, nodes and edges font: _dot -Gfontname=Helvetica -Nfontname=Helvetica -Efontname=Helvetica -Tpng -O tceetree.out_

-* see dot.1.pdf and dotguide.pdf within Graphviz documentation for many other options.
+* see _dot.1.pdf_ and _dotguide.pdf_ within [Graphviz](http://www.graphviz.org/) documentation for many other options.

-You may wish to give a try to one of the other tools provided by Graphviz instead of dot (see dot.1.pdf for a list).
+You may wish to give a try to one of the other tools provided by [Graphviz](http://www.graphviz.org/) instead of _dot_ (see _dot.1.pdf_ for a list).

@@ -37,35 +37,21 @@

 __tceetree [-c <depth>] [-C <depth>] [-f] [-F] [-h] [-i <file>]
  [-o <file>] [-p <function>] [-r <root>] [-s <style>]
- [-v] [-x <function>]
-__
+ [-v] [-x <function>]__

 Option        | Description
-
 ------------- | --------------
-
 __-c <depth>__    | Depth of tree for called functions: default is max. _Depth is measured starting from root(s) function(s)_
-
 __-C <depth>__    | Depth of tree for calling functions: default is 0. _Depth is measured starting from root(s) function(s) in backward direction_
-
 __-f__            | Print the file name where the call is near to branch.
-
 __-F__            | Group functions into one cluster for each source file.
-
 __-h__            | Print this help.
-
 __-i <file>__     | Input cscope output file: default is cscope.out.
-
 __-o <file>__     | Output file for graphviz: default is tceetree.out.
-
 __-p <function>__ | Highlight call path till function. _Path starts from root(s) till the specified function (only one), in backward or forward direction_
-
 __-r <root>__     | Root function of tree: default is main. This option may occur more than once for multiple roots (max 5).
-
 __-s <style>__    | Style for highlight call path: * 0 = red color (default); * 1 = blue color; * 2 = green color; * 3 = bold; * 4 = dashed; * 5 = dotted.
-
 __-v__            | Print version.
-
 __-x <function>__ | Function to be excluded from tree. This option may occur more than once for multiple functions (max 20). -x LIBRARY is a special case for excluding all library functions, i.e. not found defined in any file. _All the functions, called directly or indirectly from the excluded one(s) only, will be excluded too_

Home modified by Fabio Visonà

Fabio Visonà — Thu, 21 Aug 2014 19:46:28 -0000

--- v7
+++ v8
@@ -14,3 +14,58 @@
 4. execute ___cscope -b -c -R___ (build the cross reference only, don't compress it, recurse);
 5. run tceetree with ___cscope.out___ as input (default) to get ___tceetree.out___ (DOT language representation of function call tree);
 6. execute ___dot -Tpng -O tceetree.out___ to get a graphical representation of the tree in ___tceetree.out.png___.
+
+There are a lot of options you can specify when invoking dot to customize the graph, for example:
+
+* you can change output format e.g. to pdf: _dot -Tpdf -O tceetree.out_;
+
+* you may modify layout from left to right instead of top to bottom: _dot -Grankdir=LR -Tpng -O tceetree.out_;
+
+* you may modify graph, nodes and edges font: _dot -Gfontname=Helvetica -Nfontname=Helvetica -Efontname=Helvetica -Tpng -O tceetree.out_
+
+* see dot.1.pdf and dotguide.pdf within Graphviz documentation for many other options.
+
+
+
+You may wish to give a try to one of the other tools provided by Graphviz instead of dot (see dot.1.pdf for a list).
+
+
+
+This is the synopsis of tceetree:
+
+
+
+__tceetree [-c <depth>] [-C <depth>] [-f] [-F] [-h] [-i <file>]
+ [-o <file>] [-p <function>] [-r <root>] [-s <style>]
+ [-v] [-x <function>]
+__
+
+
+Option        | Description
+
+------------- | --------------
+
+__-c <depth>__    | Depth of tree for called functions: default is max. _Depth is measured starting from root(s) function(s)_
+
+__-C <depth>__    | Depth of tree for calling functions: default is 0. _Depth is measured starting from root(s) function(s) in backward direction_
+
+__-f__            | Print the file name where the call is near to branch.
+
+__-F__            | Group functions into one cluster for each source file.
+
+__-h__            | Print this help.
+
+__-i <file>__     | Input cscope output file: default is cscope.out.
+
+__-o <file>__     | Output file for graphviz: default is tceetree.out.
+
+__-p <function>__ | Highlight call path till function. _Path starts from root(s) till the specified function (only one), in backward or forward direction_
+
+__-r <root>__     | Root function of tree: default is main. This option may occur more than once for multiple roots (max 5).
+
+__-s <style>__    | Style for highlight call path: * 0 = red color (default); * 1 = blue color; * 2 = green color; * 3 = bold; * 4 = dashed; * 5 = dotted.
+
+__-v__            | Print version.
+
+__-x <function>__ | Function to be excluded from tree. This option may occur more than once for multiple functions (max 20). -x LIBRARY is a special case for excluding all library functions, i.e. not found defined in any file. _All the functions, called directly or indirectly from the excluded one(s) only, will be excluded too_
+

Home modified by Fabio Visonà

Fabio Visonà — Wed, 20 Aug 2014 22:48:49 -0000