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] Format specs #5857
[DOC] Format specs #5857
Conversation
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.
See inline responses. Note that pushing additional commits after asking for a review can make review more difficult.
Sorry. I failed to resist the temptation to plug holes and correct errors. Will do better. |
I'm re-opening this because I really really want to see improvement to the doc for format specs. I'll correct the errors cited by @jeremyevans, and seek common ground about the way the types should be documented. |
@jeremyevans, let's try for common ground on |
@jeremyevans, I'd originally thought to include this file in kernel.c, but later realized that it'll be better as a free-standing doc that all 4 *printf methods can link to. Therefore should be in doc/ not doc/kernel? If so, should the move be before this merge, or after? |
@jeremyevans Oh, and what about the many to-be-supplied sections? Keep adding to this PR, reviewing as we go? Or merge and add later? |
Let's move to
Let's merge this after the move to |
@jeremyevans, all set? I've removed the addition (kernel) to doc/.document. |
This new document would eventually replace the format spec discussion at Kernel#sprintf.
This new document would eventually replace the format spec discussion at Kernel#sprintf.
This new document would eventually replace the format spec discussion at Kernel#sprintf, which would then link to the new doc.
One of the aims here is to make the discussion of a type specifier, say
%b
, sufficient in itself, without the reader having to carry a lot of info from other sections. In this beginning, only the one type specifier is detailed; others will follow in new PRs.