[svn.haxx.se] · SVN Dev · SVN Users · SVN Org · TSVN Dev · TSVN Users · Subclipse Dev · Subclipse Users · this month's index

Re: Update documentation

From: Julian Foad <julianfoad_at_btopenworld.com>
Date: Fri, 11 Apr 2014 13:47:55 +0100 (BST)

Hi, Mayuresh.

Thank you for the patch. That 'best practices' file is certainly very out of date.

Mayuresh Rajwadkar wrote:
> I support subversion at my workplace and would usually like users to follow
>
>http://svn.apache.org/repos/asf/subversion/trunk/doc/user/svn-best-practices.html
>
> The file however is outdated and points to Subversion 1.0 documentation...
>
> Attached here is a patch, which would make the trunk point to the nightly instead of
> Subversion 1.0. Yes it probably needs more information, however at least this fixes
> the subversion links to point to a more appropriate nightly version of the
> documentation instead of a really old one...

That's a good idea. The first replacement is fine. I think we can find better replacements for the links in the second and fourth sections -- have a look at the version I committed in http://svn.apache.org/r1586631 .

The recommendation to track merges manually, is totally obsolete. I couldn't think why you choose to link it to the "Merge-Sensitive Logs and Annotations" section? I think we should instead delete it, or replace it with a reference to the section on basic merging. For now, I have left it as it was.

We could argue that the whole file exists only for historical interest. It hasn't been materially updated since it was created, exactly ten years ago.

Maybe I'll commit some additional updates to the obsolete sections, or maybe I won't. We could at least add notes saying that they're obsolete.

Thanks.

- Julian
Received on 2014-04-11 14:48:34 CEST

This is an archived mail posted to the Subversion Dev mailing list.

This site is subject to the Apache Privacy Policy and the Apache Public Forum Archive Policy.