admin@glassfish.java.net

Should hidden commands be exposed in error messages?

From: Paul M Davies (Oracle) <"Paul>
Date: Thu, 19 Aug 2010 14:12:40 -0700

Hi,

I just tried unsuccessfully to delete an instance (I think I encountered
Issue 12677
<https://glassfish.dev.java.net/issues/show_bug.cgi?id=12677>) and got
this message:

    remote failure: Command asadmin _delete-instance-filesystem on
    localhost returned a non-zero status
    Succesfully removed instance pmdinst1 from the DAS configuration,
    but failed to remove the instance files. Please run:

    asadmin _delete-instance-filesystem pmdinst1

    on localhost to complete the transaction.

    Command delete-instance failed.

I assume from the underscore at the start of its name that
_delete-instance-filesystem is a hidden command, and so is not
documented. Therefore, I'm wondering if the error message should tell
users to run this command to correct an error. If it should, perhaps
the command itself should not be hidden.

What do people think?


-- 
Oracle <http://www.oracle.com>
Paul Davies| Principal Technical Writer| +1.408.276.3413
Oracle GlassFish Server Documentation
4140 Network Circle, Santa Clara CA 95054, USA
Green Oracle <http://www.oracle.com/commitment> 	Oracle is committed to 
developing practices and products that help protect the environment