patchFreeciv - Patches: patch #3488, Reinstate useful NEWS in tarball

 
 
Show feedback again

patch #3488: Reinstate useful NEWS in tarball

Submitted by:  Jacob Nevins <jtn>
Submitted on:  Wed 08 Aug 2012 07:54:34 PM UTC  
 
Category: docsPriority: 5 - Normal
Status: DonePrivacy: Public
Assigned to: Jacob Nevins <jtn>Open/Closed: Closed
Planned Release: 2.3.3,2.4.0-beta1,2.5.0

Add a New Comment (Rich MarkupRich Markup):
   

You are not logged in

Please log in, so followups can be emailed to you.

 

(Jump to the original submission Jump to the original submission)

Tue 04 Dec 2012 09:02:13 PM UTC, SVN revision 22052:

Add a NEWS-2.3 file for minor revisions within the 2.3 series.
Content comes from wiki and covers releases up to 2.3.2 so far.

See gna patch #3488.

(Browse SVN revision 22052)

Jacob Nevins <jtn>
Project AdministratorIn charge of this item.
Tue 04 Dec 2012 09:01:52 PM UTC, SVN revision 22051:

Add a NEWS-2.4 file for minor revisions within the 2.4 series.
(Placeholder so far as there have not been any such releases yet.)

See gna patch #3488.

(Browse SVN revision 22051)

Jacob Nevins <jtn>
Project AdministratorIn charge of this item.
Sat 01 Dec 2012 02:08:42 PM UTC, comment #7:

Finishing this off:

Attached patches for S2_3 and S2_4 that add a NEWS-2.3/2.4 file respectively to each branch.
S2_3:NEWS-2.3 includes news from 2.3.0-beta2 up to 2.3.2 (I will add 2.3.3 news later, as part of release process).
S2_4:NEWS-2.4 is a placeholder (will add 2.4.0-beta2 news when available).

Trunk is left alone; the idea is that this file is created on a S2_x branch after it diverges from trunk, probably in fact after the first beta (since it will have no content in the first beta).

Still to do: update checklists at http://freeciv.wikia.com/wiki/Release to reflect the need to create/update these.

For avoidance of doubt: a given branch contains only one NEWS-2.x file; for minor NEWS from previous major releases you'll have to go to previous tarballs or version control (or ChangeLog).

> About NEWS of minor version never making it to TRUNK: What
> about your policy of making 2.b.0 NEWS relative to 2.a.x,
> not 2.a.0? What happens to NEWS between 2.a.0 and 2.a.x?

It's true that from the latest tarball you won't be able to trace fine-grained history back indefinitely.

There will now be three threads of news in the tarballs:

  • NEWS which only tracks major changes and is good for following the broad evolution of Freeciv; good for people upgrading between major versions who don't want to drown in detail. To a first approximation, the description of 2.b.0 in NEWS is relative to any 2.a.x, because changes major enough to be worth mentioning in NEWS are unlikely to happen in a 2.a.x minor release.
    • (If we did make such a major change, we could promote it to the NEWS file, in theory.)
  • NEWS-2.x which accounts for every change between minor releases, but only goes back to the start of the major branch. This is good for people upgrading within a major version to see what's changed.
    • (We could keep all previous NEWS-2.x around, but keeping them in sync across branches would be complex and error-prone, and I'm already complicating release management enough.)
  • ChangeLog, which tracks every code change, but does not provide the context, rationale, and synthesis that NEWS-2.x does.

This setup does not answer all possible questions; serious archaeologists will have to go back to old releases, either via tarballs or via version control (as they would to find the associated code).

> (On a related note, have you thought about someone using 2.a.2
> upgrading to 2.b.1 when 2.b.0 NEWS is relative to 2.a.3 and
> since then also 2.a.4 has been released)

I think the benefit from trying to answer this question is not worth the complication that it would introduce to a textual NEWS format. As above, NEWS is coarse-grained enough that it shouldn't really matter.

(In general, what is different between 2.a.2 and 2.b.1 is a hard question to answer at a higher level than diff'ing the code; its tractability depends mainly on our (developers') sanity in backporting changes and not making a fix for the same bug gratuitously different on different branches. The NEWS structure follows the "grain" in this respect.)

