/[CvsGraph]/cvsgraph/README
ViewVC logotype

Diff of /cvsgraph/README

Parent Directory Parent Directory | Revision Log Revision Log | View Revision Graph Revision Graph | View Patch Patch

revision 1.11, Wed Jan 9 00:28:36 2002 UTC revision 1.48.2.2, Wed May 21 11:51:36 2008 UTC
# Line 1  Line 1 
1  CvsGraph 1.2.0, 19-Dec-2001  CvsGraph 1.7.0, 21-May-2008
2  ===========================  ===========================
3  CvsGraph creates a graphic representation of the revisions and branches in a  CvsGraph creates a graphic representation of the revisions and branches in a
4  cvs/rcs repository. CvsGraph is inspired on the 'graph'-option from WinCVS. I  cvs/rcs repository. CvsGraph is inspired on the 'graph'-option from WinCVS. I
# Line 10  Line 10 
10    
11  New in this version  New in this version
12  -------------------  -------------------
 - The entire tree can now be drawn upside-down. This is usefull if you have  
   many revisions in a trunk and want to see the latest first. The configuration  
   includes an option 'upside_down' with a boolean argument. You can override the  
   default value on the command-line with the '-u' switch, which will negate the  
   configured value.  
   The imagemap generation also supports this, so you will still be able to point  
   and shoot on and between the revisions.  
   
 - You can now instruct CvsGraph to ommit all revisions that are not tagged. This  
   is highly usefull for very large trees/trunks to reduce the produced image  
   size. Note that the first and the last revision in a trunk are not hidden.  
   A new configuration option 'strip_untagged' with boolean argument enables this  
   feature. Alternatively, the command-line provides option '-s' wich negates the  
   value set in the configuration file. You can also strip the first revision if  
   it is untagged using '-S' and/or strip_first_rev.  
   
 - The boxes to identify the branches can now be drawn on both sides of the trunk.  
   Configuration option 'branch_dupbox' with boolean argument activates this  
   feature, which is usefull when the tree is drawn upside-down.The command-line  
   option '-b' negated the configured value.  
   
 - Configuration no longer requires a configuration file. All options can now be  
   entered on the commandline using '-O'. CvsGraph will still read the  
   configuration file if one is avaliable, but it is no longer an error if none  
   is found.  
   
 - If no file is entered on the command-line, then the input is taken from  
   standard input, like all decent *nix programs.  
   
 - ViewCVS (http://viewcvs.sourceforge.net) is now officially supporting the use  
   of CvsGraph in their code as of version 0.8. So, no bad hacks needed anymore  
   to get it working, and it always looks nice :-)  
   
 - Implemented string drawing using freetype interface of libgd. It looks very  
   nice, but it is significantly slower than gd's standard bitmap fonts. Extra  
   configuration parameters *_ttfont and *_ttsize set font and size. Option  
   use_ttf enables ttf rendering. Note that gd's bitmap fonts are used as a  
   fallback in case where the ttfont contains errors or is not found.  
13    
14  - The branch tag color and font can now be set separately using branch_tag_*  - Do a better job at drawing the merge lines by selecting the shortest path
15    configuration options.    from the revision boxes. An analysis is now done whether the source and
16      destinations should be on the left or right side.
17    
18    - Fix the left_right case for merge lines to display correctly.
19    
20    - Fix a +/-1 error on the merge lines to account for both rounding errors and
21      the shadow of the revision boxes.
22    
23    - Add configuration option 'merge_on_tag' to force the left_right case to
24      display merge lines on the tags instead of on the top/bottom sides. This
25      also solves imagemap overlaps where multiple sources or destinations would
26      be displayed at the same position.
27    
28    - Fix the imagemap function to record the correct position of the merges.
29    
30    - Use automake
31    
32    - Streamline the package with patches from the Fedora RPMS
33    
34    
35    
# Line 59  Line 38 
38    
39  create directory:  create directory:
40          $ cd /where/ever/you/want          $ cd /where/ever/you/want
41          $ tar xzf cvsgraph-1.2.0.tar.gz          $ tar xzf cvsgraph-1.7.0.tar.gz
42          $ cd cvsgraph-1.2.0          $ cd cvsgraph-1.7.0
43          $ ./configure          $ ./configure
44          $ make          $ make
45    
46  This should do the trick and you have an executable file 'cvsgraph' in the  This should do the trick and you have an executable file 'cvsgraph' in the
47  current directory.  current directory.
48    
49  NOTE:   The GD library is required for CvsGraph to function. Get it from  There are often precompiled binaries for Linux, FreeBSD, NetBSD and Windows
50          http://www.boutell.com, compile it and use either --with-gd-lib=DIR  (and probably other OSes too). Check your local mirror for details. I also have
51          and --with-gd-inc=DIR to specify its location. You might also have  some links on the homepage for precompiled binaries. Please do not complain to
52          to use --with-z-inc, --with-z-lib and --with-png-inc, --with-png-lib  me about these binaries.
53          for gd versions 1.6 and higher.  
         If you build with static libgd (i.e. libgd.a) and already have  
         libpng.so and/or libjpeg6b.so (i.e. dynamic), then you might want to  
         try to trick configure into adding these libs to the tests by adding  
         commandline options '--with-png-lib=.' and '--with-jpeg-lib=.'.  
         If you have linked libgd with freetype, then you might also need  
         either --with-freetype-lib or --with-freetype2-lib.  
