File: upgrading.html

package info (click to toggle)
viewcvs 0.9.2-4woody1
  • links: PTS
  • area: main
  • in suites: woody
  • size: 752 kB
  • ctags: 655
  • sloc: python: 6,591; sh: 80; makefile: 68
file content (356 lines) | stat: -rw-r--r-- 9,910 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN">
<html>
  <head>
    <title>Upgrading a ViewCVS Installation</title>
  </head>

<body background="images/chalk.jpg">
  <table width="100&#37;" cellspacing=5>
    <tr>
      <td width="1%"><a href="index.html"><img border=0
	     src="images/logo.png"></a>
      </td>
      <td>
	<h1>Upgrading a ViewCVS Installation</h1>
      </td>
      <td width="1%"><a href="http://sourceforge.net/"><img border=0
	    src="http://sourceforge.net/sflogo.php?group_id=18760&type=1"></a><br><a href="http://sourceforge.net/projects/viewcvs/">ViewCVS&nbsp;project&nbsp;page</a>
      </td>
    </tr>
    <tr><td width="1%" valign=top>
       <a href="index.html">Overview</a><br>
       Upgrading<br>
       <a href="contributing.html">Contributing</a><br>
       <a href="license-1.html">License</a><br>
       <a href="who.html">Who</a><br>
    </td><td colspan=2>

    <p>
      This document describes some of the things that you will need to 
      consider, change, or handle when upgrading an existing ViewCVS
      installation to a newer version.
    </p>
    <p>
      It is always recommended to install the new version in a fresh directory
      and to carefully compare the configuration files.  A possible approach
      is to name the directories <code>/usr/local/viewcvs-0.6</code>, 
      <code>/usr/local/viewcvs-0.7</code> and so on and than create a 
      symbolic link <code>viewcvs</code> pointing to the production 
      version.  This way you can easily test several versions and switch
      back, if your users start to complain.
    </p>

    <ul>
      <li><a href="#from8">Upgrading from ViewCVS 0.8</a></li>
      <li><a href="#from7">Upgrading from ViewCVS 0.7 or earlier</a></li>
    </ul>

    <hr>

    <h2><a name="from8">Upgrading from ViewCVS 0.8</a></h2>
    <p>
      This section discusses how to upgrade ViewCVS 0.8 to version
      0.9 or a later version of the software.
    </p>

    <h3>Configuration Options</h3>
    <p>
      More templates were introduced in version 0.8 of the software,
      which made many of the configuration options obsolete. This
      section covers which options were removed. If you made any
      changes to these options, then you will need to make
      corresponding changes in the templates.
    </p>
    <blockquote>
      <dl>
	<dt>
	  Colors:
	  <strong>diff_heading</strong>,
	  <strong>diff_empty</strong>,
	  <strong>diff_remove</strong>,
	  <strong>diff_change</strong>,
	  <strong>diff_add</strong>,
	  and <strong>diff_dark_change</strong>
	</dt>
	<dd>
	  These options have been incorporated into the
	  <code>diff.ezt</code> template.

	  <p></p>
	</dd>

	<dt><strong>markup_log</strong></dt>
	<dd>
	  This option has been incorporated into the
	  <code>markup.ezt</code> template.

	  <p></p>
	</dd>

        <dt>Colors: <strong>nav_header</strong>
          and <strong>alt_background</strong></dt>
	<dd>
	  These options have been incorporated into the
	  <code>header.ezt</code> template.

	  <p></p>
	</dd>

        <dt>
	  Images:
          <strong>back_icon</strong>,
          <strong>dir_icon</strong>,
          and <strong>file_icon</strong>
        </dt>
	<dd>
	  These options have been incorporated into the
	  <code>directory.ezt</code>, <code>header.ezt</code>,
	  <code>log.ezt</code>, <code>log_table.ezt</code>, and
	  <code>query.ezt</code> templates.

	  <p></p>
	</dd>

	<dt><strong>use_java_script</strong>
          and <strong>open_extern_window</strong></dt>
	<dd>
	  The templates now use JavaScript in all applicable places,
	  and open external windows for most downloading and viewing
	  of files. If you wish to not use JavaScript and/or external
	  windows, then remove the feature(s) from the templates.

	  <p></p>
	</dd>

	<dt><strong>show_author</strong></dt>
	<dd>
          Changing this option would be quite strange and rare. If you
          do not want to show the author for the revisions, then you
          should remove it from the various templates.

	  <p></p>
	</dd>

	<dt><strong>hide_non_readable</strong></dt>
	<dd>
          This option was never used, so it has been removed.

	  <p></p>
	</dd>

	<dt><strong>flip_links_in_dirview</strong></dt>
	<dd>
          This option is no longer available. If you want the links in
          your directory view flipped, then you may use the
          <code>dir_alternate.ezt</code> template.

	  <p></p>
	</dd>

      </dl>
    </blockquote>

    <h3>Template Variables</h3>
    <p>
      Some template variables that were available in 0.8 have been
      removed in 0.9. If you have custom templates that refer to these
      variables, then you will need to modify your templates.
    </p>

	  <blockquote>
	    <dl>
	      <dt><code>directory.ezt</code>: <var>headers</var></dt>
	      <dd>
		The headers are now listed explicitly in the template,
		rather than made available through a list.
		<p></p>
	      </dd>

	      <dt>
		<code>directory.ezt</code>:
		<var>rows.cols</var>,
		and <var>rows.span</var>
	      </dt>
	      <dd>
		These variables were used in conjunction with the
		<var>headers</var> variable to control the column
		displays. This is now controlled explicitly within the
		templates.
		<p></p>
	      </dd>

	      <dt><code>directory.ezt</code>:
		<var>rev_in_front</var></dt>
	      <dd>
		This was used to indicate that revision links should
		be used in the first column, rather than in their
		standard place in the second column. Changing the
		links should now be done in the template, rather than
		according to this variable. You may want to look at
		the <code>dir_alternate.ezt</code> template, which has
		the revision in front.
		<p></p>
	      </dd>

	      <dt><code>directory.ezt</code>:
		<var>rows.attic</var>
		and <var>rows.hide_attic_href</var></dt>
	      <dd>
		These variable were used to manage the hide and
		showing of the contents of the <code>Attic/</code>
		subdirectory. Several new variables were introduced
		which can be used to replace this functionality:
		<var>show_attic_href</var>,
		<var>hide_attic_href</var>, and <var>rows.state</var>.
		<p></p>
	      </dd>
	    </dl>
	  </blockquote>
    <hr>

    <h2><a name="from7">Upgrading from ViewCVS 0.7 or earlier</a></h2>
    <p>
      This section discusses how to upgrade ViewCVS 0.7, or earlier,
      to 0.8 or a later version of the software.
    </p>
    <p>
      <strong>NOTE:</strong> these changes will bring you up to the
      requirements of version 0.8. You must also follow the directions
      for <a href="#from8">upgrading from 0.8</a>.
    </p>

    <h3>Configuration Options</h3>
    <p>
      The largest change from 0.7 to 0.8, that you will need to deal
      with, is the introduction of templates. This shifted many
      configuration file options into the templates, for more direct
      editing of the output style, colors, and layout. Below is a list 
      of options that no longer exist, and where you can find their
      counterpart in the current version of ViewCVS.
    </p>
    <p>
      The following options have all been removed in ViewCVS 0.8. If
      you made local changes to your ViewCVS configuration, then you
      will need to edit templates in the <code>templates/</code>
      subdirectory.
    </p>

    <blockquote>
      <dl>
	<dt>
	  The [text] section:
	  <strong>short_intro</strong>,
	  <strong>long_intro</strong>,
	  and <strong>doc_info</strong>
	</dt>
	<dd>
	  These options have been incorporated into the
	  <code>doc/help_rootview.html</code> page and the
	  <code>doc/help_dirview.html</code> page.

	  <p></p>
	</dd>

	<dt><strong>repository_info</strong></dt>
	<dd>
	This option is now incorporated into the
	<code>directory.ezt</code> template.

	<p></p>
	</dd>

	<dt><strong>table_padding</strong></dt>
	<dd>
	  The table padding values can be changed in the
	  <code>directory.ezt</code> template.

	  <p></p>
	</dd>

	<dt><strong>table_border</strong></dt>
	<dd>
	  Edit <code>directory.ezt</code> to add a border around the
	  directory table.

	  <p></p>
	</dd>

	<dt>
	  <strong>column_header_normal</strong> and
	  <strong>column_header_sorted</strong>
	</dt>
	<dd>
	  Edit <code>directory.ezt</code> to modify the colors of the
	  column headers.

	  <p></p>
	</dd>

	<dt>
	  <strong>extern_window_width</strong> and
	  <strong>extern_window_height</strong>
	</dt>
	<dd>
	  These options were never used and have been removed.
	  <p></p>
	</dd>

	<dt><strong>logo</strong></dt>
	<dd>
	  Edit the templates directly (<code>directory.ezt</code>,
	  <code>log.ezt</code> or <code>log_table.ezt</code> and if
	  needed <code>query.ezt</code>) to alter the URL and size of
	  your logo.

	  <p></p>
	</dd>

	<dt><strong>allow_version_select</strong></dt>
	<dd>
	  Edit the <code>log.ezt</code> template if you want to remove
	  the link which allows the user to select a revision for a
	  diff.

	  <p></p>
	</dd>

	<dt><strong>input_text_size</strong></dt>
	<dd>
	  Edit the <code>log.ezt</code> template if you want to change
	  the size of the entry box for revisions for performing
	  diffs.

	  <p></p>
	</dd>

	<dt><strong>even_odd</strong></dt>
	<dd>
	  Edit the <code>directory.ezt</code> and
	  <code>query.ezt</code> templates if you want to change the
	  colors of the rows in the directory and query result tables.

          <p></p>
	</dd>

        <dt>Colors: <strong>text</strong>
          and <strong>background</strong></dt>
	<dd>
	  These options have been incorporated into the
	  <code>directory.ezt</code>, <code>log.ezt</code>, and
	  <code>log_table.ezt</code> templates.

	  <p></p>
	</dd>

      </dl>
    </blockquote>

  </td></tr></table>
  <hr>
  <address><a href="mailto:viewcvs@lyra.org">ViewCVS Users Group</a></address>
<!-- Created: Mon Sep 24 04:23:53 PDT 2001 -->
<!-- hhmts start -->
Last modified: Sat Dec 22 20:05:14 PST 2001
<!-- hhmts end -->
</body>
</html>