db-derby-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Jean T. Anderson" <...@bristowhill.com>
Subject Re: How to commit documentation patches?
Date Mon, 14 Aug 2006 20:52:44 GMT
This thread got off on a tangent about editing DITA XML -- but
knowing/editing XML is not required for committing doc patches. You just
need to know svn and understand how to build the docs so you can verify
the doc build.

Also, my pointing Dan at the web site instructions [1] wasn't really
helpful. They do tell you how to check out the source, but don't say
specifically how to commit. --They were written from Jeff's viewpoint: a
patch contributor and a doc builder.

Below are instructions for committers that I'll add to that web page
when I have time.

1) Add these entries to your  ~/.subversion/config file [2]:

*.dita = svn:eol-style=native
*.ditamap = svn:eol-style=native

2) Check out the doc source

svn checkout https://svn.apache.org/repos/asf/db/derby/docs/trunk/

3) The web site instructions [1] tell the patch creator to create the
patch at the trunk level, so download the patch to the trunk of your
local working copy.

4) If you're on linux and the patch is in Window format ....

dos2unix patch.diff

5) Apply the patch

patch -p0 < patch.diff

6) 'svn add' any files that need it

7) Verify the doc builds. The web site instructions [1] are good when it
comes to describing what to do to build the docs. All I check for is the
final message indicating success (don't want the automated nightly
builds to fail):

BUILD SUCCESSFUL
Total time: 4 minutes 24 seconds

8) Commit the changes.


Andrew, Halley, and Tomohito -- you have all committed changes to the
DITA docs. Can you think of anything that could be added?

Finally, if you have any problems, please open a Jira issue.  Last
Spring Tomohito took the time to log DERBY-1269, which resulted in
improvements to [1].  Every little bit helps.

 -jean

[1] http://db.apache.org/derby/manuals/dita.html
[2] http://www.apache.org/dev/svn-eol-style.txt

Mime
View raw message