docs: document the --disable-warnings option.

VirusTotal · Jun 19, 2024 · 12e7ad2 · 12e7ad2
1 parent 6ac53ef
commit 12e7ad2
Show file tree

Hide file tree

Showing 2 changed files with 50 additions and 5 deletions.
diff --git a/site/content/docs/intro/cli.md b/site/content/docs/intro/cli.md
@@ -91,6 +91,35 @@ Examples:
 
 Disables the output produced by the [console]({{< ref "console.md" >}}) module.
 
+### --disable-warnings, -w
+
+Disables all warnings when used alone, or disable specific warnings when
+followed by comma-separated list of warnings identifiers.
+
+Disable all warnings:
+
+```
+--disable-warnings
+```
+
+Disable warning `slow_patterns`:
+
+```
+--disable-warnings=slow_patterns
+```
+
+Disable warnings `slow_patterns` and `redundant_modifier`:
+
+```
+--disable-warnings=slow_patterns,redundant_modifier"
+```
+
+Equivalent to the previous one, but using `--disable-warnings` multiple times:
+
+```
+--disable-warnings=slow_patterns --disable-warnings=redundant_modifier
+```
+
 ### --negate, -n
 
 Prints the rules that doesn't match instead of those that match.
@@ -167,19 +196,22 @@ Each `<RULES_PATH>` is the path of YARA source file or a directory containing
 source files. When`<RULES_PATH>` is a directory YARA-X iterates the directory
 recursively looking for any `*.yar` or `*.yara` files.
 
+### --disable-warnings
+
+See [--disable-warnings](#--disable-warnings) for the scan command.
+
 ### --output, -o <OUTPUT_PATH>
 
 Specify the path for the output binary file containing the compiled rules. By
 default, is `output.yarc`.
 
-### --relaxed-re-syntax
-
-See [--relaxed-re-syntax](#--relaxed-re-syntax) for the scan command.
-
 ### --path-as-namespace
 
 See [--path-as-namespace](#--path-as-namespace) for the scan command.
 
+### --relaxed-re-syntax
+
+See [--relaxed-re-syntax](#--relaxed-re-syntax) for the scan command.
 
 ------
 

diff --git a/site/hugo_stats.json b/site/hugo_stats.json
@@ -280,9 +280,12 @@
       "--compiled-rules--c",
       "--define--d-varvalue",
       "--disable-console-logs",
+      "--disable-warnings",
+      "--disable-warnings--w",
       "--module--m-module",
       "--negate--n",
       "--no-colors",
+      "--output--o-output_path",
       "--output-format--o-format",
       "--path-as-namespace",
       "--path-as-namespace-1",
@@ -368,11 +371,15 @@
       "duplicate-rule-modifiers",
       "dyldinfo",
       "dylib",
+      "dylib_hash",
       "dyn",
       "dyntype",
       "dysymtab",
+      "entitlement_hash",
       "entropyoffset-size",
       "entropystring",
+      "entry_point_for_archtype_arg",
+      "entry_point_for_archtype_arg-subtype_arg",
       "example",
       "example-1",
       "example-2",
@@ -382,8 +389,10 @@
       "example-6",
       "example-7",
       "example-8",
+      "example-9",
       "examples",
       "export",
+      "export_hash",
       "exports_indexfn_name",
       "exports_indexfn_regex",
       "exports_indexordinal",
@@ -395,6 +404,8 @@
       "file",
       "file-size",
       "file_flag",
+      "file_index_for_archtype_arg",
+      "file_index_for_archtype_arg-subtype_arg",
       "file_type",
       "fileattributes",
       "finding-patterns-at-specific-offsets",
@@ -403,10 +414,12 @@
       "functions",
       "further-reading",
       "global-rules",
-      "global-rules-cant-depend-on-non-global-rules",
       "go-api",
       "h-rh-i-0",
       "h-rh-i-1",
+      "has_dylibdylib_name",
+      "has_entitlemententitlement",
+      "has_rpathrpath",
       "header",
       "hexinteger",
       "hexmessage-integer",