You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@subversion.apache.org by mf...@apache.org on 2010/02/11 22:04:42 UTC
svn commit: r909145 [1/6] - in /subversion/site/publish: ./ docs/
docs/community-guide/ docs/release-notes/ style/
Author: mf
Date: Thu Feb 11 21:04:38 2010
New Revision: 909145
URL: http://svn.apache.org/viewvc?rev=909145&view=rev
Log:
Replace title attributes by section links which show up when hovering
over the enclosing header.
* style/site.css
(.sectionlink): New class.
* contributing.html,
* docs/community-guide/building.part.html,
* docs/community-guide/conventions.part.html,
* docs/community-guide/debugging.part.html,
* docs/community-guide/general.part.html,
* docs/community-guide/index.html,
* docs/community-guide/issues.part.html,
* docs/community-guide/l10n.part.html,
* docs/community-guide/mailing-lists.part.html,
* docs/community-guide/releasing.part.html,
* docs/community-guide/roles.part.html,
* docs/index.html,
* docs/release-notes/1.2.html,
* docs/release-notes/1.3.html,
* docs/release-notes/1.4.html,
* docs/release-notes/1.5.html,
* docs/release-notes/1.6.html,
* docs/release-notes/1.6.zh.html,
* faq.html,
* faq.ja.html,
* faq.zh.html,
* index.html,
* issue-tracker.html,
* mailing-lists.html,
* news.html,
* packages.html,
* roadmap.html,
* source-code.html
Remove title attributes and add section links to headers.
Approved by: julianfoad, cmpilato
Modified:
subversion/site/publish/contributing.html
subversion/site/publish/docs/community-guide/building.part.html
subversion/site/publish/docs/community-guide/conventions.part.html
subversion/site/publish/docs/community-guide/debugging.part.html
subversion/site/publish/docs/community-guide/general.part.html
subversion/site/publish/docs/community-guide/index.html
subversion/site/publish/docs/community-guide/issues.part.html
subversion/site/publish/docs/community-guide/l10n.part.html
subversion/site/publish/docs/community-guide/mailing-lists.part.html
subversion/site/publish/docs/community-guide/releasing.part.html
subversion/site/publish/docs/community-guide/roles.part.html
subversion/site/publish/docs/index.html
subversion/site/publish/docs/release-notes/1.2.html
subversion/site/publish/docs/release-notes/1.3.html
subversion/site/publish/docs/release-notes/1.4.html
subversion/site/publish/docs/release-notes/1.5.html
subversion/site/publish/docs/release-notes/1.6.html
subversion/site/publish/docs/release-notes/1.6.zh.html
subversion/site/publish/faq.html
subversion/site/publish/faq.ja.html
subversion/site/publish/faq.zh.html
subversion/site/publish/features.html
subversion/site/publish/index.html
subversion/site/publish/issue-tracker.html
subversion/site/publish/mailing-lists.html
subversion/site/publish/news.html
subversion/site/publish/packages.html
subversion/site/publish/roadmap.html
subversion/site/publish/source-code.html
subversion/site/publish/style/site.css
Modified: subversion/site/publish/contributing.html
URL: http://svn.apache.org/viewvc/subversion/site/publish/contributing.html?rev=909145&r1=909144&r2=909145&view=diff
==============================================================================
--- subversion/site/publish/contributing.html (original)
+++ subversion/site/publish/contributing.html Thu Feb 11 21:04:38 2010
@@ -30,8 +30,11 @@
document.</p>
</div>
-<div class="h2" id="educate" title="educate">
-<h2>Help Others Learn</h2>
+<div class="h2" id="educate">
+<h2>Help Others Learn
+ <a class="sectionlink" href="#educate"
+ title="Link to this section">¶</a>
+</h2>
<ul>
<li><p style="font-weight: bold;">Participate in the mailing lists</p>
@@ -68,8 +71,11 @@
</div> <!-- #educate -->
-<div class="h2" id="code" title="code">
-<h2>Contribute Code</h2>
+<div class="h2" id="code">
+<h2>Contribute Code
+ <a class="sectionlink" href="#code"
+ title="Link to this section">¶</a>
+</h2>
<ul>
<li><p style="font-weight: bold;">File a bug report</p>
Modified: subversion/site/publish/docs/community-guide/building.part.html
URL: http://svn.apache.org/viewvc/subversion/site/publish/docs/community-guide/building.part.html?rev=909145&r1=909144&r2=909145&view=diff
==============================================================================
--- subversion/site/publish/docs/community-guide/building.part.html (original)
+++ subversion/site/publish/docs/community-guide/building.part.html Thu Feb 11 21:04:38 2010
@@ -1,8 +1,14 @@
-<div class="h1" id="building-and-testing" title="building-and-testing">
-<h1>Building and Testing</h1>
-
-<div class="h2" id="configury" title="configury">
-<h2>The configuration/build system under unix</h2>
+<div class="h1" id="building-and-testing">
+<h1>Building and Testing
+ <a class="sectionlink" href="#building-and-testing"
+ title="Link to this section">¶</a>
+</h1>
+
+<div class="h2" id="configury">
+<h2>The configuration/build system under unix
+ <a class="sectionlink" href="#configury"
+ title="Link to this section">¶</a>
+</h2>
<p>Greg Stein wrote a custom build system for Subversion, which had
been using `automake' and recursive Makefiles. Now it uses a single,
@@ -217,8 +223,11 @@
</div> <!-- configury -->
-<div class="h2" id="automated-tests" title="automated-tests">
-<h2>Automated tests</h2>
+<div class="h2" id="automated-tests">
+<h2>Automated tests
+ <a class="sectionlink" href="#automated-tests"
+ title="Link to this section">¶</a>
+</h2>
<p>For a description of how to use and add tests to Subversion's
automated test framework, please read <a
@@ -241,8 +250,11 @@
</div> <!-- automated-tests -->
-<div class="h2" id="build-farm" title="build-farm">
-<h2>Build farm</h2>
+<div class="h2" id="build-farm">
+<h2>Build farm
+ <a class="sectionlink" href="#build-farm"
+ title="Link to this section">¶</a>
+</h2>
<p>Lieven Govaerts has set up a
<a href="http://buildbot.sourceforge.net/" >BuildBot</a> build/test
@@ -273,8 +285,11 @@
</div> <!-- build-farm -->
-<div class="h2" id="write-test-cases-first" title="write-test-cases-first">
-<h2>Writing test cases before code</h2>
+<div class="h2" id="write-test-cases-first">
+<h2>Writing test cases before code
+ <a class="sectionlink" href="#write-test-cases-first"
+ title="Link to this section">¶</a>
+</h2>
<pre>
From: Karl Fogel <kfogel@collab.net>
Modified: subversion/site/publish/docs/community-guide/conventions.part.html
URL: http://svn.apache.org/viewvc/subversion/site/publish/docs/community-guide/conventions.part.html?rev=909145&r1=909144&r2=909145&view=diff
==============================================================================
--- subversion/site/publish/docs/community-guide/conventions.part.html (original)
+++ subversion/site/publish/docs/community-guide/conventions.part.html Thu Feb 11 21:04:38 2010
@@ -1,8 +1,14 @@
-<div class="h1" id="conventions" title="conventions">
-<h1>Coding and Commit Conventions</h1>
-
-<div class="h2" id="interface-visibility" title="interface-visibility">
-<h2>Code modularity and interface visibility</h2>
+<div class="h1" id="conventions">
+<h1>Coding and Commit Conventions
+ <a class="sectionlink" href="#conventions"
+ title="Link to this section">¶</a>
+</h1>
+
+<div class="h2" id="interface-visibility">
+<h2>Code modularity and interface visibility
+ <a class="sectionlink" href="#interface-visibility"
+ title="Link to this section">¶</a>
+</h2>
<p>Subversion's code and headers files are segregated along a couple
of key lines: library-specific vs. inter-library; public vs. private.
@@ -43,8 +49,11 @@
</div> <!-- interface-visibility -->
-<div class="h2" id="coding-style" title="coding-style">
-<h2>Coding style</h2>
+<div class="h2" id="coding-style">
+<h2>Coding style
+ <a class="sectionlink" href="#coding-style"
+ title="Link to this section">¶</a>
+</h2>
<p>Subversion uses ANSI C, and follows the GNU coding standards,
except that we do not put a space between the name of a function and
@@ -88,8 +97,11 @@
</div> <!-- coding-style -->
-<div class="h2" id="use-page-breaks" title="use-page-breaks">
-<h2>Using page breaks</h2>
+<div class="h2" id="use-page-breaks">
+<h2>Using page breaks
+ <a class="sectionlink" href="#use-page-breaks"
+ title="Link to this section">¶</a>
+</h2>
<p>We're using page breaks (the Ctrl-L character, ASCII 12) for
section boundaries in both code and plaintext prose files. Each
@@ -104,8 +116,11 @@
</div> <!-- use-page-breaks -->
-<div class="h2" id="error-messages" title="error-messages">
-<h2>Error message conventions</h2>
+<div class="h2" id="error-messages">
+<h2>Error message conventions
+ <a class="sectionlink" href="#error-messages"
+ title="Link to this section">¶</a>
+</h2>
<p>For error messages the following conventions apply:</p>
@@ -169,8 +184,11 @@
</div> <!-- error-messages -->
-<div class="h2" id="apr-pools" title="apr-pools">
-<h2>APR pool usage conventions</h2>
+<div class="h2" id="apr-pools">
+<h2>APR pool usage conventions
+ <a class="sectionlink" href="#apr-pools"
+ title="Link to this section">¶</a>
+</h2>
<p>(This assumes you already basically understand how APR pools work;
see apr_pools.h for details.)</p>
@@ -351,8 +369,11 @@
</div> <!-- apr-pools -->
-<div class="h2" id="apr-status-codes" title="apr-status-codes">
-<h2>APR status codes</h2>
+<div class="h2" id="apr-status-codes">
+<h2>APR status codes
+ <a class="sectionlink" href="#apr-status-codes"
+ title="Link to this section">¶</a>
+</h2>
<p>Always check for APR status codes (except APR_SUCCESS) with the
APR_STATUS_IS_...() macros, not by direct comparison. This is required
@@ -361,8 +382,11 @@
</div> <!-- apr-status-codes -->
-<div class="h2" id="exception-handling" title="exception-handling">
-<h2>Exception handling</h2>
+<div class="h2" id="exception-handling">
+<h2>Exception handling
+ <a class="sectionlink" href="#exception-handling"
+ title="Link to this section">¶</a>
+</h2>
<p>OK, here's how to use exceptions in Subversion.</p>
@@ -529,8 +553,11 @@
</div> <!-- exception-handling -->
-<div class="h2" id="secure-coding" title="secure-coding">
-<h2>Secure coding guidelines</h2>
+<div class="h2" id="secure-coding">
+<h2>Secure coding guidelines
+ <a class="sectionlink" href="#secure-coding"
+ title="Link to this section">¶</a>
+</h2>
<p>Just like almost any other programming language, C has undesirable
features which enables an attacker to make your program fail in
@@ -582,9 +609,11 @@
</div> <!-- secure-coding -->
-<div class="h2" id="destruction-of-stacked-resources"
- title="destruction-of-stacked-resources">
-<h2>Destruction of stacked resources</h2>
+<div class="h2" id="destruction-of-stacked-resources">
+<h2>Destruction of stacked resources
+ <a class="sectionlink" href="#destruction-of-stacked-resources"
+ title="Link to this section">¶</a>
+</h2>
<p>Some resources need destruction to ensure correct functioning of the
application. Such resources include files, especially since open
@@ -644,8 +673,11 @@
</div> <!-- destruction-of-stacked-resources -->
-<div class="h2" id="other-conventions" title="other-conventions">
-<h2>Other coding conventions</h2>
+<div class="h2" id="other-conventions">
+<h2>Other coding conventions
+ <a class="sectionlink" href="#other-conventions"
+ title="Link to this section">¶</a>
+</h2>
<p>In addition to the GNU standards, Subversion uses these
conventions:</p>
@@ -795,8 +827,11 @@
</div> <!-- other-conventions -->
-<div class="h2" id="log-messages" title="log-messages">
-<h2>Writing log messages</h2>
+<div class="h2" id="log-messages">
+<h2>Writing log messages
+ <a class="sectionlink" href="#log-messages"
+ title="Link to this section">¶</a>
+</h2>
<p>Every commit needs a log message. </p>
@@ -998,8 +1033,11 @@
</div> <!-- log-messages -->
-<div class="h2" id="crediting" title="crediting">
-<h2>Crediting</h2>
+<div class="h2" id="crediting">
+<h2>Crediting
+ <a class="sectionlink" href="#crediting"
+ title="Link to this section">¶</a>
+</h2>
<p>It is very important to record code contributions in a consistent
and parseable way. This allows us to write scripts to figure out who
Modified: subversion/site/publish/docs/community-guide/debugging.part.html
URL: http://svn.apache.org/viewvc/subversion/site/publish/docs/community-guide/debugging.part.html?rev=909145&r1=909144&r2=909145&view=diff
==============================================================================
--- subversion/site/publish/docs/community-guide/debugging.part.html (original)
+++ subversion/site/publish/docs/community-guide/debugging.part.html Thu Feb 11 21:04:38 2010
@@ -1,11 +1,20 @@
-<div class="h1" id="debugging" title="debugging">
-<h1>Debugging Subversion</h1>
-
-<div class="h2" id="server-debugging" title="server-debugging">
-<h2>Debugging the server</h2>
-
-<div class="h3" id="debugging-ra-dav" title="debugging-ra-dav">
-<h3>Debugging the DAV server</h3>
+<div class="h1" id="debugging">
+<h1>Debugging Subversion
+ <a class="sectionlink" href="#debugging"
+ title="Link to this section">¶</a>
+</h1>
+
+<div class="h2" id="server-debugging">
+<h2>Debugging the server
+ <a class="sectionlink" href="#server-debugging"
+ title="Link to this section">¶</a>
+</h2>
+
+<div class="h3" id="debugging-ra-dav">
+<h3>Debugging the DAV server
+ <a class="sectionlink" href="#debugging-ra-dav"
+ title="Link to this section">¶</a>
+</h3>
<p>'mod_dav_svn.so' contains the main Subversion server logic; it runs
as a module within mod_dav, which runs as a module within httpd.
@@ -39,8 +48,11 @@
</div> <!-- debugging-ra-dav -->
-<div class="h3" id="debugging-ra-svn" title="debugging-ra-svn">
-<h3>Debugging the ra_svn client and server, on Unix</h3>
+<div class="h3" id="debugging-ra-svn">
+<h3>Debugging the ra_svn client and server, on Unix
+ <a class="sectionlink" href="#debugging-ra-svn"
+ title="Link to this section">¶</a>
+</h3>
<p>Bugs in ra_svn usually manifest themselves with one of the
following cryptic error messages:</p>
@@ -121,8 +133,11 @@
</div> <!-- server-debugging -->
-<div class="h2" id="net-trace" title="net-trace">
-<h2>Tracing network traffic</h2>
+<div class="h2" id="net-trace">
+<h2>Tracing network traffic
+ <a class="sectionlink" href="#net-trace"
+ title="Link to this section">¶</a>
+</h2>
<p>Use <a href="http://www.wireshark.org/">Wireshark</a> (formerly
known as "Ethereal") to eavesdrop on the conversation.</p>
@@ -201,8 +216,11 @@
</div> <!-- net-trace -->
-<div class="h2" id="tracing-memory-leaks" title="tracing-memory-leaks">
-<h2>Tracking down memory leaks</h2>
+<div class="h2" id="tracing-memory-leaks">
+<h2>Tracking down memory leaks
+ <a class="sectionlink" href="#tracing-memory-leaks"
+ title="Link to this section">¶</a>
+</h2>
<p>Our use of APR pools makes it unusual for us to have memory leaks
in the strictest sense; all the memory we allocate will be cleaned up
Modified: subversion/site/publish/docs/community-guide/general.part.html
URL: http://svn.apache.org/viewvc/subversion/site/publish/docs/community-guide/general.part.html?rev=909145&r1=909144&r2=909145&view=diff
==============================================================================
--- subversion/site/publish/docs/community-guide/general.part.html (original)
+++ subversion/site/publish/docs/community-guide/general.part.html Thu Feb 11 21:04:38 2010
@@ -1,8 +1,14 @@
-<div class="h1" id="general" title="general">
-<h1>General Overview</h1>
-
-<div class="h2" id="participating" title="participating">
-<h2>Participating in the community</h2>
+<div class="h1" id="general">
+<h1>General Overview
+ <a class="sectionlink" href="#general"
+ title="Link to this section">¶</a>
+</h1>
+
+<div class="h2" id="participating">
+<h2>Participating in the community
+ <a class="sectionlink" href="#participating"
+ title="Link to this section">¶</a>
+</h2>
<p>Although Subversion was originally sponsored and hosted by
CollabNet (<a href="http://www.collab.net">http://www.collab.net</a>),
@@ -67,8 +73,11 @@
</div> <!-- participating -->
-<div class="h2" id="docs" title="docs">
-<h2>Theory and documentation</h2>
+<div class="h2" id="docs">
+<h2>Theory and documentation
+ <a class="sectionlink" href="#docs"
+ title="Link to this section">¶</a>
+</h2>
<ol>
<li><p>Design</p>
@@ -135,8 +144,11 @@
</div> <!-- docs -->
-<div class="h2" id="code-to-read" title="code-to-read">
-<h2>Code to read</h2>
+<div class="h2" id="code-to-read">
+<h2>Code to read
+ <a class="sectionlink" href="#code-to-read"
+ title="Link to this section">¶</a>
+</h2>
<p>Before you can contribute code, you'll need to familiarize yourself
with the existing code base and interfaces.</p>
@@ -193,8 +205,11 @@
</div> <!-- code-to-read -->
-<div class="h2" id="directory-layout" title="directory-layout">
-<h2>Directory layout</h2>
+<div class="h2" id="directory-layout">
+<h2>Directory layout
+ <a class="sectionlink" href="#directory-layout"
+ title="Link to this section">¶</a>
+</h2>
<p>A rough guide to the source tree:</p>
@@ -267,8 +282,11 @@
</div> <!-- directory-layout -->
-<div class="h2" id="branch-policy" title="branch-policy">
-<h2>Branching policy</h2>
+<div class="h2" id="branch-policy">
+<h2>Branching policy
+ <a class="sectionlink" href="#branch-policy"
+ title="Link to this section">¶</a>
+</h2>
<p>The Subversion project strongly prefers that active development
happen in the common trunk. Changes made to trunk have the highest
@@ -289,8 +307,11 @@
task. The following are some guidelines to make your branch-based
development work go smoothly.</p>
-<div class="h3" id="branch-creation-and-management" title="branch-creation-and-management">
-<h3>Branch creation and management</h3>
+<div class="h3" id="branch-creation-and-management">
+<h3>Branch creation and management
+ <a class="sectionlink" href="#branch-creation-and-management"
+ title="Link to this section">¶</a>
+</h3>
<p>There's nothing particularly complex about branch-based
development. You make a branch from the trunk (or from whatever
@@ -303,8 +324,11 @@
</div> <!-- branch-creation-and-management -->
-<div class="h3" id="lightweight-branches" title="lightweight-branches">
-<h3>Lightweight branches</h3>
+<div class="h3" id="lightweight-branches">
+<h3>Lightweight branches
+ <a class="sectionlink" href="#lightweight-branches"
+ title="Link to this section">¶</a>
+</h3>
<p>If you're working on a feature or bugfix in stages involving
multiple commits, and some of the intermediate stages aren't stable
@@ -337,8 +361,11 @@
</div> <!-- lightweight-branches -->
-<div class="h3" id="branch-readme-files" title="branch-readme-files">
-<h3>BRANCH-README files</h3>
+<div class="h3" id="branch-readme-files">
+<h3>BRANCH-README files
+ <a class="sectionlink" href="#branch-readme-files"
+ title="Link to this section">¶</a>
+</h3>
<p>For branches you expect to be longer-lived, we recommend the
creation and regular updating of a file in the root of your branch
@@ -395,11 +422,17 @@
</div> <!-- branch-policy -->
-<div class="h2" id="documenting" title="documenting">
-<h2>Documentation</h2>
-
-<div class="h3" id="document-everything" title="document-everything">
-<h3>Document Everything</h3>
+<div class="h2" id="documenting">
+<h2>Documentation
+ <a class="sectionlink" href="#documenting"
+ title="Link to this section">¶</a>
+</h2>
+
+<div class="h3" id="document-everything">
+<h3>Document Everything
+ <a class="sectionlink" href="#document-everything"
+ title="Link to this section">¶</a>
+</h3>
<p>Every function, whether public or internal, must start out with a
documentation comment that describes what the function does. The
@@ -474,8 +507,11 @@
</div> <!-- document-everything -->
-<div class="h3" id="doxygen-docs" title="doxygen-docs">
-<h3>Public API Documentation</h3>
+<div class="h3" id="doxygen-docs">
+<h3>Public API Documentation
+ <a class="sectionlink" href="#doxygen-docs"
+ title="Link to this section">¶</a>
+</h3>
<p>We use the <a href="http://www.doxygen.org/">Doxygen</a> format for
public interface documentation. This means anything that goes in a
@@ -509,8 +545,11 @@
</div> <!-- documenting -->
-<div class="h2" id="patches" title="patches">
-<h2>Patch submission guidelines</h2>
+<div class="h2" id="patches">
+<h2>Patch submission guidelines
+ <a class="sectionlink" href="#patches"
+ title="Link to this section">¶</a>
+</h2>
<p>Mail patches to dev@subversion.apache.org, starting the subject
line with <tt>[PATCH]</tt>. This helps our patch manager spot patches
Modified: subversion/site/publish/docs/community-guide/index.html
URL: http://svn.apache.org/viewvc/subversion/site/publish/docs/community-guide/index.html?rev=909145&r1=909144&r2=909145&view=diff
==============================================================================
--- subversion/site/publish/docs/community-guide/index.html (original)
+++ subversion/site/publish/docs/community-guide/index.html Thu Feb 11 21:04:38 2010
@@ -151,11 +151,17 @@
</div>
-<div class="h1" id="general" title="general">
-<h1>General Overview</h1>
-
-<div class="h2" id="participating" title="participating">
-<h2>Participating in the community</h2>
+<div class="h1" id="general">
+<h1>General Overview
+ <a class="sectionlink" href="#general"
+ title="Link to this section">¶</a>
+</h1>
+
+<div class="h2" id="participating">
+<h2>Participating in the community
+ <a class="sectionlink" href="#participating"
+ title="Link to this section">¶</a>
+</h2>
<p>Although Subversion was originally sponsored and hosted by
CollabNet (<a href="http://www.collab.net">http://www.collab.net</a>),
@@ -220,8 +226,11 @@
</div> <!-- participating -->
-<div class="h2" id="docs" title="docs">
-<h2>Theory and documentation</h2>
+<div class="h2" id="docs">
+<h2>Theory and documentation
+ <a class="sectionlink" href="#docs"
+ title="Link to this section">¶</a>
+</h2>
<ol>
<li><p>Design</p>
@@ -288,8 +297,11 @@
</div> <!-- docs -->
-<div class="h2" id="code-to-read" title="code-to-read">
-<h2>Code to read</h2>
+<div class="h2" id="code-to-read">
+<h2>Code to read
+ <a class="sectionlink" href="#code-to-read"
+ title="Link to this section">¶</a>
+</h2>
<p>Before you can contribute code, you'll need to familiarize yourself
with the existing code base and interfaces.</p>
@@ -346,8 +358,11 @@
</div> <!-- code-to-read -->
-<div class="h2" id="directory-layout" title="directory-layout">
-<h2>Directory layout</h2>
+<div class="h2" id="directory-layout">
+<h2>Directory layout
+ <a class="sectionlink" href="#directory-layout"
+ title="Link to this section">¶</a>
+</h2>
<p>A rough guide to the source tree:</p>
@@ -420,8 +435,11 @@
</div> <!-- directory-layout -->
-<div class="h2" id="branch-policy" title="branch-policy">
-<h2>Branching policy</h2>
+<div class="h2" id="branch-policy">
+<h2>Branching policy
+ <a class="sectionlink" href="#branch-policy"
+ title="Link to this section">¶</a>
+</h2>
<p>The Subversion project strongly prefers that active development
happen in the common trunk. Changes made to trunk have the highest
@@ -442,8 +460,11 @@
task. The following are some guidelines to make your branch-based
development work go smoothly.</p>
-<div class="h3" id="branch-creation-and-management" title="branch-creation-and-management">
-<h3>Branch creation and management</h3>
+<div class="h3" id="branch-creation-and-management">
+<h3>Branch creation and management
+ <a class="sectionlink" href="#branch-creation-and-management"
+ title="Link to this section">¶</a>
+</h3>
<p>There's nothing particularly complex about branch-based
development. You make a branch from the trunk (or from whatever
@@ -456,8 +477,11 @@
</div> <!-- branch-creation-and-management -->
-<div class="h3" id="lightweight-branches" title="lightweight-branches">
-<h3>Lightweight branches</h3>
+<div class="h3" id="lightweight-branches">
+<h3>Lightweight branches
+ <a class="sectionlink" href="#lightweight-branches"
+ title="Link to this section">¶</a>
+</h3>
<p>If you're working on a feature or bugfix in stages involving
multiple commits, and some of the intermediate stages aren't stable
@@ -490,8 +514,11 @@
</div> <!-- lightweight-branches -->
-<div class="h3" id="branch-readme-files" title="branch-readme-files">
-<h3>BRANCH-README files</h3>
+<div class="h3" id="branch-readme-files">
+<h3>BRANCH-README files
+ <a class="sectionlink" href="#branch-readme-files"
+ title="Link to this section">¶</a>
+</h3>
<p>For branches you expect to be longer-lived, we recommend the
creation and regular updating of a file in the root of your branch
@@ -548,11 +575,17 @@
</div> <!-- branch-policy -->
-<div class="h2" id="documenting" title="documenting">
-<h2>Documentation</h2>
-
-<div class="h3" id="document-everything" title="document-everything">
-<h3>Document Everything</h3>
+<div class="h2" id="documenting">
+<h2>Documentation
+ <a class="sectionlink" href="#documenting"
+ title="Link to this section">¶</a>
+</h2>
+
+<div class="h3" id="document-everything">
+<h3>Document Everything
+ <a class="sectionlink" href="#document-everything"
+ title="Link to this section">¶</a>
+</h3>
<p>Every function, whether public or internal, must start out with a
documentation comment that describes what the function does. The
@@ -627,8 +660,11 @@
</div> <!-- document-everything -->
-<div class="h3" id="doxygen-docs" title="doxygen-docs">
-<h3>Public API Documentation</h3>
+<div class="h3" id="doxygen-docs">
+<h3>Public API Documentation
+ <a class="sectionlink" href="#doxygen-docs"
+ title="Link to this section">¶</a>
+</h3>
<p>We use the <a href="http://www.doxygen.org/">Doxygen</a> format for
public interface documentation. This means anything that goes in a
@@ -662,8 +698,11 @@
</div> <!-- documenting -->
-<div class="h2" id="patches" title="patches">
-<h2>Patch submission guidelines</h2>
+<div class="h2" id="patches">
+<h2>Patch submission guidelines
+ <a class="sectionlink" href="#patches"
+ title="Link to this section">¶</a>
+</h2>
<p>Mail patches to dev@subversion.apache.org, starting the subject
line with <tt>[PATCH]</tt>. This helps our patch manager spot patches
@@ -755,11 +794,17 @@
</div> <!-- general -->
-<div class="h1" id="roles" title="roles">
-<h1>Community Roles</h1>
-
-<div class="h2" id="committers" title="committers">
-<h2>Committers</h2>
+<div class="h1" id="roles">
+<h1>Community Roles
+ <a class="sectionlink" href="#roles"
+ title="Link to this section">¶</a>
+</h1>
+
+<div class="h2" id="committers">
+<h2>Committers
+ <a class="sectionlink" href="#committers"
+ title="Link to this section">¶</a>
+</h2>
<p>Committers in the Subversion project are those folks to whom the
right to directly commit changes to our version controlled resources
@@ -775,8 +820,11 @@
>COMMITTERS</a> file lists all committers, both full and partial, and
says the domains for each partial committer.</p>
-<div class="h3" id="full-commit-access" title="full-commit-access">
-<h3>How full commit access is granted</h3>
+<div class="h3" id="full-commit-access">
+<h3>How full commit access is granted
+ <a class="sectionlink" href="#full-commit-access"
+ title="Link to this section">¶</a>
+</h3>
<p>After someone has successfully contributed a few non-trivial
patches, some full committer, usually whoever has reviewed and applied
@@ -820,8 +868,11 @@
</div> <!-- full-commit-access -->
-<div class="h3" id="partial-commit-access" title="partial-commit-access">
-<h3>How partial commit access is granted</h3>
+<div class="h3" id="partial-commit-access">
+<h3>How partial commit access is granted
+ <a class="sectionlink" href="#partial-commit-access"
+ title="Link to this section">¶</a>
+</h3>
<p>A full committer sponsors the partial committer. Usually this
means the full committer has applied several patches to the same area
@@ -865,8 +916,11 @@
</div> <!-- partial-commit-access -->
-<div class="h3" id="contrib-area" title="contrib-area">
-<h3>The contrib/ area</h3>
+<div class="h3" id="contrib-area">
+<h3>The contrib/ area
+ <a class="sectionlink" href="#contrib-area"
+ title="Link to this section">¶</a>
+</h3>
<p>When a tool is accepted into the <i>contrib/</i> area, we
automatically offer its author partial commit access to maintain the
@@ -881,8 +935,11 @@
</div> <!-- contrib-area -->
-<div class="h3" id="obvious-fix" title="obvious-fix">
-<h3>The "obvious fix" rule</h3>
+<div class="h3" id="obvious-fix">
+<h3>The "obvious fix" rule
+ <a class="sectionlink" href="#obvious-fix"
+ title="Link to this section">¶</a>
+</h3>
<p>Any committer, whether full or partial, may commit fixes for
obvious typos, grammar mistakes, and formatting problems wherever they
@@ -913,8 +970,11 @@
</div> <!-- committers -->
-<div class="h2" id="release-manager" title="release-manager">
-<h2>Release Manager</h2>
+<div class="h2" id="release-manager">
+<h2>Release Manager
+ <a class="sectionlink" href="#release-manager"
+ title="Link to this section">¶</a>
+</h2>
<p>The role of the Release Manager in the Subversion project is to
handle the process of getting code stabilized, packaged and released
@@ -944,8 +1004,11 @@
</div> <!-- release-manager -->
-<div class="h2" id="patch-manager" title="patch-manager">
-<h2>Patch Manager</h2>
+<div class="h2" id="patch-manager">
+<h2>Patch Manager
+ <a class="sectionlink" href="#patch-manager"
+ title="Link to this section">¶</a>
+</h2>
<p>Subversion usually has a Patch Manager, whose job is to watch the
dev@ mailing list and make sure that no patches "slip through the
@@ -979,11 +1042,17 @@
</div> <!-- roles -->
-<div class="h1" id="conventions" title="conventions">
-<h1>Coding and Commit Conventions</h1>
-
-<div class="h2" id="interface-visibility" title="interface-visibility">
-<h2>Code modularity and interface visibility</h2>
+<div class="h1" id="conventions">
+<h1>Coding and Commit Conventions
+ <a class="sectionlink" href="#conventions"
+ title="Link to this section">¶</a>
+</h1>
+
+<div class="h2" id="interface-visibility">
+<h2>Code modularity and interface visibility
+ <a class="sectionlink" href="#interface-visibility"
+ title="Link to this section">¶</a>
+</h2>
<p>Subversion's code and headers files are segregated along a couple
of key lines: library-specific vs. inter-library; public vs. private.
@@ -1024,8 +1093,11 @@
</div> <!-- interface-visibility -->
-<div class="h2" id="coding-style" title="coding-style">
-<h2>Coding style</h2>
+<div class="h2" id="coding-style">
+<h2>Coding style
+ <a class="sectionlink" href="#coding-style"
+ title="Link to this section">¶</a>
+</h2>
<p>Subversion uses ANSI C, and follows the GNU coding standards,
except that we do not put a space between the name of a function and
@@ -1069,8 +1141,11 @@
</div> <!-- coding-style -->
-<div class="h2" id="use-page-breaks" title="use-page-breaks">
-<h2>Using page breaks</h2>
+<div class="h2" id="use-page-breaks">
+<h2>Using page breaks
+ <a class="sectionlink" href="#use-page-breaks"
+ title="Link to this section">¶</a>
+</h2>
<p>We're using page breaks (the Ctrl-L character, ASCII 12) for
section boundaries in both code and plaintext prose files. Each
@@ -1085,8 +1160,11 @@
</div> <!-- use-page-breaks -->
-<div class="h2" id="error-messages" title="error-messages">
-<h2>Error message conventions</h2>
+<div class="h2" id="error-messages">
+<h2>Error message conventions
+ <a class="sectionlink" href="#error-messages"
+ title="Link to this section">¶</a>
+</h2>
<p>For error messages the following conventions apply:</p>
@@ -1150,8 +1228,11 @@
</div> <!-- error-messages -->
-<div class="h2" id="apr-pools" title="apr-pools">
-<h2>APR pool usage conventions</h2>
+<div class="h2" id="apr-pools">
+<h2>APR pool usage conventions
+ <a class="sectionlink" href="#apr-pools"
+ title="Link to this section">¶</a>
+</h2>
<p>(This assumes you already basically understand how APR pools work;
see apr_pools.h for details.)</p>
@@ -1332,8 +1413,11 @@
</div> <!-- apr-pools -->
-<div class="h2" id="apr-status-codes" title="apr-status-codes">
-<h2>APR status codes</h2>
+<div class="h2" id="apr-status-codes">
+<h2>APR status codes
+ <a class="sectionlink" href="#apr-status-codes"
+ title="Link to this section">¶</a>
+</h2>
<p>Always check for APR status codes (except APR_SUCCESS) with the
APR_STATUS_IS_...() macros, not by direct comparison. This is required
@@ -1342,8 +1426,11 @@
</div> <!-- apr-status-codes -->
-<div class="h2" id="exception-handling" title="exception-handling">
-<h2>Exception handling</h2>
+<div class="h2" id="exception-handling">
+<h2>Exception handling
+ <a class="sectionlink" href="#exception-handling"
+ title="Link to this section">¶</a>
+</h2>
<p>OK, here's how to use exceptions in Subversion.</p>
@@ -1510,8 +1597,11 @@
</div> <!-- exception-handling -->
-<div class="h2" id="secure-coding" title="secure-coding">
-<h2>Secure coding guidelines</h2>
+<div class="h2" id="secure-coding">
+<h2>Secure coding guidelines
+ <a class="sectionlink" href="#secure-coding"
+ title="Link to this section">¶</a>
+</h2>
<p>Just like almost any other programming language, C has undesirable
features which enables an attacker to make your program fail in
@@ -1563,9 +1653,11 @@
</div> <!-- secure-coding -->
-<div class="h2" id="destruction-of-stacked-resources"
- title="destruction-of-stacked-resources">
-<h2>Destruction of stacked resources</h2>
+<div class="h2" id="destruction-of-stacked-resources">
+<h2>Destruction of stacked resources
+ <a class="sectionlink" href="#destruction-of-stacked-resources"
+ title="Link to this section">¶</a>
+</h2>
<p>Some resources need destruction to ensure correct functioning of the
application. Such resources include files, especially since open
@@ -1625,8 +1717,11 @@
</div> <!-- destruction-of-stacked-resources -->
-<div class="h2" id="other-conventions" title="other-conventions">
-<h2>Other coding conventions</h2>
+<div class="h2" id="other-conventions">
+<h2>Other coding conventions
+ <a class="sectionlink" href="#other-conventions"
+ title="Link to this section">¶</a>
+</h2>
<p>In addition to the GNU standards, Subversion uses these
conventions:</p>
@@ -1776,8 +1871,11 @@
</div> <!-- other-conventions -->
-<div class="h2" id="log-messages" title="log-messages">
-<h2>Writing log messages</h2>
+<div class="h2" id="log-messages">
+<h2>Writing log messages
+ <a class="sectionlink" href="#log-messages"
+ title="Link to this section">¶</a>
+</h2>
<p>Every commit needs a log message. </p>
@@ -1979,8 +2077,11 @@
</div> <!-- log-messages -->
-<div class="h2" id="crediting" title="crediting">
-<h2>Crediting</h2>
+<div class="h2" id="crediting">
+<h2>Crediting
+ <a class="sectionlink" href="#crediting"
+ title="Link to this section">¶</a>
+</h2>
<p>It is very important to record code contributions in a consistent
and parseable way. This allows us to write scripts to figure out who
@@ -2139,11 +2240,17 @@
</div> <!-- conventions -->
-<div class="h1" id="building-and-testing" title="building-and-testing">
-<h1>Building and Testing</h1>
-
-<div class="h2" id="configury" title="configury">
-<h2>The configuration/build system under unix</h2>
+<div class="h1" id="building-and-testing">
+<h1>Building and Testing
+ <a class="sectionlink" href="#building-and-testing"
+ title="Link to this section">¶</a>
+</h1>
+
+<div class="h2" id="configury">
+<h2>The configuration/build system under unix
+ <a class="sectionlink" href="#configury"
+ title="Link to this section">¶</a>
+</h2>
<p>Greg Stein wrote a custom build system for Subversion, which had
been using `automake' and recursive Makefiles. Now it uses a single,
@@ -2358,8 +2465,11 @@
</div> <!-- configury -->
-<div class="h2" id="automated-tests" title="automated-tests">
-<h2>Automated tests</h2>
+<div class="h2" id="automated-tests">
+<h2>Automated tests
+ <a class="sectionlink" href="#automated-tests"
+ title="Link to this section">¶</a>
+</h2>
<p>For a description of how to use and add tests to Subversion's
automated test framework, please read <a
@@ -2382,8 +2492,11 @@
</div> <!-- automated-tests -->
-<div class="h2" id="build-farm" title="build-farm">
-<h2>Build farm</h2>
+<div class="h2" id="build-farm">
+<h2>Build farm
+ <a class="sectionlink" href="#build-farm"
+ title="Link to this section">¶</a>
+</h2>
<p>Lieven Govaerts has set up a
<a href="http://buildbot.sourceforge.net/" >BuildBot</a> build/test
@@ -2414,8 +2527,11 @@
</div> <!-- build-farm -->
-<div class="h2" id="write-test-cases-first" title="write-test-cases-first">
-<h2>Writing test cases before code</h2>
+<div class="h2" id="write-test-cases-first">
+<h2>Writing test cases before code
+ <a class="sectionlink" href="#write-test-cases-first"
+ title="Link to this section">¶</a>
+</h2>
<pre>
From: Karl Fogel <kfogel@collab.net>
@@ -2457,14 +2573,23 @@
</div> <!-- testing -->
-<div class="h1" id="debugging" title="debugging">
-<h1>Debugging Subversion</h1>
-
-<div class="h2" id="server-debugging" title="server-debugging">
-<h2>Debugging the server</h2>
-
-<div class="h3" id="debugging-ra-dav" title="debugging-ra-dav">
-<h3>Debugging the DAV server</h3>
+<div class="h1" id="debugging">
+<h1>Debugging Subversion
+ <a class="sectionlink" href="#debugging"
+ title="Link to this section">¶</a>
+</h1>
+
+<div class="h2" id="server-debugging">
+<h2>Debugging the server
+ <a class="sectionlink" href="#server-debugging"
+ title="Link to this section">¶</a>
+</h2>
+
+<div class="h3" id="debugging-ra-dav">
+<h3>Debugging the DAV server
+ <a class="sectionlink" href="#debugging-ra-dav"
+ title="Link to this section">¶</a>
+</h3>
<p>'mod_dav_svn.so' contains the main Subversion server logic; it runs
as a module within mod_dav, which runs as a module within httpd.
@@ -2498,8 +2623,11 @@
</div> <!-- debugging-ra-dav -->
-<div class="h3" id="debugging-ra-svn" title="debugging-ra-svn">
-<h3>Debugging the ra_svn client and server, on Unix</h3>
+<div class="h3" id="debugging-ra-svn">
+<h3>Debugging the ra_svn client and server, on Unix
+ <a class="sectionlink" href="#debugging-ra-svn"
+ title="Link to this section">¶</a>
+</h3>
<p>Bugs in ra_svn usually manifest themselves with one of the
following cryptic error messages:</p>
@@ -2580,8 +2708,11 @@
</div> <!-- server-debugging -->
-<div class="h2" id="net-trace" title="net-trace">
-<h2>Tracing network traffic</h2>
+<div class="h2" id="net-trace">
+<h2>Tracing network traffic
+ <a class="sectionlink" href="#net-trace"
+ title="Link to this section">¶</a>
+</h2>
<p>Use <a href="http://www.wireshark.org/">Wireshark</a> (formerly
known as "Ethereal") to eavesdrop on the conversation.</p>
@@ -2660,8 +2791,11 @@
</div> <!-- net-trace -->
-<div class="h2" id="tracing-memory-leaks" title="tracing-memory-leaks">
-<h2>Tracking down memory leaks</h2>
+<div class="h2" id="tracing-memory-leaks">
+<h2>Tracking down memory leaks
+ <a class="sectionlink" href="#tracing-memory-leaks"
+ title="Link to this section">¶</a>
+</h2>
<p>Our use of APR pools makes it unusual for us to have memory leaks
in the strictest sense; all the memory we allocate will be cleaned up
@@ -2714,8 +2848,11 @@
</div> <!-- debugging -->
-<div class="h1" id="mailing-lists" title="mailing-lists">
-<h1>Mailing Lists</h1>
+<div class="h1" id="mailing-lists">
+<h1>Mailing Lists
+ <a class="sectionlink" href="#mailing-lists"
+ title="Link to this section">¶</a>
+</h1>
<p>The advice below is based on years of experience with the
Subversion mailing lists, and addresses the problems seen most
@@ -2727,8 +2864,11 @@
<p>If you follow these conventions when posting to our mailing lists,
your post is much more likely to be read and answered.</p>
-<div class="h2" id="where-to-post" title="where-to-post">
-<h2>Where to post</h2>
+<div class="h2" id="where-to-post">
+<h2>Where to post
+ <a class="sectionlink" href="#where-to-post"
+ title="Link to this section">¶</a>
+</h2>
<p>When in doubt, mail <a href="mailto:users@subversion.apache.org"
>users@subversion.apache.org</a>, not dev@subversion.apache.org.
@@ -2756,8 +2896,11 @@
</div> <!-- where-to-post -->
-<div class="h2" id="when-to-post" title="when-to-post">
-<h2>When to post</h2>
+<div class="h2" id="when-to-post">
+<h2>When to post
+ <a class="sectionlink" href="#when-to-post"
+ title="Link to this section">¶</a>
+</h2>
<p>Sometimes, when really impassioned about a topic, it's tempting to
respond to every message in a mail thread. Please don't do this. Our
@@ -2773,11 +2916,17 @@
</div> <!-- when-to-post -->
-<div class="h2" id="formatting" title="formatting">
-<h2>Formatting</h2>
-
-<div class="h3" id="line-length" title="line-length">
-<h3>Line Length</h3>
+<div class="h2" id="formatting">
+<h2>Formatting
+ <a class="sectionlink" href="#formatting"
+ title="Link to this section">¶</a>
+</h2>
+
+<div class="h3" id="line-length">
+<h3>Line Length
+ <a class="sectionlink" href="#line-length"
+ title="Link to this section">¶</a>
+</h3>
<p>Please don't use lines longer than 72 columns. Many people use
80-column terminals to read their email. By writing your text in 72
@@ -2795,8 +2944,11 @@
</div> <!-- line-length -->
-<div class="h3" id="capitalization" title="capitalization">
-<h3>Capitalization</h3>
+<div class="h3" id="capitalization">
+<h3>Capitalization
+ <a class="sectionlink" href="#capitalization"
+ title="Link to this section">¶</a>
+</h3>
<p>Capitalize the first letter of each sentence, and use paragraphs.
If you're showing screen output or some other sort of example, offset
@@ -2809,11 +2961,17 @@
</div> <!-- formatting -->
-<div class="h2" id="replying" title="replying">
-<h2>Replying</h2>
-
-<div class="h3" id="reply-to" title="reply-to">
-<h3>Reply-To</h3>
+<div class="h2" id="replying">
+<h2>Replying
+ <a class="sectionlink" href="#replying"
+ title="Link to this section">¶</a>
+</h2>
+
+<div class="h3" id="reply-to">
+<h3>Reply-To
+ <a class="sectionlink" href="#reply-to"
+ title="Link to this section">¶</a>
+</h3>
<p>Make sure to use your mailreader's "Follow-up" or "Reply-to-all" or
"Group reply" feature when responding to a list post. Otherwise, your
@@ -2843,8 +3001,11 @@
</div> <!-- reply-to -->
-<div class="h3" id="fresh-post" title="fresh-post">
-<h3>Making a fresh post</h3>
+<div class="h3" id="fresh-post">
+<h3>Making a fresh post
+ <a class="sectionlink" href="#fresh-post"
+ title="Link to this section">¶</a>
+</h3>
<p>Don't start a new thread (subject) by replying to an existing
post. Instead, start a fresh mail, even if that means you have to
@@ -2867,8 +3028,11 @@
</div> <!-- fresh-post -->
-<div class="h3" id="rethreading" title="rethreading">
-<h3>Re-threading</h3>
+<div class="h3" id="rethreading">
+<h3>Re-threading
+ <a class="sectionlink" href="#rethreading"
+ title="Link to this section">¶</a>
+</h3>
<p>If you do need to change the <tt>Subject</tt> header while
preserving the thread (perhaps because the thread has wandered into
@@ -2887,8 +3051,11 @@
</div> <!-- rethreading -->
-<div class="h3" id="top-posting" title="top-posting">
-<h3>Top-Posting</h3>
+<div class="h3" id="top-posting">
+<h3>Top-Posting
+ <a class="sectionlink" href="#top-posting"
+ title="Link to this section">¶</a>
+</h3>
<p>Please don't reflexively chide people for top-posting.
"Top-posting" is the practice of putting the response text above the
@@ -2915,8 +3082,11 @@
</div> <!-- replying -->
-<div class="h2" id="sending-patches" title="sending-patches">
-<h2>Sending patches</h2>
+<div class="h2" id="sending-patches">
+<h2>Sending patches
+ <a class="sectionlink" href="#sending-patches"
+ title="Link to this section">¶</a>
+</h2>
<p>See <a href="#patches">here</a> for advice on how to send in a
patch. Note that you can send in a patch to modify these web pages as
@@ -2927,8 +3097,11 @@
</div> <!-- sending-patches -->
-<div class="h2" id="encodings" title="encodings">
-<h2>Languages and encodings</h2>
+<div class="h2" id="encodings">
+<h2>Languages and encodings
+ <a class="sectionlink" href="#encodings"
+ title="Link to this section">¶</a>
+</h2>
<p>Please use ASCII or ISO-8859 text if possible. Don't post HTML
mails, RichText mails, or other formats that might be opaque to
@@ -2953,8 +3126,11 @@
</div> <!-- mailing-lists -->
-<div class="h1" id="issues" title="issues">
-<h1>Bugs / Issues</h1>
+<div class="h1" id="issues">
+<h1>Bugs / Issues
+ <a class="sectionlink" href="#issues"
+ title="Link to this section">¶</a>
+</h1>
<p>Subversion isn't perfect software. It contains bugs, lacks
features, and has room for improvement like any other piece of
@@ -3015,8 +3191,11 @@
<p>The following are the policies that we ask folks to abide by when
reporting problems or requested enhancements to Subversion.</p>
-<div class="h2" id="reporting-bugs" title="reporting-bugs">
-<h2>How to report a bug</h2>
+<div class="h2" id="reporting-bugs">
+<h2>How to report a bug
+ <a class="sectionlink" href="#reporting-bugs"
+ title="Link to this section">¶</a>
+</h2>
<p>First, make sure it's a bug. If Subversion does not behave the way
you expect, look in the documentation and mailing list archives for
@@ -3095,8 +3274,11 @@
</div> <!-- reporting-bugs -->
-<div class="h2" id="bugs-where" title="bugs-where">
-<h2>Where to report a bug</h2>
+<div class="h2" id="bugs-where">
+<h2>Where to report a bug
+ <a class="sectionlink" href="#bugs-where"
+ title="Link to this section">¶</a>
+</h2>
<ul>
@@ -3142,8 +3324,11 @@
</div> <!-- bugs-where -->
-<div class="h2" id="issue-triage" title="issue-triage">
-<h2>Issue triage</h2>
+<div class="h2" id="issue-triage">
+<h2>Issue triage
+ <a class="sectionlink" href="#issue-triage"
+ title="Link to this section">¶</a>
+</h2>
<p>When an issue is filed, it goes into the special milestone "---",
meaning <em>unmilestoned</em>. This is a holding area that issues
@@ -3207,11 +3392,17 @@
</div> <!-- issues -->
-<div class="h1" id="releasing" title="releasing">
-<h1>Making Subversion Releases</h1>
-
-<div class="h2" id="release-numbering" title="release-numbering">
-<h2>Release numbering, compatibility, and deprecation</h2>
+<div class="h1" id="releasing">
+<h1>Making Subversion Releases
+ <a class="sectionlink" href="#releasing"
+ title="Link to this section">¶</a>
+</h1>
+
+<div class="h2" id="release-numbering">
+<h2>Release numbering, compatibility, and deprecation
+ <a class="sectionlink" href="#release-numbering"
+ title="Link to this section">¶</a>
+</h2>
<p>Subversion uses "MAJOR.MINOR.PATCH" release numbers, with the same
guidelines as APR (see <a href="http://apr.apache.org/versioning.html"
@@ -3371,8 +3562,11 @@
code to get wider distribution than just those who build from working
copies, we put out a prerelease.</p>
-<div class="h3" id="name-reuse" title="name-reuse">
-<h3>Reuse of release names</h3>
+<div class="h3" id="name-reuse">
+<h3>Reuse of release names
+ <a class="sectionlink" href="#name-reuse"
+ title="Link to this section">¶</a>
+</h3>
<p>If a release or candidate release needs to be quickly re-issued due
to some non-code problem (say, a packaging glitch), it's okay to reuse
@@ -3384,8 +3578,11 @@
</div> <!-- name-reuse -->
-<div class="h3" id="deprecation" title="deprecation">
-<h3>Deprecation</h3>
+<div class="h3" id="deprecation">
+<h3>Deprecation
+ <a class="sectionlink" href="#deprecation"
+ title="Link to this section">¶</a>
+</h3>
<p>When a new, improved version of an API is introduced, the old one
remains for compatibility, at least until the next major release.
@@ -3437,8 +3634,11 @@
</div> <!-- release-numbering -->
-<div class="h2" id="release-stabilization" title="release-stabilization">
-<h2>Stabilizing and maintaining releases</h2>
+<div class="h2" id="release-stabilization">
+<h2>Stabilizing and maintaining releases
+ <a class="sectionlink" href="#release-stabilization"
+ title="Link to this section">¶</a>
+</h2>
<p>Minor and major number releases go through a stabilization period
before release, and remain in maintenance (bugfix) mode after release.
@@ -3667,8 +3867,11 @@
<p>NOTE: Changes to STATUS regarding the temporary branch, including
voting, are always kept on the main release branch.</p>
-<div class="h3" id="alphas-betas" title="alphas-betas">
-<h2>Alpha and beta releases</h2>
+<div class="h3" id="alphas-betas">
+<h2>Alpha and beta releases
+ <a class="sectionlink" href="#alphas-betas"
+ title="Link to this section">¶</a>
+</h2>
<p>When we want new features to get wide testing before we enter the
formal stabilization period described above, we'll sometimes release
@@ -3702,8 +3905,11 @@
</div> <!-- release-stabilization -->
-<div class="h2" id="tarball-signing" title="tarball-signing">
-<h2>Signing source distribution packages (a.k.a tarballs)</h2>
+<div class="h2" id="tarball-signing">
+<h2>Signing source distribution packages (a.k.a tarballs)
+ <a class="sectionlink" href="#tarball-signing"
+ title="Link to this section">¶</a>
+</h2>
<p>Before a release or release candidate is officially made public, it is
made available in a temporary location for committers to test and sign.
@@ -3754,8 +3960,11 @@
</div> <!-- tarball-signing -->
-<div class="h2" id="custom-releases" title="custom-releases">
-<h2>Custom releases</h2>
+<div class="h2" id="custom-releases">
+<h2>Custom releases
+ <a class="sectionlink" href="#custom-releases"
+ title="Link to this section">¶</a>
+</h2>
<p>It is preferred to use the patch process and have your changes
accepted and applied to trunk to be released on the normal Subversion
@@ -3786,8 +3995,11 @@
</div> <!-- custom-releases -->
-<div class="h2" id="release-branches" title="release-branches">
-<h2>Creating and maintaining release branches</h2>
+<div class="h2" id="release-branches">
+<h2>Creating and maintaining release branches
+ <a class="sectionlink" href="#release-branches"
+ title="Link to this section">¶</a>
+</h2>
<p>A new release branch is created for each new major and minor
release. So, for example, a new release branch is created when
@@ -3849,8 +4061,11 @@
</div> <!-- release-branches -->
-<div class="h2" id="porting-changes" title="porting-changes">
-<h2>Porting changes to release branches</h2>
+<div class="h2" id="porting-changes">
+<h2>Porting changes to release branches
+ <a class="sectionlink" href="#porting-changes"
+ title="Link to this section">¶</a>
+</h2>
<p>Once a release branch has been created, no development <i>ever</i>
takes place there. The only changes permitted are ones made to
@@ -3865,8 +4080,11 @@
</div> <!-- porting-changes -->
-<div class="h2" id="the-changes-file" title="the-changes-file">
-<h2>Managing the CHANGES file</h2>
+<div class="h2" id="the-changes-file">
+<h2>Managing the CHANGES file
+ <a class="sectionlink" href="#the-changes-file"
+ title="Link to this section">¶</a>
+</h2>
<p>The <tt>CHANGES</tt> file is the project changelog file. Before a
release, it must be brought up to date to list all changes since the
@@ -3895,8 +4113,11 @@
<i>If it takes more than one line to describe, maybe I'm getting too
detailed?</i></p>
-<div class="h3" id="writing-initial-changes" title="writing-initial-changes">
-<h3>Writing the initial content for a branch</h3>
+<div class="h3" id="writing-initial-changes">
+<h3>Writing the initial content for a branch
+ <a class="sectionlink" href="#writing-initial-changes"
+ title="Link to this section">¶</a>
+</h3>
<p>Run <code>svn log -rHEAD:BRANCH_POINT
http://svn.apache.org/repos/asf/subversion/branches/A.B.x</code>,where
@@ -3920,7 +4141,10 @@
</div> <!-- writing-initial-changes -->
<div class="h3" id="adding-changes">
-<h3>Adding content for patch release</h3>
+<h3>Adding content for patch release
+ <a class="sectionlink" href="#adding-changes"
+ title="Link to this section">¶</a>
+</h3>
<p>As part of <a href="#release-stabilization">release
stabilization</a>, <tt>CHANGES</tt> should be updated as bug fixes are
@@ -3935,8 +4159,11 @@
</div> <!-- the-changes-file -->
-<div class="h2" id="before-release" title="before-release">
-<h2>Preparing to roll a release</h2>
+<div class="h2" id="before-release">
+<h2>Preparing to roll a release
+ <a class="sectionlink" href="#before-release"
+ title="Link to this section">¶</a>
+</h2>
<p>So, a release branch has stabilized, and you are gearing up to roll
the release. Before you can actually roll the archives, you need to
@@ -4007,8 +4234,11 @@
</div> <!-- before-release -->
-<div class="h2" id="rolling-release" title="rolling-release">
-<h2>Rolling a release</h2>
+<div class="h2" id="rolling-release">
+<h2>Rolling a release
+ <a class="sectionlink" href="#rolling-release"
+ title="Link to this section">¶</a>
+</h2>
<p>Before rolling, first make sure that the latest version of the
<tt>CHANGES</tt> file from trunk is merged into the release branch, and that
@@ -4147,8 +4377,11 @@
</div> <!-- rolling-release -->
-<div class="h2" id="releasing-release" title="releasing-release">
-<h2>The actual releasing</h2>
+<div class="h2" id="releasing-release">
+<h2>The actual releasing
+ <a class="sectionlink" href="#releasing-release"
+ title="Link to this section">¶</a>
+</h2>
<p><b>Upload the tarballs to
http://subversion.tigris.org/downloads/.</b></p>
@@ -4235,8 +4468,11 @@
</div> <!-- releasing-release -->
-<div class="h2" id="afterwards" title="afterwards">
-<h2>After a release has been made</h2>
+<div class="h2" id="afterwards">
+<h2>After a release has been made
+ <a class="sectionlink" href="#afterwards"
+ title="Link to this section">¶</a>
+</h2>
<p>When someone with administrative access to <tt>svn.collab.net</tt>
has time available, they will upgrade it to the latest release or
@@ -4246,8 +4482,11 @@
</div> <!-- afterwards -->
-<div class="h3" id="releasing-not" title="releasing-not">
-<h3>How <em>not</em> to make a Subversion release</h3>
+<div class="h3" id="releasing-not">
+<h3>How <em>not</em> to make a Subversion release
+ <a class="sectionlink" href="#releasing-not"
+ title="Link to this section">¶</a>
+</h3>
<p>For an enlightening case study of the bungled Subversion 1.5 release
cycle, see <a href="http://www.hyrumwright.org/papers/floss2009.pdf">this
@@ -4258,8 +4497,11 @@
</div> <!-- releasing -->
-<div class="h1" id="l10n" title="l10n">
-<h1>Localization (l10n)</h1>
+<div class="h1" id="l10n">
+<h1>Localization (l10n)
+ <a class="sectionlink" href="#l10n"
+ title="Link to this section">¶</a>
+</h1>
<p>Translation has been divided into two domains. First, there is the
translation of server messages sent to connecting clients. This issue
@@ -4269,8 +4511,11 @@
libraries.</p>
-<div class="h2" id="l10n-overview" title="l10n-overview">
-<h2>Localization overview</h2>
+<div class="h2" id="l10n-overview">
+<h2>Localization overview
+ <a class="sectionlink" href="#l10n-overview"
+ title="Link to this section">¶</a>
+</h2>
<p>The gettext package provides services for translating messages. It
uses the xgettext tool to extract strings from the sources for
@@ -4330,8 +4575,11 @@
</div> <!-- l10n-overview -->
-<div class="h2" id="version-requirements" title="version-requirements">
-<h2>Software version requirements</h2>
+<div class="h2" id="version-requirements">
+<h2>Software version requirements
+ <a class="sectionlink" href="#version-requirements"
+ title="Link to this section">¶</a>
+</h2>
<p>The Makefile build targets locale-gnu-* (used to maintain po files)
require GNU gettext 0.13 or newer. Note that this is not a requirement
@@ -4340,8 +4588,11 @@
</div> <!-- version-requirements -->
-<div class="h2" id="new-translation" title="new-translation">
-<h2>Starting a new translation</h2>
+<div class="h2" id="new-translation">
+<h2>Starting a new translation
+ <a class="sectionlink" href="#new-translation"
+ title="Link to this section">¶</a>
+</h2>
<p>Before starting a new translation please contact the subversion
development mailing list to make sure you are not duplicating efforts. Also
@@ -4351,8 +4602,11 @@
<p>After that, you should perform the following steps:</p>
-<div class="h3" id="unix-gnu-gettext" title="unix-gnu-gettext">
-<h3>Unix (GNU gettext)</h3>
+<div class="h3" id="unix-gnu-gettext">
+<h3>Unix (GNU gettext)
+ <a class="sectionlink" href="#unix-gnu-gettext"
+ title="Link to this section">¶</a>
+</h3>
<ol>
<li>check out Subversion (see INSTALL for more information)</li>
@@ -4417,15 +4671,21 @@
</div> <!-- unix-gnu-gettext -->
-<div class="h3" id="unix-nongnu-gettext" title="unix-nongnu-gettext">
-<h3>Unix (non-GNU gettext)</h3>
+<div class="h3" id="unix-nongnu-gettext">
+<h3>Unix (non-GNU gettext)
+ <a class="sectionlink" href="#unix-nongnu-gettext"
+ title="Link to this section">¶</a>
+</h3>
<p>To be documented</p>
</div> <!-- unix-nongnu-gettext -->
-<div class="h3" id="windows" title="windows">
-<h3>Windows</h3>
+<div class="h3" id="windows">
+<h3>Windows
+ <a class="sectionlink" href="#windows"
+ title="Link to this section">¶</a>
+</h3>
<p>See <a href="http://subversion.tigris.org/issues/show_bug.cgi?id=1977"
>issue #1977</a>.</p>
@@ -4435,8 +4695,11 @@
</div> <!-- new-translation -->
-<div class="h2" id="verifying" title="verifying">
-<h2>Verifying your po file</h2>
+<div class="h2" id="verifying">
+<h2>Verifying your po file
+ <a class="sectionlink" href="#verifying"
+ title="Link to this section">¶</a>
+</h2>
<p>Before submitting to the mailing list or committing to the repository,
please make sure your po file 'compiles'. You can do this with these
@@ -4455,8 +4718,11 @@
</div> <!-- verifying -->
-<div class="h2" id="submitting" title="submitting">
-<h2>Submitting your po file</h2>
+<div class="h2" id="submitting">
+<h2>Submitting your po file
+ <a class="sectionlink" href="#submitting"
+ title="Link to this section">¶</a>
+</h2>
<p>Please don't mail large po files to the mailing lists. There are many
subscribers on dev@subversion.apache.org who are on slow links and do
@@ -4472,8 +4738,11 @@
</div> <!-- submitting -->
-<div class="h2" id="updating" title="updating">
-<h2>Updating existing po files</h2>
+<div class="h2" id="updating">
+<h2>Updating existing po files
+ <a class="sectionlink" href="#updating"
+ title="Link to this section">¶</a>
+</h2>
<p>The Makefile based part of the build system contains a make target to
facilitate maintenance of existing po files. To update po files on
@@ -4509,8 +4778,11 @@
</div> <!-- updating -->
-<div class="h2" id="branch-maintenance" title="branch-maintenance">
-<h2>Maintenance on branches</h2>
+<div class="h2" id="branch-maintenance">
+<h2>Maintenance on branches
+ <a class="sectionlink" href="#branch-maintenance"
+ title="Link to this section">¶</a>
+</h2>
<p>Editing po files in trunk is pretty straightforward, but gets a bit more
complicated when those changes are going to be transferred to a release
@@ -4550,8 +4822,11 @@
</div> <!-- branch-maintenance -->
-<div class="h2" id="po-mo-requirements" title="po-mo-requirements">
-<h2>Requirements for po and mo files</h2>
+<div class="h2" id="po-mo-requirements">
+<h2>Requirements for po and mo files
+ <a class="sectionlink" href="#po-mo-requirements"
+ title="Link to this section">¶</a>
+</h2>
<p>On some gettext implementations we have to ensure that the mo
files — whether obtained through the project or created
@@ -4573,8 +4848,11 @@
</div> <!-- po-mo-requirements -->
-<div class="h2" id="empty-string-conventions" title="empty-string-conventions">
-<h2>Conventions for the empty string msgid section</h2>
+<div class="h2" id="empty-string-conventions">
+<h2>Conventions for the empty string msgid section
+ <a class="sectionlink" href="#empty-string-conventions"
+ title="Link to this section">¶</a>
+</h2>
<p>Some gettext implementations use a section with a msgid "" (empty
string) to keep administrative data. One of the headers suggested is
@@ -4590,8 +4868,11 @@
</div> <!-- empty-string-conventions -->
-<div class="h2" id="translation-teams" title="translation-teams">
-<h2>Translation teams</h2>
+<div class="h2" id="translation-teams">
+<h2>Translation teams
+ <a class="sectionlink" href="#translation-teams"
+ title="Link to this section">¶</a>
+</h2>
<p>The GNU translation project
(http://www2.iro.umontreal.ca/~gnutra/po/HTML/) attempts to organise
@@ -4601,8 +4882,11 @@
</div> <!-- translation-teams -->
-<div class="h2" id="quotes" title="quotes">
-<h2>Single versus double quotes</h2>
+<div class="h2" id="quotes">
+<h2>Single versus double quotes
+ <a class="sectionlink" href="#quotes"
+ title="Link to this section">¶</a>
+</h2>
<p>The project has standardised the use of quotes. Some translation
teams have done the same. If there is no translation team for your
@@ -4612,8 +4896,11 @@
</div> <!-- quotes -->
-<div class="h2" id="translating-error-messages" title="translating-error-messages">
-<h2>Error message conventions</h2>
+<div class="h2" id="translating-error-messages">
+<h2>Error message conventions
+ <a class="sectionlink" href="#translating-error-messages"
+ title="Link to this section">¶</a>
+</h2>
<p>Since translators will generally see all error messages in the code,
it's important to know that there is a <a href="#error-messages">
Modified: subversion/site/publish/docs/community-guide/issues.part.html
URL: http://svn.apache.org/viewvc/subversion/site/publish/docs/community-guide/issues.part.html?rev=909145&r1=909144&r2=909145&view=diff
==============================================================================
--- subversion/site/publish/docs/community-guide/issues.part.html (original)
+++ subversion/site/publish/docs/community-guide/issues.part.html Thu Feb 11 21:04:38 2010
@@ -1,5 +1,8 @@
-<div class="h1" id="issues" title="issues">
-<h1>Bugs / Issues</h1>
+<div class="h1" id="issues">
+<h1>Bugs / Issues
+ <a class="sectionlink" href="#issues"
+ title="Link to this section">¶</a>
+</h1>
<p>Subversion isn't perfect software. It contains bugs, lacks
features, and has room for improvement like any other piece of
@@ -60,8 +63,11 @@
<p>The following are the policies that we ask folks to abide by when
reporting problems or requested enhancements to Subversion.</p>
-<div class="h2" id="reporting-bugs" title="reporting-bugs">
-<h2>How to report a bug</h2>
+<div class="h2" id="reporting-bugs">
+<h2>How to report a bug
+ <a class="sectionlink" href="#reporting-bugs"
+ title="Link to this section">¶</a>
+</h2>
<p>First, make sure it's a bug. If Subversion does not behave the way
you expect, look in the documentation and mailing list archives for
@@ -140,8 +146,11 @@
</div> <!-- reporting-bugs -->
-<div class="h2" id="bugs-where" title="bugs-where">
-<h2>Where to report a bug</h2>
+<div class="h2" id="bugs-where">
+<h2>Where to report a bug
+ <a class="sectionlink" href="#bugs-where"
+ title="Link to this section">¶</a>
+</h2>
<ul>
@@ -187,8 +196,11 @@
</div> <!-- bugs-where -->
-<div class="h2" id="issue-triage" title="issue-triage">
-<h2>Issue triage</h2>
+<div class="h2" id="issue-triage">
+<h2>Issue triage
+ <a class="sectionlink" href="#issue-triage"
+ title="Link to this section">¶</a>
+</h2>
<p>When an issue is filed, it goes into the special milestone "---",
meaning <em>unmilestoned</em>. This is a holding area that issues
Modified: subversion/site/publish/docs/community-guide/l10n.part.html
URL: http://svn.apache.org/viewvc/subversion/site/publish/docs/community-guide/l10n.part.html?rev=909145&r1=909144&r2=909145&view=diff
==============================================================================
--- subversion/site/publish/docs/community-guide/l10n.part.html (original)
+++ subversion/site/publish/docs/community-guide/l10n.part.html Thu Feb 11 21:04:38 2010
@@ -1,5 +1,8 @@
-<div class="h1" id="l10n" title="l10n">
-<h1>Localization (l10n)</h1>
+<div class="h1" id="l10n">
+<h1>Localization (l10n)
+ <a class="sectionlink" href="#l10n"
+ title="Link to this section">¶</a>
+</h1>
<p>Translation has been divided into two domains. First, there is the
translation of server messages sent to connecting clients. This issue
@@ -9,8 +12,11 @@
libraries.</p>
-<div class="h2" id="l10n-overview" title="l10n-overview">
-<h2>Localization overview</h2>
+<div class="h2" id="l10n-overview">
+<h2>Localization overview
+ <a class="sectionlink" href="#l10n-overview"
+ title="Link to this section">¶</a>
+</h2>
<p>The gettext package provides services for translating messages. It
uses the xgettext tool to extract strings from the sources for
@@ -70,8 +76,11 @@
</div> <!-- l10n-overview -->
-<div class="h2" id="version-requirements" title="version-requirements">
-<h2>Software version requirements</h2>
+<div class="h2" id="version-requirements">
+<h2>Software version requirements
+ <a class="sectionlink" href="#version-requirements"
+ title="Link to this section">¶</a>
+</h2>
<p>The Makefile build targets locale-gnu-* (used to maintain po files)
require GNU gettext 0.13 or newer. Note that this is not a requirement
@@ -80,8 +89,11 @@
</div> <!-- version-requirements -->
-<div class="h2" id="new-translation" title="new-translation">
-<h2>Starting a new translation</h2>
+<div class="h2" id="new-translation">
+<h2>Starting a new translation
+ <a class="sectionlink" href="#new-translation"
+ title="Link to this section">¶</a>
+</h2>
<p>Before starting a new translation please contact the subversion
development mailing list to make sure you are not duplicating efforts. Also
@@ -91,8 +103,11 @@
<p>After that, you should perform the following steps:</p>
-<div class="h3" id="unix-gnu-gettext" title="unix-gnu-gettext">
-<h3>Unix (GNU gettext)</h3>
+<div class="h3" id="unix-gnu-gettext">
+<h3>Unix (GNU gettext)
+ <a class="sectionlink" href="#unix-gnu-gettext"
+ title="Link to this section">¶</a>
+</h3>
<ol>
<li>check out Subversion (see INSTALL for more information)</li>
@@ -157,15 +172,21 @@
</div> <!-- unix-gnu-gettext -->
-<div class="h3" id="unix-nongnu-gettext" title="unix-nongnu-gettext">
-<h3>Unix (non-GNU gettext)</h3>
+<div class="h3" id="unix-nongnu-gettext">
+<h3>Unix (non-GNU gettext)
+ <a class="sectionlink" href="#unix-nongnu-gettext"
+ title="Link to this section">¶</a>
+</h3>
<p>To be documented</p>
</div> <!-- unix-nongnu-gettext -->
-<div class="h3" id="windows" title="windows">
-<h3>Windows</h3>
+<div class="h3" id="windows">
+<h3>Windows
+ <a class="sectionlink" href="#windows"
+ title="Link to this section">¶</a>
+</h3>
<p>See <a href="http://subversion.tigris.org/issues/show_bug.cgi?id=1977"
>issue #1977</a>.</p>
@@ -175,8 +196,11 @@
</div> <!-- new-translation -->
-<div class="h2" id="verifying" title="verifying">
-<h2>Verifying your po file</h2>
+<div class="h2" id="verifying">
+<h2>Verifying your po file
+ <a class="sectionlink" href="#verifying"
+ title="Link to this section">¶</a>
+</h2>
<p>Before submitting to the mailing list or committing to the repository,
please make sure your po file 'compiles'. You can do this with these
@@ -195,8 +219,11 @@
</div> <!-- verifying -->
-<div class="h2" id="submitting" title="submitting">
-<h2>Submitting your po file</h2>
+<div class="h2" id="submitting">
+<h2>Submitting your po file
+ <a class="sectionlink" href="#submitting"
+ title="Link to this section">¶</a>
+</h2>
<p>Please don't mail large po files to the mailing lists. There are many
subscribers on dev@subversion.apache.org who are on slow links and do
@@ -212,8 +239,11 @@
</div> <!-- submitting -->
-<div class="h2" id="updating" title="updating">
-<h2>Updating existing po files</h2>
+<div class="h2" id="updating">
+<h2>Updating existing po files
+ <a class="sectionlink" href="#updating"
+ title="Link to this section">¶</a>
+</h2>
<p>The Makefile based part of the build system contains a make target to
facilitate maintenance of existing po files. To update po files on
@@ -249,8 +279,11 @@
</div> <!-- updating -->
-<div class="h2" id="branch-maintenance" title="branch-maintenance">
-<h2>Maintenance on branches</h2>
+<div class="h2" id="branch-maintenance">
+<h2>Maintenance on branches
+ <a class="sectionlink" href="#branch-maintenance"
+ title="Link to this section">¶</a>
+</h2>
<p>Editing po files in trunk is pretty straightforward, but gets a bit more
complicated when those changes are going to be transferred to a release
@@ -290,8 +323,11 @@
</div> <!-- branch-maintenance -->
-<div class="h2" id="po-mo-requirements" title="po-mo-requirements">
-<h2>Requirements for po and mo files</h2>
+<div class="h2" id="po-mo-requirements">
+<h2>Requirements for po and mo files
+ <a class="sectionlink" href="#po-mo-requirements"
+ title="Link to this section">¶</a>
+</h2>
<p>On some gettext implementations we have to ensure that the mo
files — whether obtained through the project or created
@@ -313,8 +349,11 @@
</div> <!-- po-mo-requirements -->
-<div class="h2" id="empty-string-conventions" title="empty-string-conventions">
-<h2>Conventions for the empty string msgid section</h2>
+<div class="h2" id="empty-string-conventions">
+<h2>Conventions for the empty string msgid section
+ <a class="sectionlink" href="#empty-string-conventions"
+ title="Link to this section">¶</a>
+</h2>
<p>Some gettext implementations use a section with a msgid "" (empty
string) to keep administrative data. One of the headers suggested is
@@ -330,8 +369,11 @@
</div> <!-- empty-string-conventions -->
-<div class="h2" id="translation-teams" title="translation-teams">
-<h2>Translation teams</h2>
+<div class="h2" id="translation-teams">
+<h2>Translation teams
+ <a class="sectionlink" href="#translation-teams"
+ title="Link to this section">¶</a>
+</h2>
<p>The GNU translation project
(http://www2.iro.umontreal.ca/~gnutra/po/HTML/) attempts to organise
@@ -341,8 +383,11 @@
</div> <!-- translation-teams -->
-<div class="h2" id="quotes" title="quotes">
-<h2>Single versus double quotes</h2>
+<div class="h2" id="quotes">
+<h2>Single versus double quotes
+ <a class="sectionlink" href="#quotes"
+ title="Link to this section">¶</a>
+</h2>
<p>The project has standardised the use of quotes. Some translation
teams have done the same. If there is no translation team for your
@@ -352,8 +397,11 @@
</div> <!-- quotes -->
-<div class="h2" id="translating-error-messages" title="translating-error-messages">
-<h2>Error message conventions</h2>
+<div class="h2" id="translating-error-messages">
+<h2>Error message conventions
+ <a class="sectionlink" href="#translating-error-messages"
+ title="Link to this section">¶</a>
+</h2>
<p>Since translators will generally see all error messages in the code,
it's important to know that there is a <a href="#error-messages">
Modified: subversion/site/publish/docs/community-guide/mailing-lists.part.html
URL: http://svn.apache.org/viewvc/subversion/site/publish/docs/community-guide/mailing-lists.part.html?rev=909145&r1=909144&r2=909145&view=diff
==============================================================================
--- subversion/site/publish/docs/community-guide/mailing-lists.part.html (original)
+++ subversion/site/publish/docs/community-guide/mailing-lists.part.html Thu Feb 11 21:04:38 2010
@@ -1,5 +1,8 @@
-<div class="h1" id="mailing-lists" title="mailing-lists">
-<h1>Mailing Lists</h1>
+<div class="h1" id="mailing-lists">
+<h1>Mailing Lists
+ <a class="sectionlink" href="#mailing-lists"
+ title="Link to this section">¶</a>
+</h1>
<p>The advice below is based on years of experience with the
Subversion mailing lists, and addresses the problems seen most
@@ -11,8 +14,11 @@
<p>If you follow these conventions when posting to our mailing lists,
your post is much more likely to be read and answered.</p>
-<div class="h2" id="where-to-post" title="where-to-post">
-<h2>Where to post</h2>
+<div class="h2" id="where-to-post">
+<h2>Where to post
+ <a class="sectionlink" href="#where-to-post"
+ title="Link to this section">¶</a>
+</h2>
<p>When in doubt, mail <a href="mailto:users@subversion.apache.org"
>users@subversion.apache.org</a>, not dev@subversion.apache.org.
@@ -40,8 +46,11 @@
</div> <!-- where-to-post -->
-<div class="h2" id="when-to-post" title="when-to-post">
-<h2>When to post</h2>
+<div class="h2" id="when-to-post">
+<h2>When to post
+ <a class="sectionlink" href="#when-to-post"
+ title="Link to this section">¶</a>
+</h2>
<p>Sometimes, when really impassioned about a topic, it's tempting to
respond to every message in a mail thread. Please don't do this. Our
@@ -57,11 +66,17 @@
</div> <!-- when-to-post -->
-<div class="h2" id="formatting" title="formatting">
-<h2>Formatting</h2>
-
-<div class="h3" id="line-length" title="line-length">
-<h3>Line Length</h3>
+<div class="h2" id="formatting">
+<h2>Formatting
+ <a class="sectionlink" href="#formatting"
+ title="Link to this section">¶</a>
+</h2>
+
+<div class="h3" id="line-length">
+<h3>Line Length
+ <a class="sectionlink" href="#line-length"
+ title="Link to this section">¶</a>
+</h3>
<p>Please don't use lines longer than 72 columns. Many people use
80-column terminals to read their email. By writing your text in 72
@@ -79,8 +94,11 @@
</div> <!-- line-length -->
-<div class="h3" id="capitalization" title="capitalization">
-<h3>Capitalization</h3>
+<div class="h3" id="capitalization">
+<h3>Capitalization
+ <a class="sectionlink" href="#capitalization"
+ title="Link to this section">¶</a>
+</h3>
<p>Capitalize the first letter of each sentence, and use paragraphs.
If you're showing screen output or some other sort of example, offset
@@ -93,11 +111,17 @@
</div> <!-- formatting -->
-<div class="h2" id="replying" title="replying">
-<h2>Replying</h2>
-
-<div class="h3" id="reply-to" title="reply-to">
-<h3>Reply-To</h3>
+<div class="h2" id="replying">
+<h2>Replying
+ <a class="sectionlink" href="#replying"
+ title="Link to this section">¶</a>
+</h2>
+
+<div class="h3" id="reply-to">
+<h3>Reply-To
+ <a class="sectionlink" href="#reply-to"
+ title="Link to this section">¶</a>
+</h3>
<p>Make sure to use your mailreader's "Follow-up" or "Reply-to-all" or
"Group reply" feature when responding to a list post. Otherwise, your
@@ -127,8 +151,11 @@
</div> <!-- reply-to -->
-<div class="h3" id="fresh-post" title="fresh-post">
-<h3>Making a fresh post</h3>
+<div class="h3" id="fresh-post">
+<h3>Making a fresh post
+ <a class="sectionlink" href="#fresh-post"
+ title="Link to this section">¶</a>
+</h3>
<p>Don't start a new thread (subject) by replying to an existing
post. Instead, start a fresh mail, even if that means you have to
@@ -151,8 +178,11 @@
</div> <!-- fresh-post -->
-<div class="h3" id="rethreading" title="rethreading">
-<h3>Re-threading</h3>
+<div class="h3" id="rethreading">
+<h3>Re-threading
+ <a class="sectionlink" href="#rethreading"
+ title="Link to this section">¶</a>
+</h3>
<p>If you do need to change the <tt>Subject</tt> header while
preserving the thread (perhaps because the thread has wandered into
@@ -171,8 +201,11 @@
</div> <!-- rethreading -->
-<div class="h3" id="top-posting" title="top-posting">
-<h3>Top-Posting</h3>
+<div class="h3" id="top-posting">
+<h3>Top-Posting
+ <a class="sectionlink" href="#top-posting"
+ title="Link to this section">¶</a>
+</h3>
<p>Please don't reflexively chide people for top-posting.
"Top-posting" is the practice of putting the response text above the
@@ -199,8 +232,11 @@
</div> <!-- replying -->
-<div class="h2" id="sending-patches" title="sending-patches">
-<h2>Sending patches</h2>
+<div class="h2" id="sending-patches">
+<h2>Sending patches
+ <a class="sectionlink" href="#sending-patches"
+ title="Link to this section">¶</a>
+</h2>
<p>See <a href="#patches">here</a> for advice on how to send in a
patch. Note that you can send in a patch to modify these web pages as
@@ -211,8 +247,11 @@
</div> <!-- sending-patches -->
-<div class="h2" id="encodings" title="encodings">
-<h2>Languages and encodings</h2>
+<div class="h2" id="encodings">
+<h2>Languages and encodings
+ <a class="sectionlink" href="#encodings"
+ title="Link to this section">¶</a>
+</h2>
<p>Please use ASCII or ISO-8859 text if possible. Don't post HTML
mails, RichText mails, or other formats that might be opaque to
Modified: subversion/site/publish/docs/community-guide/releasing.part.html
URL: http://svn.apache.org/viewvc/subversion/site/publish/docs/community-guide/releasing.part.html?rev=909145&r1=909144&r2=909145&view=diff
==============================================================================
--- subversion/site/publish/docs/community-guide/releasing.part.html (original)
+++ subversion/site/publish/docs/community-guide/releasing.part.html Thu Feb 11 21:04:38 2010
@@ -1,8 +1,14 @@
-<div class="h1" id="releasing" title="releasing">
-<h1>Making Subversion Releases</h1>
-
-<div class="h2" id="release-numbering" title="release-numbering">
-<h2>Release numbering, compatibility, and deprecation</h2>
+<div class="h1" id="releasing">
+<h1>Making Subversion Releases
+ <a class="sectionlink" href="#releasing"
+ title="Link to this section">¶</a>
+</h1>
+
+<div class="h2" id="release-numbering">
+<h2>Release numbering, compatibility, and deprecation
+ <a class="sectionlink" href="#release-numbering"
+ title="Link to this section">¶</a>
+</h2>
<p>Subversion uses "MAJOR.MINOR.PATCH" release numbers, with the same
guidelines as APR (see <a href="http://apr.apache.org/versioning.html"
@@ -162,8 +168,11 @@
code to get wider distribution than just those who build from working
copies, we put out a prerelease.</p>
-<div class="h3" id="name-reuse" title="name-reuse">
-<h3>Reuse of release names</h3>
+<div class="h3" id="name-reuse">
+<h3>Reuse of release names
+ <a class="sectionlink" href="#name-reuse"
+ title="Link to this section">¶</a>
+</h3>
<p>If a release or candidate release needs to be quickly re-issued due
to some non-code problem (say, a packaging glitch), it's okay to reuse
@@ -175,8 +184,11 @@
</div> <!-- name-reuse -->
-<div class="h3" id="deprecation" title="deprecation">
-<h3>Deprecation</h3>
+<div class="h3" id="deprecation">
+<h3>Deprecation
+ <a class="sectionlink" href="#deprecation"
+ title="Link to this section">¶</a>
+</h3>
<p>When a new, improved version of an API is introduced, the old one
remains for compatibility, at least until the next major release.
@@ -228,8 +240,11 @@
</div> <!-- release-numbering -->
-<div class="h2" id="release-stabilization" title="release-stabilization">
-<h2>Stabilizing and maintaining releases</h2>
+<div class="h2" id="release-stabilization">
+<h2>Stabilizing and maintaining releases
+ <a class="sectionlink" href="#release-stabilization"
+ title="Link to this section">¶</a>
+</h2>
<p>Minor and major number releases go through a stabilization period
before release, and remain in maintenance (bugfix) mode after release.
@@ -458,8 +473,11 @@
<p>NOTE: Changes to STATUS regarding the temporary branch, including
voting, are always kept on the main release branch.</p>
-<div class="h3" id="alphas-betas" title="alphas-betas">
-<h2>Alpha and beta releases</h2>
+<div class="h3" id="alphas-betas">
+<h2>Alpha and beta releases
+ <a class="sectionlink" href="#alphas-betas"
+ title="Link to this section">¶</a>
+</h2>
<p>When we want new features to get wide testing before we enter the
formal stabilization period described above, we'll sometimes release
@@ -493,8 +511,11 @@
</div> <!-- release-stabilization -->
-<div class="h2" id="tarball-signing" title="tarball-signing">
-<h2>Signing source distribution packages (a.k.a tarballs)</h2>
+<div class="h2" id="tarball-signing">
+<h2>Signing source distribution packages (a.k.a tarballs)
+ <a class="sectionlink" href="#tarball-signing"
+ title="Link to this section">¶</a>
+</h2>
<p>Before a release or release candidate is officially made public, it is
made available in a temporary location for committers to test and sign.
@@ -545,8 +566,11 @@
</div> <!-- tarball-signing -->
-<div class="h2" id="custom-releases" title="custom-releases">
-<h2>Custom releases</h2>
+<div class="h2" id="custom-releases">
+<h2>Custom releases
+ <a class="sectionlink" href="#custom-releases"
+ title="Link to this section">¶</a>
+</h2>
<p>It is preferred to use the patch process and have your changes
accepted and applied to trunk to be released on the normal Subversion
@@ -577,8 +601,11 @@
</div> <!-- custom-releases -->
-<div class="h2" id="release-branches" title="release-branches">
-<h2>Creating and maintaining release branches</h2>
+<div class="h2" id="release-branches">
+<h2>Creating and maintaining release branches
+ <a class="sectionlink" href="#release-branches"
+ title="Link to this section">¶</a>
+</h2>
<p>A new release branch is created for each new major and minor
release. So, for example, a new release branch is created when
@@ -640,8 +667,11 @@
</div> <!-- release-branches -->
-<div class="h2" id="porting-changes" title="porting-changes">
-<h2>Porting changes to release branches</h2>
+<div class="h2" id="porting-changes">
+<h2>Porting changes to release branches
+ <a class="sectionlink" href="#porting-changes"
+ title="Link to this section">¶</a>
+</h2>
<p>Once a release branch has been created, no development <i>ever</i>
takes place there. The only changes permitted are ones made to
@@ -656,8 +686,11 @@
</div> <!-- porting-changes -->
-<div class="h2" id="the-changes-file" title="the-changes-file">
-<h2>Managing the CHANGES file</h2>
+<div class="h2" id="the-changes-file">
+<h2>Managing the CHANGES file
+ <a class="sectionlink" href="#the-changes-file"
+ title="Link to this section">¶</a>
+</h2>
<p>The <tt>CHANGES</tt> file is the project changelog file. Before a
release, it must be brought up to date to list all changes since the
@@ -686,8 +719,11 @@
<i>If it takes more than one line to describe, maybe I'm getting too
detailed?</i></p>
-<div class="h3" id="writing-initial-changes" title="writing-initial-changes">
-<h3>Writing the initial content for a branch</h3>
+<div class="h3" id="writing-initial-changes">
+<h3>Writing the initial content for a branch
+ <a class="sectionlink" href="#writing-initial-changes"
+ title="Link to this section">¶</a>
+</h3>
<p>Run <code>svn log -rHEAD:BRANCH_POINT
http://svn.apache.org/repos/asf/subversion/branches/A.B.x</code>,where
@@ -711,7 +747,10 @@
</div> <!-- writing-initial-changes -->
<div class="h3" id="adding-changes">
-<h3>Adding content for patch release</h3>
+<h3>Adding content for patch release
+ <a class="sectionlink" href="#adding-changes"
+ title="Link to this section">¶</a>
+</h3>
<p>As part of <a href="#release-stabilization">release
stabilization</a>, <tt>CHANGES</tt> should be updated as bug fixes are
@@ -726,8 +765,11 @@
</div> <!-- the-changes-file -->
-<div class="h2" id="before-release" title="before-release">
-<h2>Preparing to roll a release</h2>
+<div class="h2" id="before-release">
+<h2>Preparing to roll a release
+ <a class="sectionlink" href="#before-release"
+ title="Link to this section">¶</a>
+</h2>
<p>So, a release branch has stabilized, and you are gearing up to roll
the release. Before you can actually roll the archives, you need to
@@ -798,8 +840,11 @@
</div> <!-- before-release -->
-<div class="h2" id="rolling-release" title="rolling-release">
-<h2>Rolling a release</h2>
+<div class="h2" id="rolling-release">
+<h2>Rolling a release
+ <a class="sectionlink" href="#rolling-release"
+ title="Link to this section">¶</a>
+</h2>
<p>Before rolling, first make sure that the latest version of the
<tt>CHANGES</tt> file from trunk is merged into the release branch, and that
@@ -938,8 +983,11 @@
</div> <!-- rolling-release -->
-<div class="h2" id="releasing-release" title="releasing-release">
-<h2>The actual releasing</h2>
+<div class="h2" id="releasing-release">
+<h2>The actual releasing
+ <a class="sectionlink" href="#releasing-release"
+ title="Link to this section">¶</a>
+</h2>
<p><b>Upload the tarballs to
http://subversion.tigris.org/downloads/.</b></p>
@@ -1026,8 +1074,11 @@
</div> <!-- releasing-release -->
-<div class="h2" id="afterwards" title="afterwards">
-<h2>After a release has been made</h2>
+<div class="h2" id="afterwards">
+<h2>After a release has been made
+ <a class="sectionlink" href="#afterwards"
+ title="Link to this section">¶</a>
+</h2>
<p>When someone with administrative access to <tt>svn.collab.net</tt>
has time available, they will upgrade it to the latest release or
@@ -1037,8 +1088,11 @@
</div> <!-- afterwards -->
-<div class="h3" id="releasing-not" title="releasing-not">
-<h3>How <em>not</em> to make a Subversion release</h3>
+<div class="h3" id="releasing-not">
+<h3>How <em>not</em> to make a Subversion release
+ <a class="sectionlink" href="#releasing-not"
+ title="Link to this section">¶</a>
+</h3>
<p>For an enlightening case study of the bungled Subversion 1.5 release
cycle, see <a href="http://www.hyrumwright.org/papers/floss2009.pdf">this