Add docs for getting GitConfigs #22559
Conversation
kshyatt
added
docs
base/libgit2/config.jl
Outdated
| """ | ||
| GitConfig(level::Consts.GIT_CONFIG = Consts.CONFIG_LEVEL_DEFAULT) | ||
|
|
||
| Get the default git configuration by loading the global, system, and XDG configuration |
There was a problem hiding this comment.
Is XDG a common abbreviation? I don't think I've seen it before.
There was a problem hiding this comment.
It's some sort of weird file thing I don't understand. I think it's how git internally organizes its files?
There was a problem hiding this comment.
Okay. If it's standard Git terminology then that's fine.
There was a problem hiding this comment.
it's not git-specific https://en.wikipedia.org/wiki/Freedesktop.org
There was a problem hiding this comment.
s/Git terminology/terminology/g
There was a problem hiding this comment.
I doubt it's a well-known acronym though so your point still stands
|
Anything more to do here? Do we want to write about XDG more? |
|
provide a link to what it's talking about? or refer to the specific paths it means |
|
I've searched again and I can't find a good summary of what this is. wat do |
|
What were you looking at that made you mention it in the first place? Are there user-level configuration files these read from? |
|
I think it was the docs on git-scm, which reference XDG but don't explain what it is |
|
I'd suggest leaving it out then, replacing it with some description of user-level configuration if relevant. |
base/libgit2/config.jl
Outdated
| @@ -1,5 +1,12 @@ | |||
| # This file is a part of Julia. License is MIT: https://julialang.org/license | |||
|
|
|||
| """ | |||
| GitConfig(path::AbstractString, level::Consts.GIT_CONFIG = Consts.CONFIG_LEVEL_APP, force::Bool=false) | |||
There was a problem hiding this comment.
Inconsistent use of spaces around =, here and in the other signatures. I'd suggest removing the spaces since that seems to be more common in Base docstrings.
|
(the FreeBSD CI doesn't understand [ci skip] yet) |
* Add docs for getting GitConfigs
No description provided.