From e9846313a569a9644713d6cb0161fc85956dafbc Mon Sep 17 00:00:00 2001 From: John Kerl Date: Mon, 6 Mar 2023 00:11:54 -0500 Subject: [PATCH] doc note for #1218 --- docs/src/manpage.md | 6 ++++-- docs/src/manpage.txt | 6 ++++-- docs/src/reference-main-flag-list.md | 2 +- internal/pkg/cli/option_parse.go | 5 +++-- man/manpage.txt | 6 ++++-- man/mlr.1 | 8 +++++--- 6 files changed, 21 insertions(+), 12 deletions(-) diff --git a/docs/src/manpage.md b/docs/src/manpage.md index 1e31d4269..a84dc34c0 100644 --- a/docs/src/manpage.md +++ b/docs/src/manpage.md @@ -562,7 +562,9 @@ MILLER(1) MILLER(1) --ofmtg {n} Use --ofmtg 6 as shorthand for --ofmt %.6g, etc. --records-per-batch {n} This is an internal parameter for maximum number of records in a batch size. Normally this does not need - to be modified. + to be modified, except when input is from `tail -f`. + See also + https://miller.readthedocs.io/en/latest/reference-main-flag-list/. --seed {n} with `n` of the form `12345678` or `0xcafefeed`. For `put`/`filter` `urand`, `urandint`, and `urand32`. --tz {timezone} Specify timezone, overriding `$TZ` environment @@ -3318,5 +3320,5 @@ MILLER(1) MILLER(1) - 2023-03-04 MILLER(1) + 2023-03-06 MILLER(1) diff --git a/docs/src/manpage.txt b/docs/src/manpage.txt index 9651b66a1..6035c0284 100644 --- a/docs/src/manpage.txt +++ b/docs/src/manpage.txt @@ -541,7 +541,9 @@ MILLER(1) MILLER(1) --ofmtg {n} Use --ofmtg 6 as shorthand for --ofmt %.6g, etc. --records-per-batch {n} This is an internal parameter for maximum number of records in a batch size. Normally this does not need - to be modified. + to be modified, except when input is from `tail -f`. + See also + https://miller.readthedocs.io/en/latest/reference-main-flag-list/. --seed {n} with `n` of the form `12345678` or `0xcafefeed`. For `put`/`filter` `urand`, `urandint`, and `urand32`. --tz {timezone} Specify timezone, overriding `$TZ` environment @@ -3297,4 +3299,4 @@ MILLER(1) MILLER(1) - 2023-03-04 MILLER(1) + 2023-03-06 MILLER(1) diff --git a/docs/src/reference-main-flag-list.md b/docs/src/reference-main-flag-list.md index d9a7bbddf..e3bda0ef5 100644 --- a/docs/src/reference-main-flag-list.md +++ b/docs/src/reference-main-flag-list.md @@ -279,7 +279,7 @@ These are flags which don't fit into any other category. * `--ofmte {n}`: Use --ofmte 6 as shorthand for --ofmt %.6e, etc. * `--ofmtf {n}`: Use --ofmtf 6 as shorthand for --ofmt %.6f, etc. * `--ofmtg {n}`: Use --ofmtg 6 as shorthand for --ofmt %.6g, etc. -* `--records-per-batch {n}`: This is an internal parameter for maximum number of records in a batch size. Normally this does not need to be modified. +* `--records-per-batch {n}`: This is an internal parameter for maximum number of records in a batch size. Normally this does not need to be modified, except when input is from `tail -f`. See also https://miller.readthedocs.io/en/latest/reference-main-flag-list/. * `--seed {n}`: with `n` of the form `12345678` or `0xcafefeed`. For `put`/`filter` `urand`, `urandint`, and `urand32`. * `--tz {timezone}`: Specify timezone, overriding `$TZ` environment variable (if any). * `-I`: Process files in-place. For each file name on the command line, output is written to a temp file in the same directory, which is then renamed over the original. Each file is processed in isolation: if the output format is CSV, CSV headers will be present in each output file, statistics are only over each file's own records; and so on. diff --git a/internal/pkg/cli/option_parse.go b/internal/pkg/cli/option_parse.go index aeec690ba..254abdbfb 100644 --- a/internal/pkg/cli/option_parse.go +++ b/internal/pkg/cli/option_parse.go @@ -2870,8 +2870,9 @@ on JSON input records, where duplicate keys always result in the last one's valu { name: "--records-per-batch", arg: "{n}", - help: `This is an internal parameter for maximum number of records in a batch size. Normally -this does not need to be modified.`, + help: "This is an internal parameter for maximum number of records in a batch size. Normally this does not\n" + + "need to be modified, except when input is from `tail -f`. See also\n" + + "https://miller.readthedocs.io/en/latest/reference-main-flag-list/.", parser: func(args []string, argc int, pargi *int, options *TOptions) { CheckArgCount(args, *pargi, argc, 2) recordsPerBatch, ok := lib.TryIntFromString(args[*pargi+1]) diff --git a/man/manpage.txt b/man/manpage.txt index 9651b66a1..6035c0284 100644 --- a/man/manpage.txt +++ b/man/manpage.txt @@ -541,7 +541,9 @@ MILLER(1) MILLER(1) --ofmtg {n} Use --ofmtg 6 as shorthand for --ofmt %.6g, etc. --records-per-batch {n} This is an internal parameter for maximum number of records in a batch size. Normally this does not need - to be modified. + to be modified, except when input is from `tail -f`. + See also + https://miller.readthedocs.io/en/latest/reference-main-flag-list/. --seed {n} with `n` of the form `12345678` or `0xcafefeed`. For `put`/`filter` `urand`, `urandint`, and `urand32`. --tz {timezone} Specify timezone, overriding `$TZ` environment @@ -3297,4 +3299,4 @@ MILLER(1) MILLER(1) - 2023-03-04 MILLER(1) + 2023-03-06 MILLER(1) diff --git a/man/mlr.1 b/man/mlr.1 index ff9da5df7..8ae38e2f0 100644 --- a/man/mlr.1 +++ b/man/mlr.1 @@ -2,12 +2,12 @@ .\" Title: mlr .\" Author: [see the "AUTHOR" section] .\" Generator: ./mkman.rb -.\" Date: 2023-03-04 +.\" Date: 2023-03-06 .\" Manual: \ \& .\" Source: \ \& .\" Language: English .\" -.TH "MILLER" "1" "2023-03-04" "\ \&" "\ \&" +.TH "MILLER" "1" "2023-03-06" "\ \&" "\ \&" .\" ----------------------------------------------------------------- .\" * Portability definitions .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -660,7 +660,9 @@ These are flags which don't fit into any other category. --ofmtg {n} Use --ofmtg 6 as shorthand for --ofmt %.6g, etc. --records-per-batch {n} This is an internal parameter for maximum number of records in a batch size. Normally this does not need - to be modified. + to be modified, except when input is from `tail -f`. + See also + https://miller.readthedocs.io/en/latest/reference-main-flag-list/. --seed {n} with `n` of the form `12345678` or `0xcafefeed`. For `put`/`filter` `urand`, `urandint`, and `urand32`. --tz {timezone} Specify timezone, overriding `$TZ` environment