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

Codechange: Move Sound Driver parameter name listings #10127

Merged
merged 1 commit into from Nov 5, 2022

Conversation

krysclarke
Copy link
Contributor

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.

  • The bug fix is important enough to be backported? (label: 'backport requested')
  • This PR touches english.txt or translations? Check the guidelines
  • This PR affects the save game format? (label 'savegame upgrade')
  • This PR affects the GS/AI API? (label 'needs review: Script API')
    • ai_changelog.hpp, gs_changelog.hpp need updating.
    • The compatibility wrappers (compat_*.nut) need updating.
  • This PR affects the NewGRF API? (label 'needs review: NewGRF')

@michicc michicc merged commit 21cea30 into OpenTTD:master Nov 5, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants