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

HDFFV-11096 fix typo in h5dump usage text #12

Merged
merged 2 commits into from
Oct 5, 2020
Merged

HDFFV-11096 fix typo in h5dump usage text #12

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
31773b7
HDFFV-11096 fix typo in h5dump usage text
byrnHDF Oct 3, 2020
e01430e
HDFFV-11096 replace backticks with doublequotes
byrnHDF Oct 4, 2020
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
2 changes: 1 addition & 1 deletion tools/src/h5dump/h5dump.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -256,7 +256,7 @@ usage(const char *prog)
" <cred> :: \"(<aws-region>,<access-id>,<access-key>)\"\n");
PRINTVALSTREAM(rawoutstream,
" If absent or <cred> -> \"(,,)\", no authentication.\n");
PRINTVALSTREAM(rawoutstream, " Has no effect is filedriver is not `ros3'.\n");
PRINTVALSTREAM(rawoutstream, " Has no effect if filedriver is not `ros3'.\n");
PRINTVALSTREAM(rawoutstream,
Copy link
Member

Choose a reason for hiding this comment

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

Please change ` to ' in ros3. I don't know why backquote is used.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good catch! In fact why is it different then all other usage, where double quotes are used.

Copy link
Member

Choose a reason for hiding this comment

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

This is a common UNIX-y convention. It's used throughout the library.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Except it was an outlier here in the usage text.

Copy link
Member

Choose a reason for hiding this comment

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

Personally, I hate it because it's harder to type a backtick than a single quote. I think we should get rid of them.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Agreed, and I did replace these in a subsequent commit.

" --hdfs-attrs=<attrs> Supply configuration information for HDFS file access.\n");
PRINTVALSTREAM(rawoutstream, " For use with \"--filedriver=hdfs\"\n");
Expand Down
2 changes: 1 addition & 1 deletion tools/testfiles/h5dump-help.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ usage: h5dump [OPTIONS] files
--s3-cred=<cred> Supply S3 authentication information to "ros3" vfd.
<cred> :: "(<aws-region>,<access-id>,<access-key>)"
If absent or <cred> -> "(,,)", no authentication.
Has no effect is filedriver is not `ros3'.
Has no effect if filedriver is not `ros3'.
--hdfs-attrs=<attrs> Supply configuration information for HDFS file access.
For use with "--filedriver=hdfs"
<attrs> :: (<namenode name>,<namenode port>,
Expand Down
2 changes: 1 addition & 1 deletion tools/testfiles/pbits/tnofilename-with-packed-bits.ddl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ usage: h5dump [OPTIONS] files
--s3-cred=<cred> Supply S3 authentication information to "ros3" vfd.
<cred> :: "(<aws-region>,<access-id>,<access-key>)"
If absent or <cred> -> "(,,)", no authentication.
Has no effect is filedriver is not `ros3'.
Has no effect if filedriver is not `ros3'.
--hdfs-attrs=<attrs> Supply configuration information for HDFS file access.
For use with "--filedriver=hdfs"
<attrs> :: (<namenode name>,<namenode port>,
Expand Down
2 changes: 1 addition & 1 deletion tools/testfiles/pbits/tpbitsIncomplete.ddl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ usage: h5dump [OPTIONS] files
--s3-cred=<cred> Supply S3 authentication information to "ros3" vfd.
<cred> :: "(<aws-region>,<access-id>,<access-key>)"
If absent or <cred> -> "(,,)", no authentication.
Has no effect is filedriver is not `ros3'.
Has no effect if filedriver is not `ros3'.
--hdfs-attrs=<attrs> Supply configuration information for HDFS file access.
For use with "--filedriver=hdfs"
<attrs> :: (<namenode name>,<namenode port>,
Expand Down
2 changes: 1 addition & 1 deletion tools/testfiles/pbits/tpbitsLengthExceeded.ddl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ usage: h5dump [OPTIONS] files
--s3-cred=<cred> Supply S3 authentication information to "ros3" vfd.
<cred> :: "(<aws-region>,<access-id>,<access-key>)"
If absent or <cred> -> "(,,)", no authentication.
Has no effect is filedriver is not `ros3'.
Has no effect if filedriver is not `ros3'.
--hdfs-attrs=<attrs> Supply configuration information for HDFS file access.
For use with "--filedriver=hdfs"
<attrs> :: (<namenode name>,<namenode port>,
Expand Down
2 changes: 1 addition & 1 deletion tools/testfiles/pbits/tpbitsLengthPositive.ddl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ usage: h5dump [OPTIONS] files
--s3-cred=<cred> Supply S3 authentication information to "ros3" vfd.
<cred> :: "(<aws-region>,<access-id>,<access-key>)"
If absent or <cred> -> "(,,)", no authentication.
Has no effect is filedriver is not `ros3'.
Has no effect if filedriver is not `ros3'.
--hdfs-attrs=<attrs> Supply configuration information for HDFS file access.
For use with "--filedriver=hdfs"
<attrs> :: (<namenode name>,<namenode port>,
Expand Down
2 changes: 1 addition & 1 deletion tools/testfiles/pbits/tpbitsMaxExceeded.ddl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ usage: h5dump [OPTIONS] files
--s3-cred=<cred> Supply S3 authentication information to "ros3" vfd.
<cred> :: "(<aws-region>,<access-id>,<access-key>)"
If absent or <cred> -> "(,,)", no authentication.
Has no effect is filedriver is not `ros3'.
Has no effect if filedriver is not `ros3'.
--hdfs-attrs=<attrs> Supply configuration information for HDFS file access.
For use with "--filedriver=hdfs"
<attrs> :: (<namenode name>,<namenode port>,
Expand Down
2 changes: 1 addition & 1 deletion tools/testfiles/pbits/tpbitsOffsetExceeded.ddl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ usage: h5dump [OPTIONS] files
--s3-cred=<cred> Supply S3 authentication information to "ros3" vfd.
<cred> :: "(<aws-region>,<access-id>,<access-key>)"
If absent or <cred> -> "(,,)", no authentication.
Has no effect is filedriver is not `ros3'.
Has no effect if filedriver is not `ros3'.
--hdfs-attrs=<attrs> Supply configuration information for HDFS file access.
For use with "--filedriver=hdfs"
<attrs> :: (<namenode name>,<namenode port>,
Expand Down
2 changes: 1 addition & 1 deletion tools/testfiles/pbits/tpbitsOffsetNegative.ddl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ usage: h5dump [OPTIONS] files
--s3-cred=<cred> Supply S3 authentication information to "ros3" vfd.
<cred> :: "(<aws-region>,<access-id>,<access-key>)"
If absent or <cred> -> "(,,)", no authentication.
Has no effect is filedriver is not `ros3'.
Has no effect if filedriver is not `ros3'.
--hdfs-attrs=<attrs> Supply configuration information for HDFS file access.
For use with "--filedriver=hdfs"
<attrs> :: (<namenode name>,<namenode port>,
Expand Down