54    
55    
56  Installing  Installing
# Line 94  Line 67 
67  ----------------  ----------------
68  Do *NOT* execute the program directly from a webserver. Direct execution would  Do *NOT* execute the program directly from a webserver. Direct execution would
69  be very insecure. Make a wrapper cgi-script in php, perl, or whatever you  be very insecure. Make a wrapper cgi-script in php, perl, or whatever you
70  normally use. The easiest way is to get the ViewCVS package from their website  normally use. There are several web-based viewers with CvsGraph support:
71  at http://viewcvs.sourceforge.net and follow the instructions.  
72    - ViewCVS       http://viewcvs.sourceforge.net
73    - CVSweb        http://www.freebsd.org/projects/cvsweb.html
74    - Chora         http://www.horde.org/chora/
75    
 Alternately, you can hack the 'cvsweb' package to call CvsGraph. There are  
 several scripts and patches available from the CvsGraph homepage (see below for  
 address). However, the scripts are no longer maintained because ViewCVS has  
 native support now.  
76    
77  To generate an image do something like:  To generate an image do something like:
78          $ cvsgraph -r /home/to/repository -m module -o mygraph.png myfile.c,v          $ cvsgraph -r /home/to/repository -m module -o mygraph.png myfile.c,v
# Line 114  Line 86 
86                          internet as if you were using cvs. The repository files                          internet as if you were using cvs. The repository files
87                          must be on a locally mounted filesystem. However, you                          must be on a locally mounted filesystem. However, you
88                          can use cvsup or rsync to get a repository to your                          can use cvsup or rsync to get a repository to your
89                          local filesystem and make then image from there.                          local filesystem and make then images from there.
90    
91  Type 'cvsgraph -h' to get a full list of options. If the output is not given  Type 'cvsgraph -h' to get a full list of options. If the output is not given
92  (no '-o'), then the output is written to standard output.  (no '-o'), then the output is written to standard output.
# Line 124  Line 96 
96    
97    
98    
99    Contributed code
100    ----------------
101    - contrib/automatic_documentation:
102      If you are interested in tag-management with respect to the correct branch
103      information, then I suggest that you take a look at the contribution from
104      Henrik Carlqvist. He submitted some server-side scripts that can manage tags
105      in a better fashion than cvs on its own.
106    
107    
108    
109  Todo  Todo
110  ----  ----
111  - do a better job in making a layout (auto moving branches and rubber banding  - do a better job in making a layout (auto moving branches and rubber banding
112    revision-connectors to make place)    revision-connectors to make place). A start is made, but this is not very
113      functional yet.
114    
 - draw only a part or parts of the tree.  
115    
116    
117  License  License
# Line 143  Line 125 
125  HomePage: http://www.akhphd.au.dk/~bertho/cvsgraph  HomePage: http://www.akhphd.au.dk/~bertho/cvsgraph
126  E-mail: cvsgraph@akhphd.au.dk  E-mail: cvsgraph@akhphd.au.dk
127    
128    
129    
130    Mailnote
131    --------
132    As of 20 August 2005, if you send me an email with a contained or attached
133    disclaimer that includes one or more of the following items:
134    
135        * legal notice or threat(s)
136        * disclosure restriction(s)
137        * forward restriction(s)
138        * "intended recipient" nonsense
139    
140    Then you automatically agree to pay me a license fee of DKK 1000,- for using my
141    email address and a DKK 250,- fee for wasting my time on reading it.
142    
143  Greetings Bertho  Greetings Bertho
144    

Legend:
Removed from v.1.11  
changed lines
  Added in v.1.48.2.2

  ViewVC Help
Powered by ViewVC 1.1.0 with CvsGraph 1.7.0