elastic / elastic/logstash

Resolve Naming of Inconsistent "Config" Options

Open
#8,584 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
Java
Stars
14.9k
Forks
3.5k
Avg merge
1d 4h
Merged PRs (30d)
88

Description

Description of issue: the "`CONFIG PATH`" long option is "`--path.config`" whereas all other "CONFIG" options are "`--config.$option`". The consistency of prepending configuration with "`--config`" was what I had expected.
Expected State: `--config.path`
Current State: `--path.config`

Version: logstash-5.6.3-1.noarch
Operating System: tested on Centos/7
Config File (if you have sensitive info, please remove it):
Steps to Reproduce: Run `/usr/share/logstash/bin/logstash --help`

screen shot 2017-11-04 at 1 15 34 am

Contributor guide

Open the contributing guide

Research direction

Start at the `/usr/share/logstash/bin/logstash` entry point and run `logstash --help` to inspect how the CONFIG options are exposed. Trace the option definition responsible for `--path.config`, then confirm that the help output uses `--config.path` consistently with the other CONFIG options.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
cli
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.