Closed (fixed)
Project:
Drupal core
Version:
8.0.x-dev
Component:
documentation
Priority:
Normal
Category:
Bug report
Assigned:
Unassigned
Reporter:
Created:
23 Jan 2014 at 11:09 UTC
Updated:
29 Jul 2014 at 23:18 UTC
Jump to comment: Most recent, Most recent file
Comments
Comment #1
sutharsan commentedComment #2
sutharsan commentedThe documentation also mentions that database information is stored in $settings, but this in not true. Description changed.
Comment #3
jhodgdonThanks for filing this!
I agree with your assessment of the bugs... I am not sure that the install profile is used at all during bootstrap though, so I don't think this is a great example for the documentation. As far as I can tell, the install profile setting is only used during installation and updates?
Comment #4
jhodgdonComment #5
sutharsan commentedYou are right, 'install_profile' is available in $settings at runtime, but is not used during installation, I did not check.
I checked the usage of some settings, and found these examples which are used during (early) bootstrap: 'drupal_classloader' and 'proxy_exceptions'. Note: proxy_server, proxy_port, etc. are listed in default.settings.php but I can't find them in core code.
Two examples of environment specific settings are: 'twig_debug' and 'file_public_path'.
We could distinguish a third type of settings for security override: 'update_free_access', 'allow_authorize_operations'. But we could see these as installation specific settings and giving too much details can harm the explanation.
Comment #6
jhodgdonAgreed, we don't want too many details.
How about saying something like this:
$settings contains information that is required to start the configuration system, temporarily overrides the configuration system (for example, debug settings and security overrides), or overrides the configuration system for one site in a set of sites that shares configuration.
Is that accurate, and complete enough?
Comment #7
sutharsan commentedSettings is a third system for system configuration and does not overlap (I think) with Config and Key/Value store (state). With your input, I gave the documentation another try.
Comment #10
sutharsan commented7: default-settings-doc-2179753-7.patch queued for re-testing.
Comment #11
jhodgdonThis patch loses the mention of $settings specifically. Was that intentional? I think we should still mention $settings.
Also... In Drupal 8, there is a difference between "state" and "configuration", and I think this new help text is confusing them a bit.
Also, it needs a bit of grammar and punctuation clean-up, but until the text is closer, I will wait on that part. But you might read it over and make sure it makes sense. Some of the sentences are garbled.
Comment #12
sutharsan commentedThis patch removes the Configuration paragraph. The Settings text was rewritten.
Comment #13
jhodgdonOK, that's clearer, thanks!
The wording is still a bit awkward though, and there are some grammar and punctuation issues... How about:
$settings contains environment-specific configuration, such as the files directory and reverse proxy address, and temporary configuration, such as turning on Twig debugging and security overrides.
Comment #14
sutharsan commentedAgree, much better. Changed the text with your proposal. Modified the
@seereference.Comment #15
jhodgdonI'm happy with that. If we're both happy, I think it's ready for RTBC.
Comment #16
jhodgdonThanks again! Committed to 8.x.