diff options
author | Jan Tojnar <jtojnar@gmail.com> | 2020-09-23 00:38:04 +0200 |
---|---|---|
committer | Jan Tojnar <jtojnar@gmail.com> | 2020-09-23 01:25:25 +0200 |
commit | e1af37634b387e18361f15b2db1c7f7f93d37ebc (patch) | |
tree | b2d13f6759d5212216bba8e454ba0d2d41391f7e /doc/languages-frameworks | |
parent | 47297487c55762e206d53127f3b02b9c2901d31f (diff) |
doc: Improve code listings
By adding prompts and removing unnecessary indentation.
Diffstat (limited to 'doc/languages-frameworks')
-rw-r--r-- | doc/languages-frameworks/beam.xml | 6 | ||||
-rw-r--r-- | doc/languages-frameworks/perl.xml | 198 | ||||
-rw-r--r-- | doc/languages-frameworks/qt.xml | 2 | ||||
-rw-r--r-- | doc/languages-frameworks/ruby.xml | 25 | ||||
-rw-r--r-- | doc/languages-frameworks/texlive.xml | 10 |
5 files changed, 120 insertions, 121 deletions
diff --git a/doc/languages-frameworks/beam.xml b/doc/languages-frameworks/beam.xml index 1d307e1d6dcf7..addab24f7f6dd 100644 --- a/doc/languages-frameworks/beam.xml +++ b/doc/languages-frameworks/beam.xml @@ -72,9 +72,9 @@ To install any of those builders into your profile, refer to them by their attribute path <literal>beamPackages.rebar3</literal>: </para> - <screen> - <prompt>$ </prompt>nix-env -f "<nixpkgs>" -iA beamPackages.rebar3 - </screen> +<screen> +<prompt>$ </prompt>nix-env -f "<nixpkgs>" -iA beamPackages.rebar3 +</screen> </section> <section xml:id="packaging-beam-applications"> diff --git a/doc/languages-frameworks/perl.xml b/doc/languages-frameworks/perl.xml index ff0f350e99ca9..b017c028f64ca 100644 --- a/doc/languages-frameworks/perl.xml +++ b/doc/languages-frameworks/perl.xml @@ -8,28 +8,28 @@ <para> When executing a Perl script, it is possible you get an error such as <literal>./myscript.pl: bad interpreter: /usr/bin/perl: no such file or directory</literal>. This happens when the script expects Perl to be installed at <filename>/usr/bin/perl</filename>, which is not the case when using Perl from nixpkgs. You can fix the script by changing the first line to: - <programlisting> - #!/usr/bin/env perl - </programlisting> +<programlisting> +#!/usr/bin/env perl +</programlisting> to take the Perl installation from the <literal>PATH</literal> environment variable, or invoke Perl directly with: - <screen> - <prompt>$ </prompt>perl ./myscript.pl - </screen> +<screen> +<prompt>$ </prompt>perl ./myscript.pl +</screen> </para> <para> When the script is using a Perl library that is not installed globally, you might get an error such as <literal>Can't locate DB_File.pm in @INC (you may need to install the DB_File module)</literal>. In that case, you can use <command>nix-shell</command> to start an ad-hoc shell with that library installed, for instance: - <screen> - <prompt>$ </prompt>nix-shell -p perl perlPackages.DBFile --run ./myscript.pl - </screen> +<screen> +<prompt>$ </prompt>nix-shell -p perl perlPackages.DBFile --run ./myscript.pl +</screen> </para> <para> If you are always using the script in places where <command>nix-shell</command> is available, you can embed the <command>nix-shell</command> invocation in the shebang like this: - <programlisting> - #!/usr/bin/env nix-shell - #! nix-shell -i perl -p perl perlPackages.DBFile - </programlisting> +<programlisting> +#!/usr/bin/env nix-shell +#! nix-shell -i perl -p perl perlPackages.DBFile +</programlisting> </para> </section> @@ -44,30 +44,30 @@ <para> Perl packages from CPAN are defined in <link xlink:href="https://github.com/NixOS/nixpkgs/blob/master/pkgs/top-level/perl-packages.nix"><filename>pkgs/top-level/perl-packages.nix</filename></link>, rather than <filename>pkgs/all-packages.nix</filename>. Most Perl packages are so straight-forward to build that they are defined here directly, rather than having a separate function for each package called from <filename>perl-packages.nix</filename>. However, more complicated packages should be put in a separate file, typically in <filename>pkgs/development/perl-modules</filename>. Here is an example of the former: - <programlisting> - ClassC3 = buildPerlPackage rec { - name = "Class-C3-0.21"; - src = fetchurl { - url = "mirror://cpan/authors/id/F/FL/FLORA/${name}.tar.gz"; - sha256 = "1bl8z095y4js66pwxnm7s853pi9czala4sqc743fdlnk27kq94gz"; - }; - }; - </programlisting> +<programlisting> +ClassC3 = buildPerlPackage rec { + name = "Class-C3-0.21"; + src = fetchurl { + url = "mirror://cpan/authors/id/F/FL/FLORA/${name}.tar.gz"; + sha256 = "1bl8z095y4js66pwxnm7s853pi9czala4sqc743fdlnk27kq94gz"; + }; +}; +</programlisting> Note the use of <literal>mirror://cpan/</literal>, and the <literal>${name}</literal> in the URL definition to ensure that the name attribute is consistent with the source that we’re actually downloading. Perl packages are made available in <filename>all-packages.nix</filename> through the variable <varname>perlPackages</varname>. For instance, if you have a package that needs <varname>ClassC3</varname>, you would typically write - <programlisting> - foo = import ../path/to/foo.nix { - inherit stdenv fetchurl ...; - inherit (perlPackages) ClassC3; - }; - </programlisting> +<programlisting> +foo = import ../path/to/foo.nix { + inherit stdenv fetchurl ...; + inherit (perlPackages) ClassC3; +}; +</programlisting> in <filename>all-packages.nix</filename>. You can test building a Perl package as follows: - <screen> - <prompt>$ </prompt>nix-build -A perlPackages.ClassC3 - </screen> +<screen> +<prompt>$ </prompt>nix-build -A perlPackages.ClassC3 +</screen> <varname>buildPerlPackage</varname> adds <literal>perl-</literal> to the start of the name attribute, so the package above is actually called <literal>perl-Class-C3-0.21</literal>. So to install it, you can say: - <screen> - <prompt>$ </prompt>nix-env -i perl-Class-C3 - </screen> +<screen> +<prompt>$ </prompt>nix-env -i perl-Class-C3 +</screen> (Of course you can also install using the attribute name: <literal>nix-env -i -A perlPackages.ClassC3</literal>.) </para> @@ -94,61 +94,61 @@ <para> <varname>buildPerlPackage</varname> is built on top of <varname>stdenv</varname>, so everything can be customised in the usual way. For instance, the <literal>BerkeleyDB</literal> module has a <varname>preConfigure</varname> hook to generate a configuration file used by <filename>Makefile.PL</filename>: - <programlisting> - { buildPerlPackage, fetchurl, db }: - - buildPerlPackage rec { - name = "BerkeleyDB-0.36"; - - src = fetchurl { - url = "mirror://cpan/authors/id/P/PM/PMQS/${name}.tar.gz"; - sha256 = "07xf50riarb60l1h6m2dqmql8q5dij619712fsgw7ach04d8g3z1"; - }; - - preConfigure = '' - echo "LIB = ${db.out}/lib" > config.in - echo "INCLUDE = ${db.dev}/include" >> config.in - ''; - } - </programlisting> +<programlisting> +{ buildPerlPackage, fetchurl, db }: + +buildPerlPackage rec { + name = "BerkeleyDB-0.36"; + + src = fetchurl { + url = "mirror://cpan/authors/id/P/PM/PMQS/${name}.tar.gz"; + sha256 = "07xf50riarb60l1h6m2dqmql8q5dij619712fsgw7ach04d8g3z1"; + }; + + preConfigure = '' + echo "LIB = ${db.out}/lib" > config.in + echo "INCLUDE = ${db.dev}/include" >> config.in + ''; +} +</programlisting> </para> <para> Dependencies on other Perl packages can be specified in the <varname>buildInputs</varname> and <varname>propagatedBuildInputs</varname> attributes. If something is exclusively a build-time dependency, use <varname>buildInputs</varname>; if it’s (also) a runtime dependency, use <varname>propagatedBuildInputs</varname>. For instance, this builds a Perl module that has runtime dependencies on a bunch of other modules: - <programlisting> - ClassC3Componentised = buildPerlPackage rec { - name = "Class-C3-Componentised-1.0004"; - src = fetchurl { - url = "mirror://cpan/authors/id/A/AS/ASH/${name}.tar.gz"; - sha256 = "0xql73jkcdbq4q9m0b0rnca6nrlvf5hyzy8is0crdk65bynvs8q1"; - }; - propagatedBuildInputs = [ - ClassC3 ClassInspector TestException MROCompat - ]; - }; - </programlisting> +<programlisting> +ClassC3Componentised = buildPerlPackage rec { + name = "Class-C3-Componentised-1.0004"; + src = fetchurl { + url = "mirror://cpan/authors/id/A/AS/ASH/${name}.tar.gz"; + sha256 = "0xql73jkcdbq4q9m0b0rnca6nrlvf5hyzy8is0crdk65bynvs8q1"; + }; + propagatedBuildInputs = [ + ClassC3 ClassInspector TestException MROCompat + ]; +}; +</programlisting> </para> <para> On Darwin, if a script has too many <literal>-I<replaceable>dir</replaceable></literal> flags in its first line (its “shebang line”), it will not run. This can be worked around by calling the <literal>shortenPerlShebang</literal> function from the <literal>postInstall</literal> phase: - <programlisting> - { stdenv, buildPerlPackage, fetchurl, shortenPerlShebang }: - - ImageExifTool = buildPerlPackage { - pname = "Image-ExifTool"; - version = "11.50"; - - src = fetchurl { - url = "https://www.sno.phy.queensu.ca/~phil/exiftool/Image-ExifTool-11.50.tar.gz"; - sha256 = "0d8v48y94z8maxkmw1rv7v9m0jg2dc8xbp581njb6yhr7abwqdv3"; - }; - - buildInputs = stdenv.lib.optional stdenv.isDarwin shortenPerlShebang; - postInstall = stdenv.lib.optional stdenv.isDarwin '' - shortenPerlShebang $out/bin/exiftool - ''; - }; - </programlisting> +<programlisting> +{ stdenv, buildPerlPackage, fetchurl, shortenPerlShebang }: + +ImageExifTool = buildPerlPackage { + pname = "Image-ExifTool"; + version = "11.50"; + + src = fetchurl { + url = "https://www.sno.phy.queensu.ca/~phil/exiftool/Image-ExifTool-11.50.tar.gz"; + sha256 = "0d8v48y94z8maxkmw1rv7v9m0jg2dc8xbp581njb6yhr7abwqdv3"; + }; + + buildInputs = stdenv.lib.optional stdenv.isDarwin shortenPerlShebang; + postInstall = stdenv.lib.optional stdenv.isDarwin '' + shortenPerlShebang $out/bin/exiftool + ''; +}; +</programlisting> This will remove the <literal>-I</literal> flags from the shebang line, rewrite them in the <literal>use lib</literal> form, and put them on the next line instead. This function can be given any number of Perl scripts as arguments; it will modify them in-place. </para> @@ -159,27 +159,27 @@ Nix expressions for Perl packages can be generated (almost) automatically from CPAN. This is done by the program <command>nix-generate-from-cpan</command>, which can be installed as follows: </para> - <screen> - <prompt>$ </prompt>nix-env -i nix-generate-from-cpan - </screen> +<screen> +<prompt>$ </prompt>nix-env -i nix-generate-from-cpan +</screen> <para> This program takes a Perl module name, looks it up on CPAN, fetches and unpacks the corresponding package, and prints a Nix expression on standard output. For example: - <screen> - <prompt>$ </prompt>nix-generate-from-cpan XML::Simple - XMLSimple = buildPerlPackage rec { - name = "XML-Simple-2.22"; - src = fetchurl { - url = "mirror://cpan/authors/id/G/GR/GRANTM/${name}.tar.gz"; - sha256 = "b9450ef22ea9644ae5d6ada086dc4300fa105be050a2030ebd4efd28c198eb49"; - }; - propagatedBuildInputs = [ XMLNamespaceSupport XMLSAX XMLSAXExpat ]; - meta = { - description = "An API for simple XML files"; - license = with stdenv.lib.licenses; [ artistic1 gpl1Plus ]; - }; - }; - </screen> +<screen> +<prompt>$ </prompt>nix-generate-from-cpan XML::Simple + XMLSimple = buildPerlPackage rec { + name = "XML-Simple-2.22"; + src = fetchurl { + url = "mirror://cpan/authors/id/G/GR/GRANTM/${name}.tar.gz"; + sha256 = "b9450ef22ea9644ae5d6ada086dc4300fa105be050a2030ebd4efd28c198eb49"; + }; + propagatedBuildInputs = [ XMLNamespaceSupport XMLSAX XMLSAXExpat ]; + meta = { + description = "An API for simple XML files"; + license = with stdenv.lib.licenses; [ artistic1 gpl1Plus ]; + }; + }; +</screen> The output can be pasted into <filename>pkgs/top-level/perl-packages.nix</filename> or wherever else you need it. </para> </section> diff --git a/doc/languages-frameworks/qt.xml b/doc/languages-frameworks/qt.xml index 8d97de504ad34..ec95621d8ff2b 100644 --- a/doc/languages-frameworks/qt.xml +++ b/doc/languages-frameworks/qt.xml @@ -18,7 +18,7 @@ mkDerivation { <co xml:id='qt-default-nix-co-2' /> buildInputs = [ qtbase ]; <co xml:id='qt-default-nix-co-3' /> } - </programlisting> +</programlisting> </example> <calloutlist> diff --git a/doc/languages-frameworks/ruby.xml b/doc/languages-frameworks/ruby.xml index 9b36801fb9667..9b579d6804f44 100644 --- a/doc/languages-frameworks/ruby.xml +++ b/doc/languages-frameworks/ruby.xml @@ -12,14 +12,14 @@ </para> <screen> -<![CDATA[$ cd pkgs/servers/monitoring -$ mkdir sensu -$ cd sensu -$ cat > Gemfile +<prompt>$ </prompt>cd pkgs/servers/monitoring +<prompt>$ </prompt>mkdir sensu +<prompt>$ </prompt>cd sensu +<prompt>$ </prompt>cat > Gemfile source 'https://rubygems.org' gem 'sensu' -$ $(nix-build '<nixpkgs>' -A bundix --no-out-link)/bin/bundix --magic -$ cat > default.nix +<prompt>$ </prompt>$(nix-build '<nixpkgs>' -A bundix --no-out-link)/bin/bundix --magic +<prompt>$ </prompt>cat > default.nix { lib, bundlerEnv, ruby }: bundlerEnv rec { @@ -37,7 +37,7 @@ bundlerEnv rec { maintainers = with maintainers; [ theuni ]; platforms = platforms.unix; }; -}]]> +} </screen> <para> @@ -49,17 +49,16 @@ bundlerEnv rec { </para> <screen> -<![CDATA[$ cd pkgs/servers/monitoring/sensu -$ nix-shell -p bundler --run 'bundle lock --update' -$ nix-shell -p bundix --run 'bundix' -]]> +<prompt>$ </prompt>cd pkgs/servers/monitoring/sensu +<prompt>$ </prompt>nix-shell -p bundler --run 'bundle lock --update' +<prompt>$ </prompt>nix-shell -p bundix --run 'bundix' </screen> <para> For tools written in Ruby - i.e. where the desire is to install a package and then execute e.g. <command>rake</command> at the command line, there is an alternative builder called <literal>bundlerApp</literal>. Set up the <filename>gemset.nix</filename> the same way, and then, for example: </para> -<screen> +<programlisting> <![CDATA[{ lib, bundlerApp }: bundlerApp { @@ -75,7 +74,7 @@ bundlerApp { platforms = platforms.unix; }; }]]> -</screen> +</programlisting> <para> The chief advantage of <literal>bundlerApp</literal> over <literal>bundlerEnv</literal> is the executables introduced in the environment are precisely those selected in the <literal>exes</literal> list, as opposed to <literal>bundlerEnv</literal> which adds all the executables made available by gems in the gemset, which can mean e.g. <command>rspec</command> or <command>rake</command> in unpredictable versions available from various packages. diff --git a/doc/languages-frameworks/texlive.xml b/doc/languages-frameworks/texlive.xml index a581ec5911cb7..141c46e5a6231 100644 --- a/doc/languages-frameworks/texlive.xml +++ b/doc/languages-frameworks/texlive.xml @@ -44,11 +44,11 @@ texlive.combine { <listitem> <para> You can list packages e.g. by <command>nix repl</command>. -<programlisting><![CDATA[ -$ nix repl -nix-repl> :l <nixpkgs> -nix-repl> texlive.collection-<TAB> -]]></programlisting> +<programlisting> +<prompt>$ </prompt>nix repl +<prompt>nix-repl> </prompt>:l <nixpkgs> +<prompt>nix-repl> </prompt>texlive.collection-<keycap function="tab" /> +</programlisting> </para> </listitem> <listitem> |