← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/help_topics/__init__.py

(jelmer) Generate environment variables section in bzr(1) from standard list
 of environment variables. (Jelmer Vernooij)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/help_topics/__init__.py
595
595
"""
596
596
 
597
597
 
598
 
_env_variables = \
599
 
"""Environment Variables
600
 
 
601
 
=================== ===========================================================
602
 
BZRPATH             Path where bzr is to look for shell plugin external
603
 
                    commands.
604
 
BZR_EMAIL           E-Mail address of the user. Overrides EMAIL.
605
 
EMAIL               E-Mail address of the user.
606
 
BZR_EDITOR          Editor for editing commit messages. Overrides EDITOR.
607
 
EDITOR              Editor for editing commit messages.
608
 
BZR_PLUGIN_PATH     Paths where bzr should look for plugins.
609
 
BZR_DISABLE_PLUGINS Plugins that bzr should not load.
610
 
BZR_PLUGINS_AT      Plugins to load from a directory not in BZR_PLUGIN_PATH.
611
 
BZR_HOME            Directory holding .bazaar config dir. Overrides HOME.
612
 
BZR_HOME (Win32)    Directory holding bazaar config dir. Overrides APPDATA and
613
 
                    HOME.
614
 
BZR_REMOTE_PATH     Full name of remote 'bzr' command (for bzr+ssh:// URLs).
615
 
BZR_SSH             Path to SSH client, or one of paramiko, openssh, sshcorp,
616
 
                    plink or lsh.
617
 
BZR_LOG             Location of .bzr.log (use '/dev/null' to suppress log).
618
 
BZR_LOG (Win32)     Location of .bzr.log (use 'NUL' to suppress log).
619
 
BZR_COLUMNS         Override implicit terminal width.
620
 
BZR_CONCURRENCY     Number of processes that can be run concurrently (selftest)
621
 
BZR_PROGRESS_BAR    Override the progress display. Values are 'none' or 'text'.
622
 
BZR_PDB             Control whether to launch a debugger on error.
623
 
BZR_SIGQUIT_PDB     Control whether SIGQUIT behaves normally or invokes a
624
 
                    breakin debugger.
625
 
BZR_TEXTUI_INPUT    Force console input mode for prompts to line-based (instead
626
 
                    of char-based).
627
 
=================== ===========================================================
628
 
"""
629
 
 
 
598
known_env_variables = [
 
599
    ("BZRPATH", "Path where bzr is to look for shell plugin external commands."),
 
600
    ("BZR_EMAIL", "E-Mail address of the user. Overrides EMAIL."),
 
601
    ("EMAIL", "E-Mail address of the user."),
 
602
    ("BZR_EDITOR", "Editor for editing commit messages. Overrides EDITOR."),
 
603
    ("EDITOR", "Editor for editing commit messages."),
 
604
    ("BZR_PLUGIN_PATH", "Paths where bzr should look for plugins."),
 
605
    ("BZR_DISABLE_PLUGINS", "Plugins that bzr should not load."),
 
606
    ("BZR_PLUGINS_AT", "Plugins to load from a directory not in BZR_PLUGIN_PATH."),
 
607
    ("BZR_HOME", "Directory holding .bazaar config dir. Overrides HOME."),
 
608
    ("BZR_HOME (Win32)", "Directory holding bazaar config dir. Overrides APPDATA and HOME."),
 
609
    ("BZR_REMOTE_PATH", "Full name of remote 'bzr' command (for bzr+ssh:// URLs)."),
 
610
    ("BZR_SSH", "Path to SSH client, or one of paramiko, openssh, sshcorp, plink or lsh."),
 
611
    ("BZR_LOG", "Location of .bzr.log (use '/dev/null' to suppress log)."),
 
612
    ("BZR_LOG (Win32)", "Location of .bzr.log (use 'NUL' to suppress log)."),
 
613
    ("BZR_COLUMNS", "Override implicit terminal width."),
 
614
    ("BZR_CONCURRENCY", "Number of processes that can be run concurrently (selftest)"),
 
615
    ("BZR_PROGRESS_BAR", "Override the progress display. Values are 'none' or 'text'."),
 
616
    ("BZR_PDB", "Control whether to launch a debugger on error."),
 
617
    ("BZR_SIGQUIT_PDB", "Control whether SIGQUIT behaves normally or invokes a breakin debugger."),
 
618
    ("BZR_TEXTUI_INPUT", "Force console input mode for prompts to line-based (instead of char-based)."),
 
619
    ]
 
620
 
 
621
def _env_variables(topic):
 
622
    import textwrap
 
623
    ret = ["Environment Variables\n\n"]
 
624
    max_key_len = max([len(k[0]) for k in known_env_variables])
 
625
    desc_len = (80 - max_key_len - 2)
 
626
    ret.append("=" * max_key_len + " " + "=" * desc_len + "\n")
 
627
    for k, desc in known_env_variables:
 
628
        ret.append(k + (max_key_len + 1 - len(k)) * " ")
 
629
        ret.append("\n".join(textwrap.wrap(
 
630
            desc, width=desc_len, subsequent_indent=" " * (max_key_len + 1))))
 
631
        ret.append("\n")
 
632
    ret += "=" * max_key_len + " " + "=" * desc_len + "\n"
 
633
    return "".join(ret)
630
634
 
631
635
_files = \
632
636
r"""Files