[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

Bug#459427: changelog vs. NEWS handling



On Thu, 30 Nov 2017 20:45:51 -0800, Russ Allbery wrote:

> I think
> the most valuable starting point would to be to standardize on
> /usr/share/doc/package/NEWS.gz for the human-readable summary and
> explicitly say to never install that as
> /usr/share/doc/package/changelog.gz.  

That would mean that we have to manually add something to d/rules for
thousands of perl packages in order to make ChangeLog, Changes etc.
getting installed as /usr/share/doc/package/NEWS.gz.
(Unless dh_installchangelogs gets some logic to install ChangeLog,
Changes etc. as NEWS.gz if there is no NEWS in the upstream tarball.
But that might be confusing …)


On Fri, 01 Dec 2017 13:34:01 -0700, Sean Whitton wrote:

> We can at least make dh_installchangelogs capable of installing both
> changelog.gz and NEWS.gz before we change Policy.  Otherwise, fixing the
> minor bugs is significantly more annoying.

Ack, this would be a good start.
 
> If we are going to add something that says that upstream NEWS/release
> notes should also be installed, why not standardise on the location?  It
> seems odd to have a standard location for upstream changelogs but not
> for upstream NEWS/release notes.
> 
> Or perhaps we should drop the standard location for upstream changelogs.
 
Having some standardization makes it easier for both users and their
tools to quickly find what they are looking for. But yeah, I think we
have at least 2 problems in this area:
- no single standard on the upstream side (c.f. the GNU style vs. the
  CPAN style(s))
- needed changes in our tooling (dh_installchangelogs)

And we have 2 questions to answer:
1) Which files to install?
2) Under what name?

What policy could say is:
1) - If there is a human-facing summary, install it.
   - If there is a human-facing summary and a VCS-style log, install
     the former but not the latter.
   - If there is no human-facing summary but a a VCS-style log,
     consider installing the latter.
   (Without mentioning file names, or maybe as examples, as they are
   not standardized).
2) Install NEWS as /usr/share/doc/package/NEWS.gz and /Change.*/i as
   /usr/share/doc/package/changelog.gz if you install them.
   (That's also something dh_installchangelogs could do easily.)


Cheers,
gregor

-- 
 .''`.  https://info.comodo.priv.at -- Debian Developer https://www.debian.org
 : :' : OpenPGP fingerprint D1E1 316E 93A7 60A8 104D  85FA BB3A 6801 8649 AA06
 `. `'  Member VIBE!AT & SPI Inc. -- Supporter Free Software Foundation Europe
   `-   NP: Jim Croce: Time In A Bottle

Attachment: signature.asc
Description: Digital Signature


Reply to: