Bug #4613
closed
Many functions in cmn_err.h aren't documented.
0%
Description
There are two undcocumented *_err() functions:
- vzcmn_err()
- dev_err() (Already bug #2922)
- printf()
- vzprintf()
- zprintf()
- vprintf()
- uprintf()
- vuprintf()
- snprintf()
- vsnprintf()
- sprintf()
Also:
- panic()
- vpanic()
Of these, some may be meant to be undocumented.
Updated by Garrett D'Amore over 9 years ago
The printf family, panic, and vpanic are definitely intended to be undocumented. Developers should use cmn_err() and friends as those are the public interfaces.
I suspect that's true for vzcmn_err() as well.
I'd like to just close this out, we already have the bug for dev_err(). That's the only one of this list that should be documented. (Probably we should update the cmn_err() header to indicate that these other interfaces are not for public consumption, or just move them to a non-public header file.)
Updated by Garrett D'Amore over 9 years ago
sprintf probably could be documented --- by snprintf() is preferred.
Updated by Johann Oskarsson over 9 years ago
Note that snprintf() isn't documented either; but vsprintf() is. There is a man page for snprintf.9f, available with google.
I don't understand, do you mean vzcmn_err() should be undocumented? Both vcmn_err() and zcmn_err() are documented.
Updated by Yuri Pankov over 6 years ago
I've documented (or redocumented) all of sprintf(), snprintf(), vsprintf(), vsnprintf() in #7682.
Updated by Yuri Pankov over 6 years ago
- Status changed from New to Feedback
What exactly we still need to do here?
Updated by Yuri Pankov about 6 years ago
- Status changed from Feedback to Closed
I think we have everything that this describes already documented, please reopen if we are still missing anything.
documented:
cmn_err
dev_err
vcmn_err
zcmn_err
vzcmn_err
sprintf
snprintf
vsprintf
vsnprintf