DO NOT REPLY [Bug 35975] New: - Confusing documentation for apr_pool_cleanup_run()

[bu...@apache.org]

DO NOT REPLY TO THIS EMAIL, BUT PLEASE POST YOUR BUG�
RELATED COMMENTS THROUGH THE WEB INTERFACE AVAILABLE AT
<http://issues.apache.org/bugzilla/show_bug.cgi?id=35975>.
ANY REPLY MADE TO THIS MESSAGE WILL NOT BE COLLECTED AND�
INSERTED IN THE BUG DATABASE.

http://issues.apache.org/bugzilla/show_bug.cgi?id=35975

           Summary: Confusing documentation for apr_pool_cleanup_run()
           Product: APR
           Version: HEAD
          Platform: Other
        OS/Version: other
            Status: NEW
          Severity: normal
          Priority: P2
         Component: APR
        AssignedTo: bugs@httpd.apache.org
        ReportedBy: zilla@kayari.org


The docs for apr_pool_cleanup_run() say the function will "Use 'data' instead of
the data that was registered with the cleanup."

See http://apr.apache.org/docs/apr/group__apr__pools.html#ga27

This is confusing and wrong, because unless the same address is passed as was
given when registering the cleanup then no cleanup will be killed, so there is
no "data that was registered with the cleanup".  Alternatively, if the same
pointer was given and a cleanup killed, then the two 'data' pointers have the
same value, so what does it matter which one is used?

The comment seems to have been written by someone trying to describe the
implementation, which is completely irrelevant to a user of the function who
only wants to know how it works.  The part about which 'data' is used should be
removed from the docs.

-- 
Configure bugmail: http://issues.apache.org/bugzilla/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
You are the assignee for the bug, or are watching the assignee.

---------------------------------------------------------------------
To unsubscribe, e-mail: bugs-unsubscribe@httpd.apache.org
For additional commands, e-mail: bugs-help@httpd.apache.org