diff options
author | Graham Christensen <graham@grahamc.com> | 2019-06-18 18:51:58 +0200 |
---|---|---|
committer | Graham Christensen <graham@grahamc.com> | 2019-06-18 18:51:58 +0200 |
commit | a82901fb5e7f244d2db6b1e6a90e9a7a23ca588a (patch) | |
tree | 66b4e9a0ef69c439117e370ee885b980812e9527 /doc | |
parent | b5cf5ff20f92d790b703db00d202a72231943845 (diff) |
snapTools.makeSnap: init
Diffstat (limited to 'doc')
-rw-r--r-- | doc/functions.xml | 1 | ||||
-rw-r--r-- | doc/functions/snaptools.xml | 74 |
2 files changed, 75 insertions, 0 deletions
diff --git a/doc/functions.xml b/doc/functions.xml index 1f2d00b9e1afa..3b60f46d81dad 100644 --- a/doc/functions.xml +++ b/doc/functions.xml @@ -16,6 +16,7 @@ <xi:include href="functions/fhs-environments.xml" /> <xi:include href="functions/shell.xml" /> <xi:include href="functions/dockertools.xml" /> + <xi:include href="functions/snaptools.xml" /> <xi:include href="functions/appimagetools.xml" /> <xi:include href="functions/prefer-remote-fetch.xml" /> <xi:include href="functions/nix-gitignore.xml" /> diff --git a/doc/functions/snaptools.xml b/doc/functions/snaptools.xml new file mode 100644 index 0000000000000..a951c36730d3c --- /dev/null +++ b/doc/functions/snaptools.xml @@ -0,0 +1,74 @@ +<section xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xml:id="sec-pkgs-snapTools"> + <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. + </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. + </para> + + <para> + 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. + </para> + </section> + + <section xml:id="ssec-pkgs-snapTools-build-a-snap-hello"> + <title>Build a Hello World Snap</title> + + <example xml:id="ex-snapTools-buildSnap-hello"> + <title>Making a Hello World Snap</title> + <para> + The following expression packages GNU Hello as a Snapcraft snap. + </para> +<programlisting><xi:include href="../../pkgs/build-support/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. + </para> + </example> + </section> + + <section xml:id="ssec-pkgs-snapTools-build-a-snap-firefox"> + <title>Build a Hello World Snap</title> + + <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. + </para> +<programlisting><xi:include href="../../pkgs/build-support/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. + </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>. + </para> + </example> + </section> +</section> |