Project

General

Profile

Bug #4613

Many functions in cmn_err.h aren't documented.

Added by Johann Oskarsson over 5 years ago. Updated over 2 years ago.

Status:
Closed
Priority:
Normal
Assignee:
-
Category:
manpage - manual pages
Start date:
2014-02-20
Due date:
% Done:

0%

Estimated time:
Difficulty:
Medium
Tags:
needs-triage

Description

There are two undcocumented *_err() functions:

  • vzcmn_err()
  • dev_err() (Already bug #2922)
Of the *printf() functions in usr/src/uts/common/sys/cmn_err.h only vsprintf.9f has a man page. The undocumented ones are:
  • printf()
  • vzprintf()
  • zprintf()
  • vprintf()
  • uprintf()
  • vuprintf()
  • snprintf()
  • vsnprintf()
  • sprintf()

Also:

  • panic()
  • vpanic()

Of these, some may be meant to be undocumented.

History

#1

Updated by Garrett D'Amore over 5 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.)

#2

Updated by Garrett D'Amore over 5 years ago

sprintf probably could be documented --- by snprintf() is preferred.

#3

Updated by Johann Oskarsson over 5 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.

#4

Updated by Yuri Pankov over 2 years ago

I've documented (or redocumented) all of sprintf(), snprintf(), vsprintf(), vsnprintf() in #7682.

#5

Updated by Yuri Pankov over 2 years ago

  • Status changed from New to Feedback

What exactly we still need to do here?

#6

Updated by Yuri Pankov over 2 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

Also available in: Atom PDF