/[CvsGraph]/cvsgraph/README
ViewVC logotype

Annotate of /cvsgraph/README

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


Revision 1.27 - (show annotations)
Sun Aug 15 17:28:05 2004 UTC (13 years, 2 months ago) by bertho
Branch: MAIN
CVS Tags: REL_1_5_0
Changes since 1.26: +1 -1 lines
Release 1.5.0
1 CvsGraph 1.5.0, 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 regex method for ignoring tags in the generation of the graph. Old trees
15 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
48 Compiling
49 ---------
50
51 create directory:
52 $ cd /where/ever/you/want
53 $ tar xzf cvsgraph-1.5.0.tar.gz
54 $ cd cvsgraph-1.5.0
55 $ ./configure
56 $ make
57
58 This should do the trick and you have an executable file 'cvsgraph' in the
59 current directory.
60
61 NOTE: The GD library is required for CvsGraph to function. Get it from
62 http://www.boutell.com, compile it and use either --with-gd-lib=DIR
63 and --with-gd-inc=DIR to specify its location. You might also have
64 to use --with-z-inc, --with-z-lib and --with-png-inc, --with-png-lib
65 for gd versions 1.6 and higher.
66 If you build with static libgd (i.e. libgd.a) and already have
67 libpng.so and/or libjpeg6b.so (i.e. dynamic), then you might want to
68 try to trick configure into adding these libs to the tests by adding
69 commandline options '--with-png-lib=.' and '--with-jpeg-lib=.'.
70 If you have linked libgd with freetype, then you might also need
71 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
81 ----------
82 Put the executable file 'cvsgraph' somewhere where you think it should go.
83 Normally this would be "/usr/local/bin" or "/usr/bin". The configuration file
84 ought to be put in "/usr/local/etc" or "/etc". The exact position can be
85 overriden on the commandline anyway. Edit the configuration file to your liking
86 and you should be all set.
87
88
89
90 Running CvsGraph
91 ----------------
92 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
94 normally use. There are several web-based viewers with CvsGraph support:
95
96 - ViewCVS http://viewcvs.sourceforge.net
97 - CVSweb http://www.freebsd.org/projects/cvsweb.html
98 - Chora http://www.horde.org/chora/
99
100
101 To generate an image do something like:
102 $ cvsgraph -r /home/to/repository -m module -o mygraph.png myfile.c,v
103
104 This generates a revison/branch image of the rcs file 'myfile.c,v' and puts it
105 into 'mygraph.png'. The '-r' option is the path to the repository *located and
106 accessible* on your filesystem. The '-m' is the module in the repository. Note
107 that the extension of the file ends with ",v".
108
109 Just to make it clear: You cannot make images from a cvs-repository over the
110 internet as if you were using cvs. The repository files
111 must be on a locally mounted filesystem. However, you
112 can use cvsup or rsync to get a repository to your
113 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
116 (no '-o'), then the output is written to standard output.
117
118 Please read the manual pages cvsgraph(1) and cvsgraph.conf(5) for more
119 information on execution and configuration.
120
121
122
123 Todo
124 ----
125 - do a better job in making a layout (auto moving branches and rubber banding
126 revision-connectors to make place). A start is made, but this is not very
127 functional yet.
128
129
130
131 License
132 -------
133 CvsGraph is distributed under GNU GPL v2. See 'LICENSE' for more information.
134
135
136
137 Contact
138 -------
139 HomePage: http://www.akhphd.au.dk/~bertho/cvsgraph
140 E-mail: cvsgraph@akhphd.au.dk
141
142 Greetings Bertho
143

  ViewVC Help
Powered by ViewVC 1.1.0 with CvsGraph 1.7.0