/[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.49, Wed May 21 01:41:18 2008 UTC
# Line 1  Line 1 
1  CvsGraph 1.2.0, 19-Dec-2001  CvsGraph 1.6.2, 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    
31    
# Line 59  Line 34 
34    
35  create directory:  create directory:
36          $ cd /where/ever/you/want          $ cd /where/ever/you/want
37          $ tar xzf cvsgraph-1.2.0.tar.gz          $ tar xzf cvsgraph-1.6.2.tar.gz
38          $ cd cvsgraph-1.2.0          $ cd cvsgraph-1.6.2
39          $ ./configure          $ ./configure
40          $ make          $ make
41    
# Line 79  Line 54 
54          If you have linked libgd with freetype, then you might also need          If you have linked libgd with freetype, then you might also need
55          either --with-freetype-lib or --with-freetype2-lib.          either --with-freetype-lib or --with-freetype2-lib.
56    
57    There are often precompiled binaries for Linux, FreeBSD, NetBSD and Windows
58    (and probably other OSes too). Check your local mirror for details. I also have
59    some links on the homepage for precompiled binaries. Please do not complain to
60    me about these binaries.
61    
62    
63    
64  Installing  Installing
65  ----------  ----------
# Line 94  Line 75 
75  ----------------  ----------------
76  Do *NOT* execute the program directly from a webserver. Direct execution would  Do *NOT* execute the program directly from a webserver. Direct execution would
77  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
78  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:
79  at http://viewcvs.sourceforge.net and follow the instructions.  
80    - ViewCVS       http://viewcvs.sourceforge.net
81    - CVSweb        http://www.freebsd.org/projects/cvsweb.html
82    - Chora         http://www.horde.org/chora/
83    
 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.  
84    
85  To generate an image do something like:  To generate an image do something like:
86          $ 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 94 
94                          internet as if you were using cvs. The repository files                          internet as if you were using cvs. The repository files
95                          must be on a locally mounted filesystem. However, you                          must be on a locally mounted filesystem. However, you
96                          can use cvsup or rsync to get a repository to your                          can use cvsup or rsync to get a repository to your
97                          local filesystem and make then image from there.                          local filesystem and make then images from there.
98    
99  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
100  (no '-o'), then the output is written to standard output.  (no '-o'), then the output is written to standard output.
# Line 124  Line 104 
104    
105    
106    
107    Contributed code
108    ----------------
109    - contrib/automatic_documentation:
110      If you are interested in tag-management with respect to the correct branch
111      information, then I suggest that you take a look at the contribution from
112      Henrik Carlqvist. He submitted some server-side scripts that can manage tags
113      in a better fashion than cvs on its own.
114    
115    
116    
117  Todo  Todo
118  ----  ----
119  - 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
120    revision-connectors to make place)    revision-connectors to make place). A start is made, but this is not very
121      functional yet.
122    
 - draw only a part or parts of the tree.  
123    
124    
125  License  License
# Line 143  Line 133 
133  HomePage: http://www.akhphd.au.dk/~bertho/cvsgraph  HomePage: http://www.akhphd.au.dk/~bertho/cvsgraph
134  E-mail: cvsgraph@akhphd.au.dk  E-mail: cvsgraph@akhphd.au.dk
135    
136    
137    
138    Mailnote
139    --------
140    As of 20 August 2005, if you send me an email with a contained or attached
141    disclaimer that includes one or more of the following items:
142    
143        * legal notice or threat(s)
144        * disclosure restriction(s)
145        * forward restriction(s)
146        * "intended recipient" nonsense
147    
148    Then you automatically agree to pay me a license fee of DKK 1000,- for using my
149    email address and a DKK 250,- fee for wasting my time on reading it.
150    
151  Greetings Bertho  Greetings Bertho
152    

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

  ViewVC Help
Powered by ViewVC 1.1.0 with CvsGraph 1.7.0