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

DOCS: MAN: Various small improvements to the manual page #4248

Merged
merged 39 commits into from Sep 17, 2022

Conversation

dwatteau
Copy link
Contributor

@dwatteau dwatteau commented Aug 29, 2022

This is a follow-up to PR #4121, regarding the manual page.

I tried to expand/update some descriptions, and improve the formatting a bit. This has been split into many smaller commits for easier (?) review.

I also plan to submit a similar update for base/commandLine.cpp, but probably in a distinct PR to avoid reviewing too many commits at once.

dwatteau added 30 commits Aug 24, 2022
$HOME/.scummvmrc is the obsolete value; just document the default one.
From backends/graphics3d/openglsdl/openglsdl-graphics3d.cpp.
…ead of "*nix"

People remembering the `*nix` name probably already know about
/dev/sequencer, so just use a simpler name. Moreover, /dev/sequencer
is only available on some Unix systems, but not all of them, nowadays.
Also use "available" instead of "enabled", since the latter is more of
a compile-time word, but we're in the usage documentation here.
It works in OpenGL graphics mode too. Technically, it still relies on
the SDL backend, but end-users care about usage, not code internals.
…uilt-in gameids and user-configured targets

The example was nice, but it was only given for the first case,
leaving you wonder what the second one really meant.
So that we don't only mention the built-in gameids (I'm not even sure
that a lot of command-line users know about them?).

Also add a bit more context.
--cdrom accepts more values than just numbers now.
…saves

There's no reason for --list-saves to document --add and --detect
again, so this is probably an old mistake.
Also remove the "specified" word in --list-all-debugflags description,
it just looks more confusing than helpful, to me.
Looks a bit better this way to me, but I'm not a native speaker...
Since base/commandLine.cpp documents it.
It looks like many engines have a different default value, nowadays.
@dwatteau dwatteau force-pushed the feat/improve-help-usage-manual-page branch from b68eca7 to 0a2570e Compare Sep 3, 2022
@sev-
Copy link
Member

sev- commented Sep 17, 2022

Looks great!

@sev- sev- merged commit 4e28498 into scummvm:master Sep 17, 2022
8 checks passed
@dwatteau dwatteau deleted the feat/improve-help-usage-manual-page branch Sep 17, 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
2 participants