Opened 5 years ago

Last modified 5 years ago

#11075 new bug

[checkfs] add examples to checkfs help / default output

Reported by: jstressman Owned by: nobody
Priority: normal Milestone: R1
Component: Applications/Command Line Tools Version: R1/Development
Keywords: Cc:
Blocked By: Blocking:
Has a Patch: no Platform: All

Description

I found myself wishing checkfs had some examples in the help/default output to give me an idea exactly what it wanted for the given parameters, so I wrote a little patch to give 2 examples. One for each of the 2 ways you can specify which device or volume you wish to check.

These are based on the code from hrev47509

The original output looks like this;

Usage: checkfs <options> <device|volume name>
 
Options:
  -h, --help        - print this help text
  -c, --check-only  - do not make any changes to the file system

I added 2 examples below that to show what we're looking for...

Usage: checkfs <options> <device|volume name>
 
Options:
  -h, --help        - print this help text
  -c, --check-only  - do not make any changes to the file system

Examples:
  checkfs -c /Haiku
  checkfs /dev/disk/ata/0/master/raw

I'm attaching the patch.

Attachments (2)

checkfs.diff (504 bytes) - added by jstressman 5 years ago.
patch to add 2 examples to the help output for checkfs
0001-Add-examples-to-checkfs-help-output.patch (961 bytes) - added by jstressman 5 years ago.
proper git patch for checkfs changes to add examples to help output.

Download all attachments as: .zip

Change History (5)

Changed 5 years ago by jstressman

Attachment: checkfs.diff added

patch to add 2 examples to the help output for checkfs

comment:1 Changed 5 years ago by jstressman

Actually I'm going to make an additional change (tab aligning the option descriptions) and then submit a proper patch following the guidelines as per https://dev.haiku-os.org/wiki/SubmittingPatches

Changed 5 years ago by jstressman

proper git patch for checkfs changes to add examples to help output.

comment:2 Changed 5 years ago by diver

Has a Patch: set

comment:3 Changed 5 years ago by diver

Component: - GeneralApplications/Command Line Tools
Has a Patch: unset
Note: See TracTickets for help on using tickets.