]> git-server-git.apps.pok.os.sepia.ceph.com Git - ceph-deploy.git/commit
projects / ceph-deploy.git / commit
? search:
summary | shortlog | log | commit | commitdiff | tree
(initial) | patch
[RM-12151] Add new 'ToggleRawTextHelpFormatter'
authorTravis Rhoden <trhoden@redhat.com>
Mon, 29 Jun 2015 21:32:55 +0000 (14:32 -0700)
committerTravis Rhoden <trhoden@redhat.com>
Wed, 1 Jul 2015 20:50:22 +0000 (13:50 -0700)
commitafa87873b07400720ab4abbc0b48b03aff10aeea
tree481d3502b4b183ad818c734276591fccff6db5batree | snapshot
[RM-12151] Add new 'ToggleRawTextHelpFormatter'

The existing use of argparse.RawDescriptionHelpFormatter seems to stem
from wanting to use newlines in argparse help output.  To use the raw
text formatter, you have to provide a static string that is always
output with --help.

The problem is that the defintion of this help string is pretty
disconnected from the rest of the code. You are documenting options many
lines away from where they are defined instead of normally being at the
same time.

To solve this, introduce a new ToggleRawTextHelpFormatter that allows
for the optional use of Raw text on any individual help item by
prefixing it with 'R|'.

