[GLASSFISH-15929] man-page-review umbrella issue Created: 09/Feb/11  Updated: 19/Dec/16  Due: 13/Feb/11  Resolved: 16/Feb/11

Status: Resolved
Project: glassfish
Component/s: docs
Affects Version/s: 3.1
Fix Version/s: 3.1_dev

Type: Bug Priority: Blocker
Reporter: Jagadish Assignee: Paul Davies
Resolution: Fixed Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
depends on GLASSFISH-15958 man page: webtier CLIs Resolved
depends on GLASSFISH-15877 man-page-review : remove the section ... Resolved
depends on GLASSFISH-15878 man-page-review : create-jdbc-connect... Resolved
depends on GLASSFISH-15879 man-page-review : note about resource... Resolved
depends on GLASSFISH-15962 Man page for update-node-config is wr... Resolved
depends on GLASSFISH-3198 Synopsis for asadmin help create-cust... Resolved
depends on GLASSFISH-15485 Error in man pages for restart-local-... Resolved
depends on GLASSFISH-15564 create-http-health-checker man page e... Resolved
depends on GLASSFISH-15566 change-master-password --help has wro... Resolved
depends on GLASSFISH-15867 documentation of create-system-proper... Resolved
depends on GLASSFISH-15872 man-page : flush-connection-pool, pin... Resolved
depends on GLASSFISH-15873 man-page-review : delete-resource-ada... Resolved
depends on GLASSFISH-15874 man-page-review : delete-connector-re... Resolved
depends on GLASSFISH-15875 man-page-review : list-admin-objects,... Resolved
depends on GLASSFISH-15876 man-page-review : list-connector-reso... Resolved
depends on GLASSFISH-15919 man-page-review: jms CLIs Resolved
depends on GLASSFISH-15956 man page: remove --upgrade option fro... Closed
depends on GLASSFISH-15947 Remove --upgrade from start-local-ins... Resolved
Tags: 3_1-approved, 3_1-release-note-added, 3_1-release-notes


Raising an umbrella issue for the man pages of various commands for Bugswat review. Please refer the "depends on" issues list.

Comment by Paul Davies [ 11/Feb/11 ]

This bug is the umbrella bug for all man page fixes for the RC 3 build. I have increased the priority to ensure that it is approved for integration in RC 3.

Comment by Paul Davies [ 11/Feb/11 ]

How bad is its impact? (Severity)
The fix needs to occur now because the issue:

  • Is likely to generate a customer support call
  • Significantly impacts the operation of a primary release driver feature
  • Is an in-your-face issue that will touch the majority of users

How often does it happen? (Frequency)
Every time a user requests help on an affected subcommand.

How much effort is required to fix it? (Cost)
Approx 4 writer days (3 writers working 1 day each on the fixes, + 1 day for integration and testing)

What is the risk of fixing it? (Risk)

Does a work around for the issue exist? Can the workaround be reasonably employed by the end user?
Yes - deliver the fixes only in the version that is published on the web.The workaround could be employed by an end user but only if the user is aware of the workaround.

If the issue is not fixed should the issue and its workaround (if applicable) be described in the Release Notes?

How long has the bug existed in the product?
The errors were introduced in this release.

Do regression tests exist for this issue?

Which tests should QA (re)run to verify the fix did not destabilize GlassFish?
QuickLook would be sufficient for this purpose.

When will a tested fix be ready for integration?
Before the RC 3 build is started.

Comment by Chris Kasso [ 11/Feb/11 ]

Approved for RC3.

Comment by Chris Kasso [ 11/Feb/11 ]

These changes will not be localized for 3.1 thus users in non-EN locales will continue to see the incorrect man pages. The release notes should direct these users to the unbundled versions of the man pages for the corrections.

Comment by Paul Davies [ 13/Feb/11 ]

For the 3.1 branch, change is committed in revision 45101.

Comment by Paul Davies [ 16/Feb/11 ]

For the trunk, the fix is committed in revision 45163.

Comment by Scott Fordin [ 24/Mar/11 ]

Added topic to 3.1 Release Notes. Added "3_1-release-note-added" tag.

Generated at Sun Jan 22 15:25:32 UTC 2017 using JIRA 6.2.3#6260-sha1:63ef1d6dac3f4f4d7db4c1effd405ba38ccdc558.