Doc #65532 [Opn->Nab]: Recommendation to remove undocumented configuration directives

Edit report at https://bugs.php.net/bug.php?id=65532&edit=1 ID: 65532 Updated by: krakjoe@php.net Reported by: cevfora at elitemail dot org Summary: Recommendation to remove undocumented configuration directives -Status: Open +Status: Not a bug Type: Documentation Problem Package: Documentation problem PHP Version: Irrelevant Block user comment: N Private report: N New Comment: This bug has been fixed in the documentation's XML sources. Since the online and downloadable versions of the documentation need some time to get updated, we would like to ask you to be a bit patient. Thank you for the report, and for helping us make our documentation better. The INI list is not meant to function as a sitemap, it is meant to provide an exhausting list, it does not necessarily have to link to other manual pages for every option on the page. I have removed the old extensions from the ini list. Previous Comments: ------------------------------------------------------------------------ [2013-08-22 22:52:20] cevfora at elitemail dot org Description: ------------ PROBLEM: The page titled "List of php.ini directives" at http://www.php.net/manual/en/ini.list.php includes directives lacking documentation such as axis2.* birdstep.max_links coin_acceptor.* daffodildb.* imlib2.* intl.* ircg.* pam.servicename python.* simple_cvs.* uploadprogress.file.filename_template valkyrie.* velocis.max_links vld.* xmms.* yami.response.timeout These directives A) lack links to documentation, and B) have no corresponding PHP extensions listed on the page http://www.php.net/manual/en/extensions.alphabetical.php where the extension name would be implied from the configuration directive name of the form <extension name>.<parameter> (e.g. pam.servicename implies extension "pam"). Moreover, PECL does not have packages with the names birdstep, ircg, velocis, simple_cvs) according to searches at http://pecl.php.net/package-search.php RECOMMENDATION: A) Remove these directives from the page "List of php.ini directives" and no longer make an effort to document them on www.php.net. or ... B) Remove these directives from the page "List of php.ini directives" and move them to a new page (e.g. "Directives Formerly Documented on www.php.net"). or ... C) Retain these directives on the page "List of php.ini directives" and provide links to a page that informs the programmer seeking documentation that the corresponding PHP extensions are no longer being documented at php.net. OPINION: The following are my opinions on these 3 possible solutions. I recognize that others may have different, and more enlightened insight into the realities of documenting a list of configuration directives that continues to evolve. Solution A is cleanest; if a directive is listed, then it is documented. Solution B could provide a resource for the programmer who asks "What happened to the directive I used 8 years ago that appears to be missing?". Solution C inelegantly combines directives currently documented on www.php.net with directives no longer adequately documented on the site. Over time the list of directives may grow with the undocumented directives becoming a larger fraction of the total set of listed directives, diluting the value of the list. The programmer would find no clear documentation of why some configuration directive "remnants" are left in the list while many other extensions (as provided in numerous PECL packages) are not documented at all. ------------------------------------------------------------------------ -- Edit this bug report at https://bugs.php.net/bug.php?id=65532&edit=1