summary refs log tree commit diff
diff options
context:
space:
mode:
authorzowoq <59103226+zowoq@users.noreply.github.com>2020-08-12 19:33:03 +1000
committerzowoq <59103226+zowoq@users.noreply.github.com>2020-08-14 07:50:37 +1000
commit961aa3145599bb7f44afb2eff9667c7ba5d28159 (patch)
tree2ee2935f0fff823dc5070072195101c298d36f30
parent6a4339974726bb78dc9f59d54859087ee5fbd429 (diff)
downloadnixpkgs-961aa3145599bb7f44afb2eff9667c7ba5d28159.tar
nixpkgs-961aa3145599bb7f44afb2eff9667c7ba5d28159.tar.gz
nixpkgs-961aa3145599bb7f44afb2eff9667c7ba5d28159.tar.bz2
nixpkgs-961aa3145599bb7f44afb2eff9667c7ba5d28159.tar.lz
nixpkgs-961aa3145599bb7f44afb2eff9667c7ba5d28159.tar.xz
nixpkgs-961aa3145599bb7f44afb2eff9667c7ba5d28159.tar.zst
nixpkgs-961aa3145599bb7f44afb2eff9667c7ba5d28159.zip
buildGoModule: update deleteVendor docs
-rw-r--r--doc/languages-frameworks/go.xml9
-rw-r--r--pkgs/development/go-modules/generic/default.nix2
2 files changed, 9 insertions, 2 deletions
diff --git a/doc/languages-frameworks/go.xml b/doc/languages-frameworks/go.xml
index eee4706e551..26414f23c7d 100644
--- a/doc/languages-frameworks/go.xml
+++ b/doc/languages-frameworks/go.xml
@@ -40,7 +40,9 @@ pet = buildGoModule rec {
 
   subPackages = [ "." ]; <co xml:id='ex-buildGoModule-2' />
 
-  runVend = true; <co xml:id='ex-buildGoModule-3' />
+  deleteVendor = true; <co xml:id='ex-buildGoModule-3' />
+
+  runVend = true; <co xml:id='ex-buildGoModule-4' />
 
   meta = with lib; {
     description = "Simple command-line snippet manager, written in Go";
@@ -68,6 +70,11 @@ pet = buildGoModule rec {
     </callout>
     <callout arearefs='ex-buildGoModule-3'>
      <para>
+      <varname>deleteVendor</varname> removes the pre-existing vendor directory and fetches the dependencies. This should only be used if the dependencies included in the vendor folder are broken or incomplete.
+     </para>
+    </callout>
+    <callout arearefs='ex-buildGoModule-4'>
+     <para>
       <varname>runVend</varname> runs the vend command to generate the vendor directory. This is useful if your code depends on c code and go mod tidy does not include the needed sources to build.
      </para>
     </callout>
diff --git a/pkgs/development/go-modules/generic/default.nix b/pkgs/development/go-modules/generic/default.nix
index 25b031a8229..020f22ecd33 100644
--- a/pkgs/development/go-modules/generic/default.nix
+++ b/pkgs/development/go-modules/generic/default.nix
@@ -89,7 +89,7 @@ let
       fi
 
       if [ -e vendor ]; then
-        echo "vendor folder exists, please set 'vendorSha256=null;' or 'deleteVendor=true;' in your expression"
+        echo "vendor folder exists, please set 'vendorSha256 = null;' in your expression"
         exit 10
       fi