Oslo Generator Sample Default Behavior
Sample Default
-------
There is a disparity between a 'default' value and a 'sample_default' value, as the intended operation is to generate a default for sample files that might differ from the actual 'default'. It might serve better to use 'sample_default to display a possible example default value where either a default is not supplied or the default, as a true default value, cannot be used due to a requirement for the user to adjust the option value.
There are two cases that can be covered in oslo-config-
1. A default value is supplied, and it is a desire to showcase an example of some other way to configure the option.
2. A default value is not supplied, and it is a desire to showcase how the option might be configured.
Usage
---------
Use case #1:
```
cfg.StrOpt(
```
Would yield an output from olso-config-
```
[DEFAULT]
# This is help text. (string value)
# Example: option1 = https:/
# option1 = mydefault_value
```
Use case #2:
```
cfg.StrOpt(
```
Would yield an output from olso-config-
```
[DEFAULT]
# This is help text. (string value)
# option1 = <example: https:/
```
Overall, this would provide some flexibility in displaying options in sample files along with the actual default vs. an example of what might be a different configuration value, without losing out on understanding what the actual default value is for the option.
References
---------------
[1] Cross Project Spec - https:/
[2] http://
Blueprint information
- Status:
- Not started
- Approver:
- None
- Priority:
- Undefined
- Drafter:
- Brian Stajkowski
- Direction:
- Needs approval
- Assignee:
- Brian Stajkowski
- Definition:
- New
- Series goal:
- None
- Implementation:
- Unknown
- Milestone target:
- None
- Started by
- Completed by
Related branches
Related bugs
Sprints
Whiteboard
Gerrit topic: https:/
Addressed by: https:/
Sample Default Handling