Re: missing docs
On Thu, 4 Jan 2001, Vivek Khera wrote: > In answering another question today, I noticed that the variable > $Apache::Registry::NameWithVirtualHost is not documented in the > perldoc for Apache::Registry. > > While scanning the Registry.pm file, I further noticed that there is a > call to $r->get_server_name for the virtual host name. This too is > not documented in perldoc Apache. The only documented way I see to > get this from the $r object is to use $r->server->server_hostname. i think you'll find plenty more that is not documented in the pods. when i started working on the eagle book with lincoln, i focused all documention effort there. i had hoped at some point the mod_perl docs would get a major overhaul, just hasn't happened yet. but patches have been coming in to fill holes, more are always welcome. > Should $r->get_server_name() be documented, or is it a "private" > method? It seems wasteful to create an Apache::Server object just to > fetch the virtual host name. $r->get_server_name is public, and is already used in Registry/PerlRun, but $r->server->is_virtual is still used.
RE: missing docs
> -Original Message- > From: Vivek Khera [mailto:[EMAIL PROTECTED]] > Sent: Thursday, January 04, 2001 12:23 PM > To: Mod Perl List > Subject: missing docs > > > In answering another question today, I noticed that the variable > $Apache::Registry::NameWithVirtualHost is not documented in the > perldoc for Apache::Registry. > > While scanning the Registry.pm file, I further noticed that there is a > call to $r->get_server_name for the virtual host name. This too is > not documented in perldoc Apache. The only documented way I see to > get this from the $r object is to use $r->server->server_hostname. > > Should $r->get_server_name() be documented, or is it a "private" > method? they are both documented (along with their differences) in the Eagle book - I guess perldoc Apache is just behind (as seems to be the usual case)... Andrew Ford's new mod_perl Pocket Reference goes a long way toward documenting new functionality as of 1.24, but I suppose it's virually impossible to keep up with the pace of development. Just take a look at the Changes file from 1.24 to current cvs. ack... --Geoff > It seems wasteful to create an Apache::Server object just to > fetch the virtual host name. > > -- > =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= > Vivek Khera, Ph.D.Khera Communications, Inc. > Internet: [EMAIL PROTECTED] Rockville, MD +1-240-453-8497 > AIM: vivekkhera Y!: vivek_khera http://www.khera.org/~vivek/ >