summary refs log tree commit diff
path: root/pkgs/test/nixpkgs-check-by-name/README.md
diff options
context:
space:
mode:
authorSilvan Mosberger <silvan.mosberger@tweag.io>2023-10-12 01:51:21 +0200
committerSilvan Mosberger <silvan.mosberger@tweag.io>2023-10-12 02:28:09 +0200
commit23541bed72c8385acddfc8e7ba0bd15d5a2c26af (patch)
treee0c9b48f18033bf7b309ec55a0ffadfc83f57d68 /pkgs/test/nixpkgs-check-by-name/README.md
parentfcaa408d005743b34aed8b7e2992ef885b4ce027 (diff)
downloadnixpkgs-23541bed72c8385acddfc8e7ba0bd15d5a2c26af.tar
nixpkgs-23541bed72c8385acddfc8e7ba0bd15d5a2c26af.tar.gz
nixpkgs-23541bed72c8385acddfc8e7ba0bd15d5a2c26af.tar.bz2
nixpkgs-23541bed72c8385acddfc8e7ba0bd15d5a2c26af.tar.lz
nixpkgs-23541bed72c8385acddfc8e7ba0bd15d5a2c26af.tar.xz
nixpkgs-23541bed72c8385acddfc8e7ba0bd15d5a2c26af.tar.zst
nixpkgs-23541bed72c8385acddfc8e7ba0bd15d5a2c26af.zip
tests.nixpkgs-check-by-name: Introduce --version
Diffstat (limited to 'pkgs/test/nixpkgs-check-by-name/README.md')
-rw-r--r--pkgs/test/nixpkgs-check-by-name/README.md6
1 files changed, 6 insertions, 0 deletions
diff --git a/pkgs/test/nixpkgs-check-by-name/README.md b/pkgs/test/nixpkgs-check-by-name/README.md
index 4dd694acd2f..ebd1cd40aba 100644
--- a/pkgs/test/nixpkgs-check-by-name/README.md
+++ b/pkgs/test/nixpkgs-check-by-name/README.md
@@ -11,6 +11,12 @@ This API may be changed over time if the CI workflow making use of it is adjuste
 - Command line: `nixpkgs-check-by-name <NIXPKGS>`
 - Arguments:
   - `<NIXPKGS>`: The path to the Nixpkgs to check
+  - `--version <VERSION>`: The version of the checks to perform.
+
+    Possible values:
+    - `v0` (default)
+
+    See [validation](#validity-checks) for the differences.
 - Exit code:
   - `0`: If the [validation](#validity-checks) is successful
   - `1`: If the [validation](#validity-checks) is not successful