about summary refs log tree commit diff
path: root/doc
diff options
context:
space:
mode:
authorFrederik Rietdijk <fridh@fridh.nl>2020-09-12 10:00:45 +0200
committerFrederik Rietdijk <fridh@fridh.nl>2020-09-12 10:00:45 +0200
commit37d29394ecba3ccff2083119ec49fc3eaf36db8c (patch)
treef5392870bb7a3c48a55cd326dc4f51d9000cb59e /doc
parent6d269ce4095d110e9e1bc0e358338f8dc8f58076 (diff)
parentfd6899d9b5171da75d53b2435cefee8de4212521 (diff)
Merge staging-next into staging
Diffstat (limited to 'doc')
-rw-r--r--doc/languages-frameworks/go.xml9
-rw-r--r--doc/languages-frameworks/rust.section.md2
-rw-r--r--doc/using/overlays.xml24
3 files changed, 28 insertions, 7 deletions
diff --git a/doc/languages-frameworks/go.xml b/doc/languages-frameworks/go.xml
index 26414f23c7d2f..7cff7a85c62c3 100644
--- a/doc/languages-frameworks/go.xml
+++ b/doc/languages-frameworks/go.xml
@@ -117,7 +117,9 @@ deis = buildGoPackage rec {
 
   goDeps = ./deps.nix; <co xml:id='ex-buildGoPackage-3' />
 
-  buildFlags = [ "--tags" "release" ]; <co xml:id='ex-buildGoPackage-4' />
+  deleteVendor = true; <co xml:id='ex-buildGoPackage-4' />
+
+  buildFlags = [ "--tags" "release" ]; <co xml:id='ex-buildGoPackage-5' />
 }
 </programlisting>
   </example>
@@ -145,6 +147,11 @@ deis = buildGoPackage rec {
     </callout>
     <callout arearefs='ex-buildGoPackage-4'>
      <para>
+      <varname>deleteVendor</varname> removes the pre-existing vendor directory. This should only be used if the dependencies included in the vendor folder are broken or incomplete.
+     </para>
+    </callout>
+    <callout arearefs='ex-buildGoPackage-5'>
+     <para>
       <varname>buildFlags</varname> is a list of flags passed to the go build command.
      </para>
     </callout>
diff --git a/doc/languages-frameworks/rust.section.md b/doc/languages-frameworks/rust.section.md
index 6c51da87cab34..7f9d93216ed98 100644
--- a/doc/languages-frameworks/rust.section.md
+++ b/doc/languages-frameworks/rust.section.md
@@ -50,7 +50,7 @@ rustPlatform.buildRustPackage rec {
 `buildRustPackage` requires a `cargoSha256` attribute which is computed over
 all crate sources of this package. Currently it is obtained by inserting a
 fake checksum into the expression and building the package once. The correct
-checksum can be then take from the failed build.
+checksum can then be taken from the failed build.
 
 Per the instructions in the [Cargo Book](https://doc.rust-lang.org/cargo/guide/cargo-toml-vs-cargo-lock.html)
 best practices guide, Rust applications should always commit the `Cargo.lock`
diff --git a/doc/using/overlays.xml b/doc/using/overlays.xml
index 7f6ee040c7c74..f6e02b969eac8 100644
--- a/doc/using/overlays.xml
+++ b/doc/using/overlays.xml
@@ -187,14 +187,28 @@ self: super:
        <listitem>
          <para>
            <link
+           xlink:href="https://github.com/flame/blis">BLIS</link>
+         </para>
+         <para>
+          BLIS, available through the attribute
+          <literal>blis</literal>, is a framework for linear algebra kernels. In
+          addition, it implements the BLAS interface.
+         </para>
+       </listitem>
+       <listitem>
+         <para>
+          <link
            xlink:href="https://developer.amd.com/amd-aocl/blas-library/">AMD
-           BLIS/LIBFLAME</link> (optimized for modern AMD x86_64 CPUs)
+          BLIS/LIBFLAME</link> (optimized for modern AMD x86_64 CPUs)
          </para>
          <para>
-          The AMD BLIS library, with attribute <literal>amd-blis</literal>,
-          provides a BLAS implementation. The complementary AMD LIBFLAME
-          library, with attribute <literal>amd-libflame</literal>, provides
-          a LAPACK implementation.
+          The AMD fork of the BLIS library, with attribute
+          <literal>amd-blis</literal>, extends BLIS with optimizations for
+          modern AMD CPUs. The changes are usually submitted to
+          the upstream BLIS project after some time. However, AMD BLIS
+          typically provides some performance improvements on AMD Zen CPUs.
+          The complementary AMD LIBFLAME library, with attribute
+          <literal>amd-libflame</literal>, provides a LAPACK implementation.
          </para>
        </listitem>
      </itemizedlist>