/[CvsGraph]/cvsgraph/README
ViewVC logotype

Annotate of /cvsgraph/README

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


Revision 1.49 - (hide annotations)
Wed May 21 01:41:18 2008 UTC (9 years, 4 months ago) by bertho
Branch: MAIN
CVS Tags: REL_1_6_2, source_head_20080521
Changes since 1.48: +16 -2 lines
- Do a better job at drawing the merge lines by selecting the shortest path
  from the revision boxes. An analysis is now done whether the source and
  destinations should be on the left or right side.
- Fix the left_right case for merge lines to display correctly.
- Fix a +/-1 error on the merge lines to account for both rounding errors and
  the shadow of the revision boxes.
- Add configuration option 'merge_on_tag' to force the left_right case to
  display merge lines on the tags instead of on the top/bottom sides. This
  also solves imagemap overlaps where multiple sources or destinations would
  be displayed at the same position.
- Fix the imagemap function to record the correct position of the merges.
1 bertho 1.49 CvsGraph 1.6.2, 21-May-2008
2 bertho 1.5 ===========================
3 bertho 1.1 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
5     could not find something right away on the web and decided that it was time to
6     write a stand-alone version. I might have been doing some double work, but hey,
7     I like a hack.
8    
9    
10    
11 bertho 1.5 New in this version
12     -------------------
13 bertho 1.14
14 bertho 1.49 - Do a better job at drawing the merge lines by selecting the shortest path
15     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 bertho 1.46
30 bertho 1.11
31 bertho 1.1
32     Compiling
33     ---------
34 bertho 1.9
35 bertho 1.1 create directory:
36     $ cd /where/ever/you/want
37 bertho 1.48 $ tar xzf cvsgraph-1.6.2.tar.gz
38     $ cd cvsgraph-1.6.2
39 bertho 1.3 $ ./configure
40 bertho 1.1 $ make
41    
42     This should do the trick and you have an executable file 'cvsgraph' in the
43     current directory.
44    
45 bertho 1.9 NOTE: The GD library is required for CvsGraph to function. Get it from
46     http://www.boutell.com, compile it and use either --with-gd-lib=DIR
47     and --with-gd-inc=DIR to specify its location. You might also have
48     to use --with-z-inc, --with-z-lib and --with-png-inc, --with-png-lib
49     for gd versions 1.6 and higher.
50     If you build with static libgd (i.e. libgd.a) and already have
51     libpng.so and/or libjpeg6b.so (i.e. dynamic), then you might want to
52     try to trick configure into adding these libs to the tests by adding
53     commandline options '--with-png-lib=.' and '--with-jpeg-lib=.'.
54 bertho 1.11 If you have linked libgd with freetype, then you might also need
55     either --with-freetype-lib or --with-freetype2-lib.
56 bertho 1.1
57 bertho 1.26 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 bertho 1.1
63 bertho 1.12
64 bertho 1.1 Installing
65     ----------
66     Put the executable file 'cvsgraph' somewhere where you think it should go.
67     Normally this would be "/usr/local/bin" or "/usr/bin". The configuration file
68     ought to be put in "/usr/local/etc" or "/etc". The exact position can be
69     overriden on the commandline anyway. Edit the configuration file to your liking
70     and you should be all set.
71    
72    
73    
74     Running CvsGraph
75     ----------------
76     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
78 bertho 1.25 normally use. There are several web-based viewers with CvsGraph support:
79    
80     - ViewCVS http://viewcvs.sourceforge.net
81     - CVSweb http://www.freebsd.org/projects/cvsweb.html
82     - Chora http://www.horde.org/chora/
83 bertho 1.10
84 bertho 1.1
85 bertho 1.2 To generate an image do something like:
86 bertho 1.5 $ cvsgraph -r /home/to/repository -m module -o mygraph.png myfile.c,v
87 bertho 1.1
88     This generates a revison/branch image of the rcs file 'myfile.c,v' and puts it
89 bertho 1.5 into 'mygraph.png'. The '-r' option is the path to the repository *located and
90 bertho 1.1 accessible* on your filesystem. The '-m' is the module in the repository. Note
91     that the extension of the file ends with ",v".
92    
93 bertho 1.9 Just to make it clear: You cannot make images from a cvs-repository over the
94     internet as if you were using cvs. The repository files
95     must be on a locally mounted filesystem. However, you
96     can use cvsup or rsync to get a repository to your
97 bertho 1.18 local filesystem and make then images from there.
98 bertho 1.9
99 bertho 1.1 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.
101    
102 bertho 1.5 Please read the manual pages cvsgraph(1) and cvsgraph.conf(5) for more
103     information on execution and configuration.
104 bertho 1.34
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 bertho 1.5
115 bertho 1.1
116    
117     Todo
118     ----
119     - do a better job in making a layout (auto moving branches and rubber banding
120 bertho 1.12 revision-connectors to make place). A start is made, but this is not very
121     functional yet.
122    
123 bertho 1.1
124    
125     License
126     -------
127 bertho 1.9 CvsGraph is distributed under GNU GPL v2. See 'LICENSE' for more information.
128 bertho 1.1
129    
130    
131     Contact
132     -------
133     HomePage: http://www.akhphd.au.dk/~bertho/cvsgraph
134     E-mail: cvsgraph@akhphd.au.dk
135 bertho 1.41
136    
137    
138     Mailnote
139     --------
140     As of 20 August 2005, if you send me an email with a contained or attached
141 bertho 1.42 disclaimer that includes one or more of the following items:
142 bertho 1.41
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 bertho 1.1
151     Greetings Bertho
152    

  ViewVC Help
Powered by ViewVC 1.1.0 with CvsGraph 1.7.0