/[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.27, Sun Aug 15 17:28:05 2004 UTC
# Line 1  Line 1 
1  CvsGraph 1.2.0, 19-Dec-2001  CvsGraph 1.5.0, 15-Aug-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  -------------------  -------------------
 - 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_*  - Add regex method for ignoring tags in the generation of the graph. Old trees
15    configuration options.    are overpolulated and this is a way to reduce it even further. New config
16      options tag_ignore, tag_nocase and tag_negate.
17    
18    - Added drawing of partial trees. You now can select a subtree based on a
19      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 59  Line 50 
50    
51  create directory:  create directory:
52          $ cd /where/ever/you/want          $ cd /where/ever/you/want
53          $ tar xzf cvsgraph-1.2.0.tar.gz          $ tar xzf cvsgraph-1.5.0.tar.gz
54          $ cd cvsgraph-1.2.0          $ cd cvsgraph-1.5.0
55          $ ./configure          $ ./configure
56          $ make          $ make
57    
# Line 79  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
81  ----------  ----------
# Line 94  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 114  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 127  Line 123 
123  Todo  Todo
124  ----  ----
125  - 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
126    revision-connectors to make place)    revision-connectors to make place). A start is made, but this is not very
127      functional yet.
128    
 - draw only a part or parts of the tree.  
129    
130    
131  License  License

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

  ViewVC Help
Powered by ViewVC 1.1.0 with CvsGraph 1.7.0