Project

General

Profile

Actions

Bug #16051

open

fmdump -A, -a, -H, -j, and -p should be documented

Added by Thirteen Oxide 18 days ago. Updated 10 days ago.

Status:
New
Priority:
Low
Category:
manpage - manual pages
Start date:
Due date:
% Done:

0%

Estimated time:
Difficulty:
Bite-size
Tags:
Gerrit CR:
External Bug:

Description

4304 introduced -j and added it to the usage output, but not to the manual. I can see little reason not to include it there, especially after the passage of time and presumably successful usage, as well as the fact that the format is described by an RFC.

11745 covers documenting the -i and -I (cap-eye) options, so I've left them out here.

-a is straightforward: it will include even those events for which the creator specified excluding them from administrative view. Again, no reason to leave this out, even though it's not in the usage message (and should be added there).

-A is documented in usage already and should be added to the manual.

-H is undocumented but occasionally useful: it simply prints the header associated with the specified (or default) file. This isn't going to change either.

-p is documented in usage already and should be added to the manual. This does not imply a higher commitment level with respect to the format of the output provided when -Vp is specified, but merely commits at the same level as the rest of the options (Evolving) to the fact that -p when used with -V modifies the formatting.

That leaves one further option that is completely undocumented: -O, which requires an argument and has two effects: first, it causes an additional column of output for the starting offset of each record; second, scanning of the file being read begins at the provided offset. This option is very poorly-conceived and is implemented using an unchecked call to strtoull, meaning that it's very easy to have it accidentally consume the next option or argument and either produce uninteded output or result in confusing option-parsing errors later on. While this is certainly a separate defect in its own right, it's also not at all clear that this option has any real value beyond engineering use when working on fault management code itself (that is, I can imagine no way for an operator to make any use of it). For these reasons I'm electing to exclude it here and leave it undocumented, and therefore Private.


Related issues

Related to illumos gate - Feature #4304: fmdump shall emit JSONResolvedJoshua M. Clulow2013-11-07

Actions
Related to illumos gate - Bug #11745: fmdump missing -i and -I parameter documentation in the man pagesNewThirteen Oxide

Actions
Related to illumos gate - Bug #16052: fmdump -O uses unchecked strtoullNewThirteen Oxide

Actions
Related to illumos gate - Bug #16054: fmdump mishandles interleaved arguments with -ANewThirteen Oxide

Actions
Actions #1

Updated by Thirteen Oxide 18 days ago

Actions #2

Updated by Thirteen Oxide 18 days ago

  • Related to Bug #11745: fmdump missing -i and -I parameter documentation in the man pages added
Actions #3

Updated by Thirteen Oxide 18 days ago

  • Related to Bug #16052: fmdump -O uses unchecked strtoull added
  • Related to Bug #16054: fmdump mishandles interleaved arguments with -A added
Actions #4

Updated by Electric Monk 10 days ago

  • Gerrit CR set to 3150
Actions

Also available in: Atom PDF