Get rid of <example>

Markdown doesn't have floats so we can't have this.
This commit is contained in:
Eelco Dolstra 2020-07-23 14:10:59 +02:00
parent 13df1faf25
commit ca130b73a0
No known key found for this signature in database
GPG key ID: 8170B4726D7198DE
6 changed files with 156 additions and 134 deletions

View file

@ -434,25 +434,32 @@ stdenv.mkDerivation { … }
</varlistentry> </varlistentry>
</variablelist> </variablelist>
<example> <para>Here are some examples of how to use
<title>Fetching a private repository over SSH</title> <literal>fetchGit</literal>.</para>
<itemizedlist>
<listitem>
<para>To fetch a private repository over SSH:</para>
<programlisting>builtins.fetchGit { <programlisting>builtins.fetchGit {
url = "git@github.com:my-secret/repository.git"; url = "git@github.com:my-secret/repository.git";
ref = "master"; ref = "master";
rev = "adab8b916a45068c044658c4158d81878f9ed1c3"; rev = "adab8b916a45068c044658c4158d81878f9ed1c3";
}</programlisting> }</programlisting>
</example>
<example> </listitem>
<title>Fetching an arbitrary ref</title>
<listitem>
<para>To fetch an arbitrary reference:</para>
<programlisting>builtins.fetchGit { <programlisting>builtins.fetchGit {
url = "https://github.com/NixOS/nix.git"; url = "https://github.com/NixOS/nix.git";
ref = "refs/heads/0.5-release"; ref = "refs/heads/0.5-release";
}</programlisting> }</programlisting>
</example> </listitem>
<example> <listitem>
<title>Fetching a repository's specific commit on an arbitrary branch</title>
<para> <para>
If the revision you're looking for is in the default branch If the revision you're looking for is in the default branch
of the git repository you don't strictly need to specify of the git repository you don't strictly need to specify
@ -463,11 +470,13 @@ stdenv.mkDerivation { … }
branch for the non-default branch you will need to specify branch for the non-default branch you will need to specify
the the <varname>ref</varname> attribute as well. the the <varname>ref</varname> attribute as well.
</para> </para>
<programlisting>builtins.fetchGit { <programlisting>builtins.fetchGit {
url = "https://github.com/nixos/nix.git"; url = "https://github.com/nixos/nix.git";
rev = "841fcbd04755c7a2865c51c1e2d3b045976b7452"; rev = "841fcbd04755c7a2865c51c1e2d3b045976b7452";
ref = "1.11-maintenance"; ref = "1.11-maintenance";
}</programlisting> }</programlisting>
<note> <note>
<para> <para>
It is nice to always specify the branch which a revision It is nice to always specify the branch which a revision
@ -478,10 +487,9 @@ stdenv.mkDerivation { … }
is specified the fault is much more obvious. is specified the fault is much more obvious.
</para> </para>
</note> </note>
</example> </listitem>
<example> <listitem>
<title>Fetching a repository's specific commit on the default branch</title>
<para> <para>
If the revision you're looking for is in the default branch If the revision you're looking for is in the default branch
of the git repository you may omit the of the git repository you may omit the
@ -491,31 +499,28 @@ stdenv.mkDerivation { … }
url = "https://github.com/nixos/nix.git"; url = "https://github.com/nixos/nix.git";
rev = "841fcbd04755c7a2865c51c1e2d3b045976b7452"; rev = "841fcbd04755c7a2865c51c1e2d3b045976b7452";
}</programlisting> }</programlisting>
</example> </listitem>
<example> <listitem>
<title>Fetching a tag</title> <para>To fetch a specific tag:</para>
<programlisting>builtins.fetchGit { <programlisting>builtins.fetchGit {
url = "https://github.com/nixos/nix.git"; url = "https://github.com/nixos/nix.git";
ref = "refs/tags/1.9"; ref = "refs/tags/1.9";
}</programlisting> }</programlisting>
</example> </listitem>
<example> <listitem>
<title>Fetching the latest version of a remote branch</title> <para>To fetch the latest version of a remote branch:</para>
<para>
<function>builtins.fetchGit</function> can behave impurely
fetch the latest version of a remote branch.
</para>
<note><para>Nix will refetch the branch in accordance to
<xref linkend="conf-tarball-ttl" />.</para></note>
<note><para>This behavior is disabled in
<emphasis>Pure evaluation mode</emphasis>.</para></note>
<programlisting>builtins.fetchGit { <programlisting>builtins.fetchGit {
url = "ssh://git@github.com/nixos/nix.git"; url = "ssh://git@github.com/nixos/nix.git";
ref = "master"; ref = "master";
}</programlisting> }</programlisting>
</example> <note><para>Nix will refetch the branch in accordance to
<xref linkend="conf-tarball-ttl" />.</para></note>
<note><para>This behavior is disabled in <emphasis>Pure
evaluation mode</emphasis>.</para></note>
</listitem>
</itemizedlist>
</listitem> </listitem>
</varlistentry> </varlistentry>

