~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/config.py

  • Committer: Patch Queue Manager
  • Date: 2012-09-19 07:12:28 UTC
  • mfrom: (6561.1.1 996401-doc-config)
  • Revision ID: pqm@pqm.ubuntu.com-20120919071228-yd09pv4quo9hxtf2
(vila) Clarify option references expansion for `bzr config`. (Vincent
 Ladeuil)

Show diffs side-by-side

added added

removed removed

Lines of Context:
4085
4085
class cmd_config(commands.Command):
4086
4086
    __doc__ = """Display, set or remove a configuration option.
4087
4087
 
4088
 
    Display the active value for a given option.
 
4088
    Display the active value for option NAME.
4089
4089
 
4090
4090
    If --all is specified, NAME is interpreted as a regular expression and all
4091
 
    matching options are displayed mentioning their scope. The active value
4092
 
    that bzr will take into account is the first one displayed for each option.
4093
 
 
4094
 
    If no NAME is given, --all .* is implied.
4095
 
 
4096
 
    Setting a value is achieved by using name=value without spaces. The value
 
4091
    matching options are displayed mentioning their scope and without resolving
 
4092
    option references in the value). The active value that bzr will take into
 
4093
    account is the first one displayed for each option.
 
4094
 
 
4095
    If NAME is not given, --all .* is implied (all options are displayed for the
 
4096
    current scope).
 
4097
 
 
4098
    Setting a value is achieved by using NAME=value without spaces. The value
4097
4099
    is set in the most relevant scope and can be checked by displaying the
4098
4100
    option again.
 
4101
 
 
4102
    Removing a value is achieved by using --remove NAME.
4099
4103
    """
4100
4104
 
4101
4105
    takes_args = ['name?']