view contrib/tcsh_completion @ 31793:69d8fcf20014

help: document bundle specifications

I softly formalized the concept of a "bundle specification" a while
ago when I was working on clone bundles and stream clone bundles and
wanted a more robust way to define what exactly is in a bundle file.

The concept has existed for a while. Since it is part of the clone
bundles feature and exposed to the user via the "-t" argument to
`hg bundle`, it is something we need to support for the long haul.

After the 4.1 release, I heard a few people comment that they didn't
realize you could generate zstd bundles with `hg bundle`. I'm
partially to blame for not documenting it in bundle's docstring.

Additionally, I added a hacky, experimental feature for controlling
the compression level of bundles in 76104a4899ad. As the commit
message says, I went with a quick and dirty solution out of time
constraints. Furthermore, I wanted to eventually store this
configuration in the "bundlespec" so it could be made more flexible.

Given:

a) bundlespecs are here to stay
b) we don't have great documentation over what they are, despite being
   a user-facing feature
c) the list of available compression engines and their behavior isn't
   exposed
d) we need an extensible place to modify behavior of compression
   engines

I want to move forward with formalizing bundlespecs as a user-facing
feature. This commit does that by introducing a "bundlespec" help
page. Leaning on the just-added compression engine documentation
and API, the topic also conveniently lists available compression
engines and details about them. This makes features like zstd
bundle compression more discoverable. e.g. you can now
`hg help -k zstd` and it lists the "bundlespec" topic.

#
# 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)/'