You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@subversion.apache.org by Daniel Shahaf <d....@daniel.shahaf.name> on 2019/11/22 02:09:06 UTC

Re: svn commit: r1870062 - /subversion/site/publish/docs/release-notes/1.14.html

hartmannathan@apache.org wrote on Thu, 21 Nov 2019 04:23 +00:00:
> +<p>The convenience script that downloads Subversion's minimal
> +build-time dependencies, get-deps.sh, has been updated to download
> +py3c. This script is found in the source distribution's root
> +directory. For the full list of Subversion's dependencies, see the
> +INSTALL file in the same directory.</p>

Suggest to link to the INSTALL file.

I'm not sure whether "INSTALL" and "get-deps.sh" should be set in <tt/>,
being filenames.  In svnbook they would be, but I'm not sure what our
house style for release notes is.

Cheers,

Daniel

Re: svn commit: r1870062 - /subversion/site/publish/docs/release-notes/1.14.html

Posted by Daniel Shahaf <d....@daniel.shahaf.name>.
Nathan Hartman wrote on Sun, Nov 24, 2019 at 12:26:04 -0500:
> On Thu, Nov 21, 2019 at 9:09 PM Daniel Shahaf <d....@daniel.shahaf.name> wrote:
> > hartmannathan@apache.org wrote on Thu, 21 Nov 2019 04:23 +00:00:
> > > +<p>The convenience script that downloads Subversion's minimal
> > > +build-time dependencies, get-deps.sh, has been updated to download
> > > +py3c. This script is found in the source distribution's root
> > > +directory. For the full list of Subversion's dependencies, see the
> > > +INSTALL file in the same directory.</p>
> >
> > Suggest to link to the INSTALL file.
> 
> Done in r1870317.
> 
> Also in r1870317, made mention of get-deps.sh a link.

Thanks.

> I went ahead and pointed both links to branches/1.14.x; currently
> there is no explicit revision number in the links because that
> information isn't known yet. Perhaps these should eventually point at
> the tag?

It's a stable branch, so there isn't _that_ much of a risk in pointing
to branches/1.14.x/INSTALL@HEAD: even if it contains unreleased changes,
at least one developer has reviewed them and considered them suitable
for backport.

> Then again, that would be useless for pre-release
> announcements/testing.

How so?  Even for pre-releases, we create tags before announcing them
to announce@.  As to anything that may happen on dev@, people subscribed
to dev@ can be assumed to know their way to the INSTALL file, broken
links notwithstanding. ☺

Re: svn commit: r1870062 - /subversion/site/publish/docs/release-notes/1.14.html

Posted by Nathan Hartman <ha...@gmail.com>.
On Thu, Nov 21, 2019 at 9:09 PM Daniel Shahaf <d....@daniel.shahaf.name> wrote:
> hartmannathan@apache.org wrote on Thu, 21 Nov 2019 04:23 +00:00:
> > +<p>The convenience script that downloads Subversion's minimal
> > +build-time dependencies, get-deps.sh, has been updated to download
> > +py3c. This script is found in the source distribution's root
> > +directory. For the full list of Subversion's dependencies, see the
> > +INSTALL file in the same directory.</p>
>
> Suggest to link to the INSTALL file.

Done in r1870317.

Also in r1870317, made mention of get-deps.sh a link.

I went ahead and pointed both links to branches/1.14.x; currently
there is no explicit revision number in the links because that
information isn't known yet. Perhaps these should eventually point at
the tag? Then again, that would be useless for pre-release
announcements/testing.

I'm replying to several related emails below...

> I'm not sure whether "INSTALL" and "get-deps.sh" should be set in <tt/>,
> being filenames.  In svnbook they would be, but I'm not sure what our
> house style for release notes is.

The only other example, in the 1.18 release notes, was not in any
special format. I went ahead and kept this the same way. Obviously if
special formatting should be used, that is easy to do.

More below:

On Fri, Nov 22, 2019 at 1:49 PM Daniel Shahaf <d....@daniel.shahaf.name> wrote:
> The link need only be valid when the first 1.14.0-* prerelease is
> announced (to announce@, not just to dev@); until then, 1.14.html is
> work in progress.  1.A.x branches are created after alphas but before
> betas. It's not likely that we'll do a 1.14.0-alpha1, and furthermore,
> I'd rather risk a broken link in an alpha release than in a beta or RC
> release. Therefore, I'd err on the side of making the link point to
> branches/1.14.x _now_ with a TODO reminding us to point the link to
> trunk if we do an alpha release…

Done in r1870318.

On Tue, Nov 19, 2019 at 11:55 AM Daniel Shahaf <d....@daniel.shahaf.name> wrote:
>
> Nathan Hartman wrote on Mon, 18 Nov 2019 15:46 +00:00:
> > The only problem with this idea is that the link won't take the reader
> > directly to the information about Python. INSTALL contains a lot of
> > other information to wade through.
>
> https://svn.apache.org/viewvc/subversion/tags/1.13.0/INSTALL?revision=1868915&view=markup#l142

