Fix display of '--' options in documentation#6318
Open
jhendersonHDF wants to merge 1 commit intoHDFGroup:developfrom
Open
Fix display of '--' options in documentation#6318jhendersonHDF wants to merge 1 commit intoHDFGroup:developfrom
jhendersonHDF wants to merge 1 commit intoHDFGroup:developfrom
Conversation
jhendersonHDF
commented
Mar 25, 2026
| * \li <strong>\--xml-dtd=U</strong> Use the DTD or schema at U | ||
| * \li <strong>\--xml-ns=S</strong> (XML Schema) Use qualified names in the XML. | ||
| * ":": no namespace, default: "hdf5:" | ||
| * E.g., to dump a file called "-f", use h5dump -- -f |
Collaborator
Author
There was a problem hiding this comment.
This part was incorrectly brought over from the old h5dump docs. Restored the original text below under the "Option Argument Conventions" section.
Contributor
|
@jhendersonHDF Nice. Thanks for quick response. I did not do a full review. |
jhendersonHDF
requested review from
bmribler,
brtnfld,
derobins,
fortnern,
glennsong09,
lrknox,
mattjala,
qkoziol and
vchoi-hdfgroup
as code owners
brtnfld
reviewed
Mar 26, 2026
| * \li <strong>--vfd-info</strong> VFD-specific info to pass to the VFL driver used for | ||
| * \li <strong>\--contents</strong> Print a list of the file contents, group and dataset, | ||
| * names and values, then exit. Optional value 1 also prints attributes, | ||
| * <code>\--contents=1</code>. \li <strong>\--superblock</strong> Print the content of the super block \li |
Collaborator
There was a problem hiding this comment.
Looks like the formatting is messed-up
Collaborator
Author
There was a problem hiding this comment.
Hmm yes, clang might have done that. I'll fix it
brtnfld
reviewed
Mar 26, 2026
| \li Use <code>--disable-h</code>l to disable the high-level library. (Recommended) | ||
| \li Use <code>--enable-unsupported</code> to build the high-level library with the thread-safety feature. | ||
| To use Autotools to build an application with \--enable-threadsafe, use one of the following approaches: | ||
| \li Use <code>\--disable-h</code>l to disable the high-level library. (Recommended) |
brtnfld
reviewed
Mar 26, 2026
| To use Autotools to build an application with --enable-threadsafe, use one of the following approaches: | ||
| \li Use <code>--disable-h</code>l to disable the high-level library. (Recommended) | ||
| \li Use <code>--enable-unsupported</code> to build the high-level library with the thread-safety feature. | ||
| To use Autotools to build an application with \--enable-threadsafe, use one of the following approaches: |
Collaborator
There was a problem hiding this comment.
some parameters have <code> </code> some don't
Collaborator
Author
There was a problem hiding this comment.
I mostly left what was there and just did a find/replace, but I can fix ones I find or that are pointed out
brtnfld
reviewed
Mar 26, 2026
| * \li <strong>\--indexed=L2</strong> Minimum number of links in the indexed format | ||
| * \li <strong>\--ssize=S[:F]</strong> Shared object header message minimum size | ||
| * \li <strong>\--minimum=M</strong> Do not apply the filter to datasets smaller than M | ||
| * \li <strong>\--file=E</strong> Name of file E with the \--file and \--layout options |
Collaborator
There was a problem hiding this comment.
--file should be wrapped in strong
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
@Dave-Allured