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
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html xmlns="http://www.w3.org/TR/xhtml1/strict">
<head>
<title>How to Contribute to the Documentation</title>
<meta content="1999-2003 The Apache Software Foundation" name="copyright"/>
<meta content="$Date: 2003/03/14 00:12:11 $" name="last-changed"/>
<meta content="Robert Sowders" name="author"/>
<meta content="rsowders@usgs.gov" name="email"/>
<link href="..//style.css" type="text/css" rel="stylesheet"/>
<link href="../images/tomcat.ico" rel="shortcut icon"/>
</head>
<body link="#525D76" vlink="#525D76" alink="#525D76" text="#000000" bgcolor="#ffffff">
<a name="TOP"/>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr height="1">
<td class="nil" height="1" bgcolor="#ffffff" width="150">
<img hspace="0" vspace="0" height="1" width="150" border="0" src="../images/pixel.gif"/>
</td>
<td class="nil" height="1" bgcolor="#ffffff" width="*">
<img hspace="0" vspace="0" height="1" width="370" border="0" src="../images/pixel.gif"/>
</td>
</tr>
<tr>
<td width="*" colspan="2" class="logo" bgcolor="#ffffff">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td align="left">
<img align="left" height="48" width="505" border="0" src="../images/jakarta.gif"/>
</td>
<td align="right">
<img align="right" border="0" src="../images/mod_jk.jpg"/>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td colspan="2" width="*" align="right" class="head" bgcolor="#999999">
<nobr>
<a href="http://www.apache.org/" class="head">Apache Software Foundation</a> |
<a href="http://jakarta.apache.org/" class="head">Jakarta Project</a> |
<a href="http://jakarta.apache.org/tomcat/" class="head">Apache Tomcat</a>
</nobr>
</td>
</tr>
<tr>
<td valign="top" width="150" bgcolor="#ffffff">
<table class="menu" cellpadding="0" cellspacing="0" width="150" border="0">
<tr height="1">
<td class="nil" height="1" bgcolor="#cccccc" width="10">
<img hspace="0" vspace="0" height="1" width="10" border="0" src="../images/pixel.gif"/>
</td>
<td class="nil" height="1" bgcolor="#cccccc" width="140">
<img hspace="0" vspace="0" height="1" width="140" border="0" src="../images/pixel.gif"/>
</td>
</tr>
<tr height="6">
<td colspan="2" width="150" bgcolor="#d0d0d0">Presentation</td>
</tr>
<tr>
<td colspan="2" width="150" bgcolor="#cccccc">
<nobr>
<a class="menu" href="../index.html">Overview</a>
</nobr>
</td>
</tr>
<tr height="2"/>
<tr height="6"/>
<tr height="6">
<td colspan="2" width="150" bgcolor="#d0d0d0">Commons</td>
</tr>
<tr>
<td colspan="2" width="150" bgcolor="#cccccc">
<nobr>
<a class="menu" href="../common/AJPv13.html">AJPv13</a>
</nobr>
</td>
</tr>
<tr height="2"/>
<tr>
<td colspan="2" width="150" bgcolor="#cccccc">
<nobr>
<a class="menu" href="../common/AJPv13-extensions-proposal.html">AJPv13 extensions Proposal</a>
</nobr>
</td>
</tr>
<tr height="2"/>
<tr>
<td colspan="2" width="150" bgcolor="#cccccc">
<nobr>
<a class="menu" href="../common/doccontrib.html">How to Contribute to the Documentation</a>
</nobr>
</td>
</tr>
<tr height="2"/>
<tr>
<td width="10" bgcolor="#cccccc"/>
<td width="140" bgcolor="#cccccc">
<a href="#Introduction" class="menu">Introduction</a>
</td>
</tr>
<tr height="1"/>
<tr>
<td width="10" bgcolor="#cccccc"/>
<td width="140" bgcolor="#cccccc">
<a href="#Getting Started Step by Step" class="menu">Getting Started Step by Step</a>
</td>
</tr>
<tr height="1"/>
<tr>
<td width="10" bgcolor="#cccccc"/>
<td width="140" bgcolor="#cccccc">
<a href="#CVS Basics" class="menu">CVS Basics</a>
</td>
</tr>
<tr height="1"/>
<tr>
<td width="10" bgcolor="#cccccc"/>
<td width="140" bgcolor="#cccccc">
<a href="#Guides and Resources" class="menu">Guides and Resources</a>
</td>
</tr>
<tr height="1"/>
<tr>
<td colspan="2" width="150" bgcolor="#cccccc">
<nobr>
<a class="menu" href="../common/tools.html">Tools</a>
</nobr>
</td>
</tr>
<tr height="2"/>
<tr>
<td colspan="2" width="150" bgcolor="#cccccc">
<nobr>
<a class="menu" href="../faq.html">FAQ</a>
</nobr>
</td>
</tr>
<tr height="2"/>
<tr height="6"/>
<tr height="6">
<td colspan="2" width="150" bgcolor="#d0d0d0">JK</td>
</tr>
<tr>
<td colspan="2" width="150" bgcolor="#cccccc">
<nobr>
<a class="menu" href="../jk/quickhowto.html">Quick Start HowTo</a>
</nobr>
</td>
</tr>
<tr height="2"/>
<tr>
<td colspan="2" width="150" bgcolor="#cccccc">
<nobr>
<a class="menu" href="../jk/aphowto.html">Apache HowTo</a>
</nobr>
</td>
</tr>
<tr height="2"/>
<tr>
<td colspan="2" width="150" bgcolor="#cccccc">
<nobr>
<a class="menu" href="../jk/domhowto.html">Domino HowTo</a>
</nobr>
</td>
</tr>
<tr height="2"/>
<tr>
<td colspan="2" width="150" bgcolor="#cccccc">
<nobr>
<a class="menu" href="../jk/iishowto.html">IIS HowTo</a>
</nobr>
</td>
</tr>
<tr height="2"/>
<tr>
<td colspan="2" width="150" bgcolor="#cccccc">
<nobr>
<a class="menu" href="../jk/neshowto.html">Netscape/iPlanet HowTo</a>
</nobr>
</td>
</tr>
<tr height="2"/>
<tr>
<td colspan="2" width="150" bgcolor="#cccccc">
<nobr>
<a class="menu" href="../jk/workershowto.html">Workers HowTo</a>
</nobr>
</td>
</tr>
<tr height="2"/>
<tr height="6"/>
<tr height="6">
<td colspan="2" width="150" bgcolor="#d0d0d0">JK2</td>
</tr>
<tr height="6"/>
<tr height="6">
<td colspan="2" width="150" bgcolor="#d0d0d0">Configuration in the Tomcat</td>
</tr>
<tr>
<td colspan="2" width="150" bgcolor="#cccccc">
<nobr>
<a class="menu" href="../jk2/configtc.html">Configuration options</a>
</nobr>
</td>
</tr>
<tr height="2"/>
<tr>
<td colspan="2" width="150" bgcolor="#cccccc">
<nobr>
<a class="menu" href="../jk2/configtccom.html">Coyote/JK2 Handlers</a>
</nobr>
</td>
</tr>
<tr height="2"/>
<tr>
<td colspan="2" width="150" bgcolor="#cccccc">
<nobr>
<a class="menu" href="../jk2/configtcex.html">Examples</a>
</nobr>
</td>
</tr>
<tr height="2"/>
<tr height="6"/>
<tr height="6">
<td colspan="2" width="150" bgcolor="#d0d0d0">Configuration in the Web Server</td>
</tr>
<tr>
<td colspan="2" width="150" bgcolor="#cccccc">
<nobr>
<a class="menu" href="../jk2/configweb.html">Configuration file</a>
</nobr>
</td>
</tr>
<tr height="2"/>
<tr>
<td colspan="2" width="150" bgcolor="#cccccc">
<nobr>
<a class="menu" href="../jk2/configwebcom.html">Components</a>
</nobr>
</td>
</tr>
<tr height="2"/>
<tr>
<td colspan="2" width="150" bgcolor="#cccccc">
<nobr>
<a class="menu" href="../jk2/configwebex.html">Examples</a>
</nobr>
</td>
</tr>
<tr height="2"/>
<tr height="6"/>
<tr height="6">
<td colspan="2" width="150" bgcolor="#d0d0d0">Installation</td>
</tr>
<tr>
<td colspan="2" width="150" bgcolor="#cccccc">
<nobr>
<a class="menu" href="../jk2/installhowto.html">Installation of jk2 in the Web Server</a>
</nobr>
</td>
</tr>
<tr height="2"/>
<tr height="6"/>
<tr height="6">
<td colspan="2" width="150" bgcolor="#d0d0d0">Howto</td>
</tr>
<tr>
<td colspan="2" width="150" bgcolor="#cccccc">
<nobr>
<a class="menu" href="../jk2/confighowto.html">Quick Start JK2 Configuration Guide</a>
</nobr>
</td>
</tr>
<tr height="2"/>
<tr>
<td colspan="2" width="150" bgcolor="#cccccc">
<nobr>
<a class="menu" href="../jk2/vhosthowto.html">Apache 2.0.43 - Tomcat 4.1.12 - jk2 - virtual host HOWTO</a>
</nobr>
</td>
</tr>
<tr height="2"/>
<tr height="6"/>
</table>
</td>
<td class="body" valign="top" width="*" bgcolor="#ffffff">
<a name="Introduction">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td align="left" valign="top" class="section" bgcolor="#525D76">
<img border="0" vspace="0" hspace="0" align="left" valign="top" src="../images/corner.gif"/>Introduction</td>
</tr>
</table>
</a>
<p class="section">
This document describes how you can easily contribute to the
documentation. I'm going to try to make it easy for everyone to help out with
the documentation of Tomcat, more specifically the documentation for the
connectors. This is written from a windows user perspective as I believe they
will most benefit from it. For people using Unix it should be easy for them to
apply these steps. Just substitute Unix sytax where needed.
</p>
<p class="section">
The documentation is produced using xml with xsl style sheets. This
effectivly seperates the content of the documents from the style, so all that
contributers need to worry about the content. It is much easier to use than
html.
</p>
<p class="section">
It's all really quite simple. Here is what you will need:
<ul>
<li>
<b>
<font color="#333333">A recent version of Ant</font>
</b>
</li>
<li>
<b>
<font color="#333333">The source code for the connectors from cvs</font>
</b>
</li>
<li>
<b>
<font color="#333333">Any ascii text editor</font>
</b>
</li>
</ul>
</p>
<br/>
<a name="Getting Started Step by Step">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td align="left" valign="top" class="section" bgcolor="#525D76">
<img border="0" vspace="0" hspace="0" align="left" valign="top" src="../images/corner.gif"/>Getting Started Step by Step</td>
</tr>
</table>
</a>
<p class="section">
After you get these tools they are simple to set up.
</p>
<a name="sub_STEP 1. Get Ant">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td align="left" valign="top" class="subsection" bgcolor="#828DA6">
<img border="0" vspace="0" hspace="0" align="left" valign="top" src="../images/corner.gif"/>STEP 1. Get Ant</td>
</tr>
</table>
</a>
<p class="section">
Install <b>
<a href="http://jakarta.apache.org/ant">Ant</a>
</b>. The only advice I
have is to choose a simple installation path. Now set an environment variable
for ANT_HOME, and then add the location of the Ant/bin directory to your PATH
variable. Consult your Operating system documentation for information on how
to do this. When you are finished verify that you can run ant from the command
line.
</p>
<p class="section">
Ant is used to build the documentation, among other things, and it must be
able to see a file called <b>
<font color="#333333">build.xml</font>
</b>. This file is located in the
<b>
<font color="#333333">CVS_HOME\jakarta-tomcat-connectors\jk</font>
</b> directory. In the
<b>
<font color="#333333">build.xml</font>
</b> file there is a target named docs that will be used to build
the docs.
</p>
<br/>
<a name="sub_STEP 2. Get the sources">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td align="left" valign="top" class="subsection" bgcolor="#828DA6">
<img border="0" vspace="0" hspace="0" align="left" valign="top" src="../images/corner.gif"/>STEP 2. Get the sources</td>
</tr>
</table>
</a>
<p class="section">
Get the sources for <b>
<a href="http://cvs.apache.org/viewcvs/jakarta-tomcat- connectors/">jakarta-tomcat-connectors</a>
</b> from the CVS repository. If you'll
be editing from a windows platform you will need a windows cvs client. There
are several available. I like <b>
<a href="http://www.cygwin.com/">cygwin</a>
</b>.
During the install open the developer group and click on cvs. Unix users
should install the CVS client of their choice, if they don't already have one.
</p>
<p class="section">
You are ready to download the sources now. Change directory to the
location where you want your repository to be, and run the following commands
to download the sources for the first time. For simplicity we will call this
your <b>
<font color="#333333">CVS_HOME.</font>
</b> Mine is located in C:\build.
</p>
<p class="section">
Login to the repository and then give the cvs password <b>
<font color="#333333">anoncvs</font>
</b>.
<p class="screen">
<div align="center">
<table bgcolor="#cccccc" cellpadding="2" cellspacing="0" border="1" width="80%">
<tr>
<td align="left" bgcolor="#cccccc">
<code class="screen">
<nobr> </nobr>
</code>
<br/>
<code class="screen">
<nobr>C:\build></nobr>
</code>
<br/>
<code class="screen">
<nobr>C:\build\>cvs -d :pserver:anoncvs@cvs.apache.org:/home/cvspublic
login</nobr>
</code>
<br/>
<code class="screen">
<nobr>cvs password: anoncvs</nobr>
</code>
<br/>
<code class="screen">
<nobr> </nobr>
</code>
<br/>
</td>
</tr>
</table>
</div>
</p>
</p>
<p class="section">
When your prompt comes back you are logged in. Now run the following
command to <b>
<font color="#333333">checkout</font>
</b> the sources for the first time. You should only
need to do this once.
<p class="screen">
<div align="center">
<table bgcolor="#cccccc" cellpadding="2" cellspacing="0" border="1" width="80%">
<tr>
<td align="left" bgcolor="#cccccc">
<code class="screen">
<nobr> </nobr>
</code>
<br/>
<code class="screen">
<nobr>C:\build\>cvs -d :pserver:anoncvs@cvs.apache.org:/home/cvspublic checkout
jakarta-tomcat-connectors</nobr>
</code>
<br/>
<code class="screen">
<nobr> </nobr>
</code>
<br/>
</td>
</tr>
</table>
</div>
</p>
</p>
<p class="section">
You should now be watching all the downloads come in. Now that you have
the sources on your machine the hard part if over. From now on, to update your
sources all you have to do is cd into any directory in your repository and run
cvs update
<p class="screen">
<div align="center">
<table bgcolor="#cccccc" cellpadding="2" cellspacing="0" border="1" width="80%">
<tr>
<td align="left" bgcolor="#cccccc">
<div class="screen"> To update your xdocs directory simply cd into the xdocs directory
and:</div>
<code class="screen">
<nobr>C:\build\jakarta-tomcat-connectors\jk\>cd xdocs</nobr>
</code>
<br/>
<code class="screen">
<nobr>C:\build\jakarta-tomcat-connectors\jk\xdocs\>cvs update -dP</nobr>
</code>
<br/>
</td>
</tr>
</table>
</div>
</p>
</p>
<br/>
<a name="sub_STEP 3. Test your build environment">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td align="left" valign="top" class="subsection" bgcolor="#828DA6">
<img border="0" vspace="0" hspace="0" align="left" valign="top" src="../images/corner.gif"/>STEP 3. Test your build environment</td>
</tr>
</table>
</a>
<p class="section">
Open a command prompt window and cd to the directory where you downloaded
the source. Now cd into the jk directory so <b>
<font color="#333333">Ant</font>
</b> can see the
<b>
<font color="#333333">build.xml</font>
</b> file and, from a command prompt, run the following:
<p class="screen">
<div align="center">
<table bgcolor="#cccccc" cellpadding="2" cellspacing="0" border="1" width="80%">
<tr>
<td align="left" bgcolor="#cccccc">
<code class="screen">
<nobr> </nobr>
</code>
<br/>
<code class="screen">
<nobr>C:\build\jakarta-tomcat-connectors>cd jk</nobr>
</code>
<br/>
<code class="screen">
<nobr>C:\build\jakarta-tomcat-connectors\jk>ant docs</nobr>
</code>
<br/>
<code class="screen">
<nobr> </nobr>
</code>
<br/>
</td>
</tr>
</table>
</div>
</p>
</p>
<p class="section">
You should see the ant compiler messages scrolling by rapidly and then stop
with the following:
<p class="screen">
<div align="center">
<table bgcolor="#cccccc" cellpadding="2" cellspacing="0" border="1" width="80%">
<tr>
<td align="left" bgcolor="#cccccc">
<code class="screen">
<nobr>[style] Transforming into C:\build\jakarta-tomcat-
connectors\jk\build\docs></nobr>
</code>
<br/>
<code class="screen">
<nobr>[style] Processing C:\build\jakarta-tomcat-connectors\jk\xdocs\faq.xml
to</nobr>
</code>
<br/>
<code class="screen">
<nobr>C:\build\jakarta-tomcat-connectors\jk\build\docs\faq.html</nobr>
</code>
<br/>
<code class="screen">
<nobr>[style] Loading stylesheet C:\build\jakarta-tomcat-
connectors\jk\xdocs\style.xsl</nobr>
</code>
<br/>
<code class="screen">
<nobr>[style] Processing C:\build\jakarta-tomcat-connectors\jk\xdocs\index.xml
to</nobr>
</code>
<br/>
<code class="screen">
<nobr>C:\build\jakarta-tomcat-connectors\jk\build\docs\index.html</nobr>
</code>
<br/>
<code class="screen">
<nobr>[copy] Copying 8 files to C:\build\jakarta-tomcat-
connectors\jk\build\docs</nobr>
</code>
<br/>
<code class="screen">
<nobr> </nobr>
</code>
<br/>
<code class="screen">
<nobr>BUILD SUCCESSFUL</nobr>
</code>
<br/>
<code class="screen">
<nobr>Total time: 10 seconds</nobr>
</code>
<br/>
<code class="screen">
<nobr>C:\build\jakarta-tomcat-connectors\jk</nobr>
</code>
<br/>
</td>
</tr>
</table>
</div>
</p>
</p>
<p class="section">
All the xml files present in the xdocs directory structure were transformed
to html and copied to the <b>
<font color="#333333">CVS_HOME\jk\docs</font>
</b> directory. Open one of the
html files in your browser and see how it looks.
</p>
<br/>
<a name="sub_STEP 4. The editing process.">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td align="left" valign="top" class="subsection" bgcolor="#828DA6">
<img border="0" vspace="0" hspace="0" align="left" valign="top" src="../images/corner.gif"/>STEP 4. The editing process.</td>
</tr>
</table>
</a>
<p class="section">
I find it easier to use two windows while doing my updates. One I call my
<b>
<font color="#333333">build</font>
</b> window. I keep this one in the <b>
<font color="#333333">CVS_HOME\jk</font>
</b> directory and I
only run two commands in this window:
<p class="screen">
<div align="center">
<table bgcolor="#cccccc" cellpadding="2" cellspacing="0" border="1" width="80%">
<tr>
<td align="left" bgcolor="#cccccc">
<code class="screen">
<nobr> </nobr>
</code>
<br/>
<div class="screen"> First I run</div>
<code class="screen">
<nobr>ant clean</nobr>
</code>
<br/>
<div class="screen"> Then I run</div>
<code class="screen">
<nobr>ant docs</nobr>
</code>
<br/>
<code class="screen">
<nobr> </nobr>
</code>
<br/>
</td>
</tr>
</table>
</div>
</p>
</p>
<p class="section">
My second window I call my <b>
<font color="#333333">edit</font>
</b> window and I keep that one in the
<b>
<font color="#333333">CVS_HOME\jk\xdocs</font>
</b> directory where I'm doing my edits, diffs, and cvs
updates.
</p>
<p class="section">
Before you start editing you should always update your local repository to
prevent conflicts.
<p class="screen">
<div align="center">
<table bgcolor="#cccccc" cellpadding="2" cellspacing="0" border="1" width="80%">
<tr>
<td align="left" bgcolor="#cccccc">
<div class="screen"> You only need to update the xdocs directory</div>
<code class="screen">
<nobr>C:\build\jakarta-tomcat-connectors\jk>cd xdocs</nobr>
</code>
<br/>
<code class="screen">
<nobr>C:\build\jakarta-tomcat-connectors\jk\xdocs></nobr>
</code>
<br/>
<code class="screen">
<nobr>C:\build\jakarta-tomcat-connectors\jk\xdocs>cvs update -dP</nobr>
</code>
<br/>
</td>
</tr>
</table>
</div>
</p>
</p>
<p class="section">
Now that your repository is up to date you can begin editing. Find
something in the documentation to edit. When you find somethng remember the
name of the file. In your <b>
<font color="#333333">edit</font>
</b> window find and edit the xml source file
with the same name. After you are done return to the <b>
<font color="#333333">build</font>
</b> window, and
in the <b>
<font color="#333333">CVS_HOME\jk</font>
</b> directory run:
<p class="screen">
<div align="center">
<table bgcolor="#cccccc" cellpadding="2" cellspacing="0" border="1" width="80%">
<tr>
<td align="left" bgcolor="#cccccc">
<code class="screen">
<nobr> </nobr>
</code>
<br/>
<code class="screen">
<nobr>C:\build\jakarta-tomcat-connectors\jk> ant clean</nobr>
</code>
<br/>
<code class="screen">
<nobr> </nobr>
</code>
<br/>
</td>
</tr>
</table>
</div>
</p>
</p>
<p class="section">
This will delete all the previous html files and make the area ready for
updated material. Now to make fresh documents that incorporate your changes
run:
<p class="screen">
<div align="center">
<table bgcolor="#cccccc" cellpadding="2" cellspacing="0" border="1" width="80%">
<tr>
<td align="left" bgcolor="#cccccc">
<code class="screen">
<nobr> </nobr>
</code>
<br/>
<code class="screen">
<nobr>C:\build\jakarta-tomcat-connectors\jk\>ant docs</nobr>
</code>
<br/>
<code class="screen">
<nobr> </nobr>
</code>
<br/>
</td>
</tr>
</table>
</div>
</p>
</p>
<p class="section">
Use your browser to view the edits you just made, they will be in the
<b>
<font color="#333333">CVS_HOME\jk\build\docs</font>
</b> sub-tree. If it looks good and is ready to go,
all that is left to do is to create a patch and submit it.
</p>
<br/>
<a name="sub_STEP 5. Creating a patch and submitting it.">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td align="left" valign="top" class="subsection" bgcolor="#828DA6">
<img border="0" vspace="0" hspace="0" align="left" valign="top" src="../images/corner.gif"/>STEP 5. Creating a patch and submitting it.</td>
</tr>
</table>
</a>
<p class="section">
From your <b>
<font color="#333333">edit</font>
</b> window cd into the directory that contains the xml
file you are working on, and run the <b>
<font color="#333333">cvs update</font>
</b> command. For example,
to produce a unified diff of the index.xml file and call it patch.txt, you
would cd into the directory containing the index.xml file and:
<p class="screen">
<div align="center">
<table bgcolor="#cccccc" cellpadding="2" cellspacing="0" border="1" width="80%">
<tr>
<td align="left" bgcolor="#cccccc">
<code class="screen">
<nobr>C:\build\jakarta-tomcat-connectors\jk\xdocscvs diff -u index.xml
patch.txt.</nobr>
</code>
<br/>
<code class="screen">
<nobr> </nobr>
</code>
<br/>
</td>
</tr>
</table>
</div>
</p>
</p>
<p class="section">
Now that you have your patch you are ready to send it in.
</p>
<p class="section">
Patches to the documentation are handled just like a bug report. You
should submit your patches to <b>
<a href="http://nagoya.apache.org/bugzilla/">http://nagoya.apache.org/bugzilla/</a>
</b>
and include a good one line subject. If this is your first time to use the
bug database then you should read <b>
<a href="http://nagoya.apache.org/bugzilla/bugwritinghelp.html">http://nagoya.apach
e.org/bugzilla/bugwritinghelp.html.</a>
</b> You will need to create a user
account. At the web site paste your patch into the web form and don't forget
to describe what it is your patch is for. Sooner or later a someone with
commit privileges will review your suggestion.
</p>
<br/>
<br/>
<a name="CVS Basics">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td align="left" valign="top" class="section" bgcolor="#525D76">
<img border="0" vspace="0" hspace="0" align="left" valign="top" src="../images/corner.gif"/>CVS Basics</td>
</tr>
</table>
</a>
<p class="section">
After you have checked out the sources the first time it is much easier to
use CVS. You can cd into any directory of the repository and run <b>
<font color="#333333">cvs
update -dP</font>
</b> to get the latest sources for that directory. For editing
purposes you should always update your repository before you start editing to
reduce conflicts.
</p>
<p class="section">
You will need to run <b>
<font color="#333333">cvs diff</font>
</b> to generate patches for submission.
Again cd into the directory containing the file you are editing and run <b>
<font color="#333333">cvs
diff -u name_of_the_file_you_edited patch.txt</font>
</b> to generate a patch for
submission. The <b>
<font color="#333333">-u</font>
</b> is the flag for a unified diff which is the prefered
type.
</p>
<p class="section">
Pay attention to the terminal window during the update.
</p>
<p class="section">
Lines begining with a <b>
<font color="#333333">P</font>
</b> mean the local copy was patched to update it
to the current version in the master repository.
</p>
<p class="section">
Lines begining with a <b>
<font color="#333333">M</font>
</b> mean your local copy is different from the
master copy, and the changes were successfully merged into your copy.
</p>
<p class="section">
Lines begining with a <b>
<font color="#333333">C</font>
</b> mean there was a conflict in merging the
changes and you need to review the file and merge the changes manually. Search
for >>>> and merge the changes.
</p>
<p class="section">
Lines begining with a <b>
<font color="#333333">?</font>
</b> indicate files that reside on your local
system which are not part of the repository. You will normally see this when
you are creating new files for submission.
</p>
<br/>
<a name="Guides and Resources">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td align="left" valign="top" class="section" bgcolor="#525D76">
<img border="0" vspace="0" hspace="0" align="left" valign="top" src="../images/corner.gif"/>Guides and Resources</td>
</tr>
</table>
</a>
<p class="section">
A little help to get you if you need it
</p>
<ul>
<li>
<b>
<a href="http://www.xml.org/xml/resources_focus_beginnerguide.shtml">XML
Beginner's Guide</a>
</b>
</li>
<li>
<b>
<a href="http://nagoya.apache.org/bugzilla/">Bugzilla</a>
</b>
</li>
<li>
<b>
<a href="http://nagoya.apache.org/bugzilla/bugwritinghelp.html">Bugzilla Bug
Writing Guide</a>
</b>
</li>
<li>
<b>
<a href="http://jakarta.apache.org/ant">Ant</a>
</b>
</li>
<li>
<b>
<a href="http://www.cvshome.org/">CVS Home</a>
</b>
</li>
<li>
<b>
<a href="http://cvs.apache.org/viewcvs/jakarta-tomcat-connectors/jk/xdocs/">JK
Docs CVS</a>
</b>
</li>
</ul>
<br/>
</td>
</tr>
</table>
</body>
</html>
|
