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

man: cleanup and update manual page #4121

Merged
merged 30 commits into from Aug 2, 2022
Merged

man: cleanup and update manual page #4121

merged 30 commits into from Aug 2, 2022

Conversation

jonathangray
Copy link
Contributor

@jonathangray jonathangray commented Jul 19, 2022

Remove roff escapes, sort and add missing options.

@dwatteau
Copy link
Contributor

@dwatteau dwatteau commented Jul 21, 2022

Thanks for this, it was sitting somewhere on my todo-list for a while.

I'm reviewing this, but indeed some documented options are outdated, when comparing them with the code. I'll add some further suggestions to this PR.

dists/scummvm.6 Outdated Show resolved Hide resolved
Copy link
Contributor

@dwatteau dwatteau left a comment

Thank you very much for this, I've made some suggestions, if you're OK with them.

(I have some other suggestions, but I'll submit my own PR after this one, since they're not related to the lines you are changing.)

dists/scummvm.6 Outdated Show resolved Hide resolved
dists/scummvm.6 Outdated Show resolved Hide resolved
dists/scummvm.6 Outdated Show resolved Hide resolved
dists/scummvm.6 Show resolved Hide resolved
dists/scummvm.6 Outdated Show resolved Hide resolved
dists/scummvm.6 Outdated Show resolved Hide resolved
dists/scummvm.6 Outdated Show resolved Hide resolved
dists/scummvm.6 Outdated Show resolved Hide resolved
dists/scummvm.6 Outdated Show resolved Hide resolved
dists/scummvm.6 Outdated Show resolved Hide resolved
@jonathangray
Copy link
Contributor Author

@jonathangray jonathangray commented Jul 26, 2022

thanks, all of the suggestions are now in the branch

@dwatteau
Copy link
Contributor

@dwatteau dwatteau commented Jul 26, 2022

Thank you very much! LGTM, let's wait a bit in case someone sees something else.

Once it's merged, I'll open my own PR with some further changes, but this first batch looks very good as is.

@digitall
Copy link
Member

@digitall digitall commented Jul 26, 2022

@jonathangray : Thanks for the improvements to the ScummVM Manual page.

One minor point, could you rebase and edit these commits to change the prefix from "man: ..." to "DOC: MAN: ..." or similar as per https://wiki.scummvm.org/index.php?title=Commit_Guidelines#Commit_message_formatting

If you don't know how to do this or don't feel able to, I or another of the team should be able to do this to the PR (since team members have permissions to edit the PR branches).

jonathangray added 24 commits Jul 26, 2022
avoids mandoc warnings of the form
STYLE: no blank before trailing delimiter: Fl n,
no longer describes options
replace with links to docs.scummvm.org and scummvm.org
@jonathangray
Copy link
Contributor Author

@jonathangray jonathangray commented Jul 26, 2022

changed prefix to DOCS: MAN: and rebased

@digitall
Copy link
Member

@digitall digitall commented Jul 26, 2022

@jonathangray : Thanks for sorting that. Previous commits to the manual have been prefixed by "DOC:", but DOCS should be fine as well.

@sev-
Copy link
Member

@sev- sev- commented Aug 2, 2022

Thank you, merging.

@sev- sev- merged commit 1d318e1 into scummvm:master Aug 2, 2022
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
4 participants