On Mon, 17 Apr 2006, Daniel Rall wrote:
> Thanks Martin, comments inline (all the way to the bottom).
>
> On Mon, 17 Apr 2006, Martin Furter wrote:
>
>> On Sat, 15 Apr 2006, Daniel Rall wrote:
>>
>>> On Sat, 15 Apr 2006, Martin Furter wrote:
>>>
>>>>
>>>> Hello
>>>>
>>>> I wrote a new html file containing an index of the scripts in tools/ and
>>>> contrib/. Only for 3 scripts i didn't find out how to describe them.
>>>>
>>>> Now where should I add a link to this new page?
>
> The READMEs could point to the new page.
Done.
>>>> Index: www/tools+contrib.html
>>> ...
>>>
>>> I'd appreciate it if you used something other than a "+" in the file
>>> name.
>>>
>>> Also, there are some README files in some of the directories
>>> (e.g. tools/hook-scripts/README) which would want to be subsumed by
>>> this document, no? (Also, you can use the descriptions from there if
>>> you didn't already.)
>>
>> Thanks for the reminder, I updated some descriptions with those I found
>> in the READMEs. Most of the descriptions I copied from the scripts, for
>> some I had to lookup the log message.
>>
>> But still three remain undocumented: whatis-rep.py and svn-dev.el
>> seem to not have a description and I am not sure what they
>> do.
>
> whatis-rep.py prints a description (including data, path, and
> revision) of the specified node reps in a Subversion filesystem (a
> rep-id is the actual data or property value of the node). It walks as
> much of the reps table as necessary to locate the data (e.g. does a
> table scan). (I've added a quick doc string to say as much.)
>
> svn-dev.el says, "Emacs Lisp help for writing Subversion code." This
> is fairly accurate -- it contains some elisp functions which could be
> helpful to employ while working on Subversion.
OK, added those two descriptions.
>> svn_update.pl has a description but I don't understand it fully.
>
> Not absolutely certain, but at first glance it appears to be a way to
> get around timeout from old versions of mod_dav_svn. It references
> issue <http://subversion.tigris.org/issues/show_bug.cgi?id=2048>; Mike
> would probably be able to confirm.
I should have done the research instead of whining...
Now I read the issue and the log message for the fix (was r13383, not
r13381-2 as stated in the issue) and wrote the following description:
<p>Run svn update and force it to produce conflicts for all
files which would be merged using diff3.
</p>
<p>This is a workaround for <a
href="http://subversion.tigris.org/issues/show_bug.cgi?id=2048"
>issue 2048</a> which was fixed in r13383 and released in
svn 1.2.0.
</p>
>> I also added an index, and tried to format it a bit better, hope you
>> like it.
>
> It looks pretty good, but doesn't look like the XHTML will validate.
> Have you run validate.sh on this?
I did now (nice script :) and fixed all the errors.
>> Is it possible to add a link to the navigation menu, maybe below
>> "Documents & Files" ? That way users will find it pretty fast.
>
> This is possible to do by editing www/project_tools.html. What are
> your reasons for preferring a left nav link would be better than
> indirect linkage from "Docs & files" or some other page?
Added a link in project_tools.html, that way people might find it faster.
As discussed on IRC you can later add a link to Docs&Files too.
>> Index: www/tools_contrib.html
>> ===================================================================
>> --- www/tools_contrib.html (revision 0)
>> +++ www/tools_contrib.html (revision 0)
>> @@ -0,0 +1,984 @@
[...]
>> +<p>The directories 'tools' and 'contrib' in the Subversion repository
>> + contain code that works with Subversion but that Subversion doesn't
>> + depend on for normal operations.
>> +<br />The files in 'tools' are maintained collectively by the Subversion
>> + project, and are under the same open source copyright as Subversion itself.
>> +<br />Code in contrib/ is open source, but may have a different license or
>> + copyright holder than Subversion itself. The Subversion project does
>> + not maintain these programs, but merely distributes them for our
>> + users' convenience.
>
> Prefer <p> tag pairs to <br>'s.
Fixed.
>> +<p>
>
> Missing closing </p> tag?
Fixed.
[...]
>> +<!-- template
[...]
>> +-->
>
> Is anyone ever going to find this template way down at the bottom?
> I'd leave it out, or move it.
Removed.
This time with a commit message :)
[[[
Added tools_contrib.html listing almost all scripts in tools and contrib.
Approved by: dlr
* /trunk/www/tools_contrib.html: New file.
* /trunk/www/project_tools.html: Added link to tools_contrib.html.
* /trunk/contrib/README, /trunk/contrib/hook-scripts/README,
/trunk/tools/README, /trunk/tools/hook-scripts/README:
Added reference to tools_contrib.html.
]]]
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org
Received on Tue Apr 18 03:44:55 2006