[Nix-dev] Breaking changes log

[Wout Mertens]

Mikey, well given Eelco's comment it seems best to generate a CHANGELOG.md
from the XML file, but then I wonder if we should have one at all (apart
from the nice location).

The goals would be:

   - Allow programmatic extraction of important changes between the current
   nixos system and the one that will be activated
   - Presenting those in a readable way
   - Automatically having a list of changes for when the next release hits.

So we'd need an XML grammar with the types of things we'd want to say...

Wout.

On Fri Dec 19 2014 at 3:22:10 PM Mikey Ariel <mikeymay972 at gmail.com> wrote:

> Maybe we can think of a way to single-source (as in port the source
> changes into two outputs, the .md file and the release notes)?
>
> I'll be happy to help if I can :-)
>
>
>
> > On 19 Dec 2014, at 15:15, Eelco Dolstra <eelco.dolstra at logicblox.com>
> wrote:
> >
> > Hi,
> >
> >> On 19/12/14 15:10, Wout Mertens wrote:
> >>
> >>    We already have a place to document breaking changes, namely the
> NixOS release
> >>    notes in nixos/doc/manual/release-__notes. I'm not in favour of
> having multiple,
> >>    out-of-sync locations to keep this info.
> >>
> >>
> >> Right, but those are not very human-readable nor is there any attempt
> to make
> >> them machine-parseable (for displaying diffs from nixos-rebuild and
> tests).
> >
> > It's probably a lot easier and well-defined to generate something from
> XML than
> > from some poorly specified, ad-hoc Markdown-like language.
> >
> > --
> > Eelco Dolstra | LogicBlox, Inc. | http://nixos.org/~eelco/
> > _______________________________________________
> > nix-dev mailing list
> > nix-dev at lists.science.uu.nl
> > http://lists.science.uu.nl/mailman/listinfo/nix-dev
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://lists.science.uu.nl/pipermail/nix-dev/attachments/20141219/da0e3883/attachment-0001.html