From 8a08813d6c92e583d9ed6ccaffc80effe0dc9669 Mon Sep 17 00:00:00 2001 From: Eelco Dolstra Date: Fri, 11 May 2012 17:39:06 -0400 Subject: [PATCH] Manual updates --- doc/manual/installation.xml | 38 +++++----- doc/manual/introduction.xml | 42 +++++------ doc/manual/manual.xml | 5 +- doc/manual/quick-start.xml | 17 +++-- doc/manual/style.css | 6 +- doc/manual/writing-nix-expressions.xml | 99 ++++++++++++++++++++------ 6 files changed, 132 insertions(+), 75 deletions(-) diff --git a/doc/manual/installation.xml b/doc/manual/installation.xml index 5e29abe9f..959a950ea 100644 --- a/doc/manual/installation.xml +++ b/doc/manual/installation.xml @@ -15,11 +15,11 @@ Linux (particularly on x86, x86_64, and PowerPC). - Mac OS X, both on Intel and - PowerPC. + Mac OS X. FreeBSD (only tested on Intel). + @@ -47,7 +48,7 @@ for Red Hat, SuSE, and Fedora Core are also available. Alternatively, the most recent sources of Nix can be obtained from its git +xlink:href="https://github.com/NixOS/nix">Git repository. For example, the following command will check out the latest revision into a directory called nix: @@ -56,8 +57,8 @@ the latest revision into a directory called $ git clone https://github.com/NixOS/nix Likewise, specific releases can be obtained from the tags - of the repository. +xlink:href="https://github.com/NixOS/nix/tags">tags of the +repository. @@ -85,9 +86,9 @@ installed, including development headers and libraries. If your distribution does not provide these, you can obtain bzip2 from . -Nix requires the SQLite embedded database library. If your -distribution does not provide it, please install it from . +Nix requires the SQLite embedded database library, version +3.6.19 or higher. If your distribution does not provide it, please +install it from . Nix requires the Perl DBI and DBD::SQLite libraries, which are available from CPAN @@ -109,21 +110,20 @@ xlink:href="http://docbook.sourceforge.net/projects/xsl/">DocBook XSL stylesheets and optionally the DocBook 5.0 RELAX NG schemas. Note that these are only required if you modify the -manual sources or when you are building from the Subversion +manual sources or when you are building from the Git repository. To build the parser, very recent versions of Bison and Flex are required. (This is because Nix needs GLR support in Bison and reentrancy support in Flex.) For Bison, you need version 2.3 or higher (1.875 does not work), -which can be obtained from -the GNU FTP -server. For Flex, you need version 2.5.33, which is available -on SourceForge. -Slightly older versions may also work, but ancient versions like the -ubiquitous 2.5.4a won't. Note that these are only required if you -modify the parser or when you are building from the Subversion -repository. +which can be obtained from the GNU FTP server. +For Flex, you need version 2.5.33, which is available on SourceForge. Slightly +older versions may also work, but ancient versions like the ubiquitous +2.5.4a won't. Note that these are only required if you modify the +parser or when you are building from the Git repository. @@ -140,8 +140,8 @@ $ make install -When building from the Subversion repository, these should be -preceded by the command: +When building from the Git repository, these should be preceded +by the command: $ ./bootstrap.sh diff --git a/doc/manual/introduction.xml b/doc/manual/introduction.xml index bdd71e5c3..5641d110b 100644 --- a/doc/manual/introduction.xml +++ b/doc/manual/introduction.xml @@ -17,10 +17,10 @@ store, usually the directory subdirectory such as -/nix/store/r8vvq9kq18pz08v249h8my6r9vs7s0n3-firefox-2.0.0.1/ +/nix/store/nlc4z5y1hm8w9s8vm6m1f5hy962xjmp5-firefox-12.0 -where r8vvq9kq… is a unique identifier for the +where nlc4z5… is a unique identifier for the package that captures all its dependencies (it’s a cryptographic hash of the package’s build dependency graph). This enables many powerful features. @@ -72,15 +72,14 @@ sounds risky, but it works extremely well. Multi-user support -Starting at version 0.11, Nix has multi-user support. This -means that non-privileged users can securely install software. Each -user can have a different profile, a set of -packages in the Nix store that appear in the user’s -PATH. If a user installs a package that another user -has already installed previously, the package won’t be built or -downloaded a second time. At the same time, it is not possible for -one user to inject a Trojan horse into a package that might be used by -another user. +Nix has multi-user support. This means that non-privileged +users can securely install software. Each user can have a different +profile, a set of packages in the Nix store that +appear in the user’s PATH. If a user installs a +package that another user has already installed previously, the +package won’t be built or downloaded a second time. At the same time, +it is not possible for one user to inject a Trojan horse into a +package that might be used by another user.