[PHP-DOC] Re: [PHP-DEV] Bug #14083: missing yp documentation for some functions From: Zak Greant (zak <email protected>)
Date: 11/16/01

On November 16, 2001 08:02 am, nathan <email protected> wrote:
> From: nathan <email protected>
> Operating system: n/a
> PHP version: 4.0.6
> PHP Bug Type: Documentation problem
> Bug description: missing yp documentation for some functions
>
>
> The current documentation at php.net lists the following
> functions for the NIS/YP function set as:
>
> yp_get_default_domain
> yp_order
> yp_master
> yp_match
> yp_first
> yp_next
>
> However in /ext/yp/php_yp.h the following addtional
> functions have beed defined and there is code in yp.c to
> make them work (atm I don't know if they work...).
> Descriptions from source code accompany function names
>
> yp_all - Traverse map and call a function on each enrty
> yp_cat - Return an array containing the entire map
> yp_errno - Return the error code from the last call or 0
> if no error occured
> yp_err_string - Returns corresponding error string fro the
> given code
>
> Can you please add thess functions to the documentation
> and maybe add an example or two? I'll be working on some
> yp stuff soon with php, so I'd be happy to send in some
> examples when I have them.

I have written some documentation on the YP functions - just drop by
http://www.php-er.com/chapters/YP_Functions.html

If you do use the docs, please let me know if you find any
inconsistencies or problems. I will incorporate the changes into the
docs.

Note that the formatting is a bit rough - that will be fixed in a few
days.

If no one gets to it first, I will write up docs for the PHP manual for
the missing YP functions. However, I would like it if someone with a
working PHP/YP setup could help verify the information and provide some
technical editing. :) 

-- 
Zak Greant

PHP Quality Assurance Team
http://qa.php.net/

"We must be the change we wish to see." - M. K. Ghandi