Apache Tomcat 连接器 - 杂项文档

安装 Ant。我唯一的建议是选择一个简单的安装路径。现在为ANT_HOME设置一个环境变量，然后将Ant/bin目录的位置添加到您的PATH变量中。请查阅您的操作系统文档以获取如何执行此操作的信息。完成后，验证您是否可以从命令行运行ant。

Ant用于构建文档等，它必须能够看到一个名为build.xml的文件。此文件位于xdocs目录中。在build.xml文件中，有一个名为all的目标将用于构建文档。

从git仓库获取tomcat-connectors的源代码。您将需要一个git客户端。如果您还没有，请安装您选择的客户端。

您现在已准备好下载源代码。将目录更改为您希望仓库所在的位置。为简单起见，我们将其称为您的GIT_HOME。我的位于C:\build。

首次运行以下命令以克隆源代码。您应该只需要执行此操作一次。

C:\build\>git clone https://github.com/apache/tomcat-connectors tomcat-connectors

您现在应该正在看到所有下载的进行。现在您已将源代码下载到您的机器上，最困难的部分已经结束。从现在开始，要更新您的源代码，您只需cd到仓库中的任何目录并运行git pull命令。

打开命令提示符窗口，cd到您下载源代码的目录。现在cd到xdocs目录，以便Ant可以找到build.xml文件。然后从命令提示符运行以下命令：

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

您应该会看到ant编译器消息快速滚动，然后停止并显示以下内容：

[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>

xdocs目录结构中存在的所有xml文件都被转换为html并复制到GIT_HOME\tomcat-connectors\build\docs目录。在您的浏览器中打开一个html文件，看看它是什么样子。

我发现在进行更新时使用两个窗口会更容易。我将一个窗口称为我的构建窗口。我将此窗口保持在GIT_HOME\tomcat-connectors\xdocs目录中，并且我只在此窗口中运行两个命令：首先我运行

ant clean

ant all

我的第二个窗口我称之为编辑窗口，我将其保持在GIT_HOME\tomcat-connectors\xdocs目录中，我在那里进行编辑、比较和git pull操作。

在开始编辑之前，您应该始终更新本地仓库以防止冲突。

C:\build\tomcat-connectors> git pull

现在您的仓库已更新，您可以开始编辑了。在文档中找到要编辑的内容。当您找到内容时，请记住文件的名称。在您的编辑窗口中，找到并编辑同名的xml源文件。完成后，返回到构建窗口，并在GIT_HOME\tomcat-connectors\xdocs目录中运行

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

这将删除所有以前的html文件，并为更新的材料准备好区域。现在，要制作包含您的更改的新文档，请运行

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

使用您的浏览器查看您刚刚进行的编辑，它们将位于GIT_HOME\tomcat-connectors\build\docs子树中。如果看起来不错并且已准备好，剩下的就是创建补丁并提交它。

从您的编辑窗口cd到包含您正在处理的xml文件的目录，然后运行git pull命令。例如，要生成index.xml文件的差异并将其命名为patch.txt，您将cd到包含index.xml文件的目录并

C:\build\tomcat-connectors\xdocs\>git diff index.xml >  
patch.txt.

现在您已经有了补丁，可以发送了。

文档的补丁处理方式与错误报告相同。您应该将补丁提交到http://issues.apache.org/bugzilla/，并包含一个简洁的主题行。如果您是第一次使用错误数据库，那么您应该阅读http://issues.apache.org/bugzilla/bugwritinghelp.html。您需要创建一个用户帐户。在网站上，将您的补丁粘贴到网页表单中，不要忘记描述您的补丁是用于什么的。迟早会有具有提交权限的人审查您的建议。