Skip to content

Commit

Permalink
nixos: Document option description changes
Browse files Browse the repository at this point in the history
This adds a release notes entry to make users (and especially
developers) aware so they no longer need to use </para><para> in option
descriptions as this is now done automatically on every two consecutive
newlines.

More details can be found in the commit message of f865d0f.

Signed-off-by: aszlig <aszlig@nix.build>
(cherry picked from commit 4652f2f)
  • Loading branch information
aszlig committed Sep 2, 2018
1 parent 0d3cfcb commit ee2463c
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions nixos/doc/manual/release-notes/rl-1809.xml
Expand Up @@ -528,6 +528,14 @@ inherit (pkgs.nixos {
to <literal>true</literal>.
</para>
</listitem>
<listitem>
<para>
NixOS option descriptions are now automatically broken up into individual
paragraphs if the text contains two consecutive newlines, so it's no
longer necessary to use <code>&lt;/para&gt;&lt;para&gt;</code> to start
a new paragraph.
</para>
</listitem>
</itemizedlist>
</section>
</section>

0 comments on commit ee2463c

Please sign in to comment.