On Thu, Jul 8, 2021 at 9:36 PM Daniel Shahaf <d...@daniel.shahaf.name> wrote:
> Generating the site API docs from _any_ revision of branches/1.A.x
> (whether @HEAD, @${MAGIC_REVISION}, or anything else) would mean
> SVN_VER_TAG and SVN_VER_REVISION would have wrong values in the
> generated API docs. So, if HACKING says to generate a release's docs
> from branches/1.A.x, that's a bug.Fixed in r1891418. > Also, HACKING doesn't define the term "magic revision" (= the revision > that's tagged, visible as the copyfrom of the tag in the repository and > the value of SVN_VER_REVISION in the tag's source tree). The term is used in > https://subversion.apache.org/docs/community-guide/how-to-roll-releases-in-private.txt, > though. That's the 'revnum' arg to the 'roll' subcommand of release.py. Is there a reason it should be termed a "magic revision" here? I didn't see this terminology except in how-to-roll-releases-in-private.txt. Ah, perhaps it was renamed in the past, or was simply called that in a discussion way back... Don't know if it's worth digging for it though. I suppose it's best fixed by defining it where it's first used, in how-to-roll-releases-in-private.txt, with something like: [[[ Index: docs/community-guide/how-to-roll-releases-in-private.txt =================================================================== --- docs/community-guide/how-to-roll-releases-in-private.txt (revision 1891418) +++ docs/community-guide/how-to-roll-releases-in-private.txt (working copy) @@ -17,12 +17,13 @@ for 1.9 would add not only 1.9.7 but also 1.8.19. [TODO: And how are the patches to be committed to trunk, then?] -- You'll be rolling a 1.a.b release with b>0, so for the magic - revision argument pass the magic revision of 1.a.c where c=b-1. You - can find the magic revision by running 'svn log -v' on the 1.a.c - tag. Run 'release.py roll' and pass '--patch DIR' where DIR - contains the CVE and CHANGES patches. The names of the patch files - should include '1.a' and end 'patch'. Example rolls: +- You'll be rolling a 1.a.b release with b>0, so for the magic revision + argument pass the magic revision of 1.a.c where c=b-1. (The magic revision + is the tag's copyfrom revision, which you can find by running 'svn log -v' + on the 1.a.c tag. It is also the value of SVN_VER_REVISION in the tagged + sources.) Run 'release.py roll' and pass '--patch DIR' where DIR contains + the CVE and CHANGES patches. The names of the patch files should include + '1.a' and end 'patch'. Example rolls: release.py roll --patch .../security/CVE-2017-9800 1.8.19 1800620 release.py roll --patch .../security/CVE-2017-9800 1.9.7 1800392 ]]] However, if there's a reason this term should be more widely used and defined in HACKING, let me know... Cheers, Nathan
