about summary refs log tree commit diff
path: root/doc
diff options
context:
space:
mode:
authorEelco Dolstra <eelco.dolstra@logicblox.com>2013-03-07T22·55+0100
committerEelco Dolstra <eelco.dolstra@logicblox.com>2013-03-07T22·55+0100
commit28bba8c44f484eae38e8a15dcec73cfa999156f6 (patch)
treef5e009a14192dc56a741703d08c622cf7236dc5b /doc
parent8057a192e3254c936fa0bcb5715e09600a28e8f8 (diff)
Prevent config.h from being clobbered
Diffstat (limited to 'doc')
-rw-r--r--doc/dev/release-procedures.txt33
-rw-r--r--doc/manual/builtins.xml12
-rw-r--r--doc/manual/opt-common.xml9
-rw-r--r--doc/manual/release-notes.xml57
4 files changed, 37 insertions, 74 deletions
diff --git a/doc/dev/release-procedures.txt b/doc/dev/release-procedures.txt
new file mode 100644
index 000000000000..1e95a9ee9aca
--- /dev/null
+++ b/doc/dev/release-procedures.txt
@@ -0,0 +1,33 @@
+To produce a `stable' release from the trunk:
+
+-1. Update the release notes; make sure that the release date is
+    correct.
+
+0. Make sure that the trunk builds in the release supervisor.
+
+1. Branch the trunk, e.g., `svn cp .../trunk
+   .../branches/0.5-release'.
+
+2. Switch to the branch, e.g., `svn switch .../branches/0.5-release'.
+
+3. In `configure.ac', change `STABLE=0' into `STABLE=1' and commit.
+
+4. In the release supervisor, add a one-time job to build
+   `.../branches/0.5-release'.
+
+5. Make sure that the release succeeds.
+
+6. Move the branch to a tag, e.g., `svn mv .../branches/0.5-release
+   .../tags/0.5'.
+
+   Note that the branch should not be used for maintenance; it should
+   be deleted after the release has been created.  A maintenance
+   branch (e.g., `.../branches/0.5') should be created from the
+   original revision of the trunk (since maintenance releases should
+   also be tested first; hence, we cannot have `STABLE=1').  The same
+   procedure can then be followed to produce maintenance releases;
+   just substitute `.../branches/VERSION' for the trunk.
+
+7. Switch back to the trunk.
+
+8. Bump the version number in `configure.ac' (in AC_INIT).
diff --git a/doc/manual/builtins.xml b/doc/manual/builtins.xml
index b75f58e21f1b..9f5f4438ce55 100644
--- a/doc/manual/builtins.xml
+++ b/doc/manual/builtins.xml
@@ -302,18 +302,6 @@ stdenv.mkDerivation {
   </varlistentry>
 
 
-  <varlistentry><term><function>builtins.hashString</function>
-  <replaceable>type</replaceable> <replaceable>s</replaceable></term>
-
-    <listitem><para>Return a base-16 representation of the
-    cryptographic hash of string <replaceable>s</replaceable>.  The
-    hash algorithm specified by <replaceable>type</replaceable> must
-    be one of <literal>"md5"</literal>, <literal>"sha1"</literal> or
-    <literal>"sha256"</literal>.</para></listitem>
-
-  </varlistentry>
-
-
   <varlistentry><term><function>builtins.head</function>
   <replaceable>list</replaceable></term>
 
diff --git a/doc/manual/opt-common.xml b/doc/manual/opt-common.xml
index 329345773dd8..72971bd6a7d5 100644
--- a/doc/manual/opt-common.xml
+++ b/doc/manual/opt-common.xml
@@ -343,11 +343,10 @@
 
 <varlistentry><term><option>-I</option> <replaceable>path</replaceable></term>
   
-  <listitem><para>Add a path to the Nix expression search path.  This
-  option may be given multiple times.  See the <envar>NIX_PATH</envar>
-  environment variable for information on the semantics of the Nix
-  search path.  Paths added through <option>-I</option> take
-  precedence over <envar>NIX_PATH</envar>.</para></listitem>
+  <listitem><para>Add a path to the Nix expression search path.  See
+  the <envar>NIX_PATH</envar> environment variable for details.  Paths
+  added through <option>-I</option> take precedence over
+  <envar>NIX_PATH</envar>.</para></listitem>
   
 </varlistentry>
 
diff --git a/doc/manual/release-notes.xml b/doc/manual/release-notes.xml
index a078be83d5ab..e7e9bf3c5b43 100644
--- a/doc/manual/release-notes.xml
+++ b/doc/manual/release-notes.xml
@@ -8,63 +8,6 @@
 
 <!--==================================================================-->
 
-<section xml:id="ssec-relnotes-1.5.1"><title>Release 1.5.1 (February 28, 2013)</title>
-
-<para>The bug fix to the bug fix had a bug itself, of course.  But
-this time it will work for sure!</para>
-
-</section>
-
-
-<!--==================================================================-->
-
-<section xml:id="ssec-relnotes-1.5"><title>Release 1.5 (February 27, 2013)</title>
-
-<para>This is a brown paper bag release to fix a regression introduced
-by the hard link security fix in 1.4.</para>
-
-</section>
-
-
-<!--==================================================================-->
-
-<section xml:id="ssec-relnotes-1.4"><title>Release 1.4 (February 26, 2013)</title>
-
-<para>This release fixes a security bug in multi-user operation.  It
-was possible for derivations to cause the mode of files outside of the
-Nix store to be changed to 444 (read-only but world-readable) by
-creating hard links to those files (<link
-xlink:href="https://github.com/NixOS/nix/commit/5526a282b5b44e9296e61e07d7d2626a79141ac4">details</link>).</para>
-
-<para>There are also the following improvements:</para>
-
-<itemizedlist>
-
-  <listitem><para>New built-in function:
-  <function>builtins.hashString</function>.</para></listitem>
-
-  <listitem><para>Build logs are now stored in
-  <filename>/nix/var/log/nix/drvs/<replaceable>XX</replaceable>/</filename>,
-  where <replaceable>XX</replaceable> is the first two characters of
-  the derivation.  This is useful on machines that keep a lot of build
-  logs (such as Hydra servers).</para></listitem>
-
-  <listitem><para>The function <function>corepkgs/fetchurl</function>
-  can now make the downloaded file executable.  This will allow
-  getting rid of all bootstrap binaries in the Nixpkgs source
-  tree.</para></listitem>
-
-  <listitem><para>Language change: The expression <literal>"${./path}
-  ..."</literal> now evaluates to a string instead of a
-  path.</para></listitem>
-
-</itemizedlist>
-
-</section>
-
-
-<!--==================================================================-->
-
 <section xml:id="ssec-relnotes-1.3"><title>Release 1.3 (January 4, 2013)</title>
 
 <para>This is primarily a bug fix release.  When this version is first