[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
370/376: Delete the stdenv section
From: |
Ludovic Courtès |
Subject: |
370/376: Delete the stdenv section |
Date: |
Wed, 28 Jan 2015 22:06:15 +0000 |
civodul pushed a commit to tag 1.8
in repository guix.
commit 68b47178730a95871eba4aa4df19a845c8e5a947
Author: Eelco Dolstra <address@hidden>
Date: Sun Dec 14 01:39:32 2014 +0100
Delete the stdenv section
It's outdated and better covered in the Nixpkgs manual.
---
doc/manual/expressions/custom-builder.xml | 26 ---------
doc/manual/expressions/debug-build.xml | 17 +++---
doc/manual/expressions/derivations.xml | 14 ++--
doc/manual/expressions/generic-builder.xml | 4 +-
doc/manual/expressions/simple-building-testing.xml | 4 +-
doc/manual/expressions/standard-env.xml | 60 --------------------
doc/manual/expressions/writing-nix-expressions.xml | 1 -
7 files changed, 21 insertions(+), 105 deletions(-)
diff --git a/doc/manual/expressions/custom-builder.xml
b/doc/manual/expressions/custom-builder.xml
deleted file mode 100644
index c26deac..0000000
--- a/doc/manual/expressions/custom-builder.xml
+++ /dev/null
@@ -1,26 +0,0 @@
-<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-custom-builder">
-
-<title>Customizing the Generic Builder</title>
-
-<para>The operation of the generic builder can be modified in many
-places by setting certain variables. These <emphasis>hook
-variables</emphasis> are typically set to the name of some shell
-function defined by you. For instance, to perform some additional
-steps after <command>make install</command> you would set the
-<varname>postInstall</varname> variable:
-
-<programlisting>
-postInstall=myPostInstall
-
-myPostInstall() {
- mkdir $out/share/extra
- cp extrafiles/* $out/share/extra
-}</programlisting>
-
-</para>
-
-</section>
\ No newline at end of file
diff --git a/doc/manual/expressions/debug-build.xml
b/doc/manual/expressions/debug-build.xml
index 508cb2c..0c1f4e6 100644
--- a/doc/manual/expressions/debug-build.xml
+++ b/doc/manual/expressions/debug-build.xml
@@ -6,13 +6,14 @@
<title>Debugging Build Failures</title>
-<para>At the beginning of each phase, the set of all shell variables
-is written to the file <filename>env-vars</filename> at the top-level
-build directory. This is useful for debugging: it allows you to
-recreate the environment in which a build was performed. For
-instance, if a build fails, then assuming you used the
-<option>-K</option> flag, you can go to the output directory and
-<quote>switch</quote> to the environment of the builder:
+<para>At the beginning of each phase of the build (such as unpacking,
+building or installing), the set of all shell variables is written to
+the file <filename>env-vars</filename> at the top-level build
+directory. This is useful for debugging: it allows you to recreate
+the environment in which a build was performed. For instance, if a
+build fails, then assuming you used the <option>-K</option> flag, you
+can go to the output directory and <quote>switch</quote> to the
+environment of the builder:
<screen>
$ nix-build -K ./foo.nix
@@ -30,4 +31,4 @@ $ make
</para>
-</section>
\ No newline at end of file
+</section>
diff --git a/doc/manual/expressions/derivations.xml
b/doc/manual/expressions/derivations.xml
index b57c33f..90e2786 100644
--- a/doc/manual/expressions/derivations.xml
+++ b/doc/manual/expressions/derivations.xml
@@ -110,12 +110,12 @@ buildInputs = [ pkg pkg.headers ];
</itemizedlist>
-<para>The function <function>mkDerivation</function> in the standard
-environment is a wrapper around <function>derivation</function> that
-adds a default value for <varname>system</varname> and always uses
-Bash as the builder, to which the supplied builder is passed as a
-command-line argument. See <xref linkend='sec-standard-environment'
-/>.</para>
+<para>The function <function>mkDerivation</function> in the Nixpkgs
+standard environment is a wrapper around
+<function>derivation</function> that adds a default value for
+<varname>system</varname> and always uses Bash as the builder, to
+which the supplied builder is passed as a command-line argument. See
+the Nixpkgs manual for details.</para>
<para>The builder is executed as follows:
@@ -208,4 +208,4 @@ command-line argument. See <xref
linkend='sec-standard-environment'
<xi:include href="advanced-attributes.xml" />
-</section>
\ No newline at end of file
+</section>
diff --git a/doc/manual/expressions/generic-builder.xml
b/doc/manual/expressions/generic-builder.xml
index f8567a0..db7ff40 100644
--- a/doc/manual/expressions/generic-builder.xml
+++ b/doc/manual/expressions/generic-builder.xml
@@ -71,7 +71,7 @@ genericBuild <co xml:id='ex-hello-builder2-co-3'
/></programlisting>
generic builder is smart enough to figure out whether to unpack
the sources using <command>gzip</command>,
<command>bzip2</command>, etc. It can be customised in many ways;
- see <xref linkend='sec-standard-environment' />.</para>
+ see the Nixpkgs manual for details.</para>
</callout>
@@ -95,4 +95,4 @@ In fact, <varname>mkDerivation</varname> provides a default
builder
that looks exactly like that, so it is actually possible to omit the
builder for Hello entirely.</para>
-</section>
\ No newline at end of file
+</section>
diff --git a/doc/manual/expressions/simple-building-testing.xml
b/doc/manual/expressions/simple-building-testing.xml
index cc90409..e0dd98b 100644
--- a/doc/manual/expressions/simple-building-testing.xml
+++ b/doc/manual/expressions/simple-building-testing.xml
@@ -83,4 +83,6 @@ Just pass the option <link linkend='opt-max-jobs'><option>-j
in parallel, or set. Typically this should be the number of
CPUs.</para>
-</section>
\ No newline at end of file
+<xi:include href="debug-build.xml" />
+
+</section>
diff --git a/doc/manual/expressions/standard-env.xml
b/doc/manual/expressions/standard-env.xml
deleted file mode 100644
index 2571f43..0000000
--- a/doc/manual/expressions/standard-env.xml
+++ /dev/null
@@ -1,60 +0,0 @@
-<chapter 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-standard-environment'>
-
-<title>The Standard Environment</title>
-
-
-<para>The standard environment is used by passing it as an input
-called <envar>stdenv</envar> to the derivation, and then doing
-
-<programlisting>
-source $stdenv/setup</programlisting>
-
-at the top of the builder.</para>
-
-<para>Apart from adding the aforementioned commands to the
-<envar>PATH</envar>, <filename>setup</filename> also does the
-following:
-
-<itemizedlist>
-
- <listitem><para>All input packages specified in the
- <envar>buildInputs</envar> environment variable have their
- <filename>/bin</filename> subdirectory added to <envar>PATH</envar>,
- their <filename>/include</filename> subdirectory added to the C/C++
- header file search path, and their <filename>/lib</filename>
- subdirectory added to the linker search path. This can be extended.
- For instance, when the <command>pkgconfig</command> package is
- used, the subdirectory <filename>/lib/pkgconfig</filename> of each
- input is added to the <envar>PKG_CONFIG_PATH</envar> environment
- variable.</para></listitem>
-
- <listitem><para>The environment variable
- <envar>NIX_CFLAGS_STRIP</envar> is set so that the compiler strips
- debug information from object files. This can be disabled by
- setting <envar>NIX_STRIP_DEBUG</envar> to
- <literal>0</literal>.</para></listitem>
-
-</itemizedlist>
-
-</para>
-
-<para>The <filename>setup</filename> script also exports a function
-called <function>genericBuild</function> that knows how to build
-typical Autoconf-style packages. It can be customised to perform
-builds for any type of package. It is advisable to use
-<function>genericBuild</function> since it provides facilities that
-are almost always useful such as unpacking of sources, patching of
-sources, nested logging, etc.</para>
-
-<para>The definitive, up-to-date documentation of the generic builder
-is the source itself, which resides in
-<filename>pkgs/stdenv/generic/setup.sh</filename>.</para>
-
-<xi:include href="custom-builder.xml" />
-<xi:include href="debug-build.xml" />
-
-</chapter>
\ No newline at end of file
diff --git a/doc/manual/expressions/writing-nix-expressions.xml
b/doc/manual/expressions/writing-nix-expressions.xml
index 6b797c2..6646ddd 100644
--- a/doc/manual/expressions/writing-nix-expressions.xml
+++ b/doc/manual/expressions/writing-nix-expressions.xml
@@ -22,6 +22,5 @@ manual</link>.</para></note>
<xi:include href="simple-expression.xml" />
<xi:include href="expression-language.xml" />
-<xi:include href="standard-env.xml" />
</part>
- 360/376: Style, (continued)
- 360/376: Style, Ludovic Courtès, 2015/01/28
- 365/376: Update .nixpkg description, Ludovic Courtès, 2015/01/28
- 366/376: Rename files, Ludovic Courtès, 2015/01/28
- 371/376: Merge commit '36c67860363c93eb00cf5b8e2ad34f6f775e6901', Ludovic Courtès, 2015/01/28
- 363/376: Style, Ludovic Courtès, 2015/01/28
- 376/376: Grmbl, Ludovic Courtès, 2015/01/28
- 372/376: Merge branch 'cygwin-master' of https://github.com/ternaris/nix, Ludovic Courtès, 2015/01/28
- 364/376: ReiserFS -> ext4, Ludovic Courtès, 2015/01/28
- 375/376: Add a section on nix-serve, Ludovic Courtès, 2015/01/28
- 361/376: Document channel format and excise most mentions of manifests and nix-pull, Ludovic Courtès, 2015/01/28
- 370/376: Delete the stdenv section,
Ludovic Courtès <=
- 374/376: Add section on SSH substituter, Ludovic Courtès, 2015/01/28
- 373/376: Pedantry, Ludovic Courtès, 2015/01/28
- 368/376: Fix build, Ludovic Courtès, 2015/01/28
- 369/376: Bla, Ludovic Courtès, 2015/01/28
- 294/376: Clean up temp roots in a more C++ way, Ludovic Courtès, 2015/01/28
- 287/376: Don't use ADDR_LIMIT_3GB, Ludovic Courtès, 2015/01/28
- 255/376: binary download: Use $NIX_CURL_FLAGS, Ludovic Courtès, 2015/01/28
- 301/376: 'build-cache-failures' -> 'build-cache-failure' in nix.conf documentation., Ludovic Courtès, 2015/01/28
- 275/376: Revert "Revert "Revert "Temporarily disable darwin builds while hydra's darwin is borked""", Ludovic Courtès, 2015/01/28
- 302/376: Don't claim FreeBSD support, Ludovic Courtès, 2015/01/28