From 3e023fa22d04dedab5d0e7845ba41d8549214303 Mon Sep 17 00:00:00 2001
From: vchoi-hdfgroup <55293060+vchoi-hdfgroup@users.noreply.github.com>
Date: Wed, 23 Sep 2026 17:52:37 -0700
Subject: [PATCH] Fix Group/Link Info Status wording and undocumented defaults
(#6616) (#6681)
Issue #6616: Group Info and Link Info are labeled Optional, but
new-style group creation always writes both, and the C library errors
reading a new-style group missing either one.
- Group Info / Link Info Status: Optional -> Required for "new style"
groups; may not be repeated (matches existing Symbol Table wording
for old-style groups).
- Documents the decoder's fallback values (8, 6) for Link Phase
Change: Maximum Compact/Minimum Dense Value when absent.
---
docs/doxygen/dox/H5.format.4.0.dox | 11 +++++++----
1 file changed, 7 insertions(+), 4 deletions(-)
diff --git a/docs/doxygen/dox/H5.format.4.0.dox b/docs/doxygen/dox/H5.format.4.0.dox
index a97d9bf3333..674f087ba79 100644
--- a/docs/doxygen/dox/H5.format.4.0.dox
+++ b/docs/doxygen/dox/H5.format.4.0.dox
@@ -5767,7 +5767,7 @@ implemented in the HDF5 Library:
| Length: Varies |
- | Status: Optional; may not be repeated. |
+ Status: Required for “new style” groups; may not be repeated. |
| Description: |
@@ -8835,7 +8835,7 @@ The following information exists only when the chunk is filtered. In other words
Length: Varies |
- | Status: Optional; may not be repeated. |
+ Status: Required for “new style” groups; may not be repeated. |
| Description: |
@@ -8908,14 +8908,17 @@ The following information exists only when the chunk is filtered. In other words
| Link Phase Change: Maximum Compact Value |
- The is the maximum number of links to store “compactly” (in the group’s object header).
+ | This is the maximum number of links to store “compactly” (in the group’s object header).
+ If this field is not present, the default value of 8 will be used for the maximum compact
+ value.
This field is present if bit 0 of Flags is set. |
| Link Phase Change: Minimum Dense Value |
This is the minimum number of links to store “densely” (in the group’s fractal
heap). The fractal heap’s address is located in the @ref subsubsec_fmt4_dataobject_hdr_msg_linkinfo
- message.
+ message. If this field is not present, the default value of 6 will be used for the minimum
+ dense value.
This field is present if bit 0 of Flags is set. |