Update verbiage about reserved ids #158
Conversation
Also, fixed another instance of a bad llnl link
markcmiller86
requested review from
lrknox,
byrnHDF,
derobins,
fortnern,
jhendersonHDF,
qkoziol,
vchoi-hdfgroup,
bmribler,
glennsong09,
mattjala,
brtnfld and
epourmal
as code owners
docs/RegisteredFilterPlugins.md
Outdated
| The filter identifier is designed to be a unique identifier for the filter. Values from `zero` through `32,767` are reserved for filters supported by The HDF Group in the HDF5 library and for filters requested and supported by the 3rd party. | ||
| The filter identifier is designed to be a unique identifier for the filter. | ||
| Values from `0` to `255` are reserved for internal use by The HDF Group for filters that are part of the HDF5 library itself. | ||
| Values from `256` through `32,767` are reserved for filters *managed* by The HDF Group but nominally requested, developed and supported by 3rd parties. |
There was a problem hiding this comment.
Values from 256 to 511 are available for testing new VOL connectors. Values from 512 to 32,767 are reserved for filters managed by The HDF Group but are nominally requested, developed, and supported by third parties.
There was a problem hiding this comment.
@brtnfld I just updated as you specified.
FYI, are you familiar with making a "suggestion" (read through there to around step 7) via GitHub GUI here?
There was a problem hiding this comment.
That's a good point. It has been some time since I've used "suggestions," but that would likely make things easier.
| The filter identifier is designed to be a unique identifier for the filter. Values from `zero` through `32,767` are reserved for filters supported by The HDF Group in the HDF5 library and for filters requested and supported by the 3rd party. | ||
| The filter identifier is designed to be a unique identifier for the filter. | ||
| Values from `0` to `255` are reserved for internal use by The HDF Group for filters that are part of the HDF5 library itself. | ||
| Values from `256` to `511` are available for testing new VOL connectors. |
There was a problem hiding this comment.
This document is about filter plugins, not VOL connectors.
There was a problem hiding this comment.
Ah, yes, I apologize for my mistake; I have had the VOLs on my mind lately. Here is what we state in the Doxygen documentation if you would like to use the same wording:
Values from zero through 32,767 are reserved for filters supported by The HDF Group in the HDF5 library and for filters requested and supported by 3rd parties. Values from 32768 to 65535 are reserved for non-distributed uses (e.g., internal company usage) or application usage when testing a feature.
Also, fixed another instance of a bad LLNL link.
The verbiage adjustment is due to this comment from @qkoziol.