Bug 2507 - Documentation out of sync with implementation regarding tmsize_t vs. tsize_t
: Documentation out of sync with implementation regarding tmsize_t vs. tsize_t
Status: RESOLVED LATER
: libtiff
default
: 4.0.1
: All All
: P2 trivial
: ---
Assigned To:
:
:
: migrated_to_gitlab
:
:
  Show dependency treegraph
 
Reported: 2015-04-01 06:44 by
Modified: 2019-10-01 14:20 (History)


Attachments


Note

You need to log in before you can comment on or make changes to this bug.


Description From 2015-04-01 06:44:59
The documentation in libtiff/html/man/TIFFReadEncodedStrip.3tiff.html and in
the documentation source file libtiff/man/TIFFReadEncodedStrip.3tiff contains
the following prototype:

tsize_t TIFFReadEncodedStrip(TIFF *tif, tstrip_t strip, tdata_t buf, tsize_t
size)

However the function is actually implemented as:

tmsize_t
TIFFReadEncodedStrip(TIFF* tif, uint32 strip, void* buf, tmsize_t size)

Note the difference between tmsize_t and tsize_t.

I checked a few other functions, and the same problem seems to exist for many
functions. For example the documentation for the following functions is wrong
as well:

tsize_t TIFFStripSize(TIFF *tif)
tsize_t TIFFVStripSize(TIFF *tif, uint32 nrows)
tsize_t TIFFRawStripSize(TIFF *tif, tstrip_t strip)
------- Comment #1 From 2019-10-01 14:20:03 -------
Bugzilla is no longer used for tracking libtiff issues. Remaining open tickets,
such as this one, have been migrated to the libtiff GitLab instance at
https://gitlab.com/libtiff/libtiff/issues .

The migrated tickets have their summary prefixed with [BZ#XXXX] where XXXX is
the initial Bugzilla issue number.