summary refs log tree commit diff
path: root/doc
diff options
context:
space:
mode:
authorDomen Kožar <domen@dev.si>2015-02-15 18:22:14 +0100
committerDomen Kožar <domen@dev.si>2015-02-15 18:22:26 +0100
commitef8aaa5571b572a3bc0d45cbef6ee5e8a828e700 (patch)
tree4ecdbd11e52c3c8c4f08077250ad491aab4b563d /doc
parent59d2ab656350991e6f8010a17a6ec72b2349984c (diff)
downloadnixpkgs-ef8aaa5571b572a3bc0d45cbef6ee5e8a828e700.tar
nixpkgs-ef8aaa5571b572a3bc0d45cbef6ee5e8a828e700.tar.gz
nixpkgs-ef8aaa5571b572a3bc0d45cbef6ee5e8a828e700.tar.bz2
nixpkgs-ef8aaa5571b572a3bc0d45cbef6ee5e8a828e700.tar.lz
nixpkgs-ef8aaa5571b572a3bc0d45cbef6ee5e8a828e700.tar.xz
nixpkgs-ef8aaa5571b572a3bc0d45cbef6ee5e8a828e700.tar.zst
nixpkgs-ef8aaa5571b572a3bc0d45cbef6ee5e8a828e700.zip
fixes #5394
Diffstat (limited to 'doc')
-rw-r--r--doc/language-support.xml91
1 files changed, 45 insertions, 46 deletions
diff --git a/doc/language-support.xml b/doc/language-support.xml
index f33202d4553..5fb123ddfc1 100644
--- a/doc/language-support.xml
+++ b/doc/language-support.xml
@@ -283,24 +283,24 @@ are provided with all modules included.</para>
   <filename>pkgs/development/python-modules/generic/default.nix</filename></link>.
   Example usage:
   
-    <programlisting language="nix">
-      twisted = buildPythonPackage {
-        name = "twisted-8.1.0";
-      
-        src = pkgs.fetchurl {
-          url = http://tmrc.mit.edu/mirror/twisted/Twisted/8.1/Twisted-8.1.0.tar.bz2;
-          sha256 = "0q25zbr4xzknaghha72mq57kh53qw1bf8csgp63pm9sfi72qhirl";
-        };
-      
-        propagatedBuildInputs = [ self.ZopeInterface ];
-      
-        meta = {
-          homepage = http://twistedmatrix.com/;
-          description = "Twisted, an event-driven networking engine written in Python";
-          license = stdenv.lib.licenses.mit;
-        };
-      };
-    </programlisting>
+<programlisting language="nix">
+twisted = buildPythonPackage {
+  name = "twisted-8.1.0";
+
+  src = pkgs.fetchurl {
+    url = http://tmrc.mit.edu/mirror/twisted/Twisted/8.1/Twisted-8.1.0.tar.bz2;
+    sha256 = "0q25zbr4xzknaghha72mq57kh53qw1bf8csgp63pm9sfi72qhirl";
+  };
+
+  propagatedBuildInputs = [ self.ZopeInterface ];
+
+  meta = {
+    homepage = http://twistedmatrix.com/;
+    description = "Twisted, an event-driven networking engine written in Python";
+    license = stdenv.lib.licenses.mit;
+  };
+};
+</programlisting>
 
   Most of Python packages that use <varname>buildPythonPackage</varname> are defined
   in <link xlink:href="https://github.com/NixOS/nixpkgs/blob/master/pkgs/top-level/python-packages.nix"><filename>pkgs/top-level/python-packages.nix</filename></link>
@@ -428,16 +428,14 @@ are provided with all modules included.</para>
   <para>
     Create Python environments using low-level <function>pkgs.buildEnv</function> function. Example <filename>default.nix</filename>:
     
-    <programlisting language="nix">
-    <![CDATA[
-      with import <nixpkgs> {};
-      
-      python.buildEnv.override {
-        extraLibs = [ pkgs.pythonPackages.pyramid ];
-        ignoreCollisions = true;
-      }
-    ]]>
-    </programlisting>
+<programlisting language="nix">
+<![CDATA[with import <nixpkgs> {};
+
+python.buildEnv.override {
+  extraLibs = [ pkgs.pythonPackages.pyramid ];
+  ignoreCollisions = true;
+}]]>
+</programlisting>
     
     Running <command>nix-build</command> will create
     <filename>/nix/store/cf1xhjwzmdki7fasgr4kz6di72ykicl5-python-2.7.8-env</filename>
@@ -507,22 +505,23 @@ exist in community to help save time. No tool is preferred at the moment.
     <command>${python.interpreter} setup.py develop</command> for the package.
   </para>
   
+  <warning><para><varname>shellPhase</varname> is executed only if <filename>setup.py</filename>
+  exists.</para></warning>
+  
   <para>
     Given a <filename>default.nix</filename>:
     
-    <programlisting language="nix">
-    <![CDATA[
-      with import <nixpkgs> {};
-      
-      buildPythonPackage {
-        name = "myproject";
-      
-        buildInputs = with pkgs.pythonPackages; [ pyramid ];
-      
-        src = ./.;
-      }
-    ]]>
-    </programlisting>
+<programlisting language="nix">
+<![CDATA[with import <nixpkgs> {};
+
+buildPythonPackage {
+  name = "myproject";
+
+  buildInputs = with pkgs.pythonPackages; [ pyramid ];
+
+  src = ./.;
+}]]>
+</programlisting>
     
     Running <command>nix-shell</command> with no arguments should give you
     the environment in which the package would be build with
@@ -615,11 +614,11 @@ sed -i '/ = data_files/d' setup.py</programlisting>
 <section xml:id="ssec-language-ruby"><title>Ruby</title>
   <para>For example, to package yajl-ruby package, use gem-nix:</para>
   
-  <screen>
-    $ nix-env -i gem-nix
-    $ gem-nix --no-user-install --nix-file=pkgs/development/interpreters/ruby/generated.nix yajl-ruby
-    $ nix-build -A rubyPackages.yajl-ruby
-  </screen>
+<screen>
+$ nix-env -i gem-nix
+$ gem-nix --no-user-install --nix-file=pkgs/development/interpreters/ruby/generated.nix yajl-ruby
+$ nix-build -A rubyPackages.yajl-ruby
+</screen>
 </section>