(file #16816, file #16817)

Jacob Nevins <jtn>
Project AdministratorIn charge of this item.
Fri 10 Aug 2012 09:40:09 AM UTC, comment #6:

Committed initial NEWS to be ready for 2.4.0-beta1, but leaving ticket open to answer remaining questions.

Jacob Nevins <jtn>
Project AdministratorIn charge of this item.
Fri 10 Aug 2012 09:38:40 AM UTC, SVN revision 21776:

Reinstate NEWS as more than a pointer; restore old information from svn
(r13819) and scrape information for newer major releases from wiki.

See gna patch #3488.

(Browse SVN revision 21776)

Jacob Nevins <jtn>
Project AdministratorIn charge of this item.
Fri 10 Aug 2012 09:37:56 AM UTC, SVN revision 21774:

Reinstate NEWS as more than a pointer; restore old information from svn
(r13819) and scrape information for newer major releases from wiki.

See gna patch #3488.

(Browse SVN revision 21774)

Jacob Nevins <jtn>
Project AdministratorIn charge of this item.
Fri 10 Aug 2012 09:37:10 AM UTC, SVN revision 21772:

Reinstate NEWS as more than a pointer; restore old information from svn
(r13819) and scrape information for newer major releases from wiki.

See gna patch #3488.

(Browse SVN revision 21772)

Jacob Nevins <jtn>
Project AdministratorIn charge of this item.
Thu 09 Aug 2012 01:00:24 AM UTC, comment #2:

> to gather comments (if any)


YAY!

> It bothers me that the distribution is not self-contained


That's why I were against removing them from under version control in the first place. Also, latest version in wiki is just one version - in theory any documentation under version control should be in sync with the code.

About NEWS of minor version never making it to TRUNK: What about your policy of making 2.b.0 NEWS relative to 2.a.x, not 2.a.0? What happens to NEWS between 2.a.0 and 2.a.x? (On a related note, have you thought about someone using 2.a.2 upgrading to 2.b.1 when 2.b.0 NEWS is relative to 2.a.3 and since then also 2.a.4 has been released)

Marko Lindqvist <cazfi>
Project Administrator
Wed 08 Aug 2012 08:34:56 PM UTC, comment #1:

Attached are the NEWS files I intend to commit to trunk/S2_4 (NEWS-2.4) and S2_3 (NEWS-2.3), containing all the old NEWS retrieved from svn and wiki. Also the script I hacked from generate_FAQ.pl to scrape wiki (which isn't quite polished/automatic enough to commit to svn yet).

Obviously the S2_4 one may still change; I expect NEWS updates to normally be outside the review cycle, like other release-related commits. I'm leaving this here for the 36h to gather comments (if any) on this approach.

(file #16348, file #16349, file #16350)

Jacob Nevins <jtn>
Project AdministratorIn charge of this item.
Wed 08 Aug 2012 07:54:34 PM UTC, original submission:

In PR#39775 / r13825, the NEWS file in the distribution has been a stub pointing at wiki.

It bothers me that the distribution is not self-contained; I'd rather that the history was available to anyone who has the tarball, for years to come, without dependence on external entities like Wikia remaining viable. This is mainly an extra chore for the release manager, and well, that's me for now :)

My plan is to continue to prepare the NEWS file on wiki, and leave a copy there, but to scrape it at release time using a script similar to the generate_FAQ.pl scraper and put that in the NEWS file in svn / tarball.

Possibly I'll only do this for major releases; not sure. NEWS between minor releases will at most live in that branch's tarballs, not forever, I think.

Jacob Nevins <jtn>
Project AdministratorIn charge of this item.

 

(Note: upload size limit is set to 1024 kB, after insertion of the required escape characters.)

Attach File(s):
   
   
Comment:
   

Attached Files
file #16818:  fetchnews.pl added by jtn (3kB - application/x-perl - Updated scraper script. Still revoltingly hacky.)
file #16816:  S2_3-minor-news.patch added by jtn (42kB - text/x-patch - S2_3/S2_4 r22036: add NEWS-2.x files for minor revisions)
file #16817:  S2_4-minor-news.patch added by jtn (2kB - text/x-patch - S2_3/S2_4 r22036: add NEWS-2.x files for minor revisions)
file #16348:  NEWS-2.4 added by jtn (69kB - application/octet-stream - Updated NEWS files and scraper script)
file #16349:  NEWS-2.3 added by jtn (51kB - application/octet-stream - Updated NEWS files and scraper script)
file #16350:  fetchnews.pl added by jtn (3kB - application/x-perl - Updated NEWS files and scraper script)

 

Depends on the following items: None found

Items that depend on this one: None found

 

Carbon-Copy List
  • -unavailable- added by cazfi (Posted a comment)
  • -unavailable- added by jtn (Submitted the item)
  •  

    Do you think this task is very important?
    If so, you can click here to add your encouragement to it.
    This task has 0 encouragements so far.

    Only logged-in users can vote.

     

    Please enter the title of George Orwell's famous dystopian book (it's a date):

     

     

    Follow 11 latest changes.

    Date Changed By Updated Field Previous Value => Replaced By
    Tue 04 Dec 2012 09:02:42 PM UTCjtnStatusReady For Test=>Done
      Open/ClosedOpen=>Closed
    Sat 01 Dec 2012 02:09:19 PM UTCjtnAttached File-=>Added fetchnews.pl, #16818
    Sat 01 Dec 2012 02:08:42 PM UTCjtnAttached File-=>Added S2_3-minor-news.patch, #16816
      Attached File-=>Added S2_4-minor-news.patch, #16817
      StatusDone=>Ready For Test
    Fri 10 Aug 2012 09:40:09 AM UTCjtnStatusReady For Test=>Done
    Wed 08 Aug 2012 08:34:56 PM UTCjtnAttached File-=>Added NEWS-2.4, #16348
      Attached File-=>Added NEWS-2.3, #16349
      Attached File-=>Added fetchnews.pl, #16350
      StatusIn Progress=>Ready For Test
    Show feedback again

    Back to the top


    Powered by Savane 3.1-cleanup