/[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.16, Sat Jul 20 20:41:40 2002 UTC revision 1.26, Sun Aug 15 16:58:22 2004 UTC
# Line 1  Line 1 
1  CvsGraph 1.3.0, 20-Jul-2002  CvsGraph 1.5.0, 16-Jul-2004
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  -------------------  -------------------
 - Implement a workaround for browsers that do not understand unordered  
   y-coordinates in the imagemap when generated upside down.  
13    
14  - Fix the slowness of CvsGraph when parsing very large (typically -kb files) by  - Add regex method for ignoring tags in the generation of the graph. Old trees
15    bypassing the parsing of the actual deltatext. On my machine (K6-2/500/256M    are overpolulated and this is a way to reduce it even further. New config
16    it makes a difference of 7.5s vs 0.04s on a 93MByte file, without counting    options tag_ignore, tag_nocase and tag_negate.
   disk-overhead; with disk-overhead it takes 12.5s).  Downside is that the  
   logentry cannot be expanded if the file is not parsed in full (see below).  
   Use option parse_logs to enable log-expansions.  
   
 - Implemented logentry expansions using %l and %L. You must enable full parsing  
   (option parse_logs) for this to work.  
   
 - Fixed a possible buffer overflow in the string expansion. However, this is a  
   very low-risk overflow, since it will trash the heap and _not_ the stack.  
   Furthermore, you need to pass strings from CGI directly to cvsgraph without  
   any checks to come even close to trash the heap.  
   
 - Fixed a segfault on IRIX in the bsearch calls. These lookups could be called  
   with a NULL pointer and IRIX's libc doesn't like that.  
   
 - Implement left to right and right to left images. The entire tree can now be  
   drawn horizontally when option left_right is set. Using both left_right and  
   upside_down results in right to left images.  
   
 - Implement limits on how many tags are printed in a revision box using new  
   config parameter rev_maxtags. Ellipsis (...) are printed if the limit becomes  
   active.  
17    
18  - Changed the configure script to handle libraries more intelligently. This  - Added drawing of partial trees. You now can select a subtree based on a
19    should be able to handle static libraries better.    revision number, branch number or symbolic tag to show only that part of the
20      tree. New config option branch_subtree selects which part is shown. If the
21      subtree is empty, then the whole tree is shown.
22    
23    - Most error and warning messages are now displayed in the graph, instead of
24      being written to stderr. This enables you to see an image eventhough errors
25      might be present. The old method would generate a corrupt image.
26      New configuration options include msg_color and msg_font to control the looks
27      of it. Messages are always printed at the bottom of the image.
28    
29    - Fixed a bug in the folding code where subtrees would not fold correctly.
30    
31    - Added diff links in the map-generation for detected merges so that you can
32      get the differences in merge-operations. The options map_merge_href and
33      map_merge_alt must be set accordingly.
34    
35    
36    
37    Known BUGS
38    ----------
39    
40    - The timezone variable does not seem to exist on Mac OSX. I have no clue how
41      to patch this yet.
42      Anyhow, the timezone problem is much worse, because it needs to be calculated
43      from the revision's commit-time and not the current timezone (Daylight saving
44      must be accounted for at commit's time, not current).
45    
46    
47    
# Line 49  Line 50 
50    
51  create directory:  create directory:
52          $ cd /where/ever/you/want          $ cd /where/ever/you/want
53          $ tar xzf cvsgraph-1.3.0.tar.gz          $ tar xzf cvsgraph-1.5.0.tar.gz
54          $ cd cvsgraph-1.3.0          $ cd cvsgraph-1.5.0
55          $ ./configure          $ ./configure
56          $ make          $ make
57    
# Line 69  Line 70 
70          If you have linked libgd with freetype, then you might also need          If you have linked libgd with freetype, then you might also need
71          either --with-freetype-lib or --with-freetype2-lib.          either --with-freetype-lib or --with-freetype2-lib.
72    
73    There are often precompiled binaries for Linux, FreeBSD, NetBSD and Windows
74    (and probably other OSes too). Check your local mirror for details. I also have
75    some links on the homepage for precompiled binaries. Please do not complain to
76    me about these binaries.
77    
78    
79    
80  Installing  Installing
# Line 85  Line 91 
91  ----------------  ----------------
92  Do *NOT* execute the program directly from a webserver. Direct execution would  Do *NOT* execute the program directly from a webserver. Direct execution would
93  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
94  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:
95  at http://viewcvs.sourceforge.net and follow the instructions.  
96    - ViewCVS       http://viewcvs.sourceforge.net
97    - CVSweb        http://www.freebsd.org/projects/cvsweb.html
98    - Chora         http://www.horde.org/chora/
99    
 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.  
100    
101  To generate an image do something like:  To generate an image do something like:
102          $ 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 105  Line 110 
110                          internet as if you were using cvs. The repository files                          internet as if you were using cvs. The repository files
111                          must be on a locally mounted filesystem. However, you                          must be on a locally mounted filesystem. However, you
112                          can use cvsup or rsync to get a repository to your                          can use cvsup or rsync to get a repository to your
113                          local filesystem and make then image from there.                          local filesystem and make then images from there.
114    
115  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
116  (no '-o'), then the output is written to standard output.  (no '-o'), then the output is written to standard output.
# Line 121  Line 126 
126    revision-connectors to make place). A start is made, but this is not very    revision-connectors to make place). A start is made, but this is not very
127    functional yet.    functional yet.
128    
 - draw only a part or parts of the tree.  
   
129    
130    
131  License  License

Legend:
Removed from v.1.16  
changed lines
  Added in v.1.26

  ViewVC Help
Powered by ViewVC 1.1.0 with CvsGraph 1.7.0