-
Notifications
You must be signed in to change notification settings - Fork 6.9k
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
doc: posix: structural reorganization of posix docs #64540
doc: posix: structural reorganization of posix docs #64540
Conversation
ba01bec
to
38cce65
Compare
Was trying to disrupt all of the red (✅ = complete, 🏁 = nearly done, Suggestions @kartben ? |
ebc48b6
to
5db507a
Compare
@kartben the things I would really like to do (in the future) are
The problem is that there are a lot of POSIX functions. Between the lines, that means it will be difficult to maintain manually (will bitrot, become inaccurate, etc). IMHO, it makes a lot more sense to script this. This PR intentionally doesn't include most of the above, in case we would like to backport it to |
5db507a
to
bd6580b
Compare
0cdd9bc
to
7f83312
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for this effort! Quite a few comments, but mostly cosmetics/formatting.
|
||
.. _posix_undefined_behaviour: | ||
|
||
.. note:: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If you make it a subheading instead of a note, and have the heading spelled "Undefined behavior" (it will arguably make it stand even more, and will make it more clear for folks why they landed there when clicking on one of the "unsupported" links), then you can :ref:`posix_undefined_behaviour`
directly in your table and it will already have a meaningful and usable title
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, I'm not crazy about that standing out, to be honest.
:header: Symbol, Support, Remarks | ||
:widths: 50, 10, 50 | ||
|
||
_POSIX_JOB_CONTROL, -1, :ref:`†<posix_undefined_behaviour>` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The obelus feels very lonely and tiny in this column (and also hard to click for people and not very accessible).
See my comment re: how to change the note to a heading, and then this can simply become
_POSIX_JOB_CONTROL, -1, :ref:`†<posix_undefined_behaviour>` | |
_POSIX_JOB_CONTROL, -1, :ref:`posix_undefined_behaviour` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, again, I'm not super happy about lumping so many things into undefined behaviour. Ideally the gap would be significantly smaller but that also takes time and work. Additionally, I'd like to look at a better solution for generating these tables rather than maintaining them by hand.
ab95e52
b9277a7
to
ab95e52
Compare
5065dbb
to
83e74f9
Compare
@kartben - does it look OK for now? These POSIX doc changes were meant to be a backportable precursor to additional features in POSIX and POSIX configuration (which probably cannot be backported). |
83e74f9
to
eab576d
Compare
mostly ok yes, thanks! I just added one more comment + you need a minor change to fix the currently broken build |
Revise the structure of the POSIX API docs. This separates related items out to dedicated pages. Further improvements could yet be made - e.g. using the 'collapse' feature to expand and collapse large sections of text or tables. Signed-off-by: Christopher Friedt <[email protected]>
eab576d
to
9af282d
Compare
Revise the structure of the POSIX API docs. This separates related items out to dedicated pages, see preview.