Re: [PATCH] code file names linkified in general.html of the Hacking Guide

On Wed, Dec 26, 2012 at 4:27 PM, Gabriela Gibson
<gabriela.gibson_at_gmail.com> wrote:
> * docs/community-guide/general.part.html
>
> (code-to-read): Linkified code file names.

You've got an extra blank line in there between the file and the identifier.

> * docs/community-guide/general.part.html
> (directory-layout): Linkified code file names.

You can list multiple identifiers in the same line comma separated if
they have the same description.

Here's an example of that type of collapsing:
http://svn.apache.org/r1428209

> @@ -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">&para;</a>
> </h2>
>
> <p>A rough guide to the source tree:</p>
>
> <ul>

You've removed the SSI code that generates the page in the above diff
hunk. You might want to work off a checkout from:
https://svn.apache.org/repos/asf/subversion/site

> -<li><p><tt>tools/</tt><br />
> +
> +<li><p><tt><a>
> + href="https://svn.apache.org/repos/asf/subversion/trunk/tools/">
> + tools/</a></tt><br />
> +

Broken HTML.

> </li>
> +
> <li><p><tt>packages/</tt><br />

Missed one/spurious whitespace addition.

> -<li><p><tt>neon/</tt><br />
> +
> +<li><p><tt><a
> + href="http://www.webdav.org/neon/doc/html">neon/</a></tt><br />
> +

Neon is no longer used by SVN in trunk, so I'd remove Neon. Serf has
replaced neon but the intent herein is to describe the layout of the
source tree. We don't support in-tree building of Serf. So I
wouldn't bother to replace it.

We do still support in-tree building of APR but frankly, I'm not sure
this is really important to have here anymore. I think the other
references are enough.

With respect to Bert's comments I generally agree, I'd link to the
documentation files which have links to the source code a
pretty-printed HTML copy of the source code. E.G. svn_client.h would
be:
http://subversion.apache.org/docs/api/latest/svn__client_8h.html
Received on 2013-01-04 05:08:32 CET