Ah, that is incredibly convenient! Thanks for mentioning it. I went
ahead and made a note of that in my notes...

Cheers,
Nathan

Re: svn commit: r1870062 - /subversion/site/publish/docs/release-notes/1.14.html

Posted by Daniel Shahaf <d....@daniel.shahaf.name>.
Nathan Hartman wrote on Fri, 22 Nov 2019 06:08 +00:00:
> Where should these point?
> 
> Perhaps to:
> https://svn.apache.org/viewvc/subversion/trunk/INSTALL?revision=HEAD
> 
> with a TODO reminding us to change 'trunk' to 'branches/1.14.x'?

The link need only be valid when the first 1.14.0-* prerelease is
announced (to announce@, not just to dev@); until then, 1.14.html is
work in progress.  1.A.x branches are created after alphas but before
betas. It's not likely that we'll do a 1.14.0-alpha1, and furthermore,
I'd rather risk a broken link in an alpha release than in a beta or RC
release. Therefore, I'd err on the side of making the link point to
branches/1.14.x _now_ with a TODO reminding us to point the link to
trunk if we do an alpha release…

… but in the great scheme of things, this is a pretty minor issue, and
there's more than one way to peel an orange.  Whoever writes the patch
will get to decide.

Cheers,

Daniel

Re: svn commit: r1870062 - /subversion/site/publish/docs/release-notes/1.14.html

Posted by Daniel Shahaf <d....@daniel.shahaf.name>.
Nathan Hartman wrote on Fri, 22 Nov 2019 06:08 +00:00:
> Where should these point?
> 
> Perhaps to:
> https://svn.apache.org/viewvc/subversion/trunk/INSTALL?revision=HEAD
> 
> with a TODO reminding us to change 'trunk' to 'branches/1.14.x'?

The link need only be valid when the first 1.14.0-* prerelease is
announced (to announce@, not just to dev@); until then, 1.14.html is
work in progress.  1.A.x branches are created after alphas but before
betas. It's not likely that we'll do a 1.14.0-alpha1, and furthermore,
I'd rather risk a broken link in an alpha release than in a beta or RC
release. Therefore, I'd err on the side of making the link point to
branches/1.14.x _now_ with a TODO reminding us to point the link to
trunk if we do an alpha release…

… but in the great scheme of things, this is a pretty minor issue, and
there's more than one way to peel an orange.  Whoever writes the patch
will get to decide.

Cheers,

Daniel

Re: svn commit: r1870062 - /subversion/site/publish/docs/release-notes/1.14.html

Posted by Nathan Hartman <ha...@gmail.com>.
On Thu, Nov 21, 2019 at 9:09 PM Daniel Shahaf <d....@daniel.shahaf.name>
wrote:

> hartmannathan@apache.org wrote on Thu, 21 Nov 2019 04:23 +00:00:
> > +<p>The convenience script that downloads Subversion's minimal
> > +build-time dependencies, get-deps.sh, has been updated to download
> > +py3c. This script is found in the source distribution's root
> > +directory. For the full list of Subversion's dependencies, see the
> > +INSTALL file in the same directory.</p>
>
> Suggest to link to the INSTALL file.
>
> I'm not sure whether "INSTALL" and "get-deps.sh" should be set in <tt/>,
> being filenames.  In svnbook they would be, but I'm not sure what our
> house style for release notes is.
>
> Cheers,
>
> Daniel
>

I agree and several other files are mentioned that should be links as well.

Where should these point?

Perhaps to:
https://svn.apache.org/viewvc/subversion/trunk/INSTALL?revision=HEAD

with a TODO reminding us to change 'trunk' to 'branches/1.14.x'?

Thanks,
Nathan

Re: svn commit: r1870062 - /subversion/site/publish/docs/release-notes/1.14.html

Posted by Nathan Hartman <ha...@gmail.com>.
On Thu, Nov 21, 2019 at 9:09 PM Daniel Shahaf <d....@daniel.shahaf.name>
wrote:

> hartmannathan@apache.org wrote on Thu, 21 Nov 2019 04:23 +00:00:
> > +<p>The convenience script that downloads Subversion's minimal
> > +build-time dependencies, get-deps.sh, has been updated to download
> > +py3c. This script is found in the source distribution's root
> > +directory. For the full list of Subversion's dependencies, see the
> > +INSTALL file in the same directory.</p>
>
> Suggest to link to the INSTALL file.
>
> I'm not sure whether "INSTALL" and "get-deps.sh" should be set in <tt/>,
> being filenames.  In svnbook they would be, but I'm not sure what our
> house style for release notes is.
>
> Cheers,
>
> Daniel
>

I agree and several other files are mentioned that should be links as well.

Where should these point?

Perhaps to:
https://svn.apache.org/viewvc/subversion/trunk/INSTALL?revision=HEAD

with a TODO reminding us to change 'trunk' to 'branches/1.14.x'?

Thanks,
Nathan