Signed-off-by: Travis Rhoden <trhoden@redhat.com>
168 files changed:
.gitignore [new file with mode: 0644] blob
LICENSE [new file with mode: 0644] blob
MANIFEST.in [new file with mode: 0644] blob
README.rst [new file with mode: 0644] blob
bootstrap [new file with mode: 0755] blob
ceph-deploy.spec [new file with mode: 0644] blob
ceph_deploy/__init__.py [new file with mode: 0644] blob
ceph_deploy/admin.py [new file with mode: 0644] blob
ceph_deploy/calamari.py [new file with mode: 0644] blob
ceph_deploy/cli.py [new file with mode: 0644] blob
ceph_deploy/cliutil.py [new file with mode: 0644] blob
ceph_deploy/conf/__init__.py [new file with mode: 0644] blob
ceph_deploy/conf/ceph.py [new file with mode: 0644] blob
ceph_deploy/conf/cephdeploy.py [new file with mode: 0644] blob
ceph_deploy/config.py [new file with mode: 0644] blob
ceph_deploy/connection.py [new file with mode: 0644] blob
ceph_deploy/exc.py [new file with mode: 0644] blob
ceph_deploy/forgetkeys.py [new file with mode: 0644] blob
ceph_deploy/gatherkeys.py [new file with mode: 0644] blob
ceph_deploy/hosts/__init__.py [new file with mode: 0644] blob
ceph_deploy/hosts/centos/__init__.py [new file with mode: 0644] blob
ceph_deploy/hosts/centos/install.py [new file with mode: 0644] blob
ceph_deploy/hosts/centos/mon/__init__.py [new file with mode: 0644] blob
ceph_deploy/hosts/centos/mon/create.py [new file with mode: 0644] blob
ceph_deploy/hosts/centos/pkg.py [new file with mode: 0644] blob
ceph_deploy/hosts/centos/uninstall.py [new file with mode: 0644] blob
ceph_deploy/hosts/common.py [new file with mode: 0644] blob
ceph_deploy/hosts/debian/__init__.py [new file with mode: 0644] blob
ceph_deploy/hosts/debian/install.py [new file with mode: 0644] blob
ceph_deploy/hosts/debian/mon/__init__.py [new file with mode: 0644] blob
ceph_deploy/hosts/debian/mon/create.py [new file with mode: 0644] blob
ceph_deploy/hosts/debian/pkg.py [new file with mode: 0644] blob
ceph_deploy/hosts/debian/uninstall.py [new file with mode: 0644] blob
ceph_deploy/hosts/fedora/__init__.py [new file with mode: 0644] blob
ceph_deploy/hosts/fedora/install.py [new file with mode: 0644] blob
ceph_deploy/hosts/fedora/mon/__init__.py [new file with mode: 0644] blob
ceph_deploy/hosts/fedora/mon/create.py [new file with mode: 0644] blob
ceph_deploy/hosts/fedora/uninstall.py [new file with mode: 0644] blob
ceph_deploy/hosts/remotes.py [new file with mode: 0644] blob
ceph_deploy/hosts/rhel/__init__.py [new file with mode: 0644] blob
ceph_deploy/hosts/rhel/install.py [new file with mode: 0644] blob
ceph_deploy/hosts/rhel/mon/__init__.py [new file with mode: 0644] blob
ceph_deploy/hosts/rhel/mon/create.py [new file with mode: 0644] blob
ceph_deploy/hosts/rhel/pkg.py [new file with mode: 0644] blob
ceph_deploy/hosts/rhel/uninstall.py [new file with mode: 0644] blob
ceph_deploy/hosts/suse/__init__.py [new file with mode: 0644] blob
ceph_deploy/hosts/suse/install.py [new file with mode: 0644] blob
ceph_deploy/hosts/suse/mon/__init__.py [new file with mode: 0644] blob
ceph_deploy/hosts/suse/mon/create.py [new file with mode: 0644] blob
ceph_deploy/hosts/suse/pkg.py [new file with mode: 0644] blob
ceph_deploy/hosts/suse/uninstall.py [new file with mode: 0644] blob
ceph_deploy/hosts/util.py [new file with mode: 0644] blob
ceph_deploy/install.py [new file with mode: 0644] blob
ceph_deploy/lib/__init__.py [new file with mode: 0644] blob
ceph_deploy/lib/vendor/__init__.py [new file with mode: 0644] blob
ceph_deploy/mds.py [new file with mode: 0644] blob
ceph_deploy/misc.py [new file with mode: 0644] blob
ceph_deploy/mon.py [new file with mode: 0644] blob
ceph_deploy/new.py [new file with mode: 0644] blob
ceph_deploy/osd.py [new file with mode: 0644] blob
ceph_deploy/pkg.py [new file with mode: 0644] blob
ceph_deploy/rgw.py [new file with mode: 0644] blob
ceph_deploy/tests/__init__.py [new file with mode: 0644] blob
ceph_deploy/tests/conftest.py [new file with mode: 0644] blob
ceph_deploy/tests/directory.py [new file with mode: 0644] blob
ceph_deploy/tests/fakes.py [new file with mode: 0644] blob
ceph_deploy/tests/parser/__init__.py [new file with mode: 0644] blob
ceph_deploy/tests/parser/test_admin.py [new file with mode: 0644] blob
ceph_deploy/tests/parser/test_calamari.py [new file with mode: 0644] blob
ceph_deploy/tests/parser/test_config.py [new file with mode: 0644] blob
ceph_deploy/tests/parser/test_disk.py [new file with mode: 0644] blob
ceph_deploy/tests/parser/test_gatherkeys.py [new file with mode: 0644] blob
ceph_deploy/tests/parser/test_install.py [new file with mode: 0644] blob
ceph_deploy/tests/parser/test_main.py [new file with mode: 0644] blob
ceph_deploy/tests/parser/test_mds.py [new file with mode: 0644] blob
ceph_deploy/tests/parser/test_mon.py [new file with mode: 0644] blob
ceph_deploy/tests/parser/test_new.py [new file with mode: 0644] blob
ceph_deploy/tests/parser/test_osd.py [new file with mode: 0644] blob
ceph_deploy/tests/parser/test_purge.py [new file with mode: 0644] blob
ceph_deploy/tests/parser/test_purgedata.py [new file with mode: 0644] blob
ceph_deploy/tests/parser/test_rgw.py [new file with mode: 0644] blob
ceph_deploy/tests/parser/test_uninstall.py [new file with mode: 0644] blob
ceph_deploy/tests/test_cli_admin.py [new file with mode: 0644] blob
ceph_deploy/tests/test_cli_mon.py [new file with mode: 0644] blob
ceph_deploy/tests/test_cli_new.py [new file with mode: 0644] blob
ceph_deploy/tests/test_cli_rgw.py [new file with mode: 0644] blob
ceph_deploy/tests/test_conf.py [new file with mode: 0644] blob
ceph_deploy/tests/test_install.py [new file with mode: 0644] blob
ceph_deploy/tests/test_mon.py [new file with mode: 0644] blob
ceph_deploy/tests/test_remotes.py [new file with mode: 0644] blob
ceph_deploy/tests/unit/hosts/test_centos.py [new file with mode: 0644] blob
ceph_deploy/tests/unit/hosts/test_hosts.py [new file with mode: 0644] blob
ceph_deploy/tests/unit/hosts/test_remotes.py [new file with mode: 0644] blob
ceph_deploy/tests/unit/hosts/test_suse.py [new file with mode: 0644] blob
ceph_deploy/tests/unit/hosts/test_util.py [new file with mode: 0644] blob
ceph_deploy/tests/unit/test_calamari.py [new file with mode: 0644] blob
ceph_deploy/tests/unit/test_cli.py [new file with mode: 0644] blob
ceph_deploy/tests/unit/test_conf.py [new file with mode: 0644] blob
ceph_deploy/tests/unit/test_exc.py [new file with mode: 0644] blob
ceph_deploy/tests/unit/test_mon.py [new file with mode: 0644] blob
ceph_deploy/tests/unit/test_new.py [new file with mode: 0644] blob
ceph_deploy/tests/unit/test_osd.py [new file with mode: 0644] blob
ceph_deploy/tests/unit/util/test_arg_validators.py [new file with mode: 0644] blob
ceph_deploy/tests/unit/util/test_constants.py [new file with mode: 0644] blob
ceph_deploy/tests/unit/util/test_net.py [new file with mode: 0644] blob
ceph_deploy/tests/unit/util/test_paths.py [new file with mode: 0644] blob
ceph_deploy/tests/unit/util/test_pkg_managers.py [new file with mode: 0644] blob
ceph_deploy/tests/unit/util/test_system.py [new file with mode: 0644] blob
ceph_deploy/tests/unit/util/test_templates.py [new file with mode: 0644] blob
ceph_deploy/tests/util.py [new file with mode: 0644] blob
ceph_deploy/util/__init__.py [new file with mode: 0644] blob
ceph_deploy/util/arg_validators.py [new file with mode: 0644] blob
ceph_deploy/util/constants.py [new file with mode: 0644] blob
ceph_deploy/util/decorators.py [new file with mode: 0644] blob
ceph_deploy/util/files.py [new file with mode: 0644] blob
ceph_deploy/util/help_formatters.py [new file with mode: 0644] blob
ceph_deploy/util/log.py [new file with mode: 0644] blob
ceph_deploy/util/net.py [new file with mode: 0644] blob
ceph_deploy/util/paths/__init__.py [new file with mode: 0644] blob
ceph_deploy/util/paths/gpg.py [new file with mode: 0644] blob
ceph_deploy/util/paths/mon.py [new file with mode: 0644] blob
ceph_deploy/util/paths/osd.py [new file with mode: 0644] blob
ceph_deploy/util/pkg_managers.py [new file with mode: 0644] blob
ceph_deploy/util/ssh.py [new file with mode: 0644] blob
ceph_deploy/util/system.py [new file with mode: 0644] blob
ceph_deploy/util/templates.py [new file with mode: 0644] blob
ceph_deploy/validate.py [new file with mode: 0644] blob
debian/ceph-deploy.install [new file with mode: 0644] blob
debian/changelog [new file with mode: 0644] blob
debian/compat [new file with mode: 0644] blob
debian/control [new file with mode: 0644] blob
debian/copyright [new file with mode: 0644] blob
debian/rules [new file with mode: 0755] blob
debian/source/format [new file with mode: 0644] blob
docs/Makefile [new file with mode: 0644] blob
docs/source/_static/.empty [new file with mode: 0644] blob
docs/source/_themes/ceph/static/font/ApexSans-Book.eot [new file with mode: 0644] blob
docs/source/_themes/ceph/static/font/ApexSans-Book.svg [new file with mode: 0644] blob
docs/source/_themes/ceph/static/font/ApexSans-Book.ttf [new file with mode: 0644] blob
docs/source/_themes/ceph/static/font/ApexSans-Book.woff [new file with mode: 0644] blob
docs/source/_themes/ceph/static/font/ApexSans-Medium.eot [new file with mode: 0644] blob
docs/source/_themes/ceph/static/font/ApexSans-Medium.svg [new file with mode: 0644] blob
docs/source/_themes/ceph/static/font/ApexSans-Medium.ttf [new file with mode: 0644] blob
docs/source/_themes/ceph/static/font/ApexSans-Medium.woff [new file with mode: 0644] blob
docs/source/_themes/ceph/static/nature.css_t [new file with mode: 0644] blob
docs/source/_themes/ceph/theme.conf [new file with mode: 0644] blob
docs/source/changelog.rst [new file with mode: 0644] blob
docs/source/conf.py [new file with mode: 0644] blob
docs/source/conf.rst [new file with mode: 0644] blob
docs/source/contents.rst [new file with mode: 0644] blob
docs/source/index.rst [new file with mode: 0644] blob
docs/source/install.rst [new file with mode: 0644] blob
docs/source/mds.rst [new file with mode: 0644] blob
docs/source/mon.rst [new file with mode: 0644] blob
docs/source/new.rst [new file with mode: 0644] blob
docs/source/pkg.rst [new file with mode: 0644] blob
docs/source/rgw.rst [new file with mode: 0644] blob
requirements-dev.txt [new file with mode: 0644] blob
requirements.txt [new file with mode: 0644] blob
scripts/build-debian.sh [new file with mode: 0755] blob
scripts/build-rpm.sh [new file with mode: 0755] blob
scripts/ceph-deploy [new file with mode: 0755] blob
scripts/jenkins-build [new file with mode: 0755] blob
scripts/jenkins-pull-requests-build [new file with mode: 0644] blob
setup.cfg [new file with mode: 0644] blob
setup.py [new file with mode: 0644] blob
tox.ini [new file with mode: 0644] blob
vendor.py [new file with mode: 0644] blob
Unnamed repository; edit this file 'description' to name the repository.