Project

General

Profile

Feature #6955

libproc should be documented and shipped

Added by Robert Mustacchi almost 5 years ago. Updated almost 5 years ago.

Status:
Closed
Priority:
Normal
Assignee:
Robert Mustacchi
Category:
lib - userland libraries
Start date:
2016-05-05
Due date:
% Done:

100%

Estimated time:
Difficulty:
Medium
Tags:
Gerrit CR:

Description

For a long time we've discussed having libproc be a public interface. At Joyent, we've ended up leveraging this a bit and finding that the API is generally solid and makes sense. As part of this, I've gone and written manual pages for the vast majority of libproc. It's worth noting that a few things haven't been promoted at this time. Particularly:

  • The old ps_* functions which represent old proc service routines all of which have modern equivalents
  • A few things which expose libproc internals, e.g. Pgrab_ops which need changes to be suitably stable and are less generally useful
  • A few other internal functions and symbols which fall into the category of spilling too much implementation detail.

All in all, this is quite a small set.

#1

Updated by Robert Mustacchi almost 5 years ago

  • Subject changed from libproc should be a public interface to libproc should be documented and shipped
#2

Updated by Robert Mustacchi almost 5 years ago

There was some discussion on developer@ and the general thoughts here were that we should just document and ship this at uncommitted for now. Having the docs and shipping it are more important at the moment than the alternative.

#3

Updated by Electric Monk almost 5 years ago

  • Status changed from New to Closed

git commit 43051d2742bbe5911de73322064cb573b6aff975

commit  43051d2742bbe5911de73322064cb573b6aff975
Author: Robert Mustacchi <rm@joyent.com>
Date:   2016-05-12T16:47:18.000Z

    6955 libproc should be documented and shipped
    6956 libproc cannot leave free() to callers
    Reviewed by: Ryan Zezeski <ryan@zinascii.com>
    Reviewed by: Cody Mello <cody.mello@joyent.com>
    Reviewed by: Joshua M. Clulow <josh@sysmgr.org>
    Approved by: Richard Lowe <richlowe@richlowe.net>

Also available in: Atom PDF