diff --git a/doc/bash_completion.txt b/doc/bash_completion.txt index 8cd3de24..a58351c5 100644 --- a/doc/bash_completion.txt +++ b/doc/bash_completion.txt @@ -11,7 +11,6 @@ Environment variables data. If unset or null (default), `configure` completion will strip everything after the '=' when returning completions. - *COMP_CVS_REMOTE*:: If set and not null, `cvs commit` completion will try to complete on remotely checked-out files. This requires passwordless access to the @@ -23,19 +22,17 @@ Environment variables *COMP_KNOWN_HOSTS_WITH_HOSTFILE*:: If set and not null (default), known hosts completion will complement - hostnames from ssh's known_hosts_files with hostnames taken from the file + hostnames from ssh's known_hosts files with hostnames taken from the file specified by the HOSTFILE shell variable (compgen -A hostname). If null, - known_hosts completion will omit hostnames from HOSTFILE. Omitting + known hosts completion will omit hostnames from HOSTFILE. Omitting hostnames from HOSTFILE is useful if HOSTFILE contains many entries for local web development or ad-blocking. - *COMP_KNOWN_HOSTS_WITH_AVAHI*:: If set and not null, known hosts completion will try to use `avahi-browse` for additional completions. This may be a slow operation in some setups. Default is unset. - *COMP_TAR_INTERNAL_PATHS*:: If set and not null *before* sourcing bash_completion, `tar` completion will do correct path completion for tar file contents. If unset or null, diff --git a/doc/styleguide.txt b/doc/styleguide.txt index d7ddb8e5..76b616ef 100644 --- a/doc/styleguide.txt +++ b/doc/styleguide.txt @@ -45,11 +45,11 @@ you absolutely need to (example: a long sed regular expression, or the like). This also holds true for the documentation and the testsuite. Other files, like ChangeLog, or COPYING, are exempt from this rule. -$(...) vs `...` ---------------- +$(...) vs \`...` +---------------- When you need to do some code substitution in your completion script, -you *MUST* use the $(...) construct, rather than the `...`. The former +you *MUST* use the $(...) construct, rather than the \`...`. The former is preferable because anyone, with any keyboard layout, is able to type it. Backticks aren't always available, without doing strange key combinations.