php.net |  support |  documentation |  report a bug |  advanced search |  search howto |  statistics |  random bug |  login

go to bug id or search bugs for

Doc Bug #31025 Unclear summaries between the 4 gz-foo functions
Submitted: 2004-12-08 20:34 UTC Modified: 2004-12-20 03:33 UTC
Votes:1
Avg. Score:1.0 ± 0.0
Reproduced:1 of 1 (100.0%)
Same Version:0 (0.0%)
Same OS:0 (0.0%)
From: php at atu dot cjb dot net Assigned:
Status: Closed Package: Documentation problem
PHP Version: Irrelevant OS: Irrelevant
Private report: No CVE-ID: None
View Developer Edit
 [2004-12-08 20:34 UTC] php at atu dot cjb dot net 
Description:
------------
These two make sense:

gzdeflate -- Deflate a string
gzinflate -- Inflate a deflated string

These two do not:

gzcompress -- Compress a string
gzuncompress -- Uncompress a deflated string

I don't know the internal of these functions well enough to say which way would be correct, but the way it is now is clearly not accurate.  Both of them say it is acting on a deflated string, however gzcompress() does not say it creates a deflated string.

Any clarity would be nice.  Thank you.

Patches

Pull Requests

History

AllCommentsChangesGit/SVN commitsRelated reports
 [2004-12-10 19:45 UTC] nlopess@php.net 
The difference is clearly stated in the manual.
gzencode() includes the gzip headers, while gzcompress don't.
 [2004-12-10 20:00 UTC] php at atu dot cjb dot net 
I don't think you noticed what I was talking about.  I am not saying the documentation for these functions is way off or anything like that.  All I am saying is that there are two pairs of functions here, and their summary lines do not match up.

The summaries for gzdeflate and gzinflate are a match: Deflate, then inflate.

But for gzcompress and gzuncompress the summaries are not a match: Compress a string, then uncompress a deflated string.

There is no mention of deflating the string in the summary for gzcompress.  All I am asking for is to make these two pairs of functions have summaries that match with the other.
 [2004-12-20 03:33 UTC] didou@php.net 
changed gzuncopress to: Uncompress a compressed string, which make more sense. Thank you for you report.

didou
 [2020-02-07 06:11 UTC] phpdocbot@php.net 
Automatic comment on behalf of didou
Revision: http://git.php.net/?p=doc/en.git;a=commit;h=4e82a2f7d2b3b6879ea61908f5db57193511d0a9
Log: fix #31025: fix summary of gzuncompress
 
PHP Copyright © 2001-2025 The PHP Group
All rights reserved. 		Last updated: Sat Jul 12 01:01:32 2025 UTC