man: Silence mandoc warnings in ksh.1. #1406
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Thanks. I'll go ahead and merge but note that we've begun work on issue #507 to convert the docs from man format to reStructuredText + Sphinx. So changes to the man page that simply affect the presentation (or lint issues) will have a short lifespan. If you have any experience working with Sphinx we'd love some help converting the documentation. |
|
Thanks for pointing that out, I was not aware of this issue or the work being done. Unfortunately I don't have any experience with sphinx and have avoided it because it requires many python dependencies here. Personally I prefer the |
JohnoKing
added a commit
to JohnoKing/ksh
that referenced
this pull request
Jan 7, 2022
This commit makes various different improvements to the documentation: - sh.1: Backported (with changes) mandoc warning fixes from ksh2020 for the ksh93(1) man page: <att#1406> - Removed unnecessary spaces at the end of lines to fix a few other mandoc warnings. - Fixed a few typos in the documentation. - ANNOUNCE: Document the addition of the ${.sh.pid} variable (re: 9de6521). - libast/man/str*: Update the man pages for the libast str* functions to improve how accurately each function is described. - ksh93/README: Update regression test/compatibility notes to include OpenBSD 7.0, FreeBSD 13.0 and WSL running Ubuntu 20.04. - Change a few places to store the return value from strlen in a size_t variable rather than signed int. - comp/setlocale.c: To avoid confusion of the global variable 'lang' and function local variable also named 'lang', the function local variable has been renamed to 'langidx'.
JohnoKing
added a commit
to JohnoKing/ksh
that referenced
this pull request
Jan 7, 2022
This commit makes various different improvements to the documentation: - sh.1: Backported (with changes) mandoc warning fixes from ksh2020 for the ksh93(1) man page: <att#1406> - Removed unnecessary spaces at the end of lines to fix a few other mandoc warnings. - Fixed various typos and capitalization errors in the documentation. - ANNOUNCE: Document the addition of the ${.sh.pid} variable (re: 9de6521). - libast/man/str*: Update the man pages for the libast str* functions to improve how accurately each function is described. - ksh93/README: Update regression test/compatibility notes to include OpenBSD 7.0, FreeBSD 13.0 and WSL running Ubuntu 20.04. - Change a few places to store the return value from strlen in a size_t variable rather than signed int. - comp/setlocale.c: To avoid confusion of the global variable 'lang' and function local variable also named 'lang', the function local variable has been renamed to 'langidx'.
JohnoKing
added a commit
to JohnoKing/ksh
that referenced
this pull request
Jan 7, 2022
This commit makes various different improvements to the documentation: - sh.1: Backported (with changes) mandoc warning fixes from ksh2020 for the ksh93(1) man page: <att#1406> - Removed unnecessary spaces at the end of lines to fix a few other mandoc warnings. - Fixed various typos and capitalization errors in the documentation. - ANNOUNCE: Document the addition of the ${.sh.pid} variable (re: 9de6521). - libast/man/str*: Update the man pages for the libast str* functions to improve how accurately each function is described. - ksh93/README: Update regression test/compatibility notes to include OpenBSD 7.0, FreeBSD 13.0 and WSL running Ubuntu 20.04. - Change a few places to store the return value from strlen in a size_t variable rather than signed int. - comp/setlocale.c: To avoid confusion of the global variable 'lang' and function local variable also named 'lang', the function local variable has been renamed to 'langidx'.
JohnoKing
added a commit
to JohnoKing/ksh
that referenced
this pull request
Jan 7, 2022
This commit makes various different improvements to the documentation: - sh.1: Backported (with changes) mandoc warning fixes from ksh2020 for the ksh93(1) man page: <att#1406> - Removed unnecessary spaces at the end of lines to fix a few other mandoc warnings. - Fixed various typos and capitalization errors in the documentation. - ANNOUNCE: Document the addition of the ${.sh.pid} variable (re: 9de6521). - libast/man/str*: Update the man pages for the libast str* functions to improve how accurately each function is described. - ksh93/README: Update regression test/compatibility notes to include OpenBSD 7.0, FreeBSD 13.0 and WSL running Ubuntu 20.04. - Change a few places to store the return value from strlen in a size_t variable rather than signed int. - comp/setlocale.c: To avoid confusion of two separate variables named lang, the function local variable has been renamed to langidx.
McDutchie
pushed a commit
to ksh93/ksh
that referenced
this pull request
Jan 7, 2022
This commit makes various different improvements to the documentation: - sh.1: Backported (with changes) mandoc warning fixes from ksh2020 for the ksh93(1) man page: <att#1406> - Removed unnecessary spaces at the end of lines to fix a few other mandoc warnings. - Fixed various typos and capitalization errors in the documentation. - ANNOUNCE: Document the addition of the ${.sh.pid} variable (re: 9de6521). - libast/man/str*: Update the man pages for the libast str* functions to improve how accurately each function is described. - ksh93/README: Update regression test/compatibility notes to include OpenBSD 7.0, FreeBSD 13.0 and WSL running Ubuntu 20.04. - Change a few places to store the return value from strlen in a size_t variable rather than signed int. - comp/setlocale.c: To avoid confusion of two separate variables named lang, the function local variable has been renamed to langidx.
McDutchie
pushed a commit
to ksh93/ksh
that referenced
this pull request
Jan 7, 2022
This commit makes various different improvements to the documentation: - sh.1: Backported (with changes) mandoc warning fixes from ksh2020 for the ksh93(1) man page: <att#1406> - Removed unnecessary spaces at the end of lines to fix a few other mandoc warnings. - Fixed various typos and capitalization errors in the documentation. - ANNOUNCE: Document the addition of the ${.sh.pid} variable (re: 9de6521). - libast/man/str*: Update the man pages for the libast str* functions to improve how accurately each function is described. - ksh93/README: Update regression test/compatibility notes to include OpenBSD 7.0, FreeBSD 13.0 and WSL running Ubuntu 20.04. - Change a few places to store the return value from strlen in a size_t variable rather than signed int. - comp/setlocale.c: To avoid confusion of two separate variables named lang, the function local variable has been renamed to langidx.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This silences most warnings in the
ksh.1man page as show bymandoc.I compared the rendered output before and after with
diff(1)and found no differences.For a mandoc warnings reference please see this link.
https://mandoc.bsd.lv/man/mandoc.1.html
Here are the silenced warnings.
Here are the remaining warnings.