-
-
Notifications
You must be signed in to change notification settings - Fork 4.3k
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.
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
xxd: reword descriptions for clarity & consistency #1465
Conversation
pages/common/xxd.md
Outdated
|
||
`xxd -p {{input_file}}` | ||
|
||
- Revert a plaintext hex into binary and store it in an output file: | ||
- Revert a plaintext hexdump into binary, and save it to a binary file: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we do "and save it to a file" ? Is the "binary file" necessary since we have already established that it generates binary ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I thought about that while writing this, but I kept it for symmetry with the second example. We can either choose to break the symmetry or make this sentence a little redundant. Which one do you find more reasonable?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah I see. Sure let's keep the symmetry.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oops! I appear to have forgotten to submit my review on this one :P
pages/common/xxd.md
Outdated
|
||
`xxd {{input_file}}` | ||
|
||
- Send the hexdump output to a file: | ||
- Generate a hexdump from a binary file and save it to a text file: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
to a text file
-> as a text file
?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sure.
|
||
`xxd -c {{8}} {{input_file}}` | ||
`xxd -c {{10}} {{input_file}}` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why 10 and not 8? lol :P
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No, that's a good question, actually. I changed the number deliberately, because 8 could induce people I to thinking this has something to do with the number of bits in a byte/octet, which isn't the case.
pages/common/xxd.md
Outdated
|
||
`xxd -p {{input_file}}` | ||
|
||
- Revert a plaintext hex into binary and store it in an output file: | ||
- Revert a plaintext hexdump into binary, and save it to a binary file: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah, I see why "text file" is appropriate.
hexdump into binary, and save it to a binary file
-> hexdump back into binary, and save it as a binary file
though?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sure :)
Hi all! This thread has not had any recent activity. Are there any updates? Thanks! |
Oh, didn't realize this was waiting on me! I'll make the changes. |
Changes done :) btw, whoever ends up merging this, please use the squash option to clean up the final commit message. |
[_]
The page (if new), does not already exist in the repo.[_]
The page (if new), has been added to the correct platform folder:
common/
if it's common to all platforms,linux/
if it's Linux-specific, and so on.The page has 8 or fewer examples.
The PR is appropriately titled:
<command name>: add page
for new pages, or<command name>: <description of changes>
for pages being editedThe page follows the contributing guidelines