From 9401f816dd0d9d550fe98a8507224bde51c4b847 Mon Sep 17 00:00:00 2001 From: hongbotian Date: Mon, 30 Nov 2015 02:41:33 -0500 Subject: upload tomcat JIRA: BOTTLENECK-7 Change-Id: I875d474869efd76ca203c30b60ebc0c3ee606d0e Signed-off-by: hongbotian --- .../docs/miscellaneous/printer/doccontrib.html | 248 +++++++++++++++++++++ 1 file changed, 248 insertions(+) create mode 100644 rubbos/app/tomcat-connectors-1.2.32-src/docs/miscellaneous/printer/doccontrib.html (limited to 'rubbos/app/tomcat-connectors-1.2.32-src/docs/miscellaneous/printer/doccontrib.html') diff --git a/rubbos/app/tomcat-connectors-1.2.32-src/docs/miscellaneous/printer/doccontrib.html b/rubbos/app/tomcat-connectors-1.2.32-src/docs/miscellaneous/printer/doccontrib.html new file mode 100644 index 00000000..6c9c92c1 --- /dev/null +++ b/rubbos/app/tomcat-connectors-1.2.32-src/docs/miscellaneous/printer/doccontrib.html @@ -0,0 +1,248 @@ +The Apache Tomcat Connector - Miscellaneous Documentation - How to Contribute to the Documentation

The Apache Tomcat Connector - Miscellaneous Documentation

How to Contribute to the Documentation

Introduction

+
+ 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 syntax where needed. +
+
+ 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. +
+
+ It's all really quite simple. Here is what you will need: +
+
+A recent version of Ant +
+
+The source code for the connectors from subversion +
+
+Any ascii text editor +
+
+
+

Getting Started Step by Step

+
+ After you get these tools they are simple to set up. +
+
STEP 1. Get Ant
+
+ Install Ant. 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. +
+
+ Ant is used to build the documentation, among other things, and it must be +able to see a file called build.xml. This file is located in the +xdocs directory. In the +build.xml file there is a target named all that will be used to build +the docs. +
+
+
STEP 2. Get the sources
+
+ Get the sources for +tomcat-connectors +from the subversion repository. If you'll +be editing from a windows platform you will need a windows subversion client. There +are several available. I like turtoiseSVN. +Unix users should install the subversion client of their choice, +if they don't already have one. +
+
+ You are ready to download the sources now. Change directory to the +location where you want your repository to be. For simplicity we will call this +your SVN_HOME. Mine is located in C:\build. +
+
+ Run the following command to checkout the sources for the first time. +You should only need to do this once. +

C:\build\>svn checkout http://svn.apache.org/repos/asf/tomcat/jk/trunk/ +tomcat-connectors

+
+
+ You should now be watching all the downloads come in. Now that you have +the sources on your machine the hard part is over. From now on, to update your +sources all you have to do is cd into any directory in your repository and run +the svn update command. +
To update your xdocs directory simply cd into the xdocs directory +and:
C:\build\tomcat-connectors\>cd xdocs
C:\build\tomcat-connectors\xdocs\>svn update
+
+
+
STEP 3. Test your build environment
+
+ Open a command prompt window and cd to the directory where you downloaded +the source. Now cd into the xdocs directory so that Ant can see the +build.xml file. Then from a command prompt, run the following: +

C:\build\tomcat-connectors>cd xdocs
C:\build\tomcat-connectors\xdocs>ant all

+
. +
+ You should see the ant compiler messages scrolling by rapidly and then stop +with the following: +
[style] Transforming into C:\build\tomcat-connectors\build\docs\news\printer>
[style] Processing C:\build\tomcat-connectors\xdocs\news\20041100.xml +to
C:\build\tomcat-connectors\build\docs\news/20041100.html
[style] Loading stylesheet C:\build\tomcat-connectors\xdocs\style.xsl
[style] Processing C:\build\tomcat-connectors\xdocs\news\20050101.xml +to
C:\build\tomcat-connectors\build\docs\news/20050101.html
[style] Processing C:\build\tomcat-connectors\xdocs\news\20060101.xml +to
C:\build\tomcat-connectors\build\docs\news/20060101.html
[style] Transforming into C:\build\tomcat-connectors\build\docs>
[style] Processing C:\build\tomcat-connectors\xdocs\index.xml +to
C:\build\tomcat-connectors\build\docs\index.html
[style] Loading stylesheet C:\build\tomcat-connectors\xdocs\style.xsl

