Codechange: Move Sound Driver parameter name listings #10127
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation / Problem
The various sound drivers don't take a consistent set of (optional) parameters, which could cause confusion if someone was trying to change the audio settings and wondering why nothing was actually changing.
Description
This change places the list of accepted parameters for each sound driver on the line in the openttd --help to be with the individual sound drivers, rather than at the top.
i.e.:
From:
-s drv = Set sound driver (see below) (param bufsize,hz)
...
List of sound drivers:
sdl: SDL Sound Driver
null: Null Sound Driver
To:
-s drv = Set sound driver (see below)
...
List of sound drivers:
sdl: SDL Sound Driver (param hz,samples)
null: Null Sound Driver
Limitations
None known.
Checklist for review
Some things are not automated, and forgotten often. This list is a reminder for the reviewers.