From 81bd80b993db123824b4a9151a94f167c0f4f17b Mon Sep 17 00:00:00 2001 From: Dennis Heimbigner Date: Thu, 1 Oct 2020 11:08:16 -0600 Subject: [PATCH] Slight mod to the incompatibilities section --- NUG/filters.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/NUG/filters.md b/NUG/filters.md index ced1aafa1..50e4d04b8 100644 --- a/NUG/filters.md +++ b/NUG/filters.md @@ -31,7 +31,7 @@ For now, this document is strongly influenced by the HDF5 mechanism. When other implementations (e.g. Zarr) support filters, this document will have multiple sections: one for each mechanism. -# A Warning on Backward Compatibility +# A Warning on Backward Compatibility {#filters_compatibility} The API defined in this document should accurately reflect the current state of filters in the netCDF-c library. Be aware @@ -52,6 +52,9 @@ have been moved to __netcdf_aux.h__. See Appendix A * It is no longer possible to use a filter name, such as "szip"; one must use the assigned filter id, 4 for szip. +For additional information, see Appendix B. + + # Enabling A HDF5 Compression Filter {#filters_enable} HDF5 supports dynamic loading of compression filters using the following @@ -702,7 +705,7 @@ This struct in effect encapsulates all of the information about and HDF5 formatted filter — the id, the number of parameters, and the parameters themselves. -Appendix B. Build Flags for Detecting the Filter Mechanism {#filters_appendixc} +Appendix B. Build Flags for Detecting the Filter Mechanism {#filters_appendixb} ========== The include file _netcdf_meta.h contains the following definition. @@ -711,7 +714,8 @@ The include file _netcdf_meta.h contains the following definition. ```` This, in conjunction with the error code _NC_ENOFILTER_ in _netcdf.h_ -can be used to see what filter mechanism is in place. +can be used to see what filter mechanism is in place as described +in the section on incompatibities. 1. !defined(NC_ENOFILTER) && !defined(NC_HAS_MULTIFILTERS) — indicates that the old pre-4.7.4 mechanism is in place. It does not support multiple filters.