Doc #67065 [NEW]: Incorrect documentation for 'ip2long'

From: Date: Sun, 13 Apr 2014 17:50:33 +0000
Subject: Doc #67065 [NEW]: Incorrect documentation for 'ip2long'
Groups: php.doc.bugs 
Request: Send a blank email to doc-bugs+get-11138@lists.php.net to get a copy of this message
From: bsasser at sindtech dot net Operating system: n/a PHP version: Irrelevant Package: Documentation problem Bug Type: Documentation Problem Bug description:Incorrect documentation for 'ip2long' Description: ------------ --- From manual page: http://www.php.net/function.ip2long (specifically http://us2.php.net/manual/en/function.ip2long.php ) --- 1) The first line incorrectly states: "ip2long — Converts a string containing an (IPv4) Internet Protocol dotted address into a proper address" This function is to convert IPv4 address to long integers (hence the name - 'ip2long'). The incorrect statement above applies to long2ip(). 2) The Description correctly shows: int ip2long ( string $ip_address ) The statement under the above incorrectly shows: "The function ip2long() generates an IPv4 Internet network address from its Internet standard format (dotted string) representation." That is not the purpose of this function (see #1). 3) Under Parameters it states: "ip_address A standard format address." which is correct. Under Return Values it states: "Returns the IPv4 address or FALSE if ip_address is invalid." which is incorrect. It is not what this function does (see #1). Test script: --------------- n/a Expected result: ---------------- Technically accurate documentation ;-) Actual result: -------------- What looks like document editing done late at night. See Description. -- Edit bug report at https://bugs.php.net/bug.php?id=67065&edit=1 -- Try a snapshot (PHP 5.4): https://bugs.php.net/fix.php?id=67065&r=trysnapshot54 Try a snapshot (PHP 5.5): https://bugs.php.net/fix.php?id=67065&r=trysnapshot55 Try a snapshot (trunk): https://bugs.php.net/fix.php?id=67065&r=trysnapshottrunk Fixed in SVN: https://bugs.php.net/fix.php?id=67065&r=fixed Fixed in release: https://bugs.php.net/fix.php?id=67065&r=alreadyfixed Need backtrace: https://bugs.php.net/fix.php?id=67065&r=needtrace Need Reproduce Script: https://bugs.php.net/fix.php?id=67065&r=needscript Try newer version: https://bugs.php.net/fix.php?id=67065&r=oldversion Not developer issue: https://bugs.php.net/fix.php?id=67065&r=support Expected behavior: https://bugs.php.net/fix.php?id=67065&r=notwrong Not enough info: https://bugs.php.net/fix.php?id=67065&r=notenoughinfo Submitted twice: https://bugs.php.net/fix.php?id=67065&r=submittedtwice register_globals: https://bugs.php.net/fix.php?id=67065&r=globals PHP 4 support discontinued: https://bugs.php.net/fix.php?id=67065&r=php4 Daylight Savings: https://bugs.php.net/fix.php?id=67065&r=dst IIS Stability: https://bugs.php.net/fix.php?id=67065&r=isapi Install GNU Sed: https://bugs.php.net/fix.php?id=67065&r=gnused Floating point limitations: https://bugs.php.net/fix.php?id=67065&r=float No Zend Extensions: https://bugs.php.net/fix.php?id=67065&r=nozend MySQL Configuration Error: https://bugs.php.net/fix.php?id=67065&r=mysqlcfg

« previous php.doc.bugs (#11138) next »