view contrib/tcsh_completion @ 20689:401f9b661a2d

doc: show short description of each commands in generated documents

Before this patch, short description of each commands is not shown in
generated documents (HTML file and UNIX man page). This omitting may
prevent users from understanding about commands.

This patch show it as the 1st paragraph in the help section of each
commands. This style is chosen because:

  - showing it as the section title in "command - short desc" style
    disallows referencing by "#command" in HTML file: in "en" locale,
    hyphen concatenated title is used as the section ID in HTML file
    for this style

  - showing it as the 1st paragraph in "command - short desc" style
    seems to be redundant: "command" appears also just before as the
    section title

  - showing it just after synopsis like "hg help command" seems not to
    be reasonable in UNIX man page

This patch just writes short description ("d['desc'][0]") before "::",
because it should be already "strip()"-ed in "get_desc()", or empty
string for the command without description.

#
# tcsh completion for Mercurial
#
# This file has been auto-generated by tcsh_completion_build.sh for
# Mercurial Distributed SCM (version 1.7.5+157-8a220ae0b2ba)
#
# Copyright (C) 2005 TK Soh.
#
# This is free software; you can redistribute it and/or modify it under
# the terms of the GNU General Public License as published by the Free
# Software Foundation; either version 2 of the License, or (at your
# option) any later version.
#

complete hg \
  'n/--cwd/d/' 'n/-R/d/' 'n/--repository/d/' \
  'C/-/( -R --repository \
    --cwd \
    -y --noninteractive \
    -q --quiet \
    -v --verbose \
    --config \
    --debug \
    --debugger \
    --encoding \
    --encodingmode \
    --traceback \
    --time \
    --profile \
    --version \
    -h --help)/' \
  'p/1/(add addremove annotate blame archive \
    backout bisect bookmarks branch branches \
    bundle cat clone commit ci \
    copy cp debugancestor debugbuilddag debugcheckstate \
    debugcommands debugcomplete debugdag debugdata debugdate \
    debugfsinfo debugignore debugindex debugindexdot debuginstall \
    debugpushkey debugrebuildstate debugrename debugrevspec debugsetparents \
    debugstate debugsub debugwalk diff export \
    forget grep heads help identify \
    id import patch incoming in \
    init locate log history manifest \
    merge outgoing out parents paths \
    pull push recover remove rm \
    rename move mv resolve revert \
    rollback root serve showconfig debugconfig \
    status st summary sum tag \
    tags tip unbundle update up \
    checkout co verify version)/'