Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

doc: improve 20.09 release notes #101874

Merged
merged 2 commits into from Oct 28, 2020
Merged

doc: improve 20.09 release notes #101874

merged 2 commits into from Oct 28, 2020

Conversation

davidak
Copy link
Member

@davidak davidak commented Oct 27, 2020 •
edited

Motivation for this change

the release notes had the same issue as mentioned in NixOS/nixos-homepage#619 (comment)

cc @jonringer

Things done
  • Tested using sandboxing (nix.useSandbox on NixOS, or option sandbox in nix.conf on non-NixOS linux)
  • Built on platform(s)
    • NixOS
    • macOS
    • other Linux distributions
  • Tested via one or more NixOS test(s) if existing and applicable for the change (look inside nixos/tests)
  • Tested compilation of all pkgs that depend on this change using nix-shell -p nixpkgs-review --run "nixpkgs-review wip"
  • Tested execution of all binary files (usually in ./result/bin/)
  • Determined the impact on package closure size (by running nix path-info -S before and after)
  • Ensured that relevant documentation is up to date
  • Fits CONTRIBUTING.md.

@davidak
Copy link
Member Author

davidak commented Oct 27, 2020

I was unable to edit the Backward Incompatibilities and Other Notable Changes sections since adding a <br /> to the text let the whole thing explode.

[davidak@gaming:~/code/nixpkgs]$ nix-build nixos/release.nix -A manual.x86_64-linux
these derivations will be built:
  /nix/store/1nly4qw4472mrc04dxfkkr9nwcvsf09n-options-docbook.xml.drv
  /nix/store/bvh9radbcynq2vwv8vldr1chn2bkbhch-generated-docbook.drv
  /nix/store/2brvdhbwy8yasagk2hrpv82id1d1b3pj-nixos-manual-combined.drv
  /nix/store/pafbf1k4nq2hbrb9w5gawqzzf3ghmsqk-manual-olinkdb.drv
  /nix/store/7ryxaplv8m3z25v4y7h6w4hydbnca0rj-nixos-manual-html.drv
building '/nix/store/1nly4qw4472mrc04dxfkkr9nwcvsf09n-options-docbook.xml.drv'...
building '/nix/store/bvh9radbcynq2vwv8vldr1chn2bkbhch-generated-docbook.drv'...
building '/nix/store/2brvdhbwy8yasagk2hrpv82id1d1b3pj-nixos-manual-combined.drv'...

manual-combined.xml:85624: element itemizedlist: Relax-NG validity error : Expecting an element listitem, got nothing
 85620      <para>
 85621         Services:
 85622      </para>
 85623      <itemizedlist>
 85624       <listitem>
 85625        <para>
 85626         <xref linkend="opt-services.ankisyncd.enable"/> Anki sync server

manual-combined.xml:85162: element section: Relax-NG validity error : Did not expect element section there
 85158    This section lists the release notes for each stable version of NixOS and
 85159    current unstable revision.
 85160   </para>
 85161   <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" version="5.0" xml:id="sec-release-21.03">
 85162   <title>Release 21.03 (&#x201C;Okapi&#x201D;, 2021.03/??)</title>
 85163
 85164   <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" version="5.0" xml:id="sec-release-21.03-highlights">

manual-combined.xml:85162: element section: Relax-NG validity error : Element appendix has extra content: section
 85158    This section lists the release notes for each stable version of NixOS and
 85159    current unstable revision.
 85160   </para>
 85161   <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" version="5.0" xml:id="sec-release-21.03">
 85162   <title>Release 21.03 (&#x201C;Okapi&#x201D;, 2021.03/??)</title>
 85163
 85164   <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" version="5.0" xml:id="sec-release-21.03-highlights">

manual-combined.xml:3: element info: Relax-NG validity error : Element book has extra content: info
     1  <?xml version="1.0"?>
     2  <book xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" version="5.0" xml:id="book-nixos-manual">
     3   <info>
     4    <title>NixOS Manual</title>
     5    <subtitle>Version 21.03
     6    </subtitle>
     7   </info>

manual-combined.xml fails to validate
builder for '/nix/store/2brvdhbwy8yasagk2hrpv82id1d1b3pj-nixos-manual-combined.drv' failed with exit code 3
cannot build derivation '/nix/store/7ryxaplv8m3z25v4y7h6w4hydbnca0rj-nixos-manual-html.drv': 1 dependencies couldn't be built
error: build of '/nix/store/7ryxaplv8m3z25v4y7h6w4hydbnca0rj-nixos-manual-html.drv' failed

@jonringer
Copy link
Contributor

I saw #101871 first, do you mind rebasing

@davidak
Copy link
Member Author

davidak commented Oct 27, 2020

@jonringer done

@jonringer
Copy link
Contributor

thanks!

@jonringer jonringer merged commit f175726 into NixOS:master Oct 28, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
6.topic: nixos 8.has: changelog 8.has: documentation 8.has: module (update) 10.rebuild-darwin: 0 10.rebuild-linux: 1-10 10.rebuild-linux: 1
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@davidak @jonringer