/[CvsGraph]/cvsgraph/README
ViewVC logotype

Annotate of /cvsgraph/README

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


Revision 1.50 - (hide annotations)
Wed May 21 13:33:35 2008 UTC (9 years, 4 months ago) by bertho
Branch: MAIN
CVS Tags: merge_automake_dev1_20080521, REL_1_7_0, HEAD
Changes since 1.49: +7 -15 lines
Merge automake into head
1 bertho 1.50 CvsGraph 1.7.0, 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.50 - Use automake
31    
32     - Streamline the package with patches from the Fedora RPMS
33    
34 bertho 1.11
35 bertho 1.1
36     Compiling
37     ---------
38 bertho 1.9
39 bertho 1.1 create directory:
40     $ cd /where/ever/you/want
41 bertho 1.50 $ tar xzf cvsgraph-1.7.0.tar.gz
42     $ cd cvsgraph-1.7.0
43 bertho 1.3 $ ./configure
44 bertho 1.1 $ make
45    
46     This should do the trick and you have an executable file 'cvsgraph' in the
47     current directory.
48    
49 bertho 1.26 There are often precompiled binaries for Linux, FreeBSD, NetBSD and Windows
50     (and probably other OSes too). Check your local mirror for details. I also have
51     some links on the homepage for precompiled binaries. Please do not complain to
52     me about these binaries.
53    
54 bertho 1.1
55 bertho 1.12
56 bertho 1.1 Installing
57     ----------
58     Put the executable file 'cvsgraph' somewhere where you think it should go.
59     Normally this would be "/usr/local/bin" or "/usr/bin". The configuration file
60     ought to be put in "/usr/local/etc" or "/etc". The exact position can be
61     overriden on the commandline anyway. Edit the configuration file to your liking
62     and you should be all set.
63    
64    
65    
66     Running CvsGraph
67     ----------------
68     Do *NOT* execute the program directly from a webserver. Direct execution would
69     be very insecure. Make a wrapper cgi-script in php, perl, or whatever you
70 bertho 1.25 normally use. There are several web-based viewers with CvsGraph support:
71    
72     - ViewCVS http://viewcvs.sourceforge.net
73     - CVSweb http://www.freebsd.org/projects/cvsweb.html
74     - Chora http://www.horde.org/chora/
75 bertho 1.10
76 bertho 1.1
77 bertho 1.2 To generate an image do something like:
78 bertho 1.5 $ cvsgraph -r /home/to/repository -m module -o mygraph.png myfile.c,v
79 bertho 1.1
80     This generates a revison/branch image of the rcs file 'myfile.c,v' and puts it
81 bertho 1.5 into 'mygraph.png'. The '-r' option is the path to the repository *located and
82 bertho 1.1 accessible* on your filesystem. The '-m' is the module in the repository. Note
83     that the extension of the file ends with ",v".
84    
85 bertho 1.9 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 bertho 1.18 local filesystem and make then images from there.
90 bertho 1.9
91 bertho 1.1 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.
93    
94 bertho 1.5 Please read the manual pages cvsgraph(1) and cvsgraph.conf(5) for more
95     information on execution and configuration.
96 bertho 1.34
97    
98    
99     Contributed code
100     ----------------
101     - contrib/automatic_documentation:
102     If you are interested in tag-management with respect to the correct branch
103     information, then I suggest that you take a look at the contribution from
104     Henrik Carlqvist. He submitted some server-side scripts that can manage tags
105     in a better fashion than cvs on its own.
106 bertho 1.5
107 bertho 1.1
108    
109     Todo
110     ----
111     - do a better job in making a layout (auto moving branches and rubber banding
112 bertho 1.12 revision-connectors to make place). A start is made, but this is not very
113     functional yet.
114    
115 bertho 1.1
116    
117     License
118     -------
119 bertho 1.9 CvsGraph is distributed under GNU GPL v2. See 'LICENSE' for more information.
120 bertho 1.1
121    
122    
123     Contact
124     -------
125     HomePage: http://www.akhphd.au.dk/~bertho/cvsgraph
126     E-mail: cvsgraph@akhphd.au.dk
127 bertho 1.41
128    
129    
130     Mailnote
131     --------
132     As of 20 August 2005, if you send me an email with a contained or attached
133 bertho 1.42 disclaimer that includes one or more of the following items:
134 bertho 1.41
135     * legal notice or threat(s)
136     * disclosure restriction(s)
137     * forward restriction(s)
138     * "intended recipient" nonsense
139    
140     Then you automatically agree to pay me a license fee of DKK 1000,- for using my
141     email address and a DKK 250,- fee for wasting my time on reading it.
142 bertho 1.1
143     Greetings Bertho
144    

  ViewVC Help
Powered by ViewVC 1.1.0 with CvsGraph 1.7.0