/[CvsGraph]/cvsgraph/README
ViewVC logotype

Annotate of /cvsgraph/README

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


Revision 1.32 - (show annotations)
Wed Oct 20 22:03:36 2004 UTC (12 years, 11 months ago) by bertho
Branch: MAIN
Changes since 1.31: +4 -0 lines
Added patch from Gordon Hollingworth <Gordon.Hollingworth {at} TTP.com> to use
mergepoints as implemented by CVSNT. Adapted the patch to enable both
tag-detected merges and mergepoints to be shows at the same time.
1 CvsGraph 1.5.1, 15-Aug-2004
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.
8
9
10
11 New in this version
12 -------------------
13
14 - Add patch from Henrik Carlqvist <henca@users.SourceForge.net>
15 * add option rev_hidenumber for disabling revision number display.
16 * add option tag_ignore_merge for disabling merge_from/merge_to display
17 if matched with tag_ignore.
18 * add resorting of branches on how many revisions they have. This saves
19 space under circumstances.
20
21 - Add option merge_findall so that merge_from/merge_to tags can have multiple
22 matches.
23
24 - Add the patches supplied by Ville Skytta <ville.skytta@iki.fi>
25 * fix spelling in the manpages and config file
26 * fix & -> &amp; problem in config
27 * fix generics in wrapper example
28
29 - Add a fix for the zimezone problem as suggested by Henrik Carlqvist
30 <henca@users.SourceForge.net> by using the environment.
31
32 - Fix a bug in the detection of branch-numbers in the logical ,v file structure
33 (reported by Daniel Dumitrache <ddumitrache@bitdefender.com>). The branch was
34 deduced from the revision, but that would fail for revision numbers that are
35 like magic branch-numbers (x.x.0.x) because they were interpreted. These
36 revision numbers are now correctly handled.
37
38 - Added patch from Gordon Hollingworth <Gordon.Hollingworth@TTP.com> to use
39 mergepoints as implemented by CVSNT. Adapted the patch to enable both
40 tag-detected merges and mergepoints to be shows at the same time.
41
42
43
44 Compiling
45 ---------
46
47 create directory:
48 $ cd /where/ever/you/want
49 $ tar xzf cvsgraph-1.5.1.tar.gz
50 $ cd cvsgraph-1.5.1
51 $ ./configure
52 $ make
53
54 This should do the trick and you have an executable file 'cvsgraph' in the
55 current directory.
56
57 NOTE: The GD library is required for CvsGraph to function. Get it from
58 http://www.boutell.com, compile it and use either --with-gd-lib=DIR
59 and --with-gd-inc=DIR to specify its location. You might also have
60 to use --with-z-inc, --with-z-lib and --with-png-inc, --with-png-lib
61 for gd versions 1.6 and higher.
62 If you build with static libgd (i.e. libgd.a) and already have
63 libpng.so and/or libjpeg6b.so (i.e. dynamic), then you might want to
64 try to trick configure into adding these libs to the tests by adding
65 commandline options '--with-png-lib=.' and '--with-jpeg-lib=.'.
66 If you have linked libgd with freetype, then you might also need
67 either --with-freetype-lib or --with-freetype2-lib.
68
69 There are often precompiled binaries for Linux, FreeBSD, NetBSD and Windows
70 (and probably other OSes too). Check your local mirror for details. I also have
71 some links on the homepage for precompiled binaries. Please do not complain to
72 me about these binaries.
73
74
75
76 Installing
77 ----------
78 Put the executable file 'cvsgraph' somewhere where you think it should go.
79 Normally this would be "/usr/local/bin" or "/usr/bin". The configuration file
80 ought to be put in "/usr/local/etc" or "/etc". The exact position can be
81 overriden on the commandline anyway. Edit the configuration file to your liking
82 and you should be all set.
83
84
85
86 Running CvsGraph
87 ----------------
88 Do *NOT* execute the program directly from a webserver. Direct execution would
89 be very insecure. Make a wrapper cgi-script in php, perl, or whatever you
90 normally use. There are several web-based viewers with CvsGraph support:
91
92 - ViewCVS http://viewcvs.sourceforge.net
93 - CVSweb http://www.freebsd.org/projects/cvsweb.html
94 - Chora http://www.horde.org/chora/
95
96
97 To generate an image do something like:
98 $ cvsgraph -r /home/to/repository -m module -o mygraph.png myfile.c,v
99
100 This generates a revison/branch image of the rcs file 'myfile.c,v' and puts it
101 into 'mygraph.png'. The '-r' option is the path to the repository *located and
102 accessible* on your filesystem. The '-m' is the module in the repository. Note
103 that the extension of the file ends with ",v".
104
105 Just to make it clear: You cannot make images from a cvs-repository over the
106 internet as if you were using cvs. The repository files
107 must be on a locally mounted filesystem. However, you
108 can use cvsup or rsync to get a repository to your
109 local filesystem and make then images from there.
110
111 Type 'cvsgraph -h' to get a full list of options. If the output is not given
112 (no '-o'), then the output is written to standard output.
113
114 Please read the manual pages cvsgraph(1) and cvsgraph.conf(5) for more
115 information on execution and configuration.
116
117
118
119 Todo
120 ----
121 - do a better job in making a layout (auto moving branches and rubber banding
122 revision-connectors to make place). A start is made, but this is not very
123 functional yet.
124
125
126
127 License
128 -------
129 CvsGraph is distributed under GNU GPL v2. See 'LICENSE' for more information.
130
131
132
133 Contact
134 -------
135 HomePage: http://www.akhphd.au.dk/~bertho/cvsgraph
136 E-mail: cvsgraph@akhphd.au.dk
137
138 Greetings Bertho
139

  ViewVC Help
Powered by ViewVC 1.1.0 with CvsGraph 1.7.0