pcp
[Top] [All Lists]

Re: Where to Document New Features/APIs?

To: Dave Brolley <brolley@xxxxxxxxxx>
Subject: Re: Where to Document New Features/APIs?
From: fche@xxxxxxxxxx (Frank Ch. Eigler)
Date: Mon, 22 Apr 2013 12:06:47 -0400
Cc: PCP <pcp@xxxxxxxxxxx>
Delivered-to: pcp@xxxxxxxxxxx
In-reply-to: <517558C6.9060005@xxxxxxxxxx> (Dave Brolley's message of "Mon, 22 Apr 2013 11:35:34 -0400")
References: <517558C6.9060005@xxxxxxxxxx>
User-agent: Gnus/5.1008 (Gnus v5.10.8) Emacs/21.4 (gnu/linux)
Dave Brolley <brolley@xxxxxxxxxx> writes:

> The work I have contributed recently has resulted in some new API
> functions at the __pm*() level (socket I/O abstraction) 

Internal libpcp functions have not been formally documented, except
perhaps via comments in the source/header files.

> and also some new user interface changes (.* and :* as access
> wildcards). I'm wondering where these changes should be documented.
> man pages? User's Guide? Web pages? Other places? Pointers to the
> locations of any documentation to be updated would be appreciated.

Those wildcards relate to ACLs implemented by pmcd, so as to effect
the /etc/pcp/pmcd/pmcd.conf file, right?  This part is documented in
man/man1/pmcd.1 (ACCESS CONTROL CONFIGURATION section).

- FChE

<Prev in Thread] Current Thread [Next in Thread>