From faef79453af8031cc012ad5d0ae92129d13a1564 Mon Sep 17 00:00:00 2001 From: jcamiel Date: Mon, 15 Apr 2024 14:38:14 +0200 Subject: [PATCH] Fix --file-root documentation. --- README.md | 2 +- completions/_hurl | 2 +- completions/_hurl.ps1 | 2 +- completions/hurl.fish | 2 +- docs/manual.md | 2 +- docs/manual/hurl.1 | 4 ++-- docs/manual/hurl.md | 2 +- docs/manual/hurlfmt.1 | 2 +- docs/spec/options/hurl/file_root.option | 4 ++-- integration/hurl/tests_ok/help.out.pattern | 2 +- packages/hurl/README.md | 2 +- packages/hurl/src/cli/options/commands.rs | 2 +- 12 files changed, 14 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index f75963e0e..033162dde 100644 --- a/README.md +++ b/README.md @@ -1185,7 +1185,7 @@ will follow a redirection only for the second entry. | -c, --cookie-jar <FILE> | Write cookies to FILE after running the session (only for one session).
The file will be written using the Netscape cookie file format.

Combined with [`-b, --cookie`](#cookie), you can simulate a cookie storage between successive Hurl runs.

This is a cli-only option.
| | --delay <MILLISECONDS> | Sets delay before each request.
| | --error-format <FORMAT> | Control the format of error message (short by default or long)

This is a cli-only option.
| -| --file-root <DIR> | Set root directory to import files in Hurl. This is used for files in multipart form data, request body and response output.
When it is not explicitly defined, files are relative to the current directory in which Hurl is running.

This is a cli-only option.
| +| --file-root <DIR> | Set root directory to import files in Hurl. This is used for files in multipart form data, request body and response output.
When it is not explicitly defined, files are relative to the Hurl file's directory.

This is a cli-only option.
| | --from-entry <ENTRY_NUMBER> | Execute Hurl file from ENTRY_NUMBER (starting at 1).

This is a cli-only option.
| | --glob <GLOB> | Specify input files that match the given glob pattern.

Multiple glob flags may be used. This flag supports common Unix glob patterns like *, ? and [].
However, to avoid your shell accidentally expanding glob patterns before Hurl handles them, you must use single quotes or double quotes around each pattern.

This is a cli-only option.
| | -0, --http1.0 | Tells Hurl to use HTTP version 1.0 instead of using its internally preferred HTTP version.
| diff --git a/completions/_hurl b/completions/_hurl index acc088743..5f3f638ee 100644 --- a/completions/_hurl +++ b/completions/_hurl @@ -29,7 +29,7 @@ _hurl() { '--delay[Sets delay before each request.]: :' \ '--error-format[Control the format of error messages]: :' \ '--fail-at-end[Fail at end]' \ - '--file-root[Set root directory to import files \[default: current directory\]]: :' \ + '--file-root[Set root directory to import files \[default: input file directory\]]: :' \ '(-L --location)'{-L,--location}'[Follow redirects]' \ '--location-trusted[Follow redirects but allows sending the name + password to all hosts that the site may redirect to.]' \ '--from-entry[Execute Hurl file from ENTRY_NUMBER (starting at 1)]: :' \ diff --git a/completions/_hurl.ps1 b/completions/_hurl.ps1 index c85617be9..7040cd187 100644 --- a/completions/_hurl.ps1 +++ b/completions/_hurl.ps1 @@ -34,7 +34,7 @@ Register-ArgumentCompleter -Native -CommandName 'hurl' -ScriptBlock { [CompletionResult]::new('--delay', 'delay', [CompletionResultType]::ParameterName, 'Sets delay before each request.') [CompletionResult]::new('--error-format', 'error-format', [CompletionResultType]::ParameterName, 'Control the format of error messages') [CompletionResult]::new('--fail-at-end', 'fail-at-end', [CompletionResultType]::ParameterName, 'Fail at end') - [CompletionResult]::new('--file-root', 'file-root', [CompletionResultType]::ParameterName, 'Set root directory to import files [default: current directory]') + [CompletionResult]::new('--file-root', 'file-root', [CompletionResultType]::ParameterName, 'Set root directory to import files [default: input file directory]') [CompletionResult]::new('--location', 'location', [CompletionResultType]::ParameterName, 'Follow redirects') [CompletionResult]::new('--location-trusted', 'location-trusted', [CompletionResultType]::ParameterName, 'Follow redirects but allows sending the name + password to all hosts that the site may redirect to.') [CompletionResult]::new('--from-entry', 'from-entry', [CompletionResultType]::ParameterName, 'Execute Hurl file from ENTRY_NUMBER (starting at 1)') diff --git a/completions/hurl.fish b/completions/hurl.fish index 2657e3e61..72ebb0fa6 100644 --- a/completions/hurl.fish +++ b/completions/hurl.fish @@ -12,7 +12,7 @@ complete -c hurl -l cookie-jar -d 'Write cookies to FILE after running the sessi complete -c hurl -l delay -d 'Sets delay before each request.' complete -c hurl -l error-format -d 'Control the format of error messages' complete -c hurl -l fail-at-end -d 'Fail at end' -complete -c hurl -l file-root -d 'Set root directory to import files [default: current directory]' +complete -c hurl -l file-root -d 'Set root directory to import files [default: input file directory]' complete -c hurl -l location -d 'Follow redirects' complete -c hurl -l location-trusted -d 'Follow redirects but allows sending the name + password to all hosts that the site may redirect to.' complete -c hurl -l from-entry -d 'Execute Hurl file from ENTRY_NUMBER (starting at 1)' diff --git a/docs/manual.md b/docs/manual.md index 15ea91911..e145a525d 100644 --- a/docs/manual.md +++ b/docs/manual.md @@ -160,7 +160,7 @@ will follow a redirection only for the second entry. | -c, --cookie-jar <FILE> | Write cookies to FILE after running the session (only for one session).
The file will be written using the Netscape cookie file format.

Combined with [`-b, --cookie`](#cookie), you can simulate a cookie storage between successive Hurl runs.

This is a cli-only option.
| | --delay <MILLISECONDS> | Sets delay before each request.
| | --error-format <FORMAT> | Control the format of error message (short by default or long)

This is a cli-only option.
| -| --file-root <DIR> | Set root directory to import files in Hurl. This is used for files in multipart form data, request body and response output.
When it is not explicitly defined, files are relative to the current directory in which Hurl is running.

This is a cli-only option.
| +| --file-root <DIR> | Set root directory to import files in Hurl. This is used for files in multipart form data, request body and response output.
When it is not explicitly defined, files are relative to the Hurl file's directory.

This is a cli-only option.
| | --from-entry <ENTRY_NUMBER> | Execute Hurl file from ENTRY_NUMBER (starting at 1).

This is a cli-only option.
| | --glob <GLOB> | Specify input files that match the given glob pattern.

Multiple glob flags may be used. This flag supports common Unix glob patterns like *, ? and [].
However, to avoid your shell accidentally expanding glob patterns before Hurl handles them, you must use single quotes or double quotes around each pattern.

This is a cli-only option.
| | -0, --http1.0 | Tells Hurl to use HTTP version 1.0 instead of using its internally preferred HTTP version.
| diff --git a/docs/manual/hurl.1 b/docs/manual/hurl.1 index 06ad1b24c..fa249dc50 100644 --- a/docs/manual/hurl.1 +++ b/docs/manual/hurl.1 @@ -1,4 +1,4 @@ -.TH hurl 1 "08 Apr 2024" "hurl 4.3.0-SNAPSHOT" " Hurl Manual" +.TH hurl 1 "15 Apr 2024" "hurl 4.3.0-SNAPSHOT" " Hurl Manual" .SH NAME hurl - run and test HTTP requests. @@ -207,7 +207,7 @@ This is a cli-only option. .IP "--file-root " Set root directory to import files in Hurl. This is used for files in multipart form data, request body and response output. -When it is not explicitly defined, files are relative to the current directory in which Hurl is running. +When it is not explicitly defined, files are relative to the Hurl file's directory. This is a cli-only option. diff --git a/docs/manual/hurl.md b/docs/manual/hurl.md index 8cec49282..8eba439fd 100644 --- a/docs/manual/hurl.md +++ b/docs/manual/hurl.md @@ -226,7 +226,7 @@ This is a cli-only option. ### --file-root {#file-root} Set root directory to import files in Hurl. This is used for files in multipart form data, request body and response output. -When it is not explicitly defined, files are relative to the current directory in which Hurl is running. +When it is not explicitly defined, files are relative to the Hurl file's directory. This is a cli-only option. diff --git a/docs/manual/hurlfmt.1 b/docs/manual/hurlfmt.1 index 7ee874968..766d1e92b 100644 --- a/docs/manual/hurlfmt.1 +++ b/docs/manual/hurlfmt.1 @@ -1,4 +1,4 @@ -.TH hurl 1 "08 Apr 2024" "hurl 4.3.0-SNAPSHOT" " Hurl Manual" +.TH hurl 1 "15 Apr 2024" "hurl 4.3.0-SNAPSHOT" " Hurl Manual" .SH NAME hurlfmt - format Hurl files diff --git a/docs/spec/options/hurl/file_root.option b/docs/spec/options/hurl/file_root.option index 43b736777..df91c40f4 100644 --- a/docs/spec/options/hurl/file_root.option +++ b/docs/spec/options/hurl/file_root.option @@ -1,8 +1,8 @@ name: file_root long: file-root value: DIR -help: Set root directory to import files [default: current directory] +help: Set root directory to import files [default: input file directory] cli_only: true --- Set root directory to import files in Hurl. This is used for files in multipart form data, request body and response output. -When it is not explicitly defined, files are relative to the current directory in which Hurl is running. +When it is not explicitly defined, files are relative to the Hurl file's directory. diff --git a/integration/hurl/tests_ok/help.out.pattern b/integration/hurl/tests_ok/help.out.pattern index d6f102886..62d2096fa 100644 --- a/integration/hurl/tests_ok/help.out.pattern +++ b/integration/hurl/tests_ok/help.out.pattern @@ -33,7 +33,7 @@ Options: --error-format Control the format of error messages [default: short] [possible values: short, long] --file-root - Set root directory to import files [default: current directory] + Set root directory to import files [default: input file directory] -L, --location Follow redirects --location-trusted diff --git a/packages/hurl/README.md b/packages/hurl/README.md index 0d1fc0506..d501646e4 100644 --- a/packages/hurl/README.md +++ b/packages/hurl/README.md @@ -1177,7 +1177,7 @@ will follow a redirection only for the second entry. | -c, --cookie-jar <FILE> | Write cookies to FILE after running the session (only for one session).
The file will be written using the Netscape cookie file format.

Combined with [`-b, --cookie`](#cookie), you can simulate a cookie storage between successive Hurl runs.

This is a cli-only option.
| | --delay <MILLISECONDS> | Sets delay before each request.
| | --error-format <FORMAT> | Control the format of error message (short by default or long)

This is a cli-only option.
| -| --file-root <DIR> | Set root directory to import files in Hurl. This is used for files in multipart form data, request body and response output.
When it is not explicitly defined, files are relative to the current directory in which Hurl is running.

This is a cli-only option.
| +| --file-root <DIR> | Set root directory to import files in Hurl. This is used for files in multipart form data, request body and response output.
When it is not explicitly defined, files are relative to the Hurl file's directory.

This is a cli-only option.
| | --from-entry <ENTRY_NUMBER> | Execute Hurl file from ENTRY_NUMBER (starting at 1).

This is a cli-only option.
| | --glob <GLOB> | Specify input files that match the given glob pattern.

Multiple glob flags may be used. This flag supports common Unix glob patterns like *, ? and [].
However, to avoid your shell accidentally expanding glob patterns before Hurl handles them, you must use single quotes or double quotes around each pattern.

This is a cli-only option.
| | -0, --http1.0 | Tells Hurl to use HTTP version 1.0 instead of using its internally preferred HTTP version.
| diff --git a/packages/hurl/src/cli/options/commands.rs b/packages/hurl/src/cli/options/commands.rs index fcc6c0df8..7bdd17070 100644 --- a/packages/hurl/src/cli/options/commands.rs +++ b/packages/hurl/src/cli/options/commands.rs @@ -150,7 +150,7 @@ pub fn file_root() -> clap::Arg { clap::Arg::new("file_root") .long("file-root") .value_name("DIR") - .help("Set root directory to import files [default: current directory]") + .help("Set root directory to import files [default: input file directory]") .num_args(1) }