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

Re: svn commit: r1869776 - /subversion/site/staging/docs/release-notes/1.14.html

From: Daniel Shahaf <d.s_at_daniel.shahaf.name>
Date: Thu, 14 Nov 2019 18:50:30 +0000

Nathan Hartman wrote on Thu, 14 Nov 2019 18:14 +00:00:
> On Thu, Nov 14, 2019 at 10:33 AM Daniel Shahaf <d.s_at_daniel.shahaf.name> wrote:
> > hartmannathan_at_apache.org wrote on Thu, 14 Nov 2019 05:26 +00:00:
> > > +<div class="notice">
> > > +<p><strong>Python is Optional.</strong></p>
> > > +
> > > +<p>Note that Subversion does not require Python for its basic
> > > +operation. If you are not using Subversion's SWIG Python bindings,
> > > +automated test suite, or other Python-coded tools that ship with
> > > +Subversion, this change does not affect you.</p>
> >
> > Python is required when building from a tag or branch, but not required
> > when building from a tarball. Should this detail be added?
>
> Isn't it more accurate that building from tarball doesn't require
> Python but building from a working copy (whether from branches/tags or
> trunk) does?

Well, yes, but the release notes aren't aimed at people building trunk.
Also, "tag of 1.13.0" v. "tarball of 1.13.0" is a minimal pair;
"trunk_at_HEAD" v. "tarball of 1.13.0" is not.

> In that case I would change the note to two boxes or two paragraphs in one box:
>
> [[[
>
> Note that Subversion does not require Python for its basic operation.
> In general, if you are not using Subversion's SWIG Python bindings,
> automated test suite, or other Python-coded tools that ship with
> Subversion, this change does not affect you.
>
> Note about building Subversion: Building from a distribution tarball
> does not require Python, but building from a checked out source working
> copy does.
>
> ]]]
>
> Thoughts?

The content looks good.

Suggest to move the mention of test suite to the second paragraph, since
it only affects downstream maintainers, not downstream users.

Suggest to delete the "Note ...:" clause, to improve flow. Instead, perhaps
"If you build Subversion yourself, Python is required if you build from a checked
out working copy or run the test suite, but not otherwise"?

Not directly related, but the phrase "other Python-coded tools" makes
for a circular definition. Does svnlook qualify? (You and I know it
doesn't, but that's an implementation detail.) Maybe make those words a
link to .../branches/1.13.x/tools/?

Cheers,

Daniel
Received on 2019-11-14 19:51:23 CET

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