View file

@ -4,7 +4,7 @@
version="5.0" version="5.0"
xml:id="ssec-copy-closure"> xml:id="ssec-copy-closure">
<title>Copying Closures Via SSH</title> <title>Copying Closures via SSH</title>
<para>The command <command <para>The command <command
linkend="sec-nix-copy-closure">nix-copy-closure</command> copies a Nix linkend="sec-nix-copy-closure">nix-copy-closure</command> copies a Nix

View file

@ -5,10 +5,10 @@
version="5.0" version="5.0"
xml:id="ssec-s3-substituter"> xml:id="ssec-s3-substituter">
<title>Serving a Nix store via AWS S3 or S3-compatible Service</title> <title>Serving a Nix store via S3</title>
<para>Nix has built-in support for storing and fetching store paths <para>Nix has built-in support for storing and fetching store paths
from Amazon S3 and S3 compatible services. This uses the same from Amazon S3 and S3-compatible services. This uses the same
<emphasis>binary</emphasis> cache mechanism that Nix usually uses to <emphasis>binary</emphasis> cache mechanism that Nix usually uses to
fetch prebuilt binaries from <uri>cache.nixos.org</uri>.</para> fetch prebuilt binaries from <uri>cache.nixos.org</uri>.</para>
@ -170,13 +170,22 @@ the S3 URL:</para>
} }
]]></programlisting> ]]></programlisting>
<example><title>Uploading with a specific credential profile for Amazon S3</title>
<para><command>nix copy --to 's3://example-nix-cache?profile=cache-upload&amp;region=eu-west-2' nixpkgs.hello</command></para>
</example>
<example><title>Uploading to an S3-Compatible Binary Cache</title>
<para><command>nix copy --to 's3://example-nix-cache?profile=cache-upload&amp;scheme=https&amp;endpoint=minio.example.com' nixpkgs.hello</command></para>
</example>
</section> </section>
<section><title>Examples</title>
<para>To upload with a specific credential profile for Amazon S3:</para>
<screen>
nix copy --to 's3://example-nix-cache?profile=cache-upload&amp;region=eu-west-2' nixpkgs.hello
</screen>
<para>To upload to an S3-compatible binary cache:</para>
<screen>
nix copy --to 's3://example-nix-cache?profile=cache-upload&amp;scheme=https&amp;endpoint=minio.example.com' nixpkgs.hello
</screen>
</section>
</section> </section>

View file

