sysutils/jq
1
0
Fork 0
mirror of https://github.com/jqlang/jq.git synced 2025-08-06 22:02:40 +03:00
Code Activity

docs: rename example jq utility to total

Browse Source 
Apparently sum(1) is a BSD and GNU coreutil used to compute the
"16-bit BSD checksum" of a file.
This commit is contained in:
Emanuele Torre
2024-01-30 17:38:40 +01:00
committed by Nico Williams
parent bd3c828f98
commit 13e02ba348
2 changed files with 11 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
docs/content/manual/manual.yml
View File

@@ -3571,8 +3571,8 @@ sections:
when writing the "shebang" for a jq script: when writing the "shebang" for a jq script:
#!/bin/sh -- #!/bin/sh --
# sum - Output the sum of the given arguments (or stdin) # total - Output the sum of the given arguments (or stdin)
# usage: sum [numbers...] # usage: total [numbers...]
# \ # \
exec jq --args -MRnf "$0" -- "$@" exec jq --args -MRnf "$0" -- "$@"
@@ -3585,16 +3585,16 @@ sections:
. as $dot | . as $dot |
try tonumber catch false | try tonumber catch false |
if not or isnan then if not or isnan then
@json "sum: Invalid number \($dot).\n" | halt_error(1) @json "total: Invalid number \($dot).\n" | halt_error(1)
end end
) as $n (0; . + $n) ) as $n (0; . + $n)
The `exec` line is considered a comment by jq, so it is ignored. The `exec` line is considered a comment by jq, so it is ignored.
But it is not ignored by `sh`, since in `sh` a backslash at the But it is not ignored by `sh`, since in `sh` a backslash at the
end of the line does not continue the comment. end of the line does not continue the comment.
With this trick, when the script is invoked as `sum 1 2`, With this trick, when the script is invoked as `total 1 2`,
`/bin/sh -- /path/to/sum 1 2` will be run, and `sh` will then `/bin/sh -- /path/to/total 1 2` will be run, and `sh` will then
run `exec jq --args -MRnf /path/to/sum -- 1 2` replacing itself run `exec jq --args -MRnf /path/to/total -- 1 2` replacing itself
with a `jq` interpreter invoked with the specified options (`-M`, with a `jq` interpreter invoked with the specified options (`-M`,
`-R`, `-n`, `--args`), that evaluates the current file (`$0`), `-R`, `-n`, `--args`), that evaluates the current file (`$0`),
with the arguments (`$@`) that were passed to `sh`. with the arguments (`$@`) that were passed to `sh`.

10
jq.1.prebuilt generated
View File

@@ -1,5 +1,5 @@
. .
.TH "JQ" "1" "December 2023" "" "" .TH "JQ" "1" "January 2024" "" ""
. .
.SH "NAME" .SH "NAME"
\fBjq\fR \- Command\-line JSON processor \fBjq\fR \- Command\-line JSON processor
@@ -3998,8 +3998,8 @@ Backslash continuing the comment on the next line can be useful when writing the
.nf .nf
#!/bin/sh \-\- #!/bin/sh \-\-
# sum \- Output the sum of the given arguments (or stdin) # total \- Output the sum of the given arguments (or stdin)
# usage: sum [numbers\.\.\.] # usage: total [numbers\.\.\.]
# \e # \e
exec jq \-\-args \-MRnf "$0" \-\- "$@" exec jq \-\-args \-MRnf "$0" \-\- "$@"
@@ -4012,7 +4012,7 @@ reduce (
\. as $dot | \. as $dot |
try tonumber catch false | try tonumber catch false |
if not or isnan then if not or isnan then
@json "sum: Invalid number \e($dot)\.\en" | halt_error(1) @json "total: Invalid number \e($dot)\.\en" | halt_error(1)
end end
) as $n (0; \. + $n) ) as $n (0; \. + $n)
. .
@@ -4021,7 +4021,7 @@ reduce (
.IP "" 0 .IP "" 0
. .
.P .P
The \fBexec\fR line is considered a comment by jq, so it is ignored\. But it is not ignored by \fBsh\fR, since in \fBsh\fR a backslash at the end of the line does not continue the comment\. With this trick, when the script is invoked as \fBsum 1 2\fR, \fB/bin/sh \-\- /path/to/sum 1 2\fR will be run, and \fBsh\fR will then run \fBexec jq \-\-args \-MRnf /path/to/sum \-\- 1 2\fR replacing itself with a \fBjq\fR interpreter invoked with the specified options (\fB\-M\fR, \fB\-R\fR, \fB\-n\fR, \fB\-\-args\fR), that evaluates the current file (\fB$0\fR), with the arguments (\fB$@\fR) that were passed to \fBsh\fR\. The \fBexec\fR line is considered a comment by jq, so it is ignored\. But it is not ignored by \fBsh\fR, since in \fBsh\fR a backslash at the end of the line does not continue the comment\. With this trick, when the script is invoked as \fBtotal 1 2\fR, \fB/bin/sh \-\- /path/to/total 1 2\fR will be run, and \fBsh\fR will then run \fBexec jq \-\-args \-MRnf /path/to/total \-\- 1 2\fR replacing itself with a \fBjq\fR interpreter invoked with the specified options (\fB\-M\fR, \fB\-R\fR, \fB\-n\fR, \fB\-\-args\fR), that evaluates the current file (\fB$0\fR), with the arguments (\fB$@\fR) that were passed to \fBsh\fR\.
. .
.SH "MODULES" .SH "MODULES"
jq has a library/module system\. Modules are files whose names end in \fB\.jq\fR\. jq has a library/module system\. Modules are files whose names end in \fB\.jq\fR\.