[[[ Changes to two section which are assembled into http://subversion.apache.org/docs/community-guide/general.html
* docs/community-guide/general.part.html (code-to-read): Linkified code file names. * docs/community-guide/general.part.html (directory-layout): Linkified code file names. Patch by: Gabriela Gibson <gabriela.gib...@gmail.com> ]]]
Index: docs/community-guide/general.part.html =================================================================== --- docs/community-guide/general.part.html (revision 1425918) +++ docs/community-guide/general.part.html (working copy) @@ -174,15 +184,54 @@ understanding of the implementation details. Here perusal order:</p> <ol> -<li><p>the basic building blocks: svn_string.h, svn_error.h, svn_types.h</p> +<li><p>the basic building blocks: +<a href= +"https://svn.apache.org/repos/asf/subversion/trunk/subversion/include/svn_string.h";> + svn_string.h</a>, +<a href= +"https://svn.apache.org/repos/asf/subversion/trunk/subversion/include/svn_error.h";> + svn_error.h</a>, +<a href= +"https://svn.apache.org/repos/asf/subversion/trunk/subversion/include/svn_types.h";> + svn_types.h</a></p> </li> -<li><p>useful utilities: svn_io.h, svn_path.h, svn_hash.h, svn_xml.h</p> +<li><p> +<a href= +"https://svn.apache.org/repos/asf/subversion/trunk/subversion/include/svn_io.h";> + svn_io.h</a>, +<a href= +"https://svn.apache.org/repos/asf/subversion/trunk/subversion/include/svn_path.h";> + svn_path.h</a>, +<a href= +"https://svn.apache.org/repos/asf/subversion/trunk/subversion/include/svn_hash.h";> + svn_hash.h</a>, +<a href= +"https://svn.apache.org/repos/asf/subversion/trunk/subversion/include/svn_xml.h";> + svn_xml.h</a></p> </li> -<li><p>the critical interface: svn_delta.h</p> +<li><p>the critical interface: +<a href= +"https://svn.apache.org/repos/asf/subversion/trunk/subversion/include/svn_delta.h";> + svn_delta.h</a></p> </li> -<li><p>client-side interfaces: svn_ra.h, svn_wc.h, svn_client.h</p> +<li><p>client-side interfaces: +<a href= +"https://svn.apache.org/repos/asf/subversion/trunk/subversion/include/svn_ra.h";> + svn_ra.h</a>, +<a href= +"https://svn.apache.org/repos/asf/subversion/trunk/subversion/include/svn_wc.h";> + svn_wc.h</a>, +<a href= +"https://svn.apache.org/repos/asf/subversion/trunk/subversion/include/svn_client.h";> + svn_client.h</a></p> </li> -<li><p>the repository and versioned filesystem: svn_repos.h, svn_fs.h</p> +<li><p>the repository and versioned filesystem: +<a href= +"https://svn.apache.org/repos/asf/subversion/trunk/subversion/include/svn_repos.h";> + svn_repos.h</a>, +<a href= +"https://svn.apache.org/repos/asf/subversion/trunk/subversion/include/svn_fs.h";> + svn_fs.h</a></p> </li> </ol> @@ -199,11 +248,25 @@ understand Subversion without first glancing over in APR (look in 'apr/include/'):</p> <ul> -<li><p>memory pools: apr_pools.h</p></li> -<li><p>filesystem access: apr_file_io.h</p></li> -<li><p>hashes and arrays: apr_hash.h, apr_tables.h</p></li> +<li><p>memory pools: +<a href= +"http://svn.apache.org/repos/asf/apr/apr/branches/1.5.x/include/apr_pools.h";> + apr_pools.h</a></p></li> +<li><p>filesystem access: +<a href= +"http://svn.apache.org/repos/asf/apr/apr/branches/1.5.x/include/apr_file_io.h";> + apr_file_io.h</a></p></li> +<li><p>hashes and arrays: +<a href= +"http://svn.apache.org/repos/asf/apr/apr/branches/1.5.x/include/apr_hash.h";> + apr_hash.h</a>, +<a href= +"http://svn.apache.org/repos/asf/apr/apr/branches/1.5.x/include/apr_tables.h";> + apr_tables.h</a> +</p></li> </ul> + <p>Subversion also tries to deliver reliable and secure software. This can only be achieved by developers who understand secure programming in the C programming language. Please see 'notes/assurance.txt' for @@ -218,72 +281,132 @@ to ask for review on the developer mailing list.</ <div class="h2" id="directory-layout"> <h2>Directory layout - <a class="sectionlink" href="<!--#echo var="GUIDE_GENERAL_PAGE" -->#directory-layout" + <a class="sectionlink" href="general.html#directory-layout" title="Link to this section">¶</a> </h2> <p>A rough guide to the source tree:</p> <ul> -<li><p><tt>doc/</tt><br /> +<li><p><tt><a + href="https://svn.apache.org/repos/asf/subversion/trunk/doc/";> + doc/</a></tt><br /> User and Developer documentation.</p> </li> -<li><p><tt>tools/</tt><br /> + +<li><p><tt><a> + href="https://svn.apache.org/repos/asf/subversion/trunk/tools/";> + tools/</a></tt><br /> + Stuff that works with Subversion, but that Subversion doesn't depend on. Code in tools/ is maintained collectively by the Subversion project, and is under the same open source copyright as Subversion itself.</p> </li> -<li><p><tt>contrib/</tt><br /> + +<li><p><tt><a + href="https://svn.apache.org/repos/asf/subversion/trunk/contrib/";> + contrib/</a></tt><br /> + Stuff that works with Subversion, but that Subversion doesn't depend on, and that is maintained by individuals who may or may not participate in Subversion development. Code in contrib/ is open source, but may have a different license or copyright holder than Subversion itself.</p> </li> + <li><p><tt>packages/</tt><br /> Stuff to help packaging systems, like rpm and dpkg.</p> </li> -<li><p><tt>subversion/</tt><br /> + +<li><p><tt><a + href="https://svn.apache.org/repos/asf/subversion/trunk/subversion/";> + subversion/</a></tt><br /> + Source code to Subversion itself (as opposed to external libraries).</p> </li> -<li><p><tt>subversion/include/</tt><br /> +<li><p><tt><a + href="https://svn.apache.org/repos/asf/subversion/trunk/subversion/include/";> + subversion/include/</a></tt><br /> + Public header files for users of Subversion libraries.</p> </li> -<li><p><tt>subversion/include/private/</tt><br /> + +<li><p><tt><a + href="https://svn.apache.org/repos/asf/subversion/trunk/subversion/include/private/";> + subversion/include/private/</a></tt><br /> + Private header files shared internally by Subversion libraries.</p> </li> -<li><p><tt>subversion/libsvn_fs/</tt><br /> + +<li><p><tt><a + href="https://svn.apache.org/repos/asf/subversion/trunk/subversion/libsvn_fs/";> + subversion/libsvn_fs/</a></tt><br /> The versioning "filesystem" API.</p> </li> -<li><p><tt>subversion/libsvn_repos/</tt><br /> + +<li><p><tt><a + href="https://svn.apache.org/repos/asf/subversion/trunk/subversion/libsvn_repos/";> + subversion/libsvn_repos/</a></tt><br /> + Repository functionality built around the `libsvn_fs' core.</p> </li> -<li><p><tt>subversion/libsvn_delta/</tt><br /> + +<li><p><tt><a + href="https://svn.apache.org/repos/asf/subversion/trunk/subversion/libsvn_delta/";> + subversion/libsvn_delta/</a></tt><br /> + Common code for tree deltas, text deltas, and property deltas.</p> </li> -<li><p><tt>subversion/libsvn_wc/</tt><br /> + +<li><p><tt><a + href="https://svn.apache.org/repos/asf/subversion/trunk/subversion/libsvn_wc/";> + subversion/libsvn_wc/</a></tt><br /> + Common code for working copies.</p> </li> -<li><p><tt>subversion/libsvn_ra/</tt><br /> + +<li><p><tt><a + href="https://svn.apache.org/repos/asf/subversion/trunk/subversion/libsvn_ra/";> + subversion/libsvn_ra/</a></tt><br /> + Common code for repository access.</p> </li> -<li><p><tt>subversion/libsvn_client/</tt><br /> + +<li><p><tt><a + href="https://svn.apache.org/repos/asf/subversion/trunk/subversion/libsvn_client/";> + subversion/libsvn_client/</a></tt><br /> + Common code for client operations.</p> </li> -<li><p><tt>subversion/svn/</tt><br /> + +<li><p><tt><a + href="https://svn.apache.org/repos/asf/subversion/trunk/subversion/svn/";> + subversion/svn/</a></tt><br /> + The command line client.</p> </li> -<li><p><tt>subversion/tests/</tt><br /> + +<li><p><tt><a + href="https://svn.apache.org/repos/asf/subversion/trunk/subversion/tests/";> + subversion/tests/</a></tt><br /> + Automated test suite.</p> </li> -<li><p><tt>apr/</tt><br /> + +<li><p><tt><a + href="http://svn.apache.org/repos/asf/apr/apr/branches/1.5.x/";> + apr/</a></tt><br /> + Apache Portable Runtime library. (Note: This is not in the same repository as Subversion. Read INSTALL for instructions on how to get it if you don't already have it.)</p> </li> -<li><p><tt>neon/</tt><br /> + +<li><p><tt><a + href="http://www.webdav.org/neon/doc/html";>neon/</a></tt><br /> + Neon library from Joe Orton. (Note: This is not in the same repository as Subversion. Read INSTALL for instructions on how to get it if you don't already have it.)</p> @@ -511,7 +634,7 @@ comments should help understanding of the code, no <p>Read over the Subversion code to get an overview of how documentation looks in practice; in particular, see <a href="http://svn.apache.org/repos/asf/subversion/trunk/subversion/include/";> -subversion/include/*.h</a> for doxygen examples. + subversion/include/*.h</a> for doxygen examples. </p> </div> <!-- document-everything -->
