ViewVC logotype

Annotate of /cvsgraph/README

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

Revision 1.14 - (show annotations)
Tue Apr 23 23:02:54 2002 UTC (16 years, 6 months ago) by bertho
Branch: MAIN
Changes since 1.13: +15 -48 lines
- Fix browserbug ordering y-coordinates
- Speed up parsing by bypassing deltatext parse
- Add logentry expansion
1 CvsGraph 1.2.1, 24-Apr-2002
2 ===========================
3 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.
11 New in this version
12 -------------------
13 - Implement a workaround for browsers that do not understand unordered
14 y-coordinates in the imagemap when generated upside down.
16 - Fix the slowness of CvsGraph when parsing very large (typically -kb files)
17 by bypassing the parsing of the actual deltatext. On my machine (K6-2/500/256M
18 it makes a difference of 7.5s vs 0.04s on a 93MByte file, without counting
19 disk-overhead; with disk-overhead it takes 12.5s).
20 Downside is that the logentry cannot be expanded if the file is not parsed in
21 full (see below). Use option parse_logs to enable log-expansions.
23 - Implemented logentry expansions using %l and %L. You must enable full parsing
24 (option parse_logs) for this to work.
28 Compiling
29 ---------
31 create directory:
32 $ cd /where/ever/you/want
33 $ tar xzf cvsgraph-1.2.1.tar.gz
34 $ cd cvsgraph-1.2.1
35 $ ./configure
36 $ make
38 This should do the trick and you have an executable file 'cvsgraph' in the
39 current directory.
41 NOTE: The GD library is required for CvsGraph to function. Get it from
42 http://www.boutell.com, compile it and use either --with-gd-lib=DIR
43 and --with-gd-inc=DIR to specify its location. You might also have
44 to use --with-z-inc, --with-z-lib and --with-png-inc, --with-png-lib
45 for gd versions 1.6 and higher.
46 If you build with static libgd (i.e. libgd.a) and already have
47 libpng.so and/or libjpeg6b.so (i.e. dynamic), then you might want to
48 try to trick configure into adding these libs to the tests by adding
49 commandline options '--with-png-lib=.' and '--with-jpeg-lib=.'.
50 If you have linked libgd with freetype, then you might also need
51 either --with-freetype-lib or --with-freetype2-lib.
55 Installing
56 ----------
57 Put the executable file 'cvsgraph' somewhere where you think it should go.
58 Normally this would be "/usr/local/bin" or "/usr/bin". The configuration file
59 ought to be put in "/usr/local/etc" or "/etc". The exact position can be
60 overriden on the commandline anyway. Edit the configuration file to your liking
61 and you should be all set.
65 Running CvsGraph
66 ----------------
67 Do *NOT* execute the program directly from a webserver. Direct execution would
68 be very insecure. Make a wrapper cgi-script in php, perl, or whatever you
69 normally use. The easiest way is to get the ViewCVS package from their website
70 at http://viewcvs.sourceforge.net and follow the instructions.
72 Alternately, you can hack the 'cvsweb' package to call CvsGraph. There are
73 several scripts and patches available from the CvsGraph homepage (see below for
74 address). However, the scripts are no longer maintained because ViewCVS has
75 native support now.
77 To generate an image do something like:
78 $ cvsgraph -r /home/to/repository -m module -o mygraph.png myfile.c,v
80 This generates a revison/branch image of the rcs file 'myfile.c,v' and puts it
81 into 'mygraph.png'. The '-r' option is the path to the repository *located and
82 accessible* on your filesystem. The '-m' is the module in the repository. Note
83 that the extension of the file ends with ",v".
85 Just to make it clear: You cannot make images from a cvs-repository over the
86 internet as if you were using cvs. The repository files
87 must be on a locally mounted filesystem. However, you
88 can use cvsup or rsync to get a repository to your
89 local filesystem and make then image from there.
91 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.
94 Please read the manual pages cvsgraph(1) and cvsgraph.conf(5) for more
95 information on execution and configuration.
99 Todo
100 ----
101 - do a better job in making a layout (auto moving branches and rubber banding
102 revision-connectors to make place). A start is made, but this is not very
103 functional yet.
105 - draw only a part or parts of the tree.
109 License
110 -------
111 CvsGraph is distributed under GNU GPL v2. See 'LICENSE' for more information.
115 Contact
116 -------
117 HomePage: http://www.akhphd.au.dk/~bertho/cvsgraph
118 E-mail: cvsgraph@akhphd.au.dk
120 Greetings Bertho

  ViewVC Help
Powered by ViewVC 1.1.0 with CvsGraph 1.7.0