BUILD SUCCESSFUL
Total time: 10 seconds
C:\build\tomcat-connectors>
+
+
+ All the xml files present in the xdocs directory structure were transformed +to html and copied to the SVN_HOME\tomcat-connectors\build\docs +directory. Open one of the +html files in your browser and see how it looks. +
+
+
STEP 4. The editing process.
+
+ I find it easier to use two windows while doing my updates. One I call my +build window. I keep this one in the SVN_HOME\tomcat-connectors\xdocs +directory and I only run two commands in this window: +

First I run
ant clean
Then I run
ant all

+
+
+ My second window I call my edit window and I keep that one in the +SVN_HOME\tomcat-connectors\xdocs directory where I'm doing my +edits, diffs and svn updates. +
+
+ Before you start editing you should always update your local repository to +prevent conflicts. +
You only need to update the xdocs directory
C:\build\tomcat-connectors>cd xdocs
C:\build\tomcat-connectors\xdocs>
C:\build\tomcat-connectors\xdocs>svn update
+
+
+ Now that your repository is up to date you can begin editing. Find +something in the documentation to edit. When you find something remember the +name of the file. In your edit window find and edit the xml source file +with the same name. After you are done return to the build window, and +in the SVN_HOME\tomcat-connectors\xdocs directory run: +

C:\build\tomcat-connectors\xdocs> ant clean

+
+
+ 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: +

C:\build\tomcat-connectors\xdocs>ant all

+
+
+ Use your browser to view the edits you just made, they will be in the +SVN_HOME\tomcat-connectors\build\docs 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. +
+
+
STEP 5. Creating a patch and submitting it.
+
+ From your edit window cd into the directory that contains the xml +file you are working on, and run the svn update command. For example, +to produce a diff of the index.xml file and call it patch.txt, you +would cd into the directory containing the index.xml file and: +
C:\build\tomcat-connectors\xdocs\>svn diff index.xml > +patch.txt.

+
+
+ Now that you have your patch you are ready to send it in. +
+
+ Patches to the documentation are handled just like a bug report. You +should submit your patches to http://issues.apache.org/bugzilla/ + and include a good one line subject. If this is your first time to use the +bug database then you should read http://issues.apach +e.org/bugzilla/bugwritinghelp.html. 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. +
+
+

Subversion Basics

+
+ After you have checked out the sources the first time it is much easier to +use subversion. You can cd into any directory of the repository and run svn +update to get the latest sources for that directory. For editing +purposes you should always update your repository before you start editing to +reduce conflicts. +
+
+ You will need to run svn diff to generate patches for submission. +Again cd into the directory containing the file you are editing and run svn +diff name_of_the_file_you_edited > patch.txt to generate a patch for +submission. +
+
+ Pay attention to the terminal window during the update. +
+
+ Lines begining with a A indicate files that have been added. +
+
+ Lines begining with a D indicate files that have been deleted. +
+
+ Lines begining with a U mean the local copy was patched to update it +to the current version in the master repository. +
+
+ Lines begining with a G mean your local copy is different from the +master copy, and the changes were successfully merged into your copy. +
+
+ Lines begining with a C 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. +
+
+ Lines begining with a ? 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. +
+

Updating Web site

+
+ Only Committers are able to update the web site (http://tomcat.apache.org/connectors-doc/). + To do it: +
+
Connect to people.apache.org.
+
umask 002
+
Copy the changed files to /www/tomcat.apache.org/connectors-doc/.
+
or use ant from a checkout tomcat/jk/trunk/xdocs repository:
+ ant -Dbuild.dir=/www/tomcat.apache.org -Ddist.name=connectors-doc +
+
The changes need around 4 hours to be synced to tomcat.apache.org.
+
+
+

Guides and Resources

+
+ A little help to get you started if you need it +
+
+
+XML +Beginner's Guide +
+
+Bugzilla +
+
+Bugzilla Bug +Writing Guide +
+
+Ant +
+
+Subversion Home +
+
+JK Docs repository +
+
+

\ No newline at end of file -- cgit 1.2.3-korg