about summary refs log tree commit diff
path: root/doc
diff options
context:
space:
mode:
authorColin L Rice <colin@daedrum.net>2020-05-07 23:13:49 -0400
committerJörg Thalheim <joerg@thalheim.io>2020-05-14 07:21:52 +0100
commitc5f18c44b14eb9b0834cb4633339c321d1f73223 (patch)
tree9e4b330f52c0a13225dbe6cc0a2ef4a64ceaa69b /doc
parent9761128d2da7bf4d878982918242e43ae28f9b94 (diff)
downloadnixlib-c5f18c44b14eb9b0834cb4633339c321d1f73223.tar
nixlib-c5f18c44b14eb9b0834cb4633339c321d1f73223.tar.gz
nixlib-c5f18c44b14eb9b0834cb4633339c321d1f73223.tar.bz2
nixlib-c5f18c44b14eb9b0834cb4633339c321d1f73223.tar.lz
nixlib-c5f18c44b14eb9b0834cb4633339c321d1f73223.tar.xz
nixlib-c5f18c44b14eb9b0834cb4633339c321d1f73223.tar.zst
nixlib-c5f18c44b14eb9b0834cb4633339c321d1f73223.zip
go-modules: Doc updates
Diffstat (limited to 'doc')
-rw-r--r--doc/languages-frameworks/go.xml14
1 files changed, 7 insertions, 7 deletions
diff --git a/doc/languages-frameworks/go.xml b/doc/languages-frameworks/go.xml
index 70c135555ea4..ff39276f640e 100644
--- a/doc/languages-frameworks/go.xml
+++ b/doc/languages-frameworks/go.xml
@@ -36,7 +36,7 @@ pet = buildGoModule rec {
     sha256 = "0m2fzpqxk7hrbxsgqplkg7h2p7gv6s1miymv3gvw0cz039skag0s";
   };
 
-  modSha256 = "1879j77k96684wi554rkjxydrj8g3hpp0kvxz03sd8dmwr3lh83j"; <co xml:id='ex-buildGoModule-1' />
+  vendorSha256 = "1879j77k96684wi554rkjxydrj8g3hpp0kvxz03sd8dmwr3lh83j"; <co xml:id='ex-buildGoModule-1' />
 
   subPackages = [ "." ]; <co xml:id='ex-buildGoModule-2' />
 
@@ -56,7 +56,7 @@ pet = buildGoModule rec {
    <calloutlist>
     <callout arearefs='ex-buildGoModule-1'>
      <para>
-      <varname>modSha256</varname> is the hash of the output of the intermediate fetcher derivation.
+      <varname>vendorSha256</varname> is the hash of the output of the intermediate fetcher derivation.
      </para>
     </callout>
     <callout arearefs='ex-buildGoModule-2'>
@@ -68,12 +68,12 @@ pet = buildGoModule rec {
   </para>
 
   <para>
-    <varname>modSha256</varname> can also take <varname>null</varname> as an input.
+    <varname>vendorSha256</varname> can also take <varname>null</varname> as an input.
 
-    When `null` is used as a value, the derivation won't be a
-    fixed-output derivation but disable the build sandbox instead. This can be useful outside
-    of nixpkgs where re-generating the modSha256 on each mod.sum changes is cumbersome,
-    but will fail to build by Hydra, as builds with a disabled sandbox are discouraged.
+    When `null` is used as a value, rather than fetching the dependencies
+    and vendoring them, we use the vendoring included within the source repo.
+    If you'd like to not have to update this field on dependency changes, 
+    run `go mod vendor` in your source repo and set 'vendorSha256 = null;'
   </para>
  </section>