Skip to content

Commit

Permalink
nixpkgs docs: format
Browse files Browse the repository at this point in the history
  • Loading branch information
grahamc committed Oct 4, 2018
1 parent 4a0da7f commit e13c208
Show file tree
Hide file tree
Showing 9 changed files with 612 additions and 613 deletions.
7 changes: 4 additions & 3 deletions doc/cross-compilation.xml
Expand Up @@ -47,9 +47,10 @@

<para>
In Nixpkgs, these three platforms are defined as attribute sets under the
names <literal>buildPlatform</literal>, <literal>hostPlatform</literal>, and
<literal>targetPlatform</literal>. They are always defined as attributes in
the standard environment. That means one can access them like:
names <literal>buildPlatform</literal>, <literal>hostPlatform</literal>,
and <literal>targetPlatform</literal>. They are always defined as
attributes in the standard environment. That means one can access them
like:
<programlisting>{ stdenv, fooDep, barDep, .. }: ...stdenv.buildPlatform...</programlisting>
.
</para>
Expand Down
1 change: 0 additions & 1 deletion doc/functions.xml
Expand Up @@ -7,7 +7,6 @@
The nixpkgs repository has several utility functions to manipulate Nix
expressions.
</para>

<xi:include href="functions/overrides.xml" />
<xi:include href="functions/generators.xml" />
<xi:include href="functions/debug.xml" />
Expand Down
30 changes: 15 additions & 15 deletions doc/functions/debug.xml
Expand Up @@ -2,20 +2,20 @@
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:xi="http://www.w3.org/2001/XInclude"
xml:id="sec-debug">
<title>Debugging Nix Expressions</title>
<title>Debugging Nix Expressions</title>

<para>
Nix is a unityped, dynamic language, this means every value can potentially
appear anywhere. Since it is also non-strict, evaluation order and what
ultimately is evaluated might surprise you. Therefore it is important to be
able to debug nix expressions.
</para>
<para>
Nix is a unityped, dynamic language, this means every value can potentially
appear anywhere. Since it is also non-strict, evaluation order and what
ultimately is evaluated might surprise you. Therefore it is important to be
able to debug nix expressions.
</para>

<para>
In the <literal>lib/debug.nix</literal> file you will find a number of
functions that help (pretty-)printing values while evaluation is runnnig.
You can even specify how deep these values should be printed recursively,
and transform them on the fly. Please consult the docstrings in
<literal>lib/debug.nix</literal> for usage information.
</para>
</section>
<para>
In the <literal>lib/debug.nix</literal> file you will find a number of
functions that help (pretty-)printing values while evaluation is runnnig. You
can even specify how deep these values should be printed recursively, and
transform them on the fly. Please consult the docstrings in
<literal>lib/debug.nix</literal> for usage information.
</para>
</section>

0 comments on commit e13c208

Please sign in to comment.