You are viewing a plain text version of this content. The canonical link for it is here.
Posted to derby-commits@db.apache.org by jt...@apache.org on 2006/08/16 19:44:24 UTC
svn commit: r431962 - in /db/derby/site/trunk: build/site/manuals/dita.html
src/documentation/content/xdocs/manuals/dita.xml
Author: jta
Date: Wed Aug 16 10:44:23 2006
New Revision: 431962
URL: http://svn.apache.org/viewvc?rev=431962&view=rev
Log:
Web site DITA instructions:
- Explained how to 'svn del' a file.
- Added instructions for committers on how to commit patches.
- Removed old Enigmail tip because we request uploading patches to Jira.
Modified:
db/derby/site/trunk/build/site/manuals/dita.html
db/derby/site/trunk/src/documentation/content/xdocs/manuals/dita.xml
Modified: db/derby/site/trunk/build/site/manuals/dita.html
URL: http://svn.apache.org/viewvc/db/derby/site/trunk/build/site/manuals/dita.html?rev=431962&r1=431961&r2=431962&view=diff
==============================================================================
--- db/derby/site/trunk/build/site/manuals/dita.html (original)
+++ db/derby/site/trunk/build/site/manuals/dita.html Wed Aug 16 10:44:23 2006
@@ -109,6 +109,9 @@
<li>
<a href="#Submitting+documentation+patches">Submitting documentation patches</a>
</li>
+<li>
+<a href="#Committing+documentation+patches">Committing documentation patches</a>
+</li>
</ul>
</div>
@@ -356,19 +359,51 @@
<li>
<p>
-Make your changes. If you are adding a new file, add it using svn.
-The example below shows adding a file named <span class="codefrag">cgsnewditafile.dita</span> to the <span class="codefrag">Getting Started Guide</span>:
+Make your changes.
</p>
+
+<ul>
+
+<li>
+
+<p>
+ If you are adding a new file add a topicref for the new file to the
+ ditamap where you want it to appear in the manual and add the file
+ using svn.
+ The example below shows adding a file named
+ <span class="codefrag">cgsnewditafile.dita</span> to the <span class="codefrag">Getting Started Guide</span>:
+ </p>
+
<pre class="code">
-svn add src/getstart/cgsnewditafile.dita
-svn propset svn:eol-style native src/getstart/cgsnewditafile.dita
-</pre>
+ svn add src/getstart/cgsnewditafile.dita
+ svn propset svn:eol-style native src/getstart/cgsnewditafile.dita
+ </pre>
+
+</li>
+
+<li>
+
+<p>
+ If you are deleting a file,
+ remove the topicref from the ditamap and
+ delete the file using svn.
+ The example below shows deleting a file named
+ <span class="codefrag">rdevcsecure131.dita</span> in the
+ <span class="codefrag">Developer's Guide</span>:
+ </p>
+
+<pre class="code">
+ svn del src/devguide/rdevcsecure131.dita
+ </pre>
+
+</li>
+
+
+</ul>
-<p>Remember to add a topicref for the new file to the ditamap where you want it to appear in the manual.
-</p>
</li>
@@ -438,45 +473,79 @@
</ol>
-<p>
+</div>
-<strong>Enigmail tips for sending and saving patches</strong>
-</p>
-<p>
-If you use Enigmail to send a patch to the
-<a href="../derby_mail.html">derby-dev</a> mail list be aware that,
-by default,
-Enigmail handles Mozilla's <em>text=flowed</em> formatting
-by replacing leading spaces with a tilde ("~") character (see
-<a class="external" href="http://enigmail.mozdev.org/troubles.html#flowed">
-http://enigmail.mozdev.org/troubles.html#flowed</a>).
-To send a patch in-line using Enigmail,
-turn off the <em>Allow flowed text</em> setting:
-</p>
-<pre class="code">
- Enigmail -> Preferences -> Sending -> Allow flowed text (RFC 2646)
-</pre>
-<p>
-If you use Enigmail to save a patch submitted to the
-<a href="../derby_mail.html">derby-dev</a> mail list,
-you may need to decrypt and save that decrypted email if it was signed using
-gnuPG because
-lines that begin with a dash get escaped with "- " (see
-<a class="external" href="http://www.stillhq.com/extracted/gnupg-api/doc/faq.html#q4.7">http://www.stillhq.com/extracted/gnupg-api/doc/faq.html#q4.7</a>).
-To extract the text in Enigmail without the escape characters,
-first decrypt the email, then save the decrypted message:
-</p>
-<pre class="code">
- Enigmail -> Decrypt/verify
- Enigmail -> Save decrypted message
+<a name="N10229"></a><a name="Committing+documentation+patches"></a>
+<h2 class="boxed">Committing documentation patches</h2>
+<div class="section">
+<ol>
+
+<li> Set up your environment (download required software, checkout Derby
+ documentation source, set environment variables) as described in the
+ <a href="#Setting+up+your+environment">Setting up your environment</a>
+ section.
+ </li>
+
+<ul>
+
+<li>Don't forget to update your
+ <a class="external" href="http://www.apache.org/dev/svn-eol-style.txt">~/.subversion/config</a>
+ file with these entries:
+<pre class="code">*.dita = svn:eol-style=native
+*.ditamap = svn:eol-style=native</pre>
+
+</li>
+
+</ul>
+
+<li>The instructions in the
+ <a href="#Submitting+documentation+patches">Submitting documentation
+ patches</a> tell contributors to create patches at the trunk
+ level, so download the patch to the trunk of your working copy.
+ </li>
+
+<li> If your machine is a different architecture from the machine on which
+ the patch was created, convert the file:
+ <ul>
+
+<li>
+<span class="codefrag">dos2unix</span> converts the file from Windows format to
+ UNIX.</li>
+
+<li>
+<span class="codefrag">unix2dos</span> converts the file from UNIX format to
+ Windows.</li>
+
+</ul>
+
+</li>
+
+<li>Apply the patch:
+<pre class="code">patch -p0 < patch.diff</pre>
+
+</li>
+
+<li>Check modifications with '<span class="codefrag">svn status</span>' and
+ add any files that need it:
+<pre class="code">svn add <em>filename</em>
</pre>
-</div>
+
+</li>
+
+<li>Follow the instructions in the
+ <a href="#Creating+output">Creating output</a> section
+ to verify the doc build succeeds.
+ </li>
+
+<li>Commit the changes. </li>
+</ol>
+</div>
<p>
-<em>Last Updated: August 10, 2006</em>
+<em>Last Updated: August 16, 2006</em>
</p>
</div>
Modified: db/derby/site/trunk/src/documentation/content/xdocs/manuals/dita.xml
URL: http://svn.apache.org/viewvc/db/derby/site/trunk/src/documentation/content/xdocs/manuals/dita.xml?rev=431962&r1=431961&r2=431962&view=diff
==============================================================================
--- db/derby/site/trunk/src/documentation/content/xdocs/manuals/dita.xml (original)
+++ db/derby/site/trunk/src/documentation/content/xdocs/manuals/dita.xml Wed Aug 16 10:44:23 2006
@@ -172,17 +172,41 @@
<li>
<p>
-Make your changes. If you are adding a new file, add it using svn.
-The example below shows adding a file named <code>cgsnewditafile.dita</code> to the <code>Getting Started Guide</code>:
+Make your changes.
</p>
-<source>
-svn add src/getstart/cgsnewditafile.dita
-svn propset svn:eol-style native src/getstart/cgsnewditafile.dita
-</source>
+ <ul>
+ <li>
+ <p>
+ If you are adding a new file add a topicref for the new file to the
+ ditamap where you want it to appear in the manual and add the file
+ using svn.
+ The example below shows adding a file named
+ <code>cgsnewditafile.dita</code> to the <code>Getting Started Guide</code>:
+ </p>
+
+ <source>
+ svn add src/getstart/cgsnewditafile.dita
+ svn propset svn:eol-style native src/getstart/cgsnewditafile.dita
+ </source>
+
+ </li>
+ <li>
+ <p>
+ If you are deleting a file,
+ remove the topicref from the ditamap and
+ delete the file using svn.
+ The example below shows deleting a file named
+ <code>rdevcsecure131.dita</code> in the
+ <code>Developer's Guide</code>:
+ </p>
+ <source>
+ svn del src/devguide/rdevcsecure131.dita
+ </source>
+ </li>
+
+ </ul>
-<p>Remember to add a topicref for the new file to the ditamap where you want it to appear in the manual.
-</p>
</li>
<li>
@@ -233,46 +257,55 @@
</ol>
+</section>
-<p>
-<strong>Enigmail tips for sending and saving patches</strong>
-</p>
-
-<p>
-If you use Enigmail to send a patch to the
-<a href="../derby_mail.html">derby-dev</a> mail list be aware that,
-by default,
-Enigmail handles Mozilla's <em>text=flowed</em> formatting
-by replacing leading spaces with a tilde ("~") character (see
-<a href="http://enigmail.mozdev.org/troubles.html#flowed">
-http://enigmail.mozdev.org/troubles.html#flowed</a>).
-To send a patch in-line using Enigmail,
-turn off the <em>Allow flowed text</em> setting:
-</p>
-
-<source>
- Enigmail -> Preferences -> Sending -> Allow flowed text (RFC 2646)
-</source>
-
-<p>
-If you use Enigmail to save a patch submitted to the
-<a href="../derby_mail.html">derby-dev</a> mail list,
-you may need to decrypt and save that decrypted email if it was signed using
-gnuPG because
-lines that begin with a dash get escaped with "- " (see
-<a href="http://www.stillhq.com/extracted/gnupg-api/doc/faq.html#q4.7">http://www.stillhq.com/extracted/gnupg-api/doc/faq.html#q4.7</a>).
-To extract the text in Enigmail without the escape characters,
-first decrypt the email, then save the decrypted message:
-</p>
+<section>
+<title>Committing documentation patches</title>
-<source>
- Enigmail -> Decrypt/verify
- Enigmail -> Save decrypted message
-</source>
+<ol>
+ <li> Set up your environment (download required software, checkout Derby
+ documentation source, set environment variables) as described in the
+ <a href="#Setting+up+your+environment">Setting up your environment</a>
+ section.
+ </li>
+ <ul>
+ <li>Don't forget to update your
+ <a href="http://www.apache.org/dev/svn-eol-style.txt">~/.subversion/config</a>
+ file with these entries:
+<source>*.dita = svn:eol-style=native
+*.ditamap = svn:eol-style=native</source>
+ </li>
+ </ul>
+ <li>The instructions in the
+ <a href="#Submitting+documentation+patches">Submitting documentation
+ patches</a> tell contributors to create patches at the trunk
+ level, so download the patch to the trunk of your working copy.
+ </li>
+ <li> If your machine is a different architecture from the machine on which
+ the patch was created, convert the file:
+ <ul>
+ <li> <code>dos2unix</code> converts the file from Windows format to
+ UNIX.</li>
+ <li> <code>unix2dos</code> converts the file from UNIX format to
+ Windows.</li>
+ </ul>
+ </li>
+ <li>Apply the patch:
+<source>patch -p0 < patch.diff</source>
+ </li>
+ <li>Check modifications with '<code>svn status</code>' and
+ add any files that need it:
+<source>svn add <em>filename</em></source>
+ </li>
+ <li>Follow the instructions in the
+ <a href="#Creating+output">Creating output</a> section
+ to verify the doc build succeeds.
+ </li>
+ <li>Commit the changes. </li>
+</ol>
</section>
-
-<p><em>Last Updated: August 10, 2006</em></p>
+<p><em>Last Updated: August 16, 2006</em></p>
</body>
</document>