Issue Details (XML | Word | Printable)

Key: GLASSFISH-15470
Type: Improvement Improvement
Status: Reopened Reopened
Priority: Minor Minor
Assignee: Paul Davies
Reporter: jbenoit
Votes: 0
Watchers: 0
Operations

If you were logged in you would be able to see more operations.
glassfish

every subcommand manual page include "asadmin-options" in the synopsis

Created: 06/Jan/11 02:51 PM   Updated: 06/Mar/12 10:50 PM
Component/s: docs
Affects Version/s: 3.1_b36
Fix Version/s: future release

Time Tracking:
Not Specified

Tags: 3_1-exclude
Participants: jbenoit and Paul Davies


 Description  « Hide

request that every subcommand manual page include "asadmin-options" in the synopsis with a note that information about the asadmin-options is on the asadmin manual page.

Here is the motivation/use case email thread from users@glassfish.java.net as to why this is requested:

http://java.net/projects/glassfish/lists/users/archive/2011-01/message/56



Paul Davies added a comment - 24/Jan/11 05:32 PM

Defer to 3.2 for consideration. However, if the proposed fix is adopted, the synopsis would have to include asadmin <asadmin-options>, which reduces the prominence in the synopsis of the subcommand that is described in the man page.


Paul Davies added a comment - 27/May/11 10:22 AM

After consideration, this RFE is declined. Adding this information would clutter the Synopsis and Options sections.


Paul Davies added a comment - 05/Aug/11 06:08 PM

After further consideration and discussion, it seems that including all the related information is more important than not reducing the prominence in the synopsis of the subcommand that is described in the
man page.

The fix for this issue requires the following changes to the man page for each asadmin subcommand:

  • In Synopsis, prefix the subcommand with asadmin [asadmin-options] just like the usage statement.
  • In Options, add an explain for asadmin-options that cross-refers to asadmin(1M) and suggests running asadmin help as an alternative.
  • In See Also, move the cross-reference to asadmin(1M) to above the references to section 1 man pages.

Paul Davies added a comment - 06/Mar/12 10:50 PM

Too ambitious for a minor release such as 3.1.2. Aim to fix in 4.0