quality@glassfish.java.net

Re: FishCAT reviews of bundled docs

From: Kedar Mhaswade <Kedar.Mhaswade_at_Sun.COM>
Date: Fri, 29 Aug 2008 08:12:49 -0700

Dick Davies wrote:
> Hi Gail
>
> finally got round to taking a look (I know it's a bit last minute but
> I've got a GF2 deployment due by Monday so have been a bit tied up).
>
> Is it intentional for the 'asadmin help <command>' syntax to
> have gone away?
>
> I assumed that's what you meant by manpages, so was a bit surprised to
> see they're not in b21.
>
> I can see that 'asadmin <command> --help' gives a usage statement,
> but it seems pretty inconsistent
>
> e.g.
>
> asadmin create-domain --help gives a brief usage statement,
> asadmin create-jdbc-connection-pool --help gives the full manpage.
>
> Should I be raising bugs about this?

Yes, please. File them under command_line_interface.

>
>
> On Fri, Aug 29, 2008 at 2:05 AM, Gail Risdal <Gail.Risdal_at_sun.com> wrote:
>> Hello,
>>
>> Bundled docs are docs that are built into the product, such as man pages and
>> the Admin Console online help. Many thanks to Manfred and others who are
>> reviewing and testing these docs. Your reviews are critical.
>>
>> I originally asked that all bugs against the bundled docs be filed no later
>> than September 1st, so fixes could be made in time for hard code freeze on
>> September 8th. That's still ideal, but I realize there have been issues with
>> the builds and that may not be possible - especially since September 1st is
>> right around the corner (and it's a holiday in the US)!
>>
>> So definitely continue with your review and testing of the bundled docs, but
>> note the following:
>>
>> * Bugs filed against the bundled docs by September 1st will be fixed for the
>> Prelude release.
>>
>> * Bugs filed against the bundled docs after September 1st won't be fixed for
>> Prelude unless they're deemed to be showstoppers, but will be fixed
>> post-Prelude. Your reviews are important and your comments will be addressed
>> - just not in time for Prelude.
>>
>> Thanks again for your work on this and let me know if you have any
>> questions. I'll be communicating soon about the review of the unbundled docs
>> (tutorials, guides, and so on), which starts September 1st and runs through
>> September 30th.
>>
>> Gail
>> ++++++
>> GlassFish Documentation
>>
>>
>> ---------------------------------------------------------------------
>> To unsubscribe, e-mail: quality-unsubscribe_at_glassfish.dev.java.net
>> For additional commands, e-mail: quality-help_at_glassfish.dev.java.net
>>
>>
>
>
>