Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove spaces from commented config lines in elasticsearch.yml and logging.yml #5842

Closed
seang-es opened this issue Apr 17, 2014 · 1 comment
Labels
:Delivery/Packaging RPM and deb packaging, tar and zip archives, shell and batch scripts >enhancement Team:Delivery Meta label for Delivery team v1.2.0 v2.0.0-beta1

Comments

@seang-es
Copy link

If a user has a mix of indented and unindented lines in elasticsearch.yml or logging.yml, elasticsearch will not parse the YML file correctly on startup. Any indented lines after an unindented line will be treated as children of the unindented line, and all of those lines will not parse correctly.

The sample config comments in elasticsearch.yml and logging.yml include space characters after the '#' character at the beginning of the lines. This encourages users to uncomment them by removing the '#' character without touching the space. This can lead to trouble if users later add other config keys without including the space. It would be better if the space characters were removed.

@seang-es seang-es self-assigned this Apr 17, 2014
@seang-es
Copy link
Author

I will remove all spaces after the '#' character on lines that include actual config keys. The lines that include descriptive comments will remain as they are, since removing the comment there is not something we expect users to do.

seang-es pushed a commit to seang-es/elasticsearch that referenced this issue Apr 17, 2014
….yml

Author: Sean Gallagher
Date: 17 Apr 2014 16:18 EDT

Removed spaces on commented lines containing config key entries to prevent
users from inadvertently messing up the indents in elasticsearch.yml.
Closes elastic#5842
seang-es pushed a commit that referenced this issue Apr 18, 2014
….yml

Author: Sean Gallagher
Date: 17 Apr 2014 16:18 EDT

Removed spaces on commented lines containing config key entries to prevent
users from inadvertently messing up the indents in elasticsearch.yml.
Closes #5842
@seang-es seang-es removed their assignment Mar 10, 2015
@clintongormley clintongormley added the :Delivery/Packaging RPM and deb packaging, tar and zip archives, shell and batch scripts label Jun 7, 2015
@mark-vieira mark-vieira added the Team:Delivery Meta label for Delivery team label Nov 11, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
:Delivery/Packaging RPM and deb packaging, tar and zip archives, shell and batch scripts >enhancement Team:Delivery Meta label for Delivery team v1.2.0 v2.0.0-beta1
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants