Skip to content
Snippets Groups Projects
  • Katsunori FUJIWARA's avatar
    b623e323
    help: indicate help omitting if help document is not fully displayed · b623e323
    Katsunori FUJIWARA authored
    Before this patch, there is no information about whether help document
    is fully displayed or not.
    
    So, some users seem to misunderstand "-v" for "hg help" just as "the
    option to show list of global options": experience on "hg help -v" for
    some commands not containing verbose containers may strengthen this
    misunderstanding.
    
    Such users have less opportunity for noticing omitted help document,
    and this may cause insufficient understanding about Mercurial.
    
    This patch indicates help omitting, if help document is not fully
    displayed.
    
    For command help, the message below is displayed at the end of help
    output, if help document is not fully displayed:
    
        use "hg -v help xxxx" to show more complete help and the global
        options
    
    and otherwise:
    
        use "hg -v help xxxx" to show the global options
    
    For topics and extensions help, the message below is displayed, only
    if help document is not fully displayed:
    
        use "hg help -v xxxx" to show more complete help
    
    This allows users to know whether there is any omitted information or
    not exactly, and can trigger "hg help -v" invocation.
    
    This patch causes formatting help document twice, to switch messages
    one for omitted help, and another for not omitted. This decreases
    performance of help document formatting, but it is not mainly focused
    at help command invocation, so this wouldn't become problem.
    b623e323
    History
    help: indicate help omitting if help document is not fully displayed
    Katsunori FUJIWARA authored
    Before this patch, there is no information about whether help document
    is fully displayed or not.
    
    So, some users seem to misunderstand "-v" for "hg help" just as "the
    option to show list of global options": experience on "hg help -v" for
    some commands not containing verbose containers may strengthen this
    misunderstanding.
    
    Such users have less opportunity for noticing omitted help document,
    and this may cause insufficient understanding about Mercurial.
    
    This patch indicates help omitting, if help document is not fully
    displayed.
    
    For command help, the message below is displayed at the end of help
    output, if help document is not fully displayed:
    
        use "hg -v help xxxx" to show more complete help and the global
        options
    
    and otherwise:
    
        use "hg -v help xxxx" to show the global options
    
    For topics and extensions help, the message below is displayed, only
    if help document is not fully displayed:
    
        use "hg help -v xxxx" to show more complete help
    
    This allows users to know whether there is any omitted information or
    not exactly, and can trigger "hg help -v" invocation.
    
    This patch causes formatting help document twice, to switch messages
    one for omitted help, and another for not omitted. This decreases
    performance of help document formatting, but it is not mainly focused
    at help command invocation, so this wouldn't become problem.