ClientUser::Help( const char *const * )

Displays a block of help text to the user. Used by p4 resolve but not p4 help.

Virtual?

Yes

  

Class

ClientUser

 

Arguments

const char *const *help

an array of arrays containing the help text.

Returns

void

 

Notes

This function is called by p4 resolve when the “?” option is selected during an interactive resolve. The default implementation displays the help text given to it, one line at a time.

Example

The default implementation is called in order to display the "merge options" block of help text during a resolve by dumping the text to stdout.

To display the resolve help text in another manner, create a subclass of ClientUser with an alternate implementation of Help().

For example, suppose you’d like a helpful message about the meaning of "yours" and "theirs" to be attached to the help message. Define the method as follows:

void MyClientUser::Help( const char *const *help )
{
    for ( ; *help; help++ )
        printf( "%s\n", *help );
    printf( "Note: In integrations, yours is the target file, \
             theirs is the source file.\n" );
}