diff options
Diffstat (limited to 'doc/functions/snaptools.xml')
-rw-r--r-- | doc/functions/snaptools.xml | 31 |
1 files changed, 8 insertions, 23 deletions
diff --git a/doc/functions/snaptools.xml b/doc/functions/snaptools.xml index d0e3efdf6c67..422fcfa37d88 100644 --- a/doc/functions/snaptools.xml +++ b/doc/functions/snaptools.xml @@ -5,28 +5,22 @@ <title>pkgs.snapTools</title> <para> - <varname>pkgs.snapTools</varname> is a set of functions for creating - Snapcraft images. Snap and Snapcraft is not used to perform these operations. + <varname>pkgs.snapTools</varname> is a set of functions for creating Snapcraft images. Snap and Snapcraft is not used to perform these operations. </para> <section xml:id="ssec-pkgs-snapTools-makeSnap-signature"> <title>The makeSnap Function</title> <para> - <function>makeSnap</function> takes a single named argument, - <parameter>meta</parameter>. This argument mirrors - <link xlink:href="https://docs.snapcraft.io/snap-format">the upstream - <filename>snap.yaml</filename> format</link> exactly. + <function>makeSnap</function> takes a single named argument, <parameter>meta</parameter>. This argument mirrors <link xlink:href="https://docs.snapcraft.io/snap-format">the upstream <filename>snap.yaml</filename> format</link> exactly. </para> <para> - The <parameter>base</parameter> should not be be specified, as - <function>makeSnap</function> will force set it. + The <parameter>base</parameter> should not be be specified, as <function>makeSnap</function> will force set it. </para> <para> - Currently, <function>makeSnap</function> does not support creating GUI - stubs. + Currently, <function>makeSnap</function> does not support creating GUI stubs. </para> </section> @@ -40,9 +34,7 @@ </para> <programlisting><xi:include href="./snap/example-hello.nix" parse="text" /></programlisting> <para> - <command>nix-build</command> this expression and install it with - <command>snap install ./result --dangerous</command>. - <command>hello</command> will now be the Snapcraft version of the package. + <command>nix-build</command> this expression and install it with <command>snap install ./result --dangerous</command>. <command>hello</command> will now be the Snapcraft version of the package. </para> </example> </section> @@ -53,21 +45,14 @@ <example xml:id="ex-snapTools-buildSnap-firefox"> <title>Making a Graphical Snap</title> <para> - Graphical programs require many more integrations with the host. This - example uses Firefox as an example, because it is one of the most - complicated programs we could package. + Graphical programs require many more integrations with the host. This example uses Firefox as an example, because it is one of the most complicated programs we could package. </para> <programlisting><xi:include href="./snap/example-firefox.nix" parse="text" /></programlisting> <para> - <command>nix-build</command> this expression and install it with - <command>snap install ./result --dangerous</command>. - <command>nix-example-firefox</command> will now be the Snapcraft version of - the Firefox package. + <command>nix-build</command> this expression and install it with <command>snap install ./result --dangerous</command>. <command>nix-example-firefox</command> will now be the Snapcraft version of the Firefox package. </para> <para> - The specific meaning behind plugs can be looked up in the - <link xlink:href="https://docs.snapcraft.io/supported-interfaces">Snapcraft - interface documentation</link>. + The specific meaning behind plugs can be looked up in the <link xlink:href="https://docs.snapcraft.io/supported-interfaces">Snapcraft interface documentation</link>. </para> </example> </section> |