chore: move format-audit-result.jq out of //users/sterni r/3762

In the spirit of the readTree filter we should also not include files in
user directories from the outside.

Change-Id: I1abe36a721048900d2758b5986063b68b8d1af93
Reviewed-on: https://cl.tvl.fyi/c/depot/+/5200
Reviewed-by: sterni <sternenseemann@systemli.org>
Reviewed-by: tazjin <tazjin@tvl.su>
Autosubmit: sterni <sternenseemann@systemli.org>
Tested-by: BuildkiteCI

1 files changed, 12 insertions, 0 deletions

diff --git a/users/sterni/nixpkgs-crate-holes/format-audit-result.jq b/tools/rust-crates-advisory/format-audit-result.jq
index e3147b8016..6f230df3f9 100644
--- a/users/sterni/nixpkgs-crate-holes/format-audit-result.jq
+++ b/tools/rust-crates-advisory/format-audit-result.jq
@@ -1,3 +1,15 @@
+# This is a jq script to format the JSON output of cargo-audit into a short
+# markdown report for humans. It is used by //users/sterni/nixpkgs-crate-holes
+# and //tools/rust-crates-advisory:check-all-our-lock-files which will provide
+# you with example invocations.
+#
+# It needs the following arguments passed to it:
+#
+# - maintainers: Either the empty string or a list of maintainers to @mention
+#   for the current lock file.
+# - attr: An attribute name (or otherwise unique identifier) to associate the
+#   report for the current lock file with.
+
 # Link to human-readable advisory info for a given vulnerability
 def link:
   [ "https://rustsec.org/advisories/", .advisory.id, ".html" ] | add;