[config] Use only .cfg extension, unify getting conf location
#827
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ix5
changed the title
.cfg extension, unify getting conf location
ix5
force-pushed
the
conf-unify
branch
3 times, most recently
from
6bd3b74 to
b4e9a31
Compare
Previously, the way of loading Isso's config was via
accessing the `defaults.ini` file by importing Isso's
`pkg_resources` at each instance.
Now, `isso.config` provides `default_file()`, which can be
used instead.
This makes it easier to keep track of mentions of isso's
config, which used to be scattered between `defaults.ini`
and `share/isso.conf` (a symlink to the former).
Replace treewide:
```
config.load(pkg_resources.resource_filename('isso', 'defaults.ini'))
```
With:
```
config.load(config.default_file())
```
This cuts down on some confusion. Since most of the docs tell users to use `.cfg` as the file extension for their own config files, settle on that extension.
`defaults.ini` was a symlink to `share/isso.cfg`. The previous commits settled upon `isso.cfg` as a config filename, so keep with that convention. Move the config to `isso/` so that `pkg_resources` can find it This helps avoid confusion and cuts down the amount of different config files flying around.
Since the conf is no longer provided as a `:download` in sphinx, it can be removed from the target dependencies.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
config: Unify getting default file name
Previously, the way of loading Isso's config was via accessing the
defaults.inifile by importing Isso'spkg_resourcesat each instance.Now,
isso.configprovidesdefault_file(), which can be used instead.This makes it easier to keep track of mentions of isso's config, which used to be scattered between
defaults.iniandshare/isso.conf(a symlink to the former).Replace treewide:
With:
treewide: Settle on .cfg extension for config files
This cuts down on some confusion.
Since most of the docs tell users to use
.cfgas the file extension for their own config files, settle on that extension.isso: config: Use isso/isso.cfg as default
defaults.iniwas a symlink toshare/isso.cfg. The previous commits settled uponisso.cfgas a config filename, so keep with that convention.Move the config to
isso/so thatpkg_resourcescan find itThis helps avoid confusion and cuts down the amount of different config files flying around.
Makefile: Omit isso.cfg from rst sources
Since the conf is no longer provided as a
:downloadin sphinx, it can be removed from the target dependencies.