From 53b5d946e15b7865d5aefb1bd566bca475727e7c Mon Sep 17 00:00:00 2001 From: Pascal Wittmann Date: Sun, 31 May 2015 18:41:34 +0200 Subject: [PATCH] doc: add section ids This commit also use enforces consistent use of the prefixes "sec" for section and "ssec" for subsection. --- doc/coding-conventions.xml | 6 +++--- doc/language-support.xml | 28 ++++++++++++++-------------- doc/meta.xml | 3 ++- doc/package-notes.xml | 2 +- doc/packageconfig.xml | 3 ++- doc/stdenv.xml | 30 +++++++++++++++++------------- 6 files changed, 39 insertions(+), 33 deletions(-) diff --git a/doc/coding-conventions.xml b/doc/coding-conventions.xml index 68b075959c9c..b041a73d8182 100644 --- a/doc/coding-conventions.xml +++ b/doc/coding-conventions.xml @@ -5,7 +5,7 @@ Coding conventions -
Syntax +
Syntax @@ -207,7 +207,7 @@ args.stdenv.mkDerivation (args // {
-
Package naming +
Package naming In Nixpkgs, there are generally three different names associated with a package: @@ -292,7 +292,7 @@ dashes between words — not in camel case. For instance, it should be allPackages.nix or AllPackages.nix. -
Hierarchy +
Hierarchy Each package should be stored in its own directory somewhere in the pkgs/ tree, i.e. in diff --git a/doc/language-support.xml b/doc/language-support.xml index 1e1bdf75eda5..14e8aa7a7ba4 100644 --- a/doc/language-support.xml +++ b/doc/language-support.xml @@ -13,7 +13,7 @@ in Nixpkgs to easily build packages for other programming languages, such as Perl or Haskell. These are described in this chapter. -
Perl +
Perl Nixpkgs provides a function buildPerlPackage, a generic package builder function for any Perl package that has a @@ -151,7 +151,7 @@ ClassC3Componentised = buildPerlPackage rec { -
Generation from CPAN +
Generation from CPAN Nix expressions for Perl packages can be generated (almost) automatically from CPAN. This is done by the program @@ -191,7 +191,7 @@ you need it.
-
Python +
Python Currently supported interpreters are python26, python27, @@ -276,7 +276,7 @@ are provided with all modules included. -
<varname>buildPythonPackage</varname> function +
<varname>buildPythonPackage</varname> function The function is implemented in @@ -438,7 +438,7 @@ twisted = buildPythonPackage {
-
<function>python.buildEnv</function> function +
<function>python.buildEnv</function> function Create Python environments using low-level pkgs.buildEnv function. Example default.nix: @@ -484,7 +484,7 @@ python.buildEnv.override {
-
Tools +
Tools Packages inside nixpkgs are written by hand. However many tools exist in community to help save time. No tool is preferred at the moment. @@ -511,7 +511,7 @@ exist in community to help save time. No tool is preferred at the moment.
-
Development +
Development To develop Python packages buildPythonPackage has @@ -555,7 +555,7 @@ buildPythonPackage {
-
FAQ +
FAQ @@ -597,7 +597,7 @@ sed -i '/ = data_files/d' setup.py
-
Contributing guidelines +
Contributing guidelines Following rules are desired to be respected: @@ -625,7 +625,7 @@ sed -i '/ = data_files/d' setup.py
-
Ruby +
Ruby There currently is support to bundle applications that are packaged as Ruby gems. The utility "bundix" allows you to write a Gemfile, let bundler create a Gemfile.lock, and then convert this into a nix expression that contains all Gem dependencies automatically. @@ -666,7 +666,7 @@ and scalable.";
-
Go +
Go The function buildGoPackage builds standard Go packages. @@ -787,7 +787,7 @@ done
-
Java +
Java Ant-based Java packages are typically built from source as follows: @@ -868,7 +868,7 @@ Runtime) instead of the OpenJRE.
-
Lua +
Lua Lua packages are built by the buildLuaPackage function. This function is @@ -915,7 +915,7 @@ fileSystem = buildLuaPackage {
-
Coq +
Coq Coq libraries should be installed in $(out)/lib/coq/${coq.coq-version}/user-contrib/. diff --git a/doc/meta.xml b/doc/meta.xml index a0ed3069b680..14a01ccb3c07 100644 --- a/doc/meta.xml +++ b/doc/meta.xml @@ -82,7 +82,8 @@ hello-2.3 A program that produces a familiar, friendly greeting -
Standard meta-attributes +
Standard +meta-attributes It is expected that each meta-attribute is one of the following: diff --git a/doc/package-notes.xml b/doc/package-notes.xml index 8a35e640324d..ecaf619472de 100644 --- a/doc/package-notes.xml +++ b/doc/package-notes.xml @@ -141,7 +141,7 @@ $ make menuconfig ARCH=arch -
+
X.org diff --git a/doc/packageconfig.xml b/doc/packageconfig.xml index 44ce1974c6cf..4e0fcc3b6a49 100644 --- a/doc/packageconfig.xml +++ b/doc/packageconfig.xml @@ -67,7 +67,8 @@ lib/licenses.nix of the nix package tree. -
Modify packages via <literal>packageOverrides</literal> +
Modify +packages via <literal>packageOverrides</literal> diff --git a/doc/stdenv.xml b/doc/stdenv.xml index 6fdebda09f98..58310834fd2f 100644 --- a/doc/stdenv.xml +++ b/doc/stdenv.xml @@ -15,7 +15,8 @@ environment does everything automatically. If can easily customise or override the various build phases. -
Using <literal>stdenv</literal> +
Using +<literal>stdenv</literal> To build a package with the standard environment, you use the function stdenv.mkDerivation, instead of the @@ -124,7 +125,8 @@ genericBuild
-
Tools provided by <literal>stdenv</literal> +
Tools provided by +<literal>stdenv</literal> The standard environment provides the following packages: @@ -225,7 +227,7 @@ genericBuild
-
Phases +
Phases The generic builder has a number of phases. Package builds are split into phases to make it easier to override @@ -243,7 +245,8 @@ is convenient to override a phase from the derivation, while the latter is convenient from a build script. -
Controlling phases +
Controlling +phases There are a number of variables that control what phases are executed and in what order: @@ -327,7 +330,7 @@ executed and in what order:
-
The unpack phase +
The unpack phase The unpack phase is responsible for unpacking the source code of the package. The default implementation of @@ -434,7 +437,7 @@ Additional file types can be supported by setting the
-
The patch phase +
The patch phase The patch phase applies the list of patches defined in the patches variable. @@ -477,7 +480,7 @@ Additional file types can be supported by setting the
-
The configure phase +
The configure phase The configure phase prepares the source tree for building. The default configurePhase runs @@ -573,7 +576,7 @@ script) if it exists.
-
The build phase +
The build phase The build phase is responsible for actually building the package (e.g. compiling it). The default buildPhase @@ -657,7 +660,7 @@ called, respectively.
-
The check phase +
The check phase The check phase checks whether the package was built correctly by running its test suite. The default @@ -717,7 +720,7 @@ doCheck = true;
-
The install phase +
The install phase The install phase is responsible for installing the package in the Nix store under out. The default @@ -772,7 +775,7 @@ installTargets = "install-bin install-doc";
-
The fixup phase +
The fixup phase The fixup phase performs some (Nix-specific) post-processing actions on the files installed under $out by the @@ -895,7 +898,8 @@ following:
-
The distribution phase +
The distribution +phase The distribution phase is intended to produce a source distribution of the package. The default @@ -1199,7 +1203,7 @@ echo @foo@
-
Purity in Nixpkgs +
Purity in Nixpkgs [measures taken to prevent dependencies on packages outside the store, and what you can do to prevent them]