diff options
| author | Roger Leigh <rleigh@codelibre.net> | 2022-06-24 15:17:51 +0100 |
|---|---|---|
| committer | Roger Leigh <rleigh@codelibre.net> | 2022-06-24 15:49:14 +0100 |
| commit | 107070b9abd03a4e47aa897669439e023d171b71 (patch) | |
| tree | 07e413b8db74d2939c1f79bcfd9d5bd5960d0a48 /doc | |
| parent | 6ab8136187c02939b887730475bafc4711fa822e (diff) | |
| download | libtiff-git-107070b9abd03a4e47aa897669439e023d171b71.tar.gz | |
doc: Correct types and cross-references
Diffstat (limited to 'doc')
38 files changed, 224 insertions, 227 deletions
diff --git a/doc/addingtags.rst b/doc/addingtags.rst index 8d190cc2..d3f2d8a9 100644 --- a/doc/addingtags.rst +++ b/doc/addingtags.rst @@ -171,7 +171,7 @@ desired TIFF handle with the list of :c:struct:`TIFFFieldInfo`. The tags need to be defined for each TIFF file opened - and when reading they should be defined before the tags of the file are read, yet a valid -:c:type:`TIFF *` is needed to merge the tags against. In order to get them +:c:expr:`TIFF *` is needed to merge the tags against. In order to get them registered at the appropriate part of the setup process, it is necessary to register our merge function as an extender callback with libtiff. This is done with :c:func:`TIFFSetTagExtender`. We also keep track of the @@ -225,7 +225,7 @@ Adding New Builtin Tags ----------------------- A similar approach is taken to the above. However, the :c:struct:`TIFFFieldInfo` -should be added to the :c:var:`tiffFieldInfo[]` list in :file:`tif_dirinfo.c`. +should be added to the :c:expr:`tiffFieldInfo[]` list in :file:`tif_dirinfo.c`. Ensure that new tags are added in sorted order by the tag number. Normally new built-in tags should be defined with :c:macro:`FIELD_CUSTOM`; however, if @@ -235,7 +235,7 @@ add appropriate handling as follows: #. Define the tag in :file:`tiff.h`. #. Add a field to the directory structure in :file:`tif_dir.h` - and define a :c:macro:`FIELD_*` bit (also update the definition of + and define a ``FIELD_*`` bit (also update the definition of :c:macro:`FIELD_CODEC` to reflect your addition). #. Add an entry in the :c:struct:`TIFFFieldInfo` array defined at the top of :file:`tif_dirinfo.c`. @@ -258,7 +258,7 @@ add appropriate handling as follows: If you want to maintain portability, beware of making assumptions about data types. Use the typedefs (:c:type:`uint16_t`, etc. when dealing with -data on disk and :c:type:`t*_t` when stuff is in memory) and be careful about +data on disk and ``t*_t`` when stuff is in memory) and be careful about passing items through printf or similar vararg interfaces. Adding New Codec-private Tags @@ -297,15 +297,15 @@ algorithm is used* follow these steps: #. Fill in the get and set routines. Be sure to call the parent method for tags that you are not handled directly. Also be sure to set the - :c:macro:`FIELD_*` bits for tags that are to be written to the file. Note that + ``FIELD_*`` bits for tags that are to be written to the file. Note that you can create "pseudo-tags" by defining tags that are processed exclusively in the get/set routines and never written to file (see the handling of :c:macro:`TIFFTAG_FAXMODE` in :file:`tif_fax3.c` for an example of this). #. Fill in the print routine, if appropriate. -Note that space has been allocated in the :c:macro:`FIELD_*` bit space for -codec-private tags. Define your bits as :c:macro:`FIELD_CODEC+<offset>` to +Note that space has been allocated in the ``FIELD_*`` bit space for +codec-private tags. Define your bits as ``FIELD_CODEC+<offset>`` to keep them away from the core tags. If you need more tags than there is room for, just increase :c:macro:`FIELD_SETLONGS` at the top of :file:`tiffiop.h`. diff --git a/doc/build.rst b/doc/build.rst index 96b3af5f..6853b867 100644 --- a/doc/build.rst +++ b/doc/build.rst @@ -622,7 +622,7 @@ it to view any of the sample images available for testing, or try :doc:`/tools/tiffinfo` to display the file metadata. See the :doc:`images` section on obtaining the test images. Otherwise, you can do a cursory check of the library with the :doc:`/tools/tiffcp` and -:doc:`/tools.tiffcmp` programs. For example, +:doc:`/tools/tiffcmp` programs. For example, .. code-block:: shell diff --git a/doc/conf.py b/doc/conf.py index 52547740..9cafcd32 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -83,7 +83,7 @@ html_theme = 'sphinxdoc' # so a file named "default.css" will overwrite the builtin "default.css". html_static_path = ['_static'] -html_extra_path = ['static'] +html_extra_path = [] # -- Options for manual page output -------------------------------------------- diff --git a/doc/contrib.rst b/doc/contrib.rst index ba687efb..58617b89 100644 --- a/doc/contrib.rst +++ b/doc/contrib.rst @@ -64,7 +64,7 @@ aren't directly TIFF related). * - :file:`contrib/pds` - various routines from Conrad Poelman; a TIFF image iterator and - code to support ``private sub-directories'' + code to support "private sub-directories" * - :file:`contrib/iptcutil` - A utility by `Bill Radcliffe <billr@corbis.com>`_ to diff --git a/doc/functions/TIFFFieldWriteCount.rst b/doc/functions/TIFFFieldWriteCount.rst index d03a2a62..7a2a4a5e 100644 --- a/doc/functions/TIFFFieldWriteCount.rst +++ b/doc/functions/TIFFFieldWriteCount.rst @@ -25,8 +25,8 @@ but there are some special values: :c:type:`uint16_t` *count* argument and a pointer *data* argument must be supplied to :c:func:`TIFFSetField`. * :c:macro:`TIFF_VARIABLE2` is the same as :c:macro:`TIFF_VARIABLE` except that the - *count* argument must have type :c:type:`uint32_t`. (On most modern machines, this makes - no practical difference, and the *count* argument can simply be an :c:type:`int` in + *count* argument must have type :c:expr:`uint32_t`. (On most modern machines, this makes + no practical difference, and the *count* argument can simply be an :c:expr:`int` in either case.) * :c:type:`TIFF_SPP` indicates that the number of arguments must be equal to the image's number of samples per pixel. diff --git a/doc/functions/TIFFGetField.rst b/doc/functions/TIFFGetField.rst index 8acac264..cec88e09 100644 --- a/doc/functions/TIFFGetField.rst +++ b/doc/functions/TIFFGetField.rst @@ -62,377 +62,377 @@ information on the meaning of each tag and their possible values. * - :c:macro:`TIFFTAG_ARTIST` - 1 - - :c:type:`const char**` + - :c:expr:`const char**` - * - :c:macro:`TIFFTAG_BADFAXLINES` - 1 - - :c:type:`uint32_t*` + - :c:expr:`uint32_t*` - * - :c:macro:`TIFFTAG_BITSPERSAMPLE` - 1 - - :c:type:`uint16_t*` + - :c:expr:`uint16_t*` - * - :c:macro:`TIFFTAG_CLEANFAXDATA` - 1 - - :c:type:`uint16_t*` + - :c:expr:`uint16_t*` - * - :c:macro:`TIFFTAG_COLORMAP` - 3 - - :c:type:`const uint16_t**` + - :c:expr:`const uint16_t**` - :c:expr:`1<<BitsPerSample` arrays * - :c:macro:`TIFFTAG_COMPRESSION` - 1 - - :c:type:`uint16_t*` + - :c:expr:`uint16_t*` - * - :c:macro:`TIFFTAG_CONSECUTIVEBADFAXLINES` - 1 - - :c:type:`uint32_t*` + - :c:expr:`uint32_t*` - * - :c:macro:`TIFFTAG_COPYRIGHT` - 1 - - :c:type:`const char**` + - :c:expr:`const char**` - * - :c:macro:`TIFFTAG_DATATYPE` - 1 - - :c:type:`uint16_t*` + - :c:expr:`uint16_t*` - * - :c:macro:`TIFFTAG_DATETIME` - 1 - - :c:type:`const char**` + - :c:expr:`const char**` - * - :c:macro:`TIFFTAG_DOCUMENTNAME` - 1 - - :c:type:`const char**` + - :c:expr:`const char**` - * - :c:macro:`TIFFTAG_DOTRANGE` - 2 - - :c:type:`uint16_t*` + - :c:expr:`uint16_t*` - * - :c:macro:`TIFFTAG_EXTRASAMPLES` - 2 - - :c:type:`uint16_t*`, :c:type:`const uint16_t**` + - :c:expr:`uint16_t*`, :c:expr:`const uint16_t**` - count, types array * - :c:macro:`TIFFTAG_FAXFILLFUNC` - 1 - - :c:type:`TIFFFaxFillFunc*` + - :c:expr:`TIFFFaxFillFunc*` - G3/G4 compression pseudo-tag * - :c:macro:`TIFFTAG_FAXMODE` - 1 - - :c:type:`int*` + - :c:expr:`int*` - G3/G4 compression pseudo-tag * - :c:macro:`TIFFTAG_FILLORDER` - 1 - - :c:type:`uint16_t*` + - :c:expr:`uint16_t*` - * - :c:macro:`TIFFTAG_GROUP3OPTIONS` - 1 - - :c:type:`uint32_t*` + - :c:expr:`uint32_t*` - * - :c:macro:`TIFFTAG_GROUP4OPTIONS` - 1 - - :c:type:`uint32_t*` + - :c:expr:`uint32_t*` - * - :c:macro:`TIFFTAG_HALFTONEHINTS` - 2 - - :c:type:`uint16_t*` + - :c:expr:`uint16_t*` - * - :c:macro:`TIFFTAG_HOSTCOMPUTER` - 1 - - :c:type:`const char**` + - :c:expr:`const char**` - * - :c:macro:`TIFFTAG_ICCPROFILE` - 2 - - :c:type:`const uint32_t*`, :c:type:`const void**` + - :c:expr:`const uint32_t*`, :c:expr:`const void**` - count, profile data‡ * - :c:macro:`TIFFTAG_IMAGEDEPTH` - 1 - - :c:type:`uint32_t*` + - :c:expr:`uint32_t*` - * - :c:macro:`TIFFTAG_IMAGEDESCRIPTION` - 1 - - :c:type:`const char**` + - :c:expr:`const char**` - * - :c:macro:`TIFFTAG_IMAGELENGTH` - 1 - - :c:type:`uint32_t*` + - :c:expr:`uint32_t*` - * - :c:macro:`TIFFTAG_IMAGEWIDTH` - 1 - - :c:type:`uint32_t*` + - :c:expr:`uint32_t*` - * - :c:macro:`TIFFTAG_INKNAMES` - 1 - - :c:type:`const char**` + - :c:expr:`const char**` - * - :c:macro:`TIFFTAG_INKSET` - 1 - - :c:type:`uint16_t*` + - :c:expr:`uint16_t*` - * - :c:macro:`TIFFTAG_JPEGCOLORMODE` - 1 - - :c:type:`int*` + - :c:expr:`int*` - JPEG pseudo-tag * - :c:macro:`TIFFTAG_JPEGQUALITY` - 1 - - :c:type:`int*` + - :c:expr:`int*` - JPEG pseudo-tag * - :c:macro:`TIFFTAG_JPEGTABLES` - 2 - - :c:type:`uint32_t*`, :c:type:`const void**` + - :c:expr:`uint32_t*`, :c:expr:`const void**` - count, tables * - :c:macro:`TIFFTAG_JPEGTABLESMODE` - 1 - - :c:type:`int*` + - :c:expr:`int*` - JPEG pseudo-tag * - :c:macro:`TIFFTAG_MAKE` - 1 - - :c:type:`const char**` + - :c:expr:`const char**` - * - :c:macro:`TIFFTAG_MATTEING` - 1 - - :c:type:`uint16_t*` + - :c:expr:`uint16_t*` - * - :c:macro:`TIFFTAG_MAXSAMPLEVALUE` - 1 - - :c:type:`uint16_t*` + - :c:expr:`uint16_t*` - * - :c:macro:`TIFFTAG_MINSAMPLEVALUE` - 1 - - :c:type:`uint16_t*` + - :c:expr:`uint16_t*` - * - :c:macro:`TIFFTAG_MODEL` - 1 - - :c:type:`const char**` + - :c:expr:`const char**` - * - :c:macro:`TIFFTAG_ORIENTATION` - 1 - - :c:type:`uint16_t*` + - :c:expr:`uint16_t*` - * - :c:macro:`TIFFTAG_PAGENAME` - 1 - - :c:type:`const char**` + - :c:expr:`const char**` - * - :c:macro:`TIFFTAG_PAGENUMBER` - 2 - - :c:type:`uint16_t*` + - :c:expr:`uint16_t*` - * - :c:macro:`TIFFTAG_PHOTOMETRIC` - 1 - - :c:type:`uint16_t*` + - :c:expr:`uint16_t*` - * - :c:macro:`TIFFTAG_PHOTOSHOP` - 2 - - :c:type:`uint32_t*`, :c:type:`const void**` + - :c:expr:`uint32_t*`, :c:expr:`const void**` - count, data * - :c:macro:`TIFFTAG_PLANARCONFIG` - 1 - - :c:type:`uint16_t*` + - :c:expr:`uint16_t*` - * - :c:macro:`TIFFTAG_PREDICTOR` - 1 - - :c:type:`uint16_t*` + - :c:expr:`uint16_t*` - * - :c:macro:`TIFFTAG_PRIMARYCHROMATICITIES` - 1 - - :c:type:`const float**` + - :c:expr:`const float**` - 6-entry array * - :c:macro:`TIFFTAG_REFERENCEBLACKWHITE` - 1 - - :c:type:`const float**` + - :c:expr:`const float**` - 6-entry array * - :c:macro:`TIFFTAG_RESOLUTIONUNIT` - 1 - - :c:type:`uint16_t*` + - :c:expr:`uint16_t*` - * - :c:macro:`TIFFTAG_RICHTIFFIPTC` - 2 - - :c:type:`uint32_t*`, :c:type:`const void**` + - :c:expr:`uint32_t*`, :c:expr:`const void**` - count, data * - :c:macro:`TIFFTAG_ROWSPERSTRIP` - 1 - - :c:type:`uint32_t*` + - :c:expr:`uint32_t*` - * - :c:macro:`TIFFTAG_SAMPLEFORMAT` - 1 - - :c:type:`uint16_t*` + - :c:expr:`uint16_t*` - * - :c:macro:`TIFFTAG_SAMPLESPERPIXEL` - 1 - - :c:type:`uint16_t*` + - :c:expr:`uint16_t*` - * - :c:macro:`TIFFTAG_SMAXSAMPLEVALUE` - 1 - - :c:type:`double*` + - :c:expr:`double*` - * - :c:macro:`TIFFTAG_SMINSAMPLEVALUE` - 1 - - :c:type:`double*` + - :c:expr:`double*` - * - :c:macro:`TIFFTAG_SOFTWARE` - 1 - - :c:type:`const char**` + - :c:expr:`const char**` - * - :c:macro:`TIFFTAG_STONITS` - 1 - - :c:type:`const double**` + - :c:expr:`const double**` - * - :c:macro:`TIFFTAG_STRIPBYTECOUNTS` - 1 - - :c:type:`const uint64_t**` + - :c:expr:`const uint64_t**` - * - :c:macro:`TIFFTAG_STRIPOFFSETS` - 1 - - :c:type:`const uint64_t**` + - :c:expr:`const uint64_t**` - * - :c:macro:`TIFFTAG_SUBFILETYPE` - 1 - - :c:type:`uint32_t*` + - :c:expr:`uint32_t*` - * - :c:macro:`TIFFTAG_SUBIFD` - 2 - - :c:type:`uint16_t*`, :c:type:`const uint64_t**` + - :c:expr:`uint16_t*`, :c:expr:`const uint64_t**` - count, offsets array * - :c:macro:`TIFFTAG_TARGETPRINTER` - 1 - - :c:type:`const char**` + - :c:expr:`const char**` - * - :c:macro:`TIFFTAG_THRESHHOLDING` - 1 - - :c:type:`uint16_t*` + - :c:expr:`uint16_t*` - * - :c:macro:`TIFFTAG_TILEBYTECOUNTS` - 1 - - :c:type:`const uint64_t**` + - :c:expr:`const uint64_t**` - * - :c:macro:`TIFFTAG_TILEDEPTH` - 1 - - :c:type:`uint32_t*` + - :c:expr:`uint32_t*` - * - :c:macro:`TIFFTAG_TILELENGTH` - 1 - - :c:type:`uint32_t*` + - :c:expr:`uint32_t*` - * - :c:macro:`TIFFTAG_TILEOFFSETS` - 1 - - :c:type:`const uint64_t**` + - :c:expr:`const uint64_t**` - * - :c:macro:`TIFFTAG_TILEWIDTH` - 1 - - :c:type:`uint32_t*` + - :c:expr:`uint32_t*` - * - :c:macro:`TIFFTAG_TRANSFERFUNCTION` - 1 or 3† - - :c:type:`const uint16_t**` + - :c:expr:`const uint16_t**` - :c:expr:`1<<BitsPerSample` entry arrays * - :c:macro:`TIFFTAG_WHITEPOINT` - 1 - - :c:type:`const float**` + - :c:expr:`const float**` - 2-entry array * - :c:macro:`TIFFTAG_XMLPACKET` - 2 - - :c:type:`uint32_t*,const void**` + - :c:expr:`uint32_t*`, :c:expr:`const void**` - count, data * - :c:macro:`TIFFTAG_XPOSITION` - 1 - - :c:type:`float*` + - :c:expr:`float*` - * - :c:macro:`TIFFTAG_XRESOLUTION` - 1 - - :c:type:`float*` + - :c:expr:`float*` - * - :c:macro:`TIFFTAG_YCBCRCOEFFICIENTS` - 1 - - :c:type:`const float**` + - :c:expr:`const float**` - 3-entry array * - :c:macro:`TIFFTAG_YCBCRPOSITIONING` - 1 - - :c:type:`uint16_t*` + - :c:expr:`uint16_t*` - * - :c:macro:`TIFFTAG_YCBCRSUBSAMPLING` - 2 - - :c:type:`uint16_t*` + - :c:expr:`uint16_t*` - * - :c:macro:`TIFFTAG_YPOSITION` - 1 - - :c:type:`float*` + - :c:expr:`float*` - * - :c:macro:`TIFFTAG_YRESOLUTION` - 1 - - :c:type:`float*` + - :c:expr:`float*` - †: diff --git a/doc/functions/TIFFRGBAImage.rst b/doc/functions/TIFFRGBAImage.rst index f61d314e..cd4ea0b1 100644 --- a/doc/functions/TIFFRGBAImage.rst +++ b/doc/functions/TIFFRGBAImage.rst @@ -229,7 +229,6 @@ See also :doc:`TIFFOpen` (3tiff), :doc:`TIFFReadRGBAImage` (3tiff), -:doc:`TIFFReadRGBAImageOriented` (3tiff), :doc:`TIFFReadRGBAStrip` (3tiff), :doc:`TIFFReadRGBATile` (3tiff), :doc:`libtiff` (3tiff) diff --git a/doc/functions/TIFFReadDirectory.rst b/doc/functions/TIFFReadDirectory.rst index db07b601..751b2701 100644 --- a/doc/functions/TIFFReadDirectory.rst +++ b/doc/functions/TIFFReadDirectory.rst @@ -139,5 +139,4 @@ See also :doc:`TIFFOpen` (3tiff), :doc:`TIFFWriteDirectory` (3tiff), :doc:`TIFFSetDirectory` (3tiff), -:doc:`TIFFSetSubDirectory` (3tiff), :doc:`libtiff` (3tiff), diff --git a/doc/functions/TIFFReadRawStrip.rst b/doc/functions/TIFFReadRawStrip.rst index 82214d21..bd235636 100644 --- a/doc/functions/TIFFReadRawStrip.rst +++ b/doc/functions/TIFFReadRawStrip.rst @@ -39,5 +39,5 @@ See also :doc:`TIFFOpen` (3tiff), :doc:`TIFFReadEncodedStrip` (3tiff), :doc:`TIFFReadScanline` (3tiff), -:doc:`TIFFStripSize` (3tiff), +:doc:`TIFFstrip` (3tiff), :doc:`libtiff` (3tiff) diff --git a/doc/functions/TIFFReadRawTile.rst b/doc/functions/TIFFReadRawTile.rst index 68af1e7d..90e4d599 100644 --- a/doc/functions/TIFFReadRawTile.rst +++ b/doc/functions/TIFFReadRawTile.rst @@ -41,5 +41,5 @@ See also :doc:`TIFFOpen` (3tiff), :doc:`TIFFReadEncodedTile` (3tiff), :doc:`TIFFReadTile` (3tiff), -:doc:`TIFFTileSize` (3tiff), +:doc:`TIFFtile` (3tiff), :doc:`libtiff` (3tiff), diff --git a/doc/functions/TIFFReadTile.rst b/doc/functions/TIFFReadTile.rst index b7d6c31f..22c47832 100644 --- a/doc/functions/TIFFReadTile.rst +++ b/doc/functions/TIFFReadTile.rst @@ -50,8 +50,7 @@ All error messages are directed to the :c:func:`TIFFError` routine. See also -------- -:doc:`TIFFCheckTile` (3tiff), -:doc:`TIFFComputeTile` (3tiff), +:doc:`TIFFtile` (3tiff), :doc:`TIFFOpen` (3tiff), :doc:`TIFFReadEncodedTile` (3tiff), :doc:`TIFFReadRawTile` (3tiff), diff --git a/doc/functions/TIFFSetDirectory.rst b/doc/functions/TIFFSetDirectory.rst index a1382700..2d49c12d 100644 --- a/doc/functions/TIFFSetDirectory.rst +++ b/doc/functions/TIFFSetDirectory.rst @@ -12,7 +12,7 @@ Synopsis .. c:function:: int TIFFSetDirectory(TIFF* tif, tdir_t dirnum) -.. c:fucntion:: int TIFFSetSubDirectory(TIFF* tif, uint64_t diroff) +.. c:function:: int TIFFSetSubDirectory(TIFF* tif, uint64_t diroff) Description ----------- @@ -51,7 +51,7 @@ All error messages are directed to the :c:func:`TIFFError` routine. See also -------- -:doc:`TIFFCurrentDirectory` (3tiff), +:doc:`TIFFquery` (3tiff), :doc:`TIFFOpen` (3tiff), :doc:`TIFFReadDirectory` (3tiff), :doc:`TIFFWriteDirectory` (3tiff), diff --git a/doc/functions/TIFFSetField.rst b/doc/functions/TIFFSetField.rst index fff7252f..b3bf1616 100644 --- a/doc/functions/TIFFSetField.rst +++ b/doc/functions/TIFFSetField.rst @@ -46,16 +46,16 @@ The data types are: * - Type - Description - * - char* + * - :c:expr:`char*` - a null-terminated string corresponding to the ``ASCII`` data type - * - uint16_t + * - :c:expr:`uint16_t` - an unsigned 16-bit value - * - uint32_t + * - :c:expr:`uint32_t` - an unsigned 32-bit value; - * - uint16_t* + * - :c:expr:`uint16_t*` - an array of unsigned 16-bit values. - * - void* - an array of data values of unspecified type. + * - :c:expr:`void*` + - an array of data values of unspecified type. Consult the TIFF specification for information on the meaning of each tag. @@ -71,283 +71,283 @@ Consult the TIFF specification for information on the meaning of each tag. * - :c:macro:`TIFFTAG_ARTIST` - 1 - - :c:type:`char*` + - :c:expr:`char*` - * - :c:macro:`TIFFTAG_BADFAXLINES` - 1 - - :c:type:`uint32_t` + - :c:expr:`uint32_t` - * - :c:macro:`TIFFTAG_BITSPERSAMPLE` - 1 - - :c:type:`uint16_t` + - :c:expr:`uint16_t` - † * - :c:macro:`TIFFTAG_CLEANFAXDATA` - 1 - - :c:type:`uint16_t` + - :c:expr:`uint16_t` - * - :c:macro:`TIFFTAG_COLORMAP` - 3 - - :c:type:`uint16_t*` + - :c:expr:`uint16_t*` - :c:expr:`1<<BitsPerSample` arrays * - :c:macro:`TIFFTAG_COMPRESSION` - 1 - - :c:type:`uint16_t` + - :c:expr:`uint16_t` - † * - :c:macro:`TIFFTAG_CONSECUTIVEBADFAXLINES` - 1 - - :c:type:`uint32_t` + - :c:expr:`uint32_t` - * - :c:macro:`TIFFTAG_COPYRIGHT` - 1 - - :c:type:`char*` + - :c:expr:`char*` - * - :c:macro:`TIFFTAG_DATETIME` - 1 - - :c:type:`char*` + - :c:expr:`char*` - * - :c:macro:`TIFFTAG_DOCUMENTNAME` - 1 - - :c:type:`char*` + - :c:expr:`char*` - * - :c:macro:`TIFFTAG_DOTRANGE` - 2 - - :c:type:`uint16_t` + - :c:expr:`uint16_t` - * - :c:macro:`TIFFTAG_EXTRASAMPLES` - 2 - - :c:type:`uint16_t`, :c:type:`uint16_t*` + - :c:expr:`uint16_t`, :c:expr:`uint16_t*` - † count, types array * - :c:macro:`TIFFTAG_FAXFILLFUNC` - 1 - - :c:type:`TIFFFaxFillFunc` + - :c:expr:`TIFFFaxFillFunc` - G3/G4 compression pseudo-tag * - :c:macro:`TIFFTAG_FAXMODE` - 1 - - :c:type:`int` + - :c:expr:`int` - † G3/G4 compression pseudo-tag * - :c:macro:`TIFFTAG_FILLORDER` - 1 - - :c:type:`uint16_t` + - :c:expr:`uint16_t` - † * - :c:macro:`TIFFTAG_GROUP3OPTIONS` - 1 - - :c:type:`uint32_t` + - :c:expr:`uint32_t` - † * - :c:macro:`TIFFTAG_GROUP4OPTIONS` - 1 - - :c:type:`uint32_t` + - :c:expr:`uint32_t` - † * - :c:macro:`TIFFTAG_HALFTONEHINTS` - 2 - - :c:type:`uint16_t` + - :c:expr:`uint16_t` - * - :c:macro:`TIFFTAG_HOSTCOMPUTER` - 1 - - :c:type:`char*` + - :c:expr:`char*` - * - :c:macro:`TIFFTAG_ICCPROFILE` - 2 - - :c:type:`uint32_t`, :c:type:`void*` + - :c:expr:`uint32_t`, :c:expr:`void*` - count, profile data* * - :c:macro:`TIFFTAG_IMAGEDEPTH` - 1 - - :c:type:`uint32_t` + - :c:expr:`uint32_t` - † * - :c:macro:`TIFFTAG_IMAGEDESCRIPTION` - 1 - - :c:type:`char*` + - :c:expr:`char*` - * - :c:macro:`TIFFTAG_IMAGELENGTH` - 1 - - :c:type:`uint32_t` + - :c:expr:`uint32_t` - * - :c:macro:`TIFFTAG_IMAGEWIDTH` - 1 - - :c:type:`uint32_t` + - :c:expr:`uint32_t` - † * - :c:macro:`TIFFTAG_INKNAMES` - 2 - - :c:type:`uint16_t`, :c:type:`char*` + - :c:expr:`uint16_t`, :c:expr:`char*` - * - :c:macro:`TIFFTAG_INKSET` - 1 - - :c:type:`uint16_t` + - :c:expr:`uint16_t` - † * - :c:macro:`TIFFTAG_JPEGCOLORMODE` - 1 - - :c:type:`int` + - :c:expr:`int` - † JPEG pseudo-tag * - :c:macro:`TIFFTAG_JPEGQUALITY` - 1 - - :c:type:`int` + - :c:expr:`int` - JPEG pseudo-tag * - :c:macro:`TIFFTAG_JPEGTABLES` - 2 - - :c:type:`uint32_t*`, :c:type:`void*` + - :c:expr:`uint32_t*`, :c:expr:`void*` - † count, tables * - :c:macro:`TIFFTAG_JPEGTABLESMODE` - 1 - - :c:type:`int` + - :c:expr:`int` - † JPEG pseudo-tag * - :c:macro:`TIFFTAG_MAKE` - 1 - - :c:type:`char*` + - :c:expr:`char*` - * - :c:macro:`TIFFTAG_MATTEING` - 1 - - :c:type:`uint16_t` + - :c:expr:`uint16_t` - † * - :c:macro:`TIFFTAG_MAXSAMPLEVALUE` - 1 - - :c:type:`uint16_t` + - :c:expr:`uint16_t` - * - :c:macro:`TIFFTAG_MINSAMPLEVALUE` - 1 - - :c:type:`uint16_t` + - :c:expr:`uint16_t` - * - :c:macro:`TIFFTAG_MODEL` - 1 - - :c:type:`char*` + - :c:expr:`char*` - * - :c:macro:`TIFFTAG_ORIENTATION` - 1 - - :c:type:`uint16_t` + - :c:expr:`uint16_t` - * - :c:macro:`TIFFTAG_PAGENAME` - 1 - - :c:type:`char*` + - :c:expr:`char*` - * - :c:macro:`TIFFTAG_PAGENUMBER` - 2 - - :c:type:`uint16_t` + - :c:expr:`uint16_t` - * - :c:macro:`TIFFTAG_PHOTOMETRIC` - 1 - - :c:type:`uint16_t` + - :c:expr:`uint16_t` - * - :c:macro:`TIFFTAG_PHOTOSHOP` - ? - - :c:type:`uint32_t`, :c:type:`void*` + - :c:expr:`uint32_t`, :c:expr:`void*` - count, data * - :c:macro:`TIFFTAG_PLANARCONFIG` - 1 - - :c:type:`uint16_t` + - :c:expr:`uint16_t` - † * - :c:macro:`TIFFTAG_PREDICTOR` - 1 - - :c:type:`uint16_t` + - :c:expr:`uint16_t` - † * - :c:macro:`TIFFTAG_PRIMARYCHROMATICITIES` - 1 - - :c:type:`float*` + - :c:expr:`float*` - 6-entry array * - :c:macro:`TIFFTAG_REFERENCEBLACKWHITE` - 1 - - :c:type:`float*` + - :c:expr:`float*` - † 6-entry array * - :c:macro:`TIFFTAG_RESOLUTIONUNIT` - 1 - - :c:type:`uint16_t` + - :c:expr:`uint16_t` - * - :c:macro:`TIFFTAG_RICHTIFFIPTC` - 2 - - :c:type:`uint32_t`, :c:type:`void*` + - :c:expr:`uint32_t`, :c:expr:`void*` - count, data * - :c:macro:`TIFFTAG_ROWSPERSTRIP` - 1 - - :c:type:`uint32_t` + - :c:expr:`uint32_t` - † must be > 0 * - :c:macro:`TIFFTAG_SAMPLEFORMAT` - 1 - - :c:type:`uint16_t` + - :c:expr:`uint16_t` - † * - :c:macro:`TIFFTAG_SAMPLESPERPIXEL` - 1 - - :c:type:`uint16_t` + - :c:expr:`uint16_t` - † value must be ≤ 4 * - :c:macro:`TIFFTAG_SMAXSAMPLEVALUE` - 1 - - :c:type:`double` + - :c:expr:`double` - * - :c:macro:`TIFFTAG_SMINSAMPLEVALUE` - 1 - - :c:type:`double` + - :c:expr:`double` - * - :c:macro:`TIFFTAG_SOFTWARE` - 1 - - :c:type:`char*` + - :c:expr:`char*` - * - :c:macro:`TIFFTAG_STONITS` - 1 - - :c:type:`double` + - :c:expr:`double` - † * - :c:macro:`TIFFTAG_SUBFILETYPE` - 1 - - :c:type:`uint32_t` + - :c:expr:`uint32_t` - * - :c:macro:`TIFFTAG_SUBIFD` - 2 - - :c:type:`uint16_t`, :c:type:`uint64_t*` + - :c:expr:`uint16_t`, :c:expr:`uint64_t*` - count, offsets array * - :c:macro:`TIFFTAG_TARGETPRINTER` - 1 - - :c:type:`char*` + - :c:expr:`char*` - * - :c:macro:`TIFFTAG_THRESHHOLDING` - 1 - - :c:type:`uint16_t` + - :c:expr:`uint16_t` - * - :c:macro:`TIFFTAG_TILEDEPTH` - 1 - - :c:type:`uint32_t` + - :c:expr:`uint32_t` - † * - :c:macro:`TIFFTAG_TILELENGTH` - 1 - - :c:type:`uint32_t` + - :c:expr:`uint32_t` - † must be a multiple of 8 * - :c:macro:`TIFFTAG_TILEWIDTH` - 1 - - :c:type:`uint32_t` + - :c:expr:`uint32_t` - † must be a multiple of 8 * - :c:macro:`TIFFTAG_TRANSFERFUNCTION` - 1 or 3‡ - - :c:type:`uint16_t*` + - :c:expr:`uint16_t*` - :c:expr:`1<<BitsPerSample` entry arrays * - :c:macro:`TIFFTAG_WHITEPOINT` - 1 - - :c:type:`float*` + - :c:expr:`float*` - 2-entry array * - :c:macro:`TIFFTAG_XMLPACKET` - 2 - - :c:type:`uint32_t`, :c:type:`void*` + - :c:expr:`uint32_t`, :c:expr:`void*` - count, data * - :c:macro:`TIFFTAG_XPOSITION` - 1 - - :c:type:`float` + - :c:expr:`float` - * - :c:macro:`TIFFTAG_XRESOLUTION` - 1 - - :c:type:`float` + - :c:expr:`float` - * - :c:macro:`TIFFTAG_YCBCRCOEFFICIENTS` - 1 - - :c:type:`float*` + - :c:expr:`float*` - † 3-entry array * - :c:macro:`TIFFTAG_YCBCRPOSITIONING` - 1 - - :c:type:`uint16_t` + - :c:expr:`uint16_t` - † * - :c:macro:`TIFFTAG_YCBCRSAMPLING` - 2 - - :c:type:`uint16_t` + - :c:expr:`uint16_t` - † * - :c:macro:`TIFFTAG_YPOSITION` - 1 - - :c:type:`float` + - :c:expr:`float` - * - :c:macro:`TIFFTAG_YRESOLUTION` - 1 - - :c:type:`float` + - :c:expr:`float` - †: diff --git a/doc/functions/TIFFWriteTile.rst b/doc/functions/TIFFWriteTile.rst index 3e25d2c1..5044d0e0 100644 --- a/doc/functions/TIFFWriteTile.rst +++ b/doc/functions/TIFFWriteTile.rst @@ -42,8 +42,7 @@ All error messages are directed to the :c:func:`TIFFError` routine. See also -------- -:doc:`TIFFCheckTile` (3tiff), -:doc:`TIFFComputeTile` (3tiff), +:doc:`TIFFtile` (3tiff), :doc:`TIFFOpen` (3tiff), :doc:`TIFFReadTile` (3tiff), :doc:`TIFFWriteScanline` (3tiff), diff --git a/doc/functions/TIFFmemory.rst b/doc/functions/TIFFmemory.rst index 169a9681..826d6d22 100644 --- a/doc/functions/TIFFmemory.rst +++ b/doc/functions/TIFFmemory.rst @@ -14,7 +14,7 @@ Synopsis .. c:function:: tdata_t _TIFFrealloc(tdata_t buffer, tsize_t size) -.. c:function:: void _TIFFfree(tdata_t " buffer ") +.. c:function:: void _TIFFfree(tdata_t buffer) .. c:function:: void _TIFFmemset(tdata_t s, int c, tsize_t n) diff --git a/doc/functions/TIFFquery.rst b/doc/functions/TIFFquery.rst index bf146f76..fc55c91a 100644 --- a/doc/functions/TIFFquery.rst +++ b/doc/functions/TIFFquery.rst @@ -92,4 +92,3 @@ See also :doc:`libtiff` (3tiff), :doc:`TIFFOpen` (3tiff), -:doc:`TIFFFdOpen` (3tiff) diff --git a/doc/internals.rst b/doc/internals.rst index 21b60417..86014d9f 100644 --- a/doc/internals.rst +++ b/doc/internals.rst @@ -13,7 +13,7 @@ The following sections are found in this chapter: Library Configuration --------------------- -Information on compiling the library is given :ref:`build` +Information on compiling the library is given :doc:`build` elsewhere in this documentation. This section describes the low-level mechanisms used to control the optional parts of the library that are configured at build @@ -298,7 +298,7 @@ structure: * - :c:type:`ttag_t` - - :c:type:`unsigned int` + - :c:expr:`unsigned int` - directory tag * - :c:type:`tdir_t` @@ -322,11 +322,11 @@ structure: - i/o size in bytes * - :c:type:`tdata_t` - - :c:type:`void *` + - :c:expr:`void *` - image data ref * - :c:type:`thandle_t` - - :c:type:`void *` + - :c:expr:`void *` - client data handle * - :c:type:`toff_t` @@ -334,7 +334,7 @@ structure: - file offset (should be off_t) * - :c:type:`tidata_t` - - :c:type:`unsigned char *` + - :c:expr:`unsigned char *` - internal image data Note that :c:type:`tstrip_t`, :c:type:`ttile_t`, and :c:type:`tsize_t` @@ -345,7 +345,7 @@ field used to store the ``SamplesPerPixel`` tag. :c:type:`tdir_t` constrains the maximum number of IFDs that may appear in an image and may be an arbitrary size (without penalty). :c:type:`ttag_t` must be either -:c:type:`int`, :c:type:`unsigned int`, pointer, or :c:type:`double` +:c:expr:`int`, :c:expr:`unsigned int`, pointer, or :c:expr:`double` because the library uses a varargs interface and ANSI C restricts the type of the parameter before an ellipsis to be a promoted type. :c:type:`toff_t` is defined as @@ -373,7 +373,7 @@ Adding New Builtin Codecs To add builtin support for a new compression algorithm, you can either use the "tag-extension" trick to override the handling of the -TIFF Compression tag (see :ref:`addingtags`), +TIFF Compression tag (see :doc:`addingtags`), or do the following to add support directly to the core library: * Define the tag value in :file:`tiff.h`. @@ -449,7 +449,7 @@ for the library to automatically flush data. The variable variable :c:member:`tif_tilesize` is the size of a tile for tiled images. This should not normally be used by compression routines, except where it relates to the compression algorithm. That is, the ``cc`` parameter to the -:c:member:`tif_decode*` and :c:member:`tif_encode*` +:c:expr:`tif_decode*` and :c:expr:`tif_encode*` routines should be used in terminating decompression/compression. This ensures these routines can be used, for example, to decode/encode entire strips of data. diff --git a/doc/libtiff.rst b/doc/libtiff.rst index 73aba89e..43f007d8 100644 --- a/doc/libtiff.rst +++ b/doc/libtiff.rst @@ -27,7 +27,7 @@ The material presented in this chapter is a basic introduction to the capabilities of the library; it is not an attempt to describe everything a developer needs to know about the library or about TIFF. Detailed information on the interfaces to the library are given in -the :doc:`manpages` that accompany this software. +the :doc:`functions` that accompany this software. Michael Still has also written a useful introduction to libtiff for the IBM DeveloperWorks site available at @@ -56,7 +56,7 @@ Within an application that uses ``libtiff`` the :c:func:`TIFFGetVersion` routine will return a pointer to a string that contains software version information. The library include file :file:`<tiffio.h>` contains a C pre-processor -define :c:define:`TIFFLIB_VERSION` that can be used to check library +define :c:macro:`TIFFLIB_VERSION` that can be used to check library version compatibility at compile time. Library Datatypes @@ -233,7 +233,7 @@ a limited set of tags. Any unknown tags that are encountered in a file are ignored. There is a mechanism to extend the set of tags the library handles without modifying the library itself; -this is described in :ref:`addingtags`. +this is described in :doc:`addingtags`. ``libtiff`` provides two interfaces for getting and setting tag values: :c:func:`TIFFGetField` and :c:func:`TIFFSetField`. diff --git a/doc/releases/v3.5.5.rst b/doc/releases/v3.5.5.rst index a4cb6383..8c10d529 100644 --- a/doc/releases/v3.5.5.rst +++ b/doc/releases/v3.5.5.rst @@ -62,7 +62,7 @@ Library changes * Fix bug in :file:`tif_write.c` when switching between reading one directory and writing to another. * Made :c:func:`TIFFWriteCheck` public, and added :c:func:`TIFFCreateDirectory` -* Added :doc:`TIFFmemory` functions to :file:`libtiff.def`. +* Added :doc:`/functions/TIFFmemory` functions to :file:`libtiff.def`. * Added :file:`libtiff/libtiff.def` to ``TIFFILES`` distribution list. diff --git a/doc/releases/v3.5.6beta.rst b/doc/releases/v3.5.6beta.rst index 2b72e184..55d17bdc 100644 --- a/doc/releases/v3.5.6beta.rst +++ b/doc/releases/v3.5.6beta.rst @@ -97,10 +97,10 @@ Library changes caught by BoundsChecker. From `Arvan Pritchard <arvan.pritchard@infomatix.co.uk>`_ (untested). * :file:`tif_getimage.c`: Applied patch to silence VC6 warnings. From - `Arvan Pritchard <arvan.pritchard@informatix.co.uk>`_. + `Arvan Pritchard <arvan.pritchard@informatix.co.uk>`__. * :file:`tif_lzw.c`: Applied patch to silence VC6 warnings. From - `Arvan Pritchard <arvan.pritchard@informatix.co.uk>`_. + `Arvan Pritchard <arvan.pritchard@informatix.co.uk>`__. * :file:`libtiff/tif_apple.c`: Applied "Carbon" support patches supplied by `Leonard Rosenthol <leonardr@lazerware.com>`_. May interfere diff --git a/doc/releases/v3.5.7.rst b/doc/releases/v3.5.7.rst index 2f2199a1..97e9a289 100644 --- a/doc/releases/v3.5.7.rst +++ b/doc/releases/v3.5.7.rst @@ -108,7 +108,7 @@ Library changes * :file:`libtiff/tif_dirinfo.c`: Modified the :c:enumerator:`TIFF_BYTE` definition for :c:macro:`TIFFTAG_PHOTOSHOP` to use a writecount of :c:enumerator:`TIFF_VARIABLE2` (-3) to - force use of :c:type:`uint32` counts instead of :c:type:`short` counts. + force use of :c:type:`uint32` counts instead of :c:expr:`short` counts. * :file:`libtiff/tif_dirinfo.c`: moved pixar and copyright flags to ensure everything is in order. diff --git a/doc/releases/v3.6.0.rst b/doc/releases/v3.6.0.rst index d64754db..345c5f18 100644 --- a/doc/releases/v3.6.0.rst +++ b/doc/releases/v3.6.0.rst @@ -193,7 +193,7 @@ Library changes * :file:`libtiff/tif_dirwrite.c`, :file:`libtiff/tif_write.c`, :file:`libtiff/tiffio.h`: :c:func:`TIFFCheckpointDirectory` routine added as per bug :bugzilla-rs:`124`. - The :doc:`TIFFWriteDirectory` man page discusses this new function as well as the related + The :doc:`/functions/TIFFWriteDirectory` man page discusses this new function as well as the related :c:func:`TIFFRewriteDirectory`. * :file:`libtiff/tif_codec.c`, :file:`libtiff/tif_compress.c`, diff --git a/doc/releases/v3.6.1.rst b/doc/releases/v3.6.1.rst index f648dc22..bb7cbdf4 100644 --- a/doc/releases/v3.6.1.rst +++ b/doc/releases/v3.6.1.rst @@ -23,7 +23,7 @@ Major changes * New utility :program:`tiff2pdf` for converting TIFF images directly into PDF. -* New :doc:`TIFFColor` color conversion module. +* New :doc:`/functions/TIFFcolor` color conversion module. * Full support for ``Orientation`` tag in ``TIFFRGBAImage`` interface. * Many bugs fixed. @@ -84,7 +84,7 @@ Library changes * :file:`libtiff/tif_color.c`, :file:`libtiff/tif_getimage.c`, :file:`libtiff/tiffio.h`: New color space conversion code: CIE L*a*b* 1976 images now supported by the ``TIFFRGBAImage`` interface. YCbCr to RGB conversion code also moved there and now has - :doc:`TIFFcolor` publicly available interface. These + :doc:`/functions/TIFFcolor` publicly available interface. These routines currently used in ``TIFFRGBAImage`` interface only and not supported in other libtiff tools yet. So if you want, for example, to convert CIE Lab image into PostScript file you should do it in two steps: change colorspace to RGB diff --git a/doc/releases/v3.7.1.rst b/doc/releases/v3.7.1.rst index 65a22b11..bf8bffe2 100644 --- a/doc/releases/v3.7.1.rst +++ b/doc/releases/v3.7.1.rst @@ -64,7 +64,7 @@ Library changes :bugzilla-rs:`703` and :bugzilla-rs:`704`. -* :file:`tif_win32.c`: Use :c:type:`char*` strings instead of :c:type:`TCHAR` in windowed +* :file:`tif_win32.c`: Use :c:expr:`char*` strings instead of :c:type:`TCHAR` in windowed mode as per bug :bugzilla-rs:`697` diff --git a/doc/releases/v3.7.2.rst b/doc/releases/v3.7.2.rst index ae877253..b7369cd7 100644 --- a/doc/releases/v3.7.2.rst +++ b/doc/releases/v3.7.2.rst @@ -58,7 +58,7 @@ Library changes * :file:`tif_open.c`: Remove unnecessary :c:func:`TIFFSeekFile` call as per bug :bugzilla-rs:`756` -* :file:`tiff.h`: Changed the :c:type:`int8` definition to be always :c:type:`signed char` +* :file:`tiff.h`: Changed the :c:type:`int8` definition to be always :c:expr:`signed char` as per bug :bugzilla-rs:`727` diff --git a/doc/releases/v3.7.3.rst b/doc/releases/v3.7.3.rst index 107d6a67..c558e0d5 100644 --- a/doc/releases/v3.7.3.rst +++ b/doc/releases/v3.7.3.rst @@ -55,7 +55,7 @@ Library changes the first IFD when needed. As per bug :bugzilla-rs:`875` -* :file:`tiff.h`: Use correct :c:type:`int` size on Sparc 64bit/Sun compiler +* :file:`tiff.h`: Use correct :c:expr:`int` size on Sparc 64bit/Sun compiler platform. As per bug :bugzilla-rs:`855` @@ -76,7 +76,7 @@ Library changes * :file:`tif_dirinfo.c`, :file:`tif_print.c`: :c:func:`TIFFFetchByteArray` returns :c:type:`uint16` array when fetching the ``BYTE`` and ``SBYTE`` fields, so we should - consider result as pointer to :c:type:`uint16` array and not as array of :c:type:`char`. + consider result as pointer to :c:type:`uint16` array and not as array of :c:expr:`char`. As per bug :bugzilla-rs:`831` @@ -95,7 +95,7 @@ Library changes ``stripbytecount[0]`` if it appears bogus to ignore if ``stripoffset[0]`` is zero. This is a common case with GDAL indicating a "null" tile/strip. -* :file:`tif_jpeg.c`: added ``LIB_JPEG_MK1`` support in :c:func:`JPEGDecodeRaw``. +* :file:`tif_jpeg.c`: added ``LIB_JPEG_MK1`` support in :c:func:`JPEGDecodeRaw`. * :file:`tif_dirread.c`: Ensure that broken files with too many values in :c:func:`TIFFFetchPerSampleShorts`, :c:func:`TIFFFetchPerSampleLongs` and diff --git a/doc/releases/v3.7.4.rst b/doc/releases/v3.7.4.rst index 7e4c0037..4ee369ac 100644 --- a/doc/releases/v3.7.4.rst +++ b/doc/releases/v3.7.4.rst @@ -49,8 +49,8 @@ Library changes values (128 bits as 2 64 bits doubles). GDAL gcore tests now pass on bigendian (macosx) system. -* :file:`libtiff/tif_dirread.c`, :file:`libtiff/tif_dirinfo.c`: Do not upcast ``BYTE``s to - ``SHORT``s in the :c:func:`TIFFFetchByteArray`. Remove :c:func:`TIFFFetchExtraSamples` +* :file:`libtiff/tif_dirread.c`, :file:`libtiff/tif_dirinfo.c`: Do not upcast ``BYTE`` to + ``SHORT`` in the :c:func:`TIFFFetchByteArray`. Remove :c:func:`TIFFFetchExtraSamples` function, use :c:func:`TIFFFetchNormalTag` instead as per bug :bugzilla-rs:`831` diff --git a/doc/releases/v3.8.2.rst b/doc/releases/v3.8.2.rst index 1d1fb89e..ef33685e 100644 --- a/doc/releases/v3.8.2.rst +++ b/doc/releases/v3.8.2.rst @@ -48,7 +48,7 @@ Library changes * :file:`tif_jpeg.c`: Do not cleanup codec state in :c:func:`TIFFInitJPEG`. As per bug :bugzilla-rs:`1119` -* :file:`tif_dir.c`: Use :c:type:`double` type instead of :c:type:`dblparam_t`. +* :file:`tif_dir.c`: Use :c:expr:`double` type instead of :c:type:`dblparam_t`. * :file:`tif_dirread.c`: Do not check the ``PlanarConfig`` tag presence in :c:func:`TIFFReadDirectory`, because it is always set at the start of diff --git a/doc/releases/v3.9.0.rst b/doc/releases/v3.9.0.rst index 8723c938..e256199b 100644 --- a/doc/releases/v3.9.0.rst +++ b/doc/releases/v3.9.0.rst @@ -63,7 +63,7 @@ Library changes size to all the other blocks in the same directory. This is dangerous in many situations and can easily corrupt a file. (observed in esoteric GDAL situation that's hard to document). - This change involves leaving the :c:var:`stripbytecount[]` values + This change involves leaving the :c:expr:`stripbytecount[]` values unaltered till :c:func:`TIFFAppendToStrip`. Now we only write a block back to the same location it used to be at if the new data is the same size or smaller - otherwise we move it to the end of diff --git a/doc/releases/v3.9.3.rst b/doc/releases/v3.9.3.rst index d9a29fa6..07127889 100644 --- a/doc/releases/v3.9.3.rst +++ b/doc/releases/v3.9.3.rst @@ -74,7 +74,7 @@ Library changes * Restore ``ReferenceBlackWhite`` as a non-custom field. This avoids a multi-thread reentrancy problem as well as fixing output of wrong tag value due to redundant definitions for the - same tag in the :c:var:`tiffFieldInfo[]` array. Resolves + same tag in the :c:expr:`tiffFieldInfo[]` array. Resolves :bugzilla:`2185` Tools changes diff --git a/doc/releases/v3.9.5.rst b/doc/releases/v3.9.5.rst index 6263a721..1246debb 100644 --- a/doc/releases/v3.9.5.rst +++ b/doc/releases/v3.9.5.rst @@ -110,7 +110,7 @@ Library changes `Even Rouault <even.rouault@mines-paris.org>`_ * :file:`libtiff/tif_dirwrite.c`: Avoid undefined behaviour when casting from - :c:type:`float` to :c:type:`unsigned integer` in :c:func:`TIFFWriteRationalArray` as reported by + :c:expr:`float` to :c:expr:`unsigned int` in :c:func:`TIFFWriteRationalArray` as reported by Kareem Shehata. * :file:`libtiff/tif_fax3.h`: Protect against a fax ``VL(n)`` codeword commanding diff --git a/doc/releases/v4.0.4.rst b/doc/releases/v4.0.4.rst index 5af7ae75..b211b76b 100644 --- a/doc/releases/v4.0.4.rst +++ b/doc/releases/v4.0.4.rst @@ -127,7 +127,7 @@ Tools changes * :program:`tiff2pdf` * :bugzilla:`2078`: Suppress initial output of the header. - * :buzilla:`2150`: Change ColorTransform from "0" to "1". + * :bugzilla:`2150`: Change ColorTransform from "0" to "1". * Take care in using the return value from :c:func:`snprintf`. * Coverity 1024181 "Structurally dead code". * Coverity 1024181 "Structurally dead code". diff --git a/doc/releases/v4.0.4beta.rst b/doc/releases/v4.0.4beta.rst index d4f848ca..f281d636 100644 --- a/doc/releases/v4.0.4beta.rst +++ b/doc/releases/v4.0.4beta.rst @@ -132,7 +132,7 @@ Library changes * :file:`tif_write.c`: :c:type:`tmsize_t` related casting warning fixed for 64bit linux. -* :c:file:`tif_read.c`: :c:type:`uint64`/:c:type:`tmsize_t` change for MSVC warnings. +* :file:`tif_read.c`: :c:type:`uint64`/:c:type:`tmsize_t` change for MSVC warnings. (:bugzilla:`2427`) * Fix :c:func:`TIFFPrintDirectory` handling of diff --git a/doc/releases/v4.0.5.rst b/doc/releases/v4.0.5.rst index c1dccfc4..56cd7f55 100644 --- a/doc/releases/v4.0.5.rst +++ b/doc/releases/v4.0.5.rst @@ -36,7 +36,7 @@ Software configuration changes * :file:`configure.ac` / :program:`configure` * Test for and use :c:func:`fseeko` if it is available. This allows - supporting large files on Unix-type systems with a 32-bit :c:type:`long` + supporting large files on Unix-type systems with a 32-bit :c:expr:`long` type and a 64-bit :c:type:`off_t` type. @@ -66,7 +66,7 @@ Library changes I/O to a maximum size of 2GB for extremely large I/O requests. This surmounts limitations in the Microsoft Windows :c:func:`read` and :c:func:`write` APIs (which are limited to the range of a - 32-bit :c:type:`int`), and may avoid poor behavior with extremely large + 32-bit :c:expr:`int`), and may avoid poor behavior with extremely large I/O requests on other systems. diff --git a/doc/releases/v4.0.7.rst b/doc/releases/v4.0.7.rst index 7075b180..d7dccaf3 100644 --- a/doc/releases/v4.0.7.rst +++ b/doc/releases/v4.0.7.rst @@ -164,7 +164,7 @@ Library changes fix regression, introduced on 2014-12-23, when reading a one-strip file without a ``StripByteCounts`` tag. GDAL #6490 -* libtiff/*: upstream typo fixes (mostly contributed by Kurt +* :file:`libtiff/*`: upstream typo fixes (mostly contributed by Kurt Schwehr) coming from GDAL internal libtiff * :file:`libtiff/tif_fax3.h`: make :c:member:`Param` member of :c:struct:`TIFFFaxTabEnt` diff --git a/doc/releases/v4.0.8.rst b/doc/releases/v4.0.8.rst index 38b9d264..00ec2d89 100644 --- a/doc/releases/v4.0.8.rst +++ b/doc/releases/v4.0.8.rst @@ -177,7 +177,7 @@ Library changes ``-Wimplicit-fallthrough`` warnings. * :file:`libtiff/tif_dirread.c`: fix memory leak in non - :c::macro:`DEFER_STRILE_LOAD` mode (ie default) when there is both a + :c:macro:`DEFER_STRILE_LOAD` mode (ie default) when there is both a ``StripOffsets`` and ``TileOffsets`` tag, or a ``StripByteCounts`` and ``TileByteCounts``. Fixes :bugzilla:`2689` @@ -250,19 +250,19 @@ Library changes * :file:`libtiff/tif_pixarlog.c`: :c:func:`PixarLogDecode`: resync :c:member:`tif_rawcp` with :c:member:`next_in` and :c:member:`tif_rawcc` with :c:member:`avail_in` at beginning and end - of function, similarly to what is done in :c:func:`LZWDecode. Likely + of function, similarly to what is done in :c:func:`LZWDecode`. Likely needed so that it works properly with latest chnges in :file:`tif_read.c` in :c:macro:`CHUNKY_STRIP_READ_SUPPORT` mode. But untested... * :file:`libtiff/tif_getimage.c`: :c:func:`initYCbCrConversion`: add basic validation of :c:var:`luma` and :c:var:`refBlackWhite` coefficients (just check - they are not NaN for now), to avoid potential :c:type:`float` to :c:type:`int` + they are not NaN for now), to avoid potential :c:expr:`float` to :c:expr:`int` overflows. Fixes https://bugs.chromium.org/p/oss-fuzz/issues/detail?id=1663 Credit to OSS Fuzz * :file:`libtiff/tif_read.c`: :c:func:`_TIFFVSetField`: fix outside range cast - of :c:type:`double` to :c:type:`float`. Credit to Google Autofuzz project + of :c:expr:`double` to :c:expr:`float`. Credit to Google Autofuzz project * :file:`libtiff/tif_getimage.c`: :c:func:`initYCbCrConversion`: check ``luma[1]`` is not zero to avoid division by zero. Fixes @@ -270,7 +270,7 @@ Library changes Credit to OSS Fuzz * :file:`libtiff/tif_read.c`: :c:func:`_TIFFVSetField`: fix outside range cast - of :c:type:`double` to :c:type:`float`. Credit to Google Autofuzz project + of :c:expr:`double` to :c:expr:`float`. Credit to Google Autofuzz project * :file:`libtiff/tif_getimage.c`: :c:func:`initYCbCrConversion`: check ``luma[1]`` is not zero to avoid division by zero. Fixes @@ -279,7 +279,7 @@ Library changes * :file:`libtiff/tif_getimage.c`: :c:func:`initYCbCrConversion`: stricter validation for :c:var:`refBlackWhite` coefficients values. To avoid - invalid :c:var:`float` to :c:var:`int32` conversion. Fixes + invalid :c:expr:`float` to :c:expr:`int32` conversion. Fixes https://bugs.chromium.org/p/oss-fuzz/issues/detail?id=1718 Credit to OSS Fuzz @@ -297,7 +297,7 @@ Tools changes library. Reported by Agostino Sarubbo. Fixes :bugzilla:`2598` - * :file:`tools/tiffcrop.c`: fix :c:func:`readContigStripsIntoBuffer` in ``-i`` +* :file:`tools/tiffcrop.c`: fix :c:func:`readContigStripsIntoBuffer` in ``-i`` (ignore) mode so that the output buffer is correctly incremented to avoid write outside bounds. Reported by Agostino Sarubbo. Fixes diff --git a/doc/releases/v4.0.9.rst b/doc/releases/v4.0.9.rst index 9b0836c5..7a5318da 100644 --- a/doc/releases/v4.0.9.rst +++ b/doc/releases/v4.0.9.rst @@ -73,7 +73,7 @@ Library changes Fixes :oss-fuzz:`1907`. Credit to OSS Fuzz -* :file:`libtiff/tif_dirinfo.c`, :file:`tif_dirread.c`: add :c:func:`_TIFFCheckFieldIsValidForCodec`()`, +* :file:`libtiff/tif_dirinfo.c`, :file:`tif_dirread.c`: add :c:func:`_TIFFCheckFieldIsValidForCodec`, and use it in :c:func:`TIFFReadDirectory` so as to ignore fields whose tag is a codec-specified tag but this codec is not enabled. This avoids :c:func:`TIFFGetField` to behave differently depending on whether the codec is enabled or not, and @@ -107,15 +107,15 @@ Library changes excessive memory allocation. Fixes :oss-fuzz:`2215`. Credit to OSS Fuzz -* :file:`libtiff/tif_getimage.c`: avoid many (harmless) :c:type:`unsigned int` overflows. -* :file:`libtiff/tif_fax3.c`: avoid :c:type:`unsigned int` overflow in :c:func:`Fax3Encode2DRow`. Could +* :file:`libtiff/tif_getimage.c`: avoid many (harmless) :c:expr:`unsigned int` overflows. +* :file:`libtiff/tif_fax3.c`: avoid :c:expr:`unsigned int` overflow in :c:func:`Fax3Encode2DRow`. Could potentially be a bug with huge rows. -* :file:`libtiff/tif_jpeg.c`: avoid (harmless) :c:type:`unsigned int` overflow on tiled images. -* :file:`libtiff/tif_dirread.c`: avoid :c:type:`unsigned int` overflow in :c:func:`EstimateStripByteCounts` +* :file:`libtiff/tif_jpeg.c`: avoid (harmless) :c:expr:`unsigned int` overflow on tiled images. +* :file:`libtiff/tif_dirread.c`: avoid :c:expr:`unsigned int` overflow in :c:func:`EstimateStripByteCounts` and ``BYTECOUNTLOOKSBAD`` when file is too short. -* :file:`libtiff/tif_predict.c`: decorate legitimate functions where :c:type:`unsigned int` +* :file:`libtiff/tif_predict.c`: decorate legitimate functions where :c:expr:`unsigned int` overflow occur with :c:macro:`TIFF_NOSANITIZE_UNSIGNED_INT_OVERFLOW` -* :file:`libtiff/tif_dirread.c`: avoid :c:type:`unsigned int` overflow in :c:func:`EstimateStripByteCounts` +* :file:`libtiff/tif_dirread.c`: avoid :c:expr:`unsigned int` overflow in :c:func:`EstimateStripByteCounts` * :file:`libtiff/tiffiop.h`: add :c:macro:`TIFF_NOSANITIZE_UNSIGNED_INT_OVERFLOW` macro to disable CLang warnings raised by ``-fsanitize=undefined,unsigned-integer-overflow`` * :file:`libtiff/tif_jpeg.c`: add anti-denial of service measure to avoid excessive @@ -196,8 +196,8 @@ Library changes * :file:`libtiff/tif_dir.c`: avoid potential null pointer dereference in :c:func:`_TIFFVGetField` on corrupted TIFFTAG_NUMBEROFINKS tag instance. Fixes :bugzilla:`2713` - <LI> tools/tiff2pdf.c: prevent heap buffer overflow write in "Raw" - mode on PlanarConfig=Contig input images. +* :file:`tools/tiff2pdf.c`: prevent heap buffer overflow write in "Raw" + mode on ``PlanarConfig=Contig`` input images. Fixes :bugzilla:`2715` Reported by team OWL337 * :file:`libtiff/tif_read.c`: :c:func:`TIFFFillStrip` / :c:func:`TIFFFillTile`. diff --git a/doc/releases/v4.1.0.rst b/doc/releases/v4.1.0.rst index 23e5ec20..112346fb 100644 --- a/doc/releases/v4.1.0.rst +++ b/doc/releases/v4.1.0.rst @@ -38,8 +38,10 @@ Major changes whole array. This is enabled with the new ``O`` (Ondemand) flag of :c:func:`TIFFOpen` (which implies ``D``). - The public :c:func:`TIFFGetStrileOffset[WithErr]` and - :c:func:`TIFFGetStrileByteCount[WithErr]` functions have been added to + The public :c:func:`TIFFGetStrileOffset`, + :c:func:`TIFFGetStrileOffsetWithErr`, + :c:func:`TIFFGetStrileByteCount` and + :c:func:`TIFFGetStrileByteCountWithErr` functions have been added to API. They are of particular interest when using sparse files (with ``offset == bytecount == 0``) and you want to detect if a strile is present or not without decompressing the data, or updating an |