Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update verbiage about reserved ids #158

Merged
merged 2 commits into from
Nov 22, 2024
Merged

Update verbiage about reserved ids #158

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
23e5e1f
Update verbiage about reserved ids
markcmiller86 Nov 19, 2024
4ec13a9
Update as per @brtnfld
markcmiller86 Nov 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions docs/RegisteredFilterPlugins.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,10 @@ To register a filter please contact The HDF Helpdesk with the following informat
* Links to any relevant information including licensing information

Here is the current policy regarding filter identifier assignment:
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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This document is about filter plugins, not VOL connectors.

Copy link
Contributor

@brtnfld brtnfld Nov 20, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

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.
Values from `32768` to `65535` are reserved for non-distributed uses (e.g., internal company usage) or for application usage when testing a feature. The HDF Group does not track or document the usage of filters with identifiers from this range.
Please contact the maintainer of a filter for help with the filter/compression support in HDF5.

Expand Down Expand Up @@ -382,7 +385,7 @@ fpzip is a library for lossless or lossy compression of 2D or 3D floating-point

#### Filter Information:

For more information see: http://computation.llnl.gov/projects/floating-point-compression/
For more information see: http://computing.llnl.gov/projects/floating-point-compression/

#### Contact Information:

Expand Down