diff mbox series

[1/3] doc: note config file restrictions for completion.commands

Message ID 20190301173443.16429-2-tmz@pobox.com (mailing list archive)
State New, archived
Headers show
Series [1/3] doc: note config file restrictions for completion.commands | expand

Commit Message

Todd Zullinger March 1, 2019, 5:34 p.m. UTC
The completion.commands config var must be set in either the system-wide
or global config file.  The completion script does not read a local
repository config.

Signed-off-by: Todd Zullinger <tmz@pobox.com>
---
 Documentation/config/completion.txt | 3 ++-
 Documentation/git.txt               | 3 ++-
 2 files changed, 4 insertions(+), 2 deletions(-)

Comments

Duy Nguyen March 17, 2019, 1:12 p.m. UTC | #1
Poking this thread before it goes completely dead...

On Sat, Mar 2, 2019 at 12:34 AM Todd Zullinger <tmz@pobox.com> wrote:
>
> The completion.commands config var must be set in either the system-wide
> or global config file.  The completion script does not read a local
> repository config.

After the last discussion, I think the consensus was it's ok to allow
per-repo config so we can just drop this and update the code to read
from any config file, right?

>
> Signed-off-by: Todd Zullinger <tmz@pobox.com>
> ---
>  Documentation/config/completion.txt | 3 ++-
>  Documentation/git.txt               | 3 ++-
>  2 files changed, 4 insertions(+), 2 deletions(-)
>
> diff --git a/Documentation/config/completion.txt b/Documentation/config/completion.txt
> index 4d99bf33c9..4859d18e86 100644
> --- a/Documentation/config/completion.txt
> +++ b/Documentation/config/completion.txt
> @@ -4,4 +4,5 @@ completion.commands::
>         porcelain commands and a few select others are completed. You
>         can add more commands, separated by space, in this
>         variable. Prefixing the command with '-' will remove it from
> -       the existing list.
> +       the existing list.  The variable must be set in either the
> +       system-wide or global config.
> diff --git a/Documentation/git.txt b/Documentation/git.txt
> index 00156d64aa..638f4d6cc9 100644
> --- a/Documentation/git.txt
> +++ b/Documentation/git.txt
> @@ -172,7 +172,8 @@ foo.bar= ...`) sets `foo.bar` to the empty string which `git config
>         others (all other commands in `$PATH` that have git- prefix),
>         list-<category> (see categories in command-list.txt),
>         nohelpers (exclude helper commands), alias and config
> -       (retrieve command list from config variable completion.commands)
> +       (retrieve command list from config variable completion.commands,
> +       set in the global or system-wide config file)
>
>  GIT COMMANDS
>  ------------
diff mbox series

Patch

diff --git a/Documentation/config/completion.txt b/Documentation/config/completion.txt
index 4d99bf33c9..4859d18e86 100644
--- a/Documentation/config/completion.txt
+++ b/Documentation/config/completion.txt
@@ -4,4 +4,5 @@  completion.commands::
 	porcelain commands and a few select others are completed. You
 	can add more commands, separated by space, in this
 	variable. Prefixing the command with '-' will remove it from
-	the existing list.
+	the existing list.  The variable must be set in either the
+	system-wide or global config.
diff --git a/Documentation/git.txt b/Documentation/git.txt
index 00156d64aa..638f4d6cc9 100644
--- a/Documentation/git.txt
+++ b/Documentation/git.txt
@@ -172,7 +172,8 @@  foo.bar= ...`) sets `foo.bar` to the empty string which `git config
 	others (all other commands in `$PATH` that have git- prefix),
 	list-<category> (see categories in command-list.txt),
 	nohelpers (exclude helper commands), alias and config
-	(retrieve command list from config variable completion.commands)
+	(retrieve command list from config variable completion.commands,
+	set in the global or system-wide config file)
 
 GIT COMMANDS
 ------------