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/05/26 20:17:32 UTC
svn commit: r409712 - in /db/derby/site/trunk:
build/site/papers/derby_web.html
src/documentation/content/xdocs/papers/derby_web.xml
Author: jta
Date: Fri May 26 11:17:32 2006
New Revision: 409712
URL: http://svn.apache.org/viewvc?rev=409712&view=rev
Log:
Added an explanation to the Derby site build instructions on how forrest
generates inconsistent line endings on Windows machines.
Modified:
db/derby/site/trunk/build/site/papers/derby_web.html
db/derby/site/trunk/src/documentation/content/xdocs/papers/derby_web.xml
Modified: db/derby/site/trunk/build/site/papers/derby_web.html
URL: http://svn.apache.org/viewvc/db/derby/site/trunk/build/site/papers/derby_web.html?rev=409712&r1=409711&r2=409712&view=diff
==============================================================================
--- db/derby/site/trunk/build/site/papers/derby_web.html (original)
+++ db/derby/site/trunk/build/site/papers/derby_web.html Fri May 26 11:17:32 2006
@@ -156,13 +156,16 @@
<a href="#5.+Test+the+changes">5. Test the changes </a>
</li>
<li>
-<a href="#6.+Commit+changes+to+the+src+and+build%2Fsite+directories">6. Commit changes to the src and build/site directories</a>
+<a href="#odd_diffs">6. Odd diffs under build/site/skin and build/site/papers explained (sort of) </a>
</li>
<li>
-<a href="#7.+Make+web+site+changes+visible">7. Make web site changes visible</a>
+<a href="#7.+Commit+changes+to+the+src+and+build%2Fsite+directories">7. Commit changes to the src and build/site directories</a>
</li>
<li>
-<a href="#8.+Considering+a+quick+fix+to+the+build+tree%3F">8. Considering a quick fix to the build tree?</a>
+<a href="#8.+Make+web+site+changes+visible">8. Make web site changes visible</a>
+</li>
+<li>
+<a href="#9.+Considering+a+quick+fix+to+the+build+tree%3F">9. Considering a quick fix to the build tree?</a>
</li>
</ul>
</li>
@@ -613,8 +616,36 @@
won't be added when the site is viewed locally.</a>
</p>
-<a name="N10256"></a><a name="6.+Commit+changes+to+the+src+and+build%2Fsite+directories"></a>
-<h3 class="boxed">6. Commit changes to the src and build/site directories</h3>
+<a name="N10256"></a><a name="odd_diffs"></a>
+<h3 class="boxed">6. Odd diffs under build/site/skin and build/site/papers explained (sort of) </h3>
+<p>
+Forrest generates inconsistent line endings on Windows machines
+(see <a class="external" href="https://issues.apache.org/jira/browse/FOR-492">FOR-492</a>
+and <a class="external" href="https://issues.apache.org/jira/browse/FOR-805">FOR-805</a>).
+Also <span class="codefrag">png</span> files generated from <span class="codefrag">aart</span>
+source may get generated differently on different platforms.
+</p>
+<p>
+Derby developers build the site on a variety of platforms,
+including Windows, Mac, and Linux.
+<span class="codefrag">svn status</span> may report modifications to files under
+<span class="codefrag">build/site/skin</span>
+and to the <span class="codefrag">png</span> files under
+<span class="codefrag">build/site/papers</span>
+after you build the site,
+depending on who last committed those files.
+</p>
+<p>
+It's harmless to commit those files, though it does add some minor bloat
+to the Derby repository, and
+it's also harmless to <span class="codefrag">svn revert</span> them.
+And it's certainly confusing!
+Feel free to ask on
+<a href="../derby_mail.html">derby-dev@db.apache.org</a>
+if a particular file should be committed or not.
+</p>
+<a name="N10287"></a><a name="7.+Commit+changes+to+the+src+and+build%2Fsite+directories"></a>
+<h3 class="boxed">7. Commit changes to the src and build/site directories</h3>
<p>
Commit modified pages in the <span class="codefrag">src</span> and
<span class="codefrag">build/site</span> trees.
@@ -655,8 +686,8 @@
<pre class="code">
svn commit --message "here is my commit message" src build/site
</pre>
-<a name="N1029B"></a><a name="7.+Make+web+site+changes+visible"></a>
-<h3 class="boxed">7. Make web site changes visible</h3>
+<a name="N102CC"></a><a name="8.+Make+web+site+changes+visible"></a>
+<h3 class="boxed">8. Make web site changes visible</h3>
<p>
A Derby committer can make web site changes visible as follows:
</p>
@@ -669,8 +700,8 @@
www.apache.org automatically syncs up with people.apache.org every couple hours
(the specific schedule could change).
</p>
-<a name="N102AF"></a><a name="8.+Considering+a+quick+fix+to+the+build+tree%3F"></a>
-<h3 class="boxed">8. Considering a quick fix to the build tree?</h3>
+<a name="N102E0"></a><a name="9.+Considering+a+quick+fix+to+the+build+tree%3F"></a>
+<h3 class="boxed">9. Considering a quick fix to the build tree?</h3>
<p>
If you modify a file in the <span class="codefrag">build/site</span> tree,
be sure to also change the source file in the <span class="codefrag">src</span> tree.
@@ -678,7 +709,7 @@
will likely overwrite your changes to the build tree.
</p>
<p>
-<em>Last updated April 20, 2006</em>
+<em>Last updated May 26, 2006</em>
</p>
</div>
Modified: db/derby/site/trunk/src/documentation/content/xdocs/papers/derby_web.xml
URL: http://svn.apache.org/viewvc/db/derby/site/trunk/src/documentation/content/xdocs/papers/derby_web.xml?rev=409712&r1=409711&r2=409712&view=diff
==============================================================================
--- db/derby/site/trunk/src/documentation/content/xdocs/papers/derby_web.xml (original)
+++ db/derby/site/trunk/src/documentation/content/xdocs/papers/derby_web.xml Fri May 26 11:17:32 2006
@@ -449,8 +449,42 @@
</p>
</section>
+<section id="odd_diffs">
+<title>6. Odd diffs under build/site/skin and build/site/papers explained (sort of) </title>
+
+<p>
+Forrest generates inconsistent line endings on Windows machines
+(see <a href="https://issues.apache.org/jira/browse/FOR-492">FOR-492</a>
+and <a href="https://issues.apache.org/jira/browse/FOR-805">FOR-805</a>).
+Also <code>png</code> files generated from <code>aart</code>
+source may get generated differently on different platforms.
+</p>
+
+<p>
+Derby developers build the site on a variety of platforms,
+including Windows, Mac, and Linux.
+<code>svn status</code> may report modifications to files under
+<code>build/site/skin</code>
+and to the <code>png</code> files under
+<code>build/site/papers</code>
+after you build the site,
+depending on who last committed those files.
+</p>
+
+<p>
+It's harmless to commit those files, though it does add some minor bloat
+to the Derby repository, and
+it's also harmless to <code>svn revert</code> them.
+And it's certainly confusing!
+Feel free to ask on
+<a href="../derby_mail.html">derby-dev@db.apache.org</a>
+if a particular file should be committed or not.
+</p>
+
+</section>
+
<section>
-<title>6. Commit changes to the src and build/site directories</title>
+<title>7. Commit changes to the src and build/site directories</title>
<p>
Commit modified pages in the <code>src</code> and
@@ -500,7 +534,7 @@
</section>
<section>
-<title>7. Make web site changes visible</title>
+<title>8. Make web site changes visible</title>
<p>
A Derby committer can make web site changes visible as follows:
@@ -520,7 +554,7 @@
</section>
<section>
-<title>8. Considering a quick fix to the build tree?</title>
+<title>9. Considering a quick fix to the build tree?</title>
<p>
If you modify a file in the <code>build/site</code> tree,
be sure to also change the source file in the <code>src</code> tree.
@@ -530,7 +564,7 @@
</section>
-<p><em>Last updated April 20, 2006</em></p>
+<p><em>Last updated May 26, 2006</em></p>
</section>
</body>