@ -169,7 +169,9 @@ For instance, `derivation` is also available as `builtins.derivation`.
A Boolean parameter that specifies whether submodules should be A Boolean parameter that specifies whether submodules should be
checked out. Defaults to `false`. checked out. Defaults to `false`.
<!-- end list --> Here are some examples of how to use `fetchGit`.
- To fetch a private repository over SSH:
builtins.fetchGit { builtins.fetchGit {
url = "git@github.com:my-secret/repository.git"; url = "git@github.com:my-secret/repository.git";
@ -177,18 +179,20 @@ For instance, `derivation` is also available as `builtins.derivation`.
rev = "adab8b916a45068c044658c4158d81878f9ed1c3"; rev = "adab8b916a45068c044658c4158d81878f9ed1c3";
} }
- To fetch an arbitrary reference:
builtins.fetchGit { builtins.fetchGit {
url = "https://github.com/NixOS/nix.git"; url = "https://github.com/NixOS/nix.git";
ref = "refs/heads/0.5-release"; ref = "refs/heads/0.5-release";
} }
If the revision you're looking for is in the default branch of the - If the revision you're looking for is in the default branch of
git repository you don't strictly need to specify the branch name in the git repository you don't strictly need to specify the branch
the `ref` attribute. name in the `ref` attribute.
However, if the revision you're looking for is in a future branch However, if the revision you're looking for is in a future
for the non-default branch you will need to specify the the `ref` branch for the non-default branch you will need to specify the
attribute as well. the `ref` attribute as well.
builtins.fetchGit { builtins.fetchGit {
url = "https://github.com/nixos/nix.git"; url = "https://github.com/nixos/nix.git";
@ -198,27 +202,34 @@ For instance, `derivation` is also available as `builtins.derivation`.
> **Note** > **Note**
> >
> It is nice to always specify the branch which a revision belongs > It is nice to always specify the branch which a revision
> to. Without the branch being specified, the fetcher might fail if > belongs to. Without the branch being specified, the fetcher
> the default branch changes. Additionally, it can be confusing to > might fail if the default branch changes. Additionally, it can
> try a commit from a non-default branch and see the fetch fail. If > be confusing to try a commit from a non-default branch and see
> the branch is specified the fault is much more obvious. > the fetch fail. If the branch is specified the fault is much
> more obvious.
If the revision you're looking for is in the default branch of the - If the revision you're looking for is in the default branch of
git repository you may omit the `ref` attribute. the git repository you may omit the `ref` attribute.
builtins.fetchGit { builtins.fetchGit {
url = "https://github.com/nixos/nix.git"; url = "https://github.com/nixos/nix.git";
rev = "841fcbd04755c7a2865c51c1e2d3b045976b7452"; rev = "841fcbd04755c7a2865c51c1e2d3b045976b7452";
} }
- To fetch a specific tag:
builtins.fetchGit { builtins.fetchGit {
url = "https://github.com/nixos/nix.git"; url = "https://github.com/nixos/nix.git";
ref = "refs/tags/1.9"; ref = "refs/tags/1.9";
} }
`builtins.fetchGit` can behave impurely fetch the latest version of - To fetch the latest version of a remote branch:
a remote branch.
builtins.fetchGit {
url = "ssh://git@github.com/nixos/nix.git";
ref = "master";
}
> **Note** > **Note**
> >
@ -229,11 +240,6 @@ For instance, `derivation` is also available as `builtins.derivation`.
> >
> This behavior is disabled in *Pure evaluation mode*. > This behavior is disabled in *Pure evaluation mode*.
builtins.fetchGit {
url = "ssh://git@github.com/nixos/nix.git";
ref = "master";
}
- `builtins.filter` f xs - `builtins.filter` f xs
Return a list consisting of the elements of xs for which the Return a list consisting of the elements of xs for which the
function f returns `true`. function f returns `true`.

View file

@ -1,4 +1,4 @@
# Copying Closures Via SSH # Copying Closures via SSH
The command `nix-copy-closure` copies a Nix store path along with all The command `nix-copy-closure` copies a Nix store path along with all
its dependencies to or from another machine via the SSH protocol. It its dependencies to or from another machine via the SSH protocol. It

View file

@ -1,7 +1,7 @@
# Serving a Nix store via AWS S3 or S3-compatible Service # Serving a Nix store via S3
Nix has built-in support for storing and fetching store paths from Nix has built-in support for storing and fetching store paths from
Amazon S3 and S3 compatible services. This uses the same *binary* cache Amazon S3 and S3-compatible services. This uses the same *binary* cache
mechanism that Nix usually uses to fetch prebuilt binaries from mechanism that Nix usually uses to fetch prebuilt binaries from
[cache.nixos.org](cache.nixos.org). [cache.nixos.org](cache.nixos.org).
@ -124,10 +124,12 @@ Your account will need the following IAM policy to upload to the cache:
] ]
} }
`nix copy --to ## Examples
's3://example-nix-cache?profile=cache-upload&region=eu-west-2'
nixpkgs.hello`
`nix copy --to To upload with a specific credential profile for Amazon S3:
's3://example-nix-cache?profile=cache-upload&scheme=https&endpoint=minio.example.com'
nixpkgs.hello` nix copy --to 's3://example-nix-cache?profile=cache-upload&region=eu-west-2' nixpkgs.hello
To upload to an S3-compatible binary cache:
nix copy --to 's3://example-nix-cache?profile=cache-upload&scheme=https&endpoint=minio.example.com' nixpkgs.hello