Project

General

Profile

Bug #4712

Prefer 'parsable' over 'parseable' in the manual pages

Added by Josef Sipek over 6 years ago. Updated over 4 years ago.

Status:
Closed
Priority:
Low
Assignee:
Category:
manpage - manual pages
Start date:
2014-03-28
Due date:
% Done:

100%

Estimated time:
Difficulty:
Bite-size
Tags:
needs-triage
Gerrit CR:

Description

The manpage uses both "parsable" and "parseable". It should be "parsable".

#1

Updated by Chris Josephes over 5 years ago

The following manpages also contain the word parseable:

man1/cputrack.1
man1/elfsign.1
man1/prctl.1
man1m/cpustat.1m
man1m/dladm.1m
man1m/flowadm.1m
man1m/ipmpstat.1m
man1m/kstat.1m
man1m/routeadm.1m

The following manages contain the word parsable:

man1/passwd.1
man1m/bart.1m
man1m/beadm.1m
man1m/cfgadm.1m
man1m/cfgadm_sbd.1m
man1m/dladm.1m
man1m/ipadm.1m
man1m/itadm.1m
man1m/lockstat.1m
man1m/th_define.1m
man1m/trapstat.1m
man1m/zfs.1m
man1m/zoneadm.1m
man1m/zpool.1m
man3exacct/ea_pack_object.3exacct

If we want to be consistent, it will require editing more than one manpage. Also, command source code may need to be edited in order to make sure if "parseable" is a long option (like it is in "diadm", it is still supported.

#2

Updated by Cody Mello over 4 years ago

  • Subject changed from dladm manpage can't decide on "parsable" spelling to Prefer 'parsable' over 'parseable' in the manual pages
  • Assignee set to Cody Mello

With the changes made in #7040, we can check for and prefer the spelling of 'parsable' in the manual pages. Both flowadm(1M) and dladm(1M) already support both --parsable and --parseable [1], so changing the flags documented in their manual pages shouldn't be an issue.

[1] https://github.com/joyent/illumos-joyent/commit/8002d4117c1ea26aff1f16f584ae97bdbd5b21d5

#3

Updated by Electric Monk over 4 years ago

  • Status changed from New to Closed
  • % Done changed from 0 to 100

git commit f3a07f941f1be263a48a040c059edbcb722cf436

commit  f3a07f941f1be263a48a040c059edbcb722cf436
Author: Cody Peter Mello <cody.mello@joyent.com>
Date:   2016-06-21T04:46:44.000Z

    4712 Prefer 'parsable' over 'parseable' in the manual pages
    Reviewed by: Robert Mustacchi <rm@joyent.com>
    Approved by: Dan McDonald <danmcd@omniti.com>

Also available in: Atom PDF