Bug 5553 - required parameters are marked as optional in installadm(1M) man page
: required parameters are marked as optional in installadm(1M) man page
Status: RESOLVED FIXED
Product: opensolaris
install
: 200811
: Other OpenSolaris
: P3 blocker (vote)
: in-200906
Assigned To: Barbara Lundquist
:
:
: 2009.06-04 jsc-qa
:
:
:
  Show dependency treegraph
 
Reported: 2008-12-02 06:47 UTC by Rudolf Kutina
Modified: 2009-04-07 10:23 UTC (History)
6 users (show)

See Also:


Attachments


Note

You need to log in before you can comment on or make changes to this bug.


Description Rudolf Kutina 2008-12-02 06:47:59 UTC
I make it P2, nice to have it fixed for upcomming public AI previe release !

1. For exampple command defintions show then parameters are optional, but text
under it say required (and they are really required)

installadm add [-m manifest] [-n svcname]
installadm remove [-m manifest] [-n svcname]

install amd-create client ...

2. Parameters in commands and desctipsions must follow up convention then
required are on line and in destription on first place
Comment 1 Rudolf Kutina 2008-12-02 07:52:58 UTC
Same errors are in OpenSolaris 2008.11 Automated Installer Guide, likks like
copy pasted from same source.
Comment 2 virginia.wray 2008-12-17 13:41:09 UTC
Reclassifying this as a documentation bug.
Comment 3 Barbara Lundquist 2008-12-19 10:23:31 UTC
I will correct this for next release.

Barbara
Comment 4 David Garcia 2009-02-11 03:25:18 UTC
-s <srcimage> is marked as optional in create-service both in man pages and
usage section.
It should be mandatory (i.e. remove brackets)

man:
     installadm create-service [-d] [-u][-f bootfile]
     [-D DHCPserver] [-n svcname]
     [-i dhcp_ip_start] [-c count_of_ipaddr]
     [-s srcimage] targetdir

usage:
   create-service    [-d] [-u] [-f <bootfile>] [-D <DHCPserver>]
           [-n <svcname>] [-i <dhcp_ip_start>]
           [-c <count_of_ipaddr>] [-s <srcimage>] <targetdir>
Comment 5 Jan Damborsky 2009-02-11 06:38:47 UTC
(In reply to comment #4)
> -s <srcimage> is marked as optional in create-service both in man pages and
> usage section.
> It should be mandatory (i.e. remove brackets)
> 

After talking to Sue, she pointed out that '-s' is not mandatory, but optional
and 'usage' as well as SYNOPSIS section in man page are correct.

It is not quite obvious by looking at installadm(1M) man page and this should
be clarified, as man page mentions in SUBCOMMANDS AND OPTIONS section:

...
   Publishes the OSInstall service. Only a source image
   and a target directory are required for basic setup.
... 
   -s srcimage
   Required: Specifies location of source image to use
   for setting up OSInstall service.
...
Comment 6 Barbara Lundquist 2009-04-07 10:23:28 UTC
Fixed in online man page copy, ready for delivery to engineering build.