On 5/27/07, Edward Z. Yang <[EMAIL PROTECTED]> wrote:
Here it is, for review. If there are no objections, I would consider
this set release ready. No incomplete files are included in this zip
file (I used zip just to warn that they are using DOS-style newlines. I
might have to convert those before comitting).
>> URLs still haven't been put in global_entities file. Sorry. I'm lazy.
> This must be changed before any commit is made or really before a true
> review can be performed.
Done.
> The tone of this warning makes it sound like a bug, and maybe it is, but
> it could be a feature too. That and we do not document bugs. Please
> rewrite it to simply report the behavior and if this behavior changes in
> the future then we will document it.
Warnings were toned done, bugs were noted as features. Goes against my
instinct, though, because in my mind, documentation should be for people
who want to use the extension here and now, and should clearly state
limitations. Nevertheless, hopefully we'll have a SVN 0.3 coming out
soon (I've filed an oodle of bug reports for the extension).
> This has never been done before (that I know of) and although it's
> useful I would prefer not having these hard links. We should be able to
> automate the process of linking constants (livedocs) so please instead
> use either <constant> or link to the constants page directly.
I'm not sure what you mean. I changed them to use
svn.constants#svn.constants.auth but that points to a sort of "orphan"
page and I'm not precisely sure what to do.
> Some words (like in configure.xml) are written for today but not
> tomorrow.
Fixed. Mostly. I got rid of the flagrant "as of" cases, some other
things may have sneaked by though.
> Some constants in constants.xml are lowercase... is this really correct?
Yep. The extension directly copies over C's typedef declarations.
> Also add .cvsignore for new extensions (see another extension for an
> example)
Done.
> 2. Pick 5 functions
I set the whole set, since they're all complete, but you can review just
the first five if that is easier for you.
Looks great overall but there are a few copy&paste markup errors...
The constants.xml file is missing <listitem> around many <simpara />
Also when you don't write a description you must include
<listitem><simpara /></listitem> after the <term /> block.
Formal examples must include a <title /> (svn-update.xml,
svn-cleanup.xml, svn-cat.xml..)
Formal tables must include a <title /> (svn-log.xml)
And as Philip said, linkend="id#anchor-id" is incorrect, simply use
linkend="anchor-id".
Everything that has a id="the-id" attribute can be linked to with
linkend="the-id".
And one last note: you don't have to fill in the $Revision:$ tags
yourself, it is dealt with by cvs :)
-Hannes
