threads / discuss / 53711

git config not following include paths by default

Subject: git config not following include paths by default

## tl;dr

4 messages between Jun 18, 2020 and Jun 19, 2020.

replies: 3people: 2as markdown or json

Paul S. Strauss· Jun 18, 2020, 20:25 UTC · lore
Using git version 2.25.1 in a bash shell on Ubuntu 20.04 (focal).

My global git config file has an [include] with path set to additional configuration.

"git config --list --show-origin --includes" shows all of my configuration, including items from the included file.

"git config --list --show-origin" shows only the items in my main config file. Not sure why "--no-includes" is the default, but not a huge deal either way.

What is a big deal is that none of the configuration in my included config file is available to me. I have lots of aliases and other settings in the included file, but none of them work.

This can't be the expected behavior, can it? If so, then including config files is pretty useless.

-- 
Paul S. Strausspss@acm.org
Paul S. Strauss· Jun 18, 2020, 20:40 UTC · re: Paul S. Strauss · lore

Re: git config not following include paths by default

Update:

The problem is related to my having GIT_CONFIG set to a file other than ~/.gitconfig - when I unset GIT_CONFIG and copied my config file to ~/.gitconfig, the include worked as expected.

So, to reproduce:
    Do NOT have a ~/.gitconfig file
    Set GIT_CONFIG to a configuration file with [include] statements
    Then the behavior I mentioned will occur
On 6/18/20 1:25 PM, Paul S. Strauss wrote:
Show 18 quoted lines
> Using git version 2.25.1 in a bash shell on Ubuntu 20.04 (focal).
>
> My global git config file has an [include] with path set to additional 
> configuration.
>
> "git config --list --show-origin --includes" shows all of my configuration, 
> including items from the included file.
>
> "git config --list --show-origin" shows only the items in my main config file. 
> Not sure why "--no-includes" is the default, but not a huge deal either way.
>
> What is a big deal is that none of the configuration in my included config 
> file is available to me. I have lots of aliases and other settings in the 
> included file, but none of them work.
>
> This can't be the expected behavior, can it? If so, then including config 
> files is pretty useless.
>
-- 
Paul S. Strauss                                  pss@acm.org
Jeff King· Jun 19, 2020, 11:58 UTC · re: Paul S. Strauss · lore

Re: git config not following include paths by default

On Thu, Jun 18, 2020 at 01:40:11PM -0700, Paul S. Strauss wrote:
> The problem is related to my having GIT_CONFIG set to a file other than
> ~/.gitconfig - when I unset GIT_CONFIG and copied my config file to
> ~/.gitconfig, the include worked as expected.
That's working as designed. From git-config(1):
   --[no-]includes
       Respect include.* directives in config files when looking up
       values. Defaults to off when a specific file is given (e.g.,
       using --file, --global, etc) and on when searching all config
       files.

The reasons for that are historical. Includes were added much later, and you would probably not want "git config --file=.gitmodules" against an untrusted input to be able to include from anywhere on your filesystem.

$GIT_CONFIG works the same way (as it's equivalent to using --file). We generally discourage the use of the environment variable (and its existence is yet another historical compatibility thing). If you tell us more about what you're trying to accomplish with it, we might be able to suggest a better solution.

-Peff
Paul S. Strauss· Jun 19, 2020, 18:50 UTC · re: Jeff King · lore

Re: git config not following include paths by default

Thank you very much for your help.

I was trying to set up a dual-platform git configuration with a common (synced) home directory structure.

I created gitconfig-linux and gitconfig-windows files that both include gitconfig-common. (I would have done it the other way around if there was a platform-based includeIf). Then I just set GIT_CONFIG to gitconfig-<platform> on each system, which led to the problem.

I worked around it by linking ~/.gitconfig to the the platform-specific file on each platform, but that is not ideal, IMO.

I didn't realize that using GIT_CONFIG was deprecated (or that it was equivalent to specifying a file); there didn't seem to be a better way to do what I wanted.

    - Paul
On 6/19/20 4:58 AM, Jeff King wrote:
Show 24 quoted lines
> On Thu, Jun 18, 2020 at 01:40:11PM -0700, Paul S. Strauss wrote:
>
>> The problem is related to my having GIT_CONFIG set to a file other than
>> ~/.gitconfig - when I unset GIT_CONFIG and copied my config file to
>> ~/.gitconfig, the include worked as expected.
> That's working as designed. From git-config(1):
>
>     --[no-]includes
>         Respect include.* directives in config files when looking up
>         values. Defaults to off when a specific file is given (e.g.,
>         using --file, --global, etc) and on when searching all config
>         files.
>
> The reasons for that are historical. Includes were added much later, and
> you would probably not want "git config --file=.gitmodules" against an
> untrusted input to be able to include from anywhere on your filesystem.
>
> $GIT_CONFIG works the same way (as it's equivalent to using --file).  We
> generally discourage the use of the environment variable (and its
> existence is yet another historical compatibility thing). If you tell us
> more about what you're trying to accomplish with it, we might be able to
> suggest a better solution.
>
> -Peff
-- 
Paul S. Strauss                                  pss@acm.org

← back to recent threads