Conversation
athre0z
left a comment
There was a problem hiding this comment.
Thanks for the PR! LGTM in general, I left a few minor comments.
Should the files have .ronn extension? Since they seem to be vanilla Markdown, if that works, I think it would make sense to have them end in .md to make GitHub web render them if you view them.
Standard UNIX manpages are painful to write, but luckly there are tools like Ronn(-NG) or Pandoc that allow to write the page in simple Markdown and convert it in roff, the format that man uses.
I just looked up an example and am inclined to agree -- it looks pretty terrible indeed. Good choice to go with a transpiler approach!
These man pages are extremely basic, since I'm not very familiar with the tools and how they work :/
Neither are we, so I guess we'll just merge things and wait for someone with more experience to flame us for all that we did wrong! :)
man/ZydisDisasm.1.ronn
Outdated
|
|
||
| ## SYNOPSIS | ||
|
|
||
| `ZydisDisasm -[real|16|32|64] <input file>` |
There was a problem hiding this comment.
| `ZydisDisasm -[real|16|32|64] <input file>` | |
| `ZydisDisasm -[real|16|32|64] [input file]` |
The input file is optional, in which case ZydisDisasm reads from stdin.
man/ZydisInfo.1.ronn
Outdated
| ZydisInfo(1) -- disassemble in your terminal | ||
| ============================================ |
There was a problem hiding this comment.
| ZydisInfo(1) -- disassemble in your terminal | |
| ============================================ | |
| ZydisInfo(1) -- detailed instruction information | |
| ================================================ |
I feel like this might be a slightly more accurate description, but I'm also fine with the original one if you don't like it.
man/ZydisInfo.1.ronn
Outdated
|
|
||
| ## SYNOPSIS | ||
|
|
||
| `ZydisInfo -[real|16|32|64] <hexbytes>` |
There was a problem hiding this comment.
Current syntax is:
ZydisInfo <machine_mode> [stack_width] <hexbytes>
Machine mode: -real|-16|-32|-64
Stack width: -16|-32|-64
There was a problem hiding this comment.
Do these options also apply to ZydisDisasm?
There was a problem hiding this comment.
For ZydisDisasm I never implemented the stack-width option if I remember correctly.
Might be a nice addition tho. Will keep that in mind for future improvement.
Yes, because they aren't actually pure Markdown, it has a few manpage-specific features (like special rendering of
Haha, good idea I'll address your feedback as soon as possible |
Zydis ships two command line tools, but doesn't provide any man page. Since Debian enforces that every binary must also provide a man page here I am providing a patch. Standard UNIX manpages are painful to write, but luckly there are tools like Ronn(-NG) or Pandoc that allow to write the page in simple Markdown and convert it in roff, the format that `man` uses. These man pages are extremely basic, since I'm not very familiar with the tools and how they work :/ Please don't hesitate making suggestions :) Since Ronn-NG is an extra dependency the manpages are not built by default, but only if requested with `ZYDIS_BUILD_MAN`. Ronn-NG is required instead of the old Ronn because the latter always generates output files in the same dir as the input files, and that doesn't play nice with CMake and out of tree builds, while the -NG version has a `--output-dir` option.
|
Tried to apply your suggestions :) Please note that this is the first time I "write" manpages, and I'm also not familiar with the terminology used by Zydis (I've never done anything serious with assembly language, unfortunately), so any corrections will always be appreciated (even grammatical ones, I'm not a native English speaker) |
Zydis ships two command line tools, but doesn't provide any man page. Since Debian enforces that every binary must also provide a man page here I am providing a patch.
Standard UNIX manpages are painful to write, but luckly there are tools like Ronn(-NG) or Pandoc that allow to write the page in simple Markdown and convert it in roff, the format that
manuses.These man pages are extremely basic, since I'm not very familiar with the tools and how they work :/
Please don't hesitate making suggestions :)
Since Ronn-NG is an extra dependency the manpages are not built by default, but only if requested with
ZYDIS_BUILD_MAN.Ronn-NG is required instead of the old Ronn because the latter always generates output files in the same dir as the input files, and that doesn't play nice with CMake and out of tree builds, while the -NG version has a
--output-diroption.