From 035d844f1d2223c014bcbb99d3eb780f4b3f1e01 Mon Sep 17 00:00:00 2001 From: Jean-Christophe Amiel Date: Thu, 24 Oct 2024 09:04:35 +0200 Subject: [PATCH] Fix option connect-timeout help message and documentation. --- README.md | 2 +- docs/manual.md | 2 +- docs/manual/hurl.1 | 4 +--- docs/manual/hurl.md | 2 -- docs/manual/hurlfmt.1 | 2 +- docs/spec/options/README.md | 6 ++++++ docs/spec/options/hurl/connect_timeout.option | 1 - packages/hurl/README.md | 2 +- 8 files changed, 11 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 078f0bc221a..b72cf0a16c5 100644 --- a/README.md +++ b/README.md @@ -1224,7 +1224,7 @@ will follow a redirection only for the second entry. | -E, --cert <CERTIFICATE[:PASSWORD]> | Client certificate file and password.

See also [`--key`](#key).
| | --color | Colorize debug output (the HTTP response output is not colorized).

This is a cli-only option.
| | --compressed | Request a compressed response using one of the algorithms br, gzip, deflate and automatically decompress the content.
| -| --connect-timeout <SECONDS> | Maximum time in seconds that you allow Hurl's connection to take.

You can specify time units in the connect timeout expression. Set Hurl to use a connect timeout of 20 seconds with `--connect-timeout 20s` or set it to 35,000 milliseconds with `--connect-timeout 35000ms`. No spaces allowed.

See also [`-m, --max-time`](#max-time).

This is a cli-only option.
| +| --connect-timeout <SECONDS> | Maximum time in seconds that you allow Hurl's connection to take.

You can specify time units in the connect timeout expression. Set Hurl to use a connect timeout of 20 seconds with `--connect-timeout 20s` or set it to 35,000 milliseconds with `--connect-timeout 35000ms`. No spaces allowed.

See also [`-m, --max-time`](#max-time).
| | --connect-to <HOST1:PORT1:HOST2:PORT2> | For a request to the given HOST1:PORT1 pair, connect to HOST2:PORT2 instead. This option can be used several times in a command line.

See also [`--resolve`](#resolve).
| | --continue-on-error | Continue executing requests to the end of the Hurl file even when an assert error occurs.
By default, Hurl exits after an assert error in the HTTP response.

Note that this option does not affect the behavior with multiple input Hurl files.

All the input files are executed independently. The result of one file does not affect the execution of the other Hurl files.

This is a cli-only option.
| | -b, --cookie <FILE> | Read cookies from FILE (using the Netscape cookie file format).

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

This is a cli-only option.
| diff --git a/docs/manual.md b/docs/manual.md index 0028da149b5..9d49b8a500a 100644 --- a/docs/manual.md +++ b/docs/manual.md @@ -154,7 +154,7 @@ will follow a redirection only for the second entry. | -E, --cert <CERTIFICATE[:PASSWORD]> | Client certificate file and password.

See also [`--key`](#key).
| | --color | Colorize debug output (the HTTP response output is not colorized).

This is a cli-only option.
| | --compressed | Request a compressed response using one of the algorithms br, gzip, deflate and automatically decompress the content.
| -| --connect-timeout <SECONDS> | Maximum time in seconds that you allow Hurl's connection to take.

You can specify time units in the connect timeout expression. Set Hurl to use a connect timeout of 20 seconds with `--connect-timeout 20s` or set it to 35,000 milliseconds with `--connect-timeout 35000ms`. No spaces allowed.

See also [`-m, --max-time`](#max-time).

This is a cli-only option.
| +| --connect-timeout <SECONDS> | Maximum time in seconds that you allow Hurl's connection to take.

You can specify time units in the connect timeout expression. Set Hurl to use a connect timeout of 20 seconds with `--connect-timeout 20s` or set it to 35,000 milliseconds with `--connect-timeout 35000ms`. No spaces allowed.

See also [`-m, --max-time`](#max-time).
| | --connect-to <HOST1:PORT1:HOST2:PORT2> | For a request to the given HOST1:PORT1 pair, connect to HOST2:PORT2 instead. This option can be used several times in a command line.

See also [`--resolve`](#resolve).
| | --continue-on-error | Continue executing requests to the end of the Hurl file even when an assert error occurs.
By default, Hurl exits after an assert error in the HTTP response.

Note that this option does not affect the behavior with multiple input Hurl files.

All the input files are executed independently. The result of one file does not affect the execution of the other Hurl files.

This is a cli-only option.
| | -b, --cookie <FILE> | Read cookies from FILE (using the Netscape cookie file format).

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

This is a cli-only option.
| diff --git a/docs/manual/hurl.1 b/docs/manual/hurl.1 index 22f65b59161..39cdfdac114 100644 --- a/docs/manual/hurl.1 +++ b/docs/manual/hurl.1 @@ -1,4 +1,4 @@ -.TH hurl 1 "11 Sep 2024" "hurl 6.0.0-SNAPSHOT" " Hurl Manual" +.TH hurl 1 "24 Oct 2024" "hurl 6.0.0-SNAPSHOT" " Hurl Manual" .SH NAME hurl - run and test HTTP requests. @@ -163,8 +163,6 @@ You can specify time units in the connect timeout expression. Set Hurl to use a See also \fI-m, --max-time\fP. -This is a cli-only option. - .IP "--connect-to " For a request to the given HOST1:PORT1 pair, connect to HOST2:PORT2 instead. This option can be used several times in a command line. diff --git a/docs/manual/hurl.md b/docs/manual/hurl.md index 1e76340100d..6b9b6b6c7bc 100644 --- a/docs/manual/hurl.md +++ b/docs/manual/hurl.md @@ -182,8 +182,6 @@ You can specify time units in the connect timeout expression. Set Hurl to use a See also [`-m, --max-time`](#max-time). -This is a cli-only option. - ### --connect-to {#connect-to} For a request to the given HOST1:PORT1 pair, connect to HOST2:PORT2 instead. This option can be used several times in a command line. diff --git a/docs/manual/hurlfmt.1 b/docs/manual/hurlfmt.1 index 6bff7ddad85..bd9943c692a 100644 --- a/docs/manual/hurlfmt.1 +++ b/docs/manual/hurlfmt.1 @@ -1,4 +1,4 @@ -.TH hurl 1 "11 Sep 2024" "hurl 6.0.0-SNAPSHOT" " Hurl Manual" +.TH hurl 1 "24 Oct 2024" "hurl 6.0.0-SNAPSHOT" " Hurl Manual" .SH NAME hurlfmt - format Hurl files diff --git a/docs/spec/options/README.md b/docs/spec/options/README.md index 970fef5c22c..fabff006c16 100644 --- a/docs/spec/options/README.md +++ b/docs/spec/options/README.md @@ -31,3 +31,9 @@ $ bin/spec/options/generate_man.py docs/spec/options/hurlfmt/*.option ``` This script generates (part of) man file for `hurl` / `hurlfmt`. + +A script is provided to run all these commands: + +```shell +$ bin/spec/options/generate_all.py +``` diff --git a/docs/spec/options/hurl/connect_timeout.option b/docs/spec/options/hurl/connect_timeout.option index 176f1370e2e..c7ba06740d8 100644 --- a/docs/spec/options/hurl/connect_timeout.option +++ b/docs/spec/options/hurl/connect_timeout.option @@ -3,7 +3,6 @@ long: connect-timeout value: SECONDS value_default: 300 help: Maximum time allowed for connection -cli_only: true --- Maximum time in seconds that you allow Hurl's connection to take. diff --git a/packages/hurl/README.md b/packages/hurl/README.md index f76f51c3d8e..258511b81a1 100644 --- a/packages/hurl/README.md +++ b/packages/hurl/README.md @@ -1224,7 +1224,7 @@ will follow a redirection only for the second entry. | -E, --cert <CERTIFICATE[:PASSWORD]> | Client certificate file and password.

See also [`--key`](#key).
| | --color | Colorize debug output (the HTTP response output is not colorized).

This is a cli-only option.
| | --compressed | Request a compressed response using one of the algorithms br, gzip, deflate and automatically decompress the content.
| -| --connect-timeout <SECONDS> | Maximum time in seconds that you allow Hurl's connection to take.

You can specify time units in the connect timeout expression. Set Hurl to use a connect timeout of 20 seconds with `--connect-timeout 20s` or set it to 35,000 milliseconds with `--connect-timeout 35000ms`. No spaces allowed.

See also [`-m, --max-time`](#max-time).

This is a cli-only option.
| +| --connect-timeout <SECONDS> | Maximum time in seconds that you allow Hurl's connection to take.

You can specify time units in the connect timeout expression. Set Hurl to use a connect timeout of 20 seconds with `--connect-timeout 20s` or set it to 35,000 milliseconds with `--connect-timeout 35000ms`. No spaces allowed.

See also [`-m, --max-time`](#max-time).
| | --connect-to <HOST1:PORT1:HOST2:PORT2> | For a request to the given HOST1:PORT1 pair, connect to HOST2:PORT2 instead. This option can be used several times in a command line.

See also [`--resolve`](#resolve).
| | --continue-on-error | Continue executing requests to the end of the Hurl file even when an assert error occurs.
By default, Hurl exits after an assert error in the HTTP response.

Note that this option does not affect the behavior with multiple input Hurl files.

All the input files are executed independently. The result of one file does not affect the execution of the other Hurl files.

This is a cli-only option.
| | -b, --cookie <FILE> | Read cookies from FILE (using the Netscape cookie file format).

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

This is a cli-only option.
|