Skip to content

Updates to Configuration Files docs for SC18#9801

Merged
scheibelp merged 2 commits intospack:developfrom
adamjstewart:docs/config-files
Nov 11, 2018
Merged

Updates to Configuration Files docs for SC18#9801
scheibelp merged 2 commits intospack:developfrom
adamjstewart:docs/config-files

Conversation

@adamjstewart
Copy link
Copy Markdown
Member

I think the only controversial change here is a change in how our configuration scopes are presented. Previously, we listed the custom scope added via --config-scope as "command line" scope. However, there is actually a higher precedence scope of build settings listed on the command line. I separated "command line" into "custom" and "command line" to distinguish this. Let me know how people feel about this change before I make the same change to the Configuration Tutorial.

@adamjstewart adamjstewart added documentation Improvements or additions to documentation SC18 labels Nov 10, 2018
@@ -109,26 +111,25 @@ and `scopeb`, to a `spack spec` command:
Command-line scopes come *after* the ``spack`` command and *before* the
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@adamjstewart this still says "command-line"

@scheibelp
Copy link
Copy Markdown
Member

I agree with the change of terminology (command-line scope -> custom scope)

There is a remaining use of the term "command-line scope" that needs to be updated. Once that's done ping me and I'll merge this.

@tgamblin
Copy link
Copy Markdown
Member

I like the new terminology.

@tgamblin
Copy link
Copy Markdown
Member

You might consider changing the help text for spack -H to say "add a custom configuration scope" instead of "use an additional configurations scope".

@adamjstewart
Copy link
Copy Markdown
Member Author

I'm looking at some of the internals in lib/spack/spack/config.py and lib/spack/spack/main.py and I'm noticing a command_line scope. It seems to be used for both command-line settings as well as custom config files. I'm hesitant to make any changes to this so close to SC, but I also hate leaving things out of sync with the docs. It seems like right now, these two scopes have the same precedence, which isn't ideal in my mind.

@scheibelp scheibelp merged commit d366e64 into spack:develop Nov 11, 2018
@scheibelp
Copy link
Copy Markdown
Member

I'm looking at some of the internals in lib/spack/spack/config.py and lib/spack/spack/main.py and I'm noticing a command_line scope.

Internally it may assign variable names like custom scope but that can be adjusted later

It seems like right now, these two scopes have the same precedence, which isn't ideal in my mind.

They are treated as separate scopes so one will definitely have precedence, and Spack should arrange when pushing scopes to preserve the command line scope (as we refer to it here) as the highest precedence one

@adamjstewart adamjstewart deleted the docs/config-files branch November 12, 2018 01:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants