Skip to content

Commit

Permalink
Fixed docs rendering of --query-timeout
Browse files Browse the repository at this point in the history
When using single backticks, the documentation generator tries
to create automatic links (As explained in README). This goes
horribly wrong somehow, and so after looking at other parts
of the docs, it seems we usually use triple backticks for
command line options, to prevent automatic linking.

Changelog: None
Ticket: CFE-3254
Signed-off-by: Ole Herman Schumacher Elgesem <ole@northern.tech>
  • Loading branch information
olehermanse committed Feb 10, 2020
1 parent 1b8937a commit 3d2b076
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion reference/components/cf-hub.markdown
Expand Up @@ -119,7 +119,7 @@ The total time it uses for one host before giving up can be up to 10 times the c

Also note that this value is passed to the underlying OS code (`select()`), there is no guarantee that it will wait for that long.

This parameter can also be set using the command line option, `--query-timeout`.
This parameter can also be set using the command line option, ```--query-timeout```.
If specified in both policy and command line, the command line option takes precedence.
If one of the options (command line or policy) specifies `0`, the other one is used.
If both are not specified (or `0`), the default is used.
Expand Down

0 comments on commit 3d2b076

Please sign in to comment.