/[CvsGraph]/cvsgraph/README
ViewVC logotype

Annotate of /cvsgraph/README

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


Revision 1.39 - (show annotations)
Tue Jun 14 20:40:14 2005 UTC (12 years, 5 months ago) by bertho
Branch: MAIN
CVS Tags: REL_1_5_2
Changes since 1.38: +3 -1 lines
- Fix merge lines to untagged revisions when strip_untagged is active
- Prepare release 1.5.2
1 CvsGraph 1.5.2, 14-Jun-2005
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 - Fix POSIX compliance in timezone handling. Only putenv() is used now.
15
16 - Fix branch-count when branches get folded.
17
18 - Fix configure script to detect gd-2 problems (Thanks to Russell Yanofsky)
19
20 - Work around CVSNT wrong keyword ordering breaking rcsfile(5) ordering
21
22 - Fix complaining about a new CVSNT keyword properties
23
24 - Fix mergepoint1 syntax used by CVSNT allowing revision numbers as argument
25
26 - Fix merge lines to untagged revisions when strip_untagged is active
27
28
29
30 Compiling
31 ---------
32
33 create directory:
34 $ cd /where/ever/you/want
35 $ tar xzf cvsgraph-1.5.2.tar.gz
36 $ cd cvsgraph-1.5.2
37 $ ./configure
38 $ make
39
40 This should do the trick and you have an executable file 'cvsgraph' in the
41 current directory.
42
43 NOTE: The GD library is required for CvsGraph to function. Get it from
44 http://www.boutell.com, compile it and use either --with-gd-lib=DIR
45 and --with-gd-inc=DIR to specify its location. You might also have
46 to use --with-z-inc, --with-z-lib and --with-png-inc, --with-png-lib
47 for gd versions 1.6 and higher.
48 If you build with static libgd (i.e. libgd.a) and already have
49 libpng.so and/or libjpeg6b.so (i.e. dynamic), then you might want to
50 try to trick configure into adding these libs to the tests by adding
51 commandline options '--with-png-lib=.' and '--with-jpeg-lib=.'.
52 If you have linked libgd with freetype, then you might also need
53 either --with-freetype-lib or --with-freetype2-lib.
54
55 There are often precompiled binaries for Linux, FreeBSD, NetBSD and Windows
56 (and probably other OSes too). Check your local mirror for details. I also have
57 some links on the homepage for precompiled binaries. Please do not complain to
58 me about these binaries.
59
60
61
62 Installing
63 ----------
64 Put the executable file 'cvsgraph' somewhere where you think it should go.
65 Normally this would be "/usr/local/bin" or "/usr/bin". The configuration file
66 ought to be put in "/usr/local/etc" or "/etc". The exact position can be
67 overriden on the commandline anyway. Edit the configuration file to your liking
68 and you should be all set.
69
70
71
72 Running CvsGraph
73 ----------------
74 Do *NOT* execute the program directly from a webserver. Direct execution would
75 be very insecure. Make a wrapper cgi-script in php, perl, or whatever you
76 normally use. There are several web-based viewers with CvsGraph support:
77
78 - ViewCVS http://viewcvs.sourceforge.net
79 - CVSweb http://www.freebsd.org/projects/cvsweb.html
80 - Chora http://www.horde.org/chora/
81
82
83 To generate an image do something like:
84 $ cvsgraph -r /home/to/repository -m module -o mygraph.png myfile.c,v
85
86 This generates a revison/branch image of the rcs file 'myfile.c,v' and puts it
87 into 'mygraph.png'. The '-r' option is the path to the repository *located and
88 accessible* on your filesystem. The '-m' is the module in the repository. Note
89 that the extension of the file ends with ",v".
90
91 Just to make it clear: You cannot make images from a cvs-repository over the
92 internet as if you were using cvs. The repository files
93 must be on a locally mounted filesystem. However, you
94 can use cvsup or rsync to get a repository to your
95 local filesystem and make then images from there.
96
97 Type 'cvsgraph -h' to get a full list of options. If the output is not given
98 (no '-o'), then the output is written to standard output.
99
100 Please read the manual pages cvsgraph(1) and cvsgraph.conf(5) for more
101 information on execution and configuration.
102
103
104
105 Contributed code
106 ----------------
107 - contrib/automatic_documentation:
108 If you are interested in tag-management with respect to the correct branch
109 information, then I suggest that you take a look at the contribution from
110 Henrik Carlqvist. He submitted some server-side scripts that can manage tags
111 in a better fashion than cvs on its own.
112
113
114
115 Todo
116 ----
117 - do a better job in making a layout (auto moving branches and rubber banding
118 revision-connectors to make place). A start is made, but this is not very
119 functional yet.
120
121
122
123 License
124 -------
125 CvsGraph is distributed under GNU GPL v2. See 'LICENSE' for more information.
126
127
128
129 Contact
130 -------
131 HomePage: http://www.akhphd.au.dk/~bertho/cvsgraph
132 E-mail: cvsgraph@akhphd.au.dk
133
134 Greetings Bertho
135

  ViewVC Help
Powered by ViewVC 1.1.0 with CvsGraph 1.7.0