Merge lp:~vila/bzr/config-modify into lp:bzr
- config-modify
- Merge into bzr.dev
| Status: | Merged |
|---|---|
| Approved by: | Vincent Ladeuil |
| Approved revision: | no longer in the source branch. |
| Merged at revision: | 5499 |
| Proposed branch: | lp:~vila/bzr/config-modify |
| Merge into: | lp:bzr |
| Diff against target: |
996 lines (+765/-4) 9 files modified
bzrlib/builtins.py (+1/-0) bzrlib/config.py (+283/-4) bzrlib/errors.py (+16/-0) bzrlib/tests/blackbox/__init__.py (+1/-0) bzrlib/tests/blackbox/test_config.py (+204/-0) bzrlib/tests/test_config.py (+194/-0) doc/en/release-notes/bzr-2.3.txt (+5/-0) doc/en/user-guide/configuring_bazaar.txt (+53/-0) doc/en/whats-new/whats-new-in-2.3.txt (+8/-0) |
| To merge this branch: | bzr merge lp:~vila/bzr/config-modify |
| Related bugs: |
| Reviewer | Review Type | Date Requested | Status |
|---|---|---|---|
| Martin Pool | Needs Fixing | ||
|
Review via email:
|
|||
Commit message
Add ``bzr config` command.
Description of the change
This proposal implements a new ``bzr config`` new command that can:
* displays the configuration options for a given directory. It
accepts a glob to match against multiple options at once,
* set a new value for a given option in any configuration file,
* remove an option from any configuration file.
There are some awkward hacks mostly caused by the BranchConfig
implementation that doesn't help sharing code and other
limitations of our current section handling in the configuration
files.
Branchconfig
============
BranchConfig is actually implemented by delegating the config
variables handling to TreeConfig (badly named as noted in a
comment) and the file containing the text to TransportConfig.
As such it implements a minimal API to get or set a config
variable.
Surprisingly it also implements its own locking mechanism. This
doesn't seem necessary since the config is always accessed via
the branch itself which is already locked.
Numerous related problems here, but luckily I didn't have to
support RemoteBranchCon
Section handling
================
For historical reasons, each of bazaar.conf, locations.conf and
branch.conf use sections in a different way:
- bazaar.conf: Defining options outside of any config is
supported by the underlying configobj but hard to do while
using the official API. Instead, all options should be in a
given section and for bzr itself, we use DEFAULTS and
ALIASES. Plugins can (and some do, at least lp:bookmarks)
define and use their own sections.
- locations.conf: Each location defines its own section. This
conflicts with section use in bazaar.conf since you can't
define aliases or bookmarks by location.
- branch.conf: No sections are used here because BranchConfig
(and its composites) doesn't provide access to them. The
bookmarks plugin works around this limitation by prefixing the
bookmarks with 'bookmarks_' (hint, hint, we can avoid using
sections in bazaar.conf by using a proper name space for
options).
Option removal
==============
In the actual implementation, only aliases can be removed with
unset_alias().
With the proposed implementation all options can be removed
(well, except the ones that are not in DEFAULT section in
bazaar.conf for reasons explained above).
Referring to config files
=======
Using absolute paths when referring to config files is user
hostile, so I went with introducing an id for each config file
(anticipating the implementation of a registry for them).
While it may seem acceptable to display and require the user to
use ${HOME}
${HOME}
reveal an implementation detail and that's bad :)
So I used 'bazaar', 'locations' and 'branch' instead, clean and
short. We may have to provide something else for bound branches
though... But one can argue that ``bzr unbind`` will allow
playing with both configuration files already.
Exceptions
==========
I didn't declare the new exceptions in config.py because it would
have meant error.py couldn't be lazy imported any more... I can't
see how to work around that which isn't great since we want to
declare exceptions closer to where they are needed.
Command naming
==============
I chose 'config' over 'configuration' as the later is already an
help topic. Cheap shot :)
Tests
=====
Not tests were harmed during this proposal development.
35 tests were added and became part of the 197 tests running in
<2s and ensuring against regression with:
./bzr selftest -s bb.test_config -s bt.test_config
Running a full test suite before submitting didn't reveal any
fallout.
Summary
=======
Yeah, I know, that's pretty long for a cover letter, yet, there
is more to say about configs and I will start a thread on the
mailing list on future plans.
This proposal is one step to help us better figure out how we use
our configuration files today without changing any existing
implementation (have a look at 'bzr config -d lp:bzr', yeah, no
harm done, but still...) and make it easier to play with various
configuration schemes with a simple way to look at the results.
| Vincent Ladeuil (vila) wrote : | # |
> Epic cover letter. What a shame it's not updating the user documentation. :-)
> Perhaps you could paste and update some of it into there: we need the
> documentation, and checking how it's explained to the user is a good way to
> find out if the ui is actually sane.
Well, basically I'm raising problems I want to address but since I don't have answers so far, I can't (yet) update the user documentation.
>
> This should also be mentioned in whatsnew.
Right, I can do that.
>
> And, I don't want to hijack your mp, but perhaps some of the other text could
> go into a developer document giving an overview of configurations?
Please, let's not hijack it indeed, nothing has changed in this regard, the problems are still here and we don't provide (yet) a clearly defined set of features.
>
> > Section handling
>
> That seems like a good description of the situation. I think locations.conf
> is on the right track by reserving the section headers to match _which_
> configuration applies, not as part of the settings.
Right, and from there, do you agree that sections should not be used *at all* in the other configuration files.
I realise we will need to address the ALIASES and BOOKMARKS cases, but we must first agree on that.
>
>
> > I chose 'config' over 'configuration' as the later is already an help topic.
> Cheap shot :)
>
> Probably the topic needs to be updated then.
>
> > + ('cmd_config', ['conf'], 'bzrlib.config'),
>
> I don't think people will type this often enough that saving two characters is
> worth it.
>
> -from fnmatch import fnmatch
> +import fnmatch
>
> Not this again :-)
That's a different case, the former makes it *impossible* to use fnmatch.translate !
>
> + def id(self):
> + return 'bazaar'
>
> 'id' is of course a Python builtin. It's legal and not shadowing anything to
> put it as an instance attribute but I wonder if it's a good idea; maybe
> config_id would be better.
>
I can do that, it will probably go away in the end and be controlled via the registry (when it's implemented).
> + commands.
> + short_name='f', type=unicode),
>
> Force it to do what? :)
>
> If it's going to be "config --force ~/.bazaar/
> strange and inconsistent with other uses of --force, which take no argument.
> Maybe just --file?
>
> OK, I see later on this is actually passing a kind of configuration scope.
>
> + if matching is None:
> + matching = '*'
> + self._show_
>
> Why assign to 'matching' in here?
Left over, good catch.
>
> + else:
> + if remove:
> + self._remove_
> + else:
> + pos = matching.find('=')
> + if pos == -1:
> + self._show_
> + else:
> + self._set_
> + directory, force)
> +
>
> I would unfold the 'remove' to one if/elif/else.
And unconditionally do ...
| Martin Pool (mbp) wrote : | # |
On 12 October 2010 19:06, Vincent Ladeuil <email address hidden> wrote:
>> Epic cover letter. What a shame it's not updating the user documentation. :-)
>> Perhaps you could paste and update some of it into there: we need the
>> documentation, and checking how it's explained to the user is a good way to
>> find out if the ui is actually sane.
>
> Well, basically I'm raising problems I want to address but since I don't have answers so far, I can't (yet) update the user documentation.
I think it should at least address the new command, even if the
description is imperfect or if some uncertainty remains. For example
the user guide ought to mention the existence of this command.
>
>>
>> > Section handling
>>
>> That seems like a good description of the situation. I think locations.conf
>> is on the right track by reserving the section headers to match _which_
>> configuration applies, not as part of the settings.
>
> Right, and from there, do you agree that sections should not be used *at all* in the other configuration files.
>
> I realise we will need to address the ALIASES and BOOKMARKS cases, but we must first agree on that.
I almost agree. I think they should only be used in ways that are
parallel to locations. For instance I think the authentication.conf
thing is basically ok, because parallel to locations.conf the sections
are used to find which settings are relevant.
>> + def test_locations_
>> + self.bazaar_
>> + self.locations_
>> + script.
>> +$ bzr config
>> +bazaar:
>> + hello = world
>> +''')
>> +
>>
>> Now that scripts automatically strip consistent indentation, I think we should
>> normally keep them indented inside the block, so that they don't mess up the
>> Python structure.
>
> Well, I'm never comfortable with inlined files that differ from what they would be on disk. I forgot the '\' at the end of the first line for that to be true though.
>
> Should we bikeshed on that or is it ok to have different povs there ?
Maybe we can bikeshed a bit :-). I don't see these as inlined files.
I know you just added test-script but I don't think they normally are
files on disk; they're primarily bits of a Python program. In all the
editors we use it's easy to indent/dedent things.
>> I wonder if the output from config when showing more than one variable should
>> be something that looks like a config file?
>
> This output is a *valid* content for a config file.
>
> At least for the actual tests ;)
>
> Things may become more complicated if we want to ensure that tough:
> - comments are not displayed,
> - strings are not quoted,
> - multi-lines strings are not even considered.
>
> And why would you use such output to put into a config file ?
I wouldn't necessarily send it into a file, I just don't think it
should be gratuituously different.
So is
locations:
file = locations
a valid configobject file? It's not the form we tend to use, which
has [] sections.
>> istm that if you ask just for the value of a variable, you should by default
>> just get that one variable, a...
| Vincent Ladeuil (vila) wrote : | # |
> On 12 October 2010 19:06, Vincent Ladeuil <email address hidden> wrote:
> >> Epic cover letter. What a shame it's not updating the user documentation.
> :-)
> >> Perhaps you could paste and update some of it into there: we need the
> >> documentation, and checking how it's explained to the user is a good way to
> >> find out if the ui is actually sane.
> >
> > Well, basically I'm raising problems I want to address but since I don't
> have answers so far, I can't (yet) update the user documentation.
>
> I think it should at least address the new command, even if the
> description is imperfect or if some uncertainty remains. For example
> the user guide ought to mention the existence of this command.
Ok.
> > Right, and from there, do you agree that sections should not be used *at
> all* in the other configuration files.
> >
> > I realise we will need to address the ALIASES and BOOKMARKS cases, but we
> must first agree on that.
>
> I almost agree. I think they should only be used in ways that are
> parallel to locations. For instance I think the authentication.conf
> thing is basically ok, because parallel to locations.conf the sections
> are used to find which settings are relevant.
Exactly, I didn't mention authentication.conf yet, but it re-implements too much things already in IniConfig and I did that at the time because I felt it wasn't fitting well there.
> Maybe we can bikeshed a bit :-). I don't see these as inlined files.
> I know you just added test-script but I don't think they normally are
> files on disk; they're primarily bits of a Python program.
Hmm, I'd argue that their syntax has nothing to do with python.
> In all the
> editors we use it's easy to indent/dedent things.
But even in python the indentation is meaningful (I agree that in this case the initial indentations are meaningless but we are still using dedent as a syntactic sugar and mostly because we can and because we apply a python rule).
>
> >> I wonder if the output from config when showing more than one variable
> should
> >> be something that looks like a config file?
> >
> > This output is a *valid* content for a config file.
> >
> > At least for the actual tests ;)
> >
> > Things may become more complicated if we want to ensure that tough:
> > - comments are not displayed,
> > - strings are not quoted,
> > - multi-lines strings are not even considered.
> >
> > And why would you use such output to put into a config file ?
>
> I wouldn't necessarily send it into a file, I just don't think it
> should be gratuituously different.
>
> So is
>
> locations:
> file = locations
>
> a valid configobject file? It's not the form we tend to use, which
> has [] sections.
Rhaaa, of course not, I was referring to ' file = locations' not the config id line.
>
> >> istm that if you ask just for the value of a variable, you should by
> default
> >> just get that one variable, and only with say -v be told where it comes
> from.
> >
> > Well, that would quickly be confusing since you want to see the multiple
> definitions as soon as there is more than one without having to specify -v,
> remember that you can use 'bzr config' without specifying any v...
| Martin Pool (mbp) wrote : | # |
> > On 12 October 2010 19:06, Vincent Ladeuil <email address hidden> wrote:
> > >> Epic cover letter. What a shame it's not updating the user
> documentation.
> > :-)
> > >> Perhaps you could paste and update some of it into there: we need the
> > >> documentation, and checking how it's explained to the user is a good way
> to
> > >> find out if the ui is actually sane.
> > >
> > > Well, basically I'm raising problems I want to address but since I don't
> > have answers so far, I can't (yet) update the user documentation.
> >
> > I think it should at least address the new command, even if the
> > description is imperfect or if some uncertainty remains. For example
> > the user guide ought to mention the existence of this command.
>
> Ok.
That looks nice, and it makes this easier to review.
My main question from what you have documented there is, when you set a value, in what scope is it set?
(It would be really cool, later, to actually do scriptrunner tests within the user guide; somehow we would need to make sure the setup/check code was not too intrusive to people reading the document.)
> > Maybe we can bikeshed a bit :-). I don't see these as inlined files.
> > I know you just added test-script but I don't think they normally are
> > files on disk; they're primarily bits of a Python program.
>
> Hmm, I'd argue that their syntax has nothing to do with python.
That's true the test itself is not Python syntax. However, it is embedded within a Python file, and the rule there is that things are indented by scope. Even though technically the indent whitespace appears within the triplequoted string, the effect we want to achieve is that the whole thing is shifted right.
docstrings or (in other programs) inline sql are not Python either but they're normally indented; <https:/
>
> > In all the
> > editors we use it's easy to indent/dedent things.
>
> But even in python the indentation is meaningful (I agree that in this case
> the initial indentations are meaningless but we are still using dedent as a
> syntactic sugar and mostly because we can and because we apply a python rule).
The main reason I want them indented is so that scanning over the file, I can easily see the classes and the test modules within them. Having internals of the tests flush left messes that up.
> > So is
> >
> > locations:
> > file = locations
> >
> > a valid configobject file? It's not the form we tend to use, which
> > has [] sections.
>
> Rhaaa, of course not, I was referring to ' file = locations' not the config
> id line.
I think the output needs to make some things more clear to the user:
1- wtf is 'locations'? :-)
2- which value is actually active? which of these is most important?
3- which location section is matching that this matters?
We could perhaps make that more obvious with
# per-location-config from /home/mbp/
(I'm open to tweaking this after landing)
> > >> istm that if you ask just for the value of a variable, you should by
> > default
> > >> just get that one variable, and only with say -v be told where it comes
> > from...
| Vincent Ladeuil (vila) wrote : | # |
sent to pqm by email
Preview Diff
| 1 | === modified file 'bzrlib/builtins.py' | |||
| 2 | --- bzrlib/builtins.py 2010-10-12 09:46:37 +0000 | |||
| 3 | +++ bzrlib/builtins.py 2010-10-15 09:37:41 +0000 | |||
| 4 | @@ -6070,6 +6070,7 @@ | |||
| 5 | 6070 | # be only called once. | 6070 | # be only called once. |
| 6 | 6071 | for (name, aliases, module_name) in [ | 6071 | for (name, aliases, module_name) in [ |
| 7 | 6072 | ('cmd_bundle_info', [], 'bzrlib.bundle.commands'), | 6072 | ('cmd_bundle_info', [], 'bzrlib.bundle.commands'), |
| 8 | 6073 | ('cmd_config', [], 'bzrlib.config'), | ||
| 9 | 6073 | ('cmd_dpush', [], 'bzrlib.foreign'), | 6074 | ('cmd_dpush', [], 'bzrlib.foreign'), |
| 10 | 6074 | ('cmd_version_info', [], 'bzrlib.cmd_version_info'), | 6075 | ('cmd_version_info', [], 'bzrlib.cmd_version_info'), |
| 11 | 6075 | ('cmd_resolve', ['resolved'], 'bzrlib.conflicts'), | 6076 | ('cmd_resolve', ['resolved'], 'bzrlib.conflicts'), |
| 12 | 6076 | 6077 | ||
| 13 | === modified file 'bzrlib/config.py' | |||
| 14 | --- bzrlib/config.py 2010-10-13 15:28:45 +0000 | |||
| 15 | +++ bzrlib/config.py 2010-10-15 09:37:41 +0000 | |||
| 16 | @@ -65,17 +65,19 @@ | |||
| 17 | 65 | import os | 65 | import os |
| 18 | 66 | import sys | 66 | import sys |
| 19 | 67 | 67 | ||
| 20 | 68 | from bzrlib import commands | ||
| 21 | 68 | from bzrlib.decorators import needs_write_lock | 69 | from bzrlib.decorators import needs_write_lock |
| 22 | 69 | from bzrlib.lazy_import import lazy_import | 70 | from bzrlib.lazy_import import lazy_import |
| 23 | 70 | lazy_import(globals(), """ | 71 | lazy_import(globals(), """ |
| 24 | 71 | import errno | 72 | import errno |
| 26 | 72 | from fnmatch import fnmatch | 73 | import fnmatch |
| 27 | 73 | import re | 74 | import re |
| 28 | 74 | from cStringIO import StringIO | 75 | from cStringIO import StringIO |
| 29 | 75 | 76 | ||
| 30 | 76 | import bzrlib | 77 | import bzrlib |
| 31 | 77 | from bzrlib import ( | 78 | from bzrlib import ( |
| 32 | 78 | atomicfile, | 79 | atomicfile, |
| 33 | 80 | bzrdir, | ||
| 34 | 79 | debug, | 81 | debug, |
| 35 | 80 | errors, | 82 | errors, |
| 36 | 81 | lockdir, | 83 | lockdir, |
| 37 | @@ -153,6 +155,10 @@ | |||
| 38 | 153 | def __init__(self): | 155 | def __init__(self): |
| 39 | 154 | super(Config, self).__init__() | 156 | super(Config, self).__init__() |
| 40 | 155 | 157 | ||
| 41 | 158 | def config_id(self): | ||
| 42 | 159 | """Returns a unique ID for the config.""" | ||
| 43 | 160 | raise NotImplementedError(self.config_id) | ||
| 44 | 161 | |||
| 45 | 156 | def get_editor(self): | 162 | def get_editor(self): |
| 46 | 157 | """Get the users pop up editor.""" | 163 | """Get the users pop up editor.""" |
| 47 | 158 | raise NotImplementedError | 164 | raise NotImplementedError |
| 48 | @@ -444,6 +450,54 @@ | |||
| 49 | 444 | """Override this to define the section used by the config.""" | 450 | """Override this to define the section used by the config.""" |
| 50 | 445 | return "DEFAULT" | 451 | return "DEFAULT" |
| 51 | 446 | 452 | ||
| 52 | 453 | def _get_sections(self, name=None): | ||
| 53 | 454 | """Returns an iterator of the sections specified by ``name``. | ||
| 54 | 455 | |||
| 55 | 456 | :param name: The section name. If None is supplied, the default | ||
| 56 | 457 | configurations are yielded. | ||
| 57 | 458 | |||
| 58 | 459 | :return: A tuple (name, section, config_id) for all sections that will | ||
| 59 | 460 | be walked by user_get_option() in the 'right' order. The first one | ||
| 60 | 461 | is where set_user_option() will update the value. | ||
| 61 | 462 | """ | ||
| 62 | 463 | parser = self._get_parser() | ||
| 63 | 464 | if name is not None: | ||
| 64 | 465 | yield (name, parser[name], self.config_id()) | ||
| 65 | 466 | else: | ||
| 66 | 467 | # No section name has been given so we fallback to the configobj | ||
| 67 | 468 | # itself which holds the variables defined outside of any section. | ||
| 68 | 469 | yield (None, parser, self.config_id()) | ||
| 69 | 470 | |||
| 70 | 471 | def _get_options(self, sections=None): | ||
| 71 | 472 | """Return an ordered list of (name, value, section, config_id) tuples. | ||
| 72 | 473 | |||
| 73 | 474 | All options are returned with their associated value and the section | ||
| 74 | 475 | they appeared in. ``config_id`` is a unique identifier for the | ||
| 75 | 476 | configuration file the option is defined in. | ||
| 76 | 477 | |||
| 77 | 478 | :param sections: Default to ``_get_matching_sections`` if not | ||
| 78 | 479 | specified. This gives a better control to daughter classes about | ||
| 79 | 480 | which sections should be searched. This is a list of (name, | ||
| 80 | 481 | configobj) tuples. | ||
| 81 | 482 | """ | ||
| 82 | 483 | opts = [] | ||
| 83 | 484 | if sections is None: | ||
| 84 | 485 | parser = self._get_parser() | ||
| 85 | 486 | sections = [] | ||
| 86 | 487 | for (section_name, _) in self._get_matching_sections(): | ||
| 87 | 488 | try: | ||
| 88 | 489 | section = parser[section_name] | ||
| 89 | 490 | except KeyError: | ||
| 90 | 491 | # This could happen for an empty file for which we define a | ||
| 91 | 492 | # DEFAULT section. FIXME: Force callers to provide sections | ||
| 92 | 493 | # instead ? -- vila 20100930 | ||
| 93 | 494 | continue | ||
| 94 | 495 | sections.append((section_name, section)) | ||
| 95 | 496 | config_id = self.config_id() | ||
| 96 | 497 | for (section_name, section) in sections: | ||
| 97 | 498 | for (name, value) in section.iteritems(): | ||
| 98 | 499 | yield (name, value, section_name, config_id) | ||
| 99 | 500 | |||
| 100 | 447 | def _get_option_policy(self, section, option_name): | 501 | def _get_option_policy(self, section, option_name): |
| 101 | 448 | """Return the policy for the given (section, option_name) pair.""" | 502 | """Return the policy for the given (section, option_name) pair.""" |
| 102 | 449 | return POLICY_NONE | 503 | return POLICY_NONE |
| 103 | @@ -536,6 +590,26 @@ | |||
| 104 | 536 | def _get_nickname(self): | 590 | def _get_nickname(self): |
| 105 | 537 | return self.get_user_option('nickname') | 591 | return self.get_user_option('nickname') |
| 106 | 538 | 592 | ||
| 107 | 593 | def remove_user_option(self, option_name, section_name=None): | ||
| 108 | 594 | """Remove a user option and save the configuration file. | ||
| 109 | 595 | |||
| 110 | 596 | :param option_name: The option to be removed. | ||
| 111 | 597 | |||
| 112 | 598 | :param section_name: The section the option is defined in, default to | ||
| 113 | 599 | the default section. | ||
| 114 | 600 | """ | ||
| 115 | 601 | self.reload() | ||
| 116 | 602 | parser = self._get_parser() | ||
| 117 | 603 | if section_name is None: | ||
| 118 | 604 | section = parser | ||
| 119 | 605 | else: | ||
| 120 | 606 | section = parser[section_name] | ||
| 121 | 607 | try: | ||
| 122 | 608 | del section[option_name] | ||
| 123 | 609 | except KeyError: | ||
| 124 | 610 | raise errors.NoSuchConfigOption(option_name) | ||
| 125 | 611 | self._write_config_file() | ||
| 126 | 612 | |||
| 127 | 539 | def _write_config_file(self): | 613 | def _write_config_file(self): |
| 128 | 540 | if self.file_name is None: | 614 | if self.file_name is None: |
| 129 | 541 | raise AssertionError('We cannot save, self.file_name is None') | 615 | raise AssertionError('We cannot save, self.file_name is None') |
| 130 | @@ -604,6 +678,11 @@ | |||
| 131 | 604 | def break_lock(self): | 678 | def break_lock(self): |
| 132 | 605 | self._lock.break_lock() | 679 | self._lock.break_lock() |
| 133 | 606 | 680 | ||
| 134 | 681 | @needs_write_lock | ||
| 135 | 682 | def remove_user_option(self, option_name, section_name=None): | ||
| 136 | 683 | super(LockableConfig, self).remove_user_option(option_name, | ||
| 137 | 684 | section_name) | ||
| 138 | 685 | |||
| 139 | 607 | def _write_config_file(self): | 686 | def _write_config_file(self): |
| 140 | 608 | if self._lock is None or not self._lock.is_held: | 687 | if self._lock is None or not self._lock.is_held: |
| 141 | 609 | # NB: if the following exception is raised it probably means a | 688 | # NB: if the following exception is raised it probably means a |
| 142 | @@ -618,6 +697,9 @@ | |||
| 143 | 618 | def __init__(self): | 697 | def __init__(self): |
| 144 | 619 | super(GlobalConfig, self).__init__(file_name=config_filename()) | 698 | super(GlobalConfig, self).__init__(file_name=config_filename()) |
| 145 | 620 | 699 | ||
| 146 | 700 | def config_id(self): | ||
| 147 | 701 | return 'bazaar' | ||
| 148 | 702 | |||
| 149 | 621 | @classmethod | 703 | @classmethod |
| 150 | 622 | def from_string(cls, str_or_unicode, save=False): | 704 | def from_string(cls, str_or_unicode, save=False): |
| 151 | 623 | """Create a config object from a string. | 705 | """Create a config object from a string. |
| 152 | @@ -667,6 +749,30 @@ | |||
| 153 | 667 | self._write_config_file() | 749 | self._write_config_file() |
| 154 | 668 | 750 | ||
| 155 | 669 | 751 | ||
| 156 | 752 | def _get_sections(self, name=None): | ||
| 157 | 753 | """See IniBasedConfig._get_sections().""" | ||
| 158 | 754 | parser = self._get_parser() | ||
| 159 | 755 | # We don't give access to options defined outside of any section, we | ||
| 160 | 756 | # used the DEFAULT section by... default. | ||
| 161 | 757 | if name in (None, 'DEFAULT'): | ||
| 162 | 758 | # This could happen for an empty file where the DEFAULT section | ||
| 163 | 759 | # doesn't exist yet. So we force DEFAULT when yielding | ||
| 164 | 760 | name = 'DEFAULT' | ||
| 165 | 761 | if 'DEFAULT' not in parser: | ||
| 166 | 762 | parser['DEFAULT']= {} | ||
| 167 | 763 | yield (name, parser[name], self.config_id()) | ||
| 168 | 764 | |||
| 169 | 765 | @needs_write_lock | ||
| 170 | 766 | def remove_user_option(self, option_name, section_name=None): | ||
| 171 | 767 | if section_name is None: | ||
| 172 | 768 | # We need to force the default section. | ||
| 173 | 769 | section_name = 'DEFAULT' | ||
| 174 | 770 | # We need to avoid the LockableConfig implementation or we'll lock | ||
| 175 | 771 | # twice | ||
| 176 | 772 | super(LockableConfig, self).remove_user_option(option_name, | ||
| 177 | 773 | section_name) | ||
| 178 | 774 | |||
| 179 | 775 | |||
| 180 | 670 | class LocationConfig(LockableConfig): | 776 | class LocationConfig(LockableConfig): |
| 181 | 671 | """A configuration object that gives the policy for a location.""" | 777 | """A configuration object that gives the policy for a location.""" |
| 182 | 672 | 778 | ||
| 183 | @@ -680,6 +786,9 @@ | |||
| 184 | 680 | location = urlutils.local_path_from_url(location) | 786 | location = urlutils.local_path_from_url(location) |
| 185 | 681 | self.location = location | 787 | self.location = location |
| 186 | 682 | 788 | ||
| 187 | 789 | def config_id(self): | ||
| 188 | 790 | return 'locations' | ||
| 189 | 791 | |||
| 190 | 683 | @classmethod | 792 | @classmethod |
| 191 | 684 | def from_string(cls, str_or_unicode, location, save=False): | 793 | def from_string(cls, str_or_unicode, location, save=False): |
| 192 | 685 | """Create a config object from a string. | 794 | """Create a config object from a string. |
| 193 | @@ -717,7 +826,7 @@ | |||
| 194 | 717 | names = zip(location_names, section_names) | 826 | names = zip(location_names, section_names) |
| 195 | 718 | matched = True | 827 | matched = True |
| 196 | 719 | for name in names: | 828 | for name in names: |
| 198 | 720 | if not fnmatch(name[0], name[1]): | 829 | if not fnmatch.fnmatch(name[0], name[1]): |
| 199 | 721 | matched = False | 830 | matched = False |
| 200 | 722 | break | 831 | break |
| 201 | 723 | if not matched: | 832 | if not matched: |
| 202 | @@ -728,6 +837,7 @@ | |||
| 203 | 728 | continue | 837 | continue |
| 204 | 729 | matches.append((len(section_names), section, | 838 | matches.append((len(section_names), section, |
| 205 | 730 | '/'.join(location_names[len(section_names):]))) | 839 | '/'.join(location_names[len(section_names):]))) |
| 206 | 840 | # put the longest (aka more specific) locations first | ||
| 207 | 731 | matches.sort(reverse=True) | 841 | matches.sort(reverse=True) |
| 208 | 732 | sections = [] | 842 | sections = [] |
| 209 | 733 | for (length, section, extra_path) in matches: | 843 | for (length, section, extra_path) in matches: |
| 210 | @@ -740,6 +850,14 @@ | |||
| 211 | 740 | pass | 850 | pass |
| 212 | 741 | return sections | 851 | return sections |
| 213 | 742 | 852 | ||
| 214 | 853 | def _get_sections(self, name=None): | ||
| 215 | 854 | """See IniBasedConfig._get_sections().""" | ||
| 216 | 855 | # We ignore the name here as the only sections handled are named with | ||
| 217 | 856 | # the location path and we don't expose embedded sections either. | ||
| 218 | 857 | parser = self._get_parser() | ||
| 219 | 858 | for name, extra_path in self._get_matching_sections(): | ||
| 220 | 859 | yield (name, parser[name], self.config_id()) | ||
| 221 | 860 | |||
| 222 | 743 | def _get_option_policy(self, section, option_name): | 861 | def _get_option_policy(self, section, option_name): |
| 223 | 744 | """Return the policy for the given (section, option_name) pair.""" | 862 | """Return the policy for the given (section, option_name) pair.""" |
| 224 | 745 | # check for the old 'recurse=False' flag | 863 | # check for the old 'recurse=False' flag |
| 225 | @@ -824,9 +942,13 @@ | |||
| 226 | 824 | self._get_branch_data_config, | 942 | self._get_branch_data_config, |
| 227 | 825 | self._get_global_config) | 943 | self._get_global_config) |
| 228 | 826 | 944 | ||
| 229 | 945 | def config_id(self): | ||
| 230 | 946 | return 'branch' | ||
| 231 | 947 | |||
| 232 | 827 | def _get_branch_data_config(self): | 948 | def _get_branch_data_config(self): |
| 233 | 828 | if self._branch_data_config is None: | 949 | if self._branch_data_config is None: |
| 234 | 829 | self._branch_data_config = TreeConfig(self.branch) | 950 | self._branch_data_config = TreeConfig(self.branch) |
| 235 | 951 | self._branch_data_config.config_id = self.config_id | ||
| 236 | 830 | return self._branch_data_config | 952 | return self._branch_data_config |
| 237 | 831 | 953 | ||
| 238 | 832 | def _get_location_config(self): | 954 | def _get_location_config(self): |
| 239 | @@ -900,6 +1022,31 @@ | |||
| 240 | 900 | return value | 1022 | return value |
| 241 | 901 | return None | 1023 | return None |
| 242 | 902 | 1024 | ||
| 243 | 1025 | def _get_sections(self, name=None): | ||
| 244 | 1026 | """See IniBasedConfig.get_sections().""" | ||
| 245 | 1027 | for source in self.option_sources: | ||
| 246 | 1028 | for section in source()._get_sections(name): | ||
| 247 | 1029 | yield section | ||
| 248 | 1030 | |||
| 249 | 1031 | def _get_options(self, sections=None): | ||
| 250 | 1032 | opts = [] | ||
| 251 | 1033 | # First the locations options | ||
| 252 | 1034 | for option in self._get_location_config()._get_options(): | ||
| 253 | 1035 | yield option | ||
| 254 | 1036 | # Then the branch options | ||
| 255 | 1037 | branch_config = self._get_branch_data_config() | ||
| 256 | 1038 | if sections is None: | ||
| 257 | 1039 | sections = [('DEFAULT', branch_config._get_parser())] | ||
| 258 | 1040 | # FIXME: We shouldn't have to duplicate the code in IniBasedConfig but | ||
| 259 | 1041 | # Config itself has no notion of sections :( -- vila 20101001 | ||
| 260 | 1042 | config_id = self.config_id() | ||
| 261 | 1043 | for (section_name, section) in sections: | ||
| 262 | 1044 | for (name, value) in section.iteritems(): | ||
| 263 | 1045 | yield (name, value, section_name, config_id) | ||
| 264 | 1046 | # Then the global options | ||
| 265 | 1047 | for option in self._get_global_config()._get_options(): | ||
| 266 | 1048 | yield option | ||
| 267 | 1049 | |||
| 268 | 903 | def set_user_option(self, name, value, store=STORE_BRANCH, | 1050 | def set_user_option(self, name, value, store=STORE_BRANCH, |
| 269 | 904 | warn_masked=False): | 1051 | warn_masked=False): |
| 270 | 905 | if store == STORE_BRANCH: | 1052 | if store == STORE_BRANCH: |
| 271 | @@ -923,6 +1070,9 @@ | |||
| 272 | 923 | trace.warning('Value "%s" is masked by "%s" from' | 1070 | trace.warning('Value "%s" is masked by "%s" from' |
| 273 | 924 | ' branch.conf', value, mask_value) | 1071 | ' branch.conf', value, mask_value) |
| 274 | 925 | 1072 | ||
| 275 | 1073 | def remove_user_option(self, option_name, section_name=None): | ||
| 276 | 1074 | self._get_branch_data_config().remove_option(option_name, section_name) | ||
| 277 | 1075 | |||
| 278 | 926 | def _gpg_signing_command(self): | 1076 | def _gpg_signing_command(self): |
| 279 | 927 | """See Config.gpg_signing_command.""" | 1077 | """See Config.gpg_signing_command.""" |
| 280 | 928 | return self._get_safe_value('_gpg_signing_command') | 1078 | return self._get_safe_value('_gpg_signing_command') |
| 281 | @@ -1086,12 +1236,23 @@ | |||
| 282 | 1086 | 1236 | ||
| 283 | 1087 | def set_option(self, value, name, section=None): | 1237 | def set_option(self, value, name, section=None): |
| 284 | 1088 | """Set a per-branch configuration option""" | 1238 | """Set a per-branch configuration option""" |
| 285 | 1239 | # FIXME: We shouldn't need to lock explicitly here but rather rely on | ||
| 286 | 1240 | # higher levels providing the right lock -- vila 20101004 | ||
| 287 | 1089 | self.branch.lock_write() | 1241 | self.branch.lock_write() |
| 288 | 1090 | try: | 1242 | try: |
| 289 | 1091 | self._config.set_option(value, name, section) | 1243 | self._config.set_option(value, name, section) |
| 290 | 1092 | finally: | 1244 | finally: |
| 291 | 1093 | self.branch.unlock() | 1245 | self.branch.unlock() |
| 292 | 1094 | 1246 | ||
| 293 | 1247 | def remove_option(self, option_name, section_name=None): | ||
| 294 | 1248 | # FIXME: We shouldn't need to lock explicitly here but rather rely on | ||
| 295 | 1249 | # higher levels providing the right lock -- vila 20101004 | ||
| 296 | 1250 | self.branch.lock_write() | ||
| 297 | 1251 | try: | ||
| 298 | 1252 | self._config.remove_option(option_name, section_name) | ||
| 299 | 1253 | finally: | ||
| 300 | 1254 | self.branch.unlock() | ||
| 301 | 1255 | |||
| 302 | 1095 | 1256 | ||
| 303 | 1096 | class AuthenticationConfig(object): | 1257 | class AuthenticationConfig(object): |
| 304 | 1097 | """The authentication configuration file based on a ini file. | 1258 | """The authentication configuration file based on a ini file. |
| 305 | @@ -1540,8 +1701,8 @@ | |||
| 306 | 1540 | """A Config that reads/writes a config file on a Transport. | 1701 | """A Config that reads/writes a config file on a Transport. |
| 307 | 1541 | 1702 | ||
| 308 | 1542 | It is a low-level object that considers config data to be name/value pairs | 1703 | It is a low-level object that considers config data to be name/value pairs |
| 311 | 1543 | that may be associated with a section. Assigning meaning to the these | 1704 | that may be associated with a section. Assigning meaning to these values |
| 312 | 1544 | values is done at higher levels like TreeConfig. | 1705 | is done at higher levels like TreeConfig. |
| 313 | 1545 | """ | 1706 | """ |
| 314 | 1546 | 1707 | ||
| 315 | 1547 | def __init__(self, transport, filename): | 1708 | def __init__(self, transport, filename): |
| 316 | @@ -1580,6 +1741,14 @@ | |||
| 317 | 1580 | configobj.setdefault(section, {})[name] = value | 1741 | configobj.setdefault(section, {})[name] = value |
| 318 | 1581 | self._set_configobj(configobj) | 1742 | self._set_configobj(configobj) |
| 319 | 1582 | 1743 | ||
| 320 | 1744 | def remove_option(self, option_name, section_name=None): | ||
| 321 | 1745 | configobj = self._get_configobj() | ||
| 322 | 1746 | if section_name is None: | ||
| 323 | 1747 | del configobj[option_name] | ||
| 324 | 1748 | else: | ||
| 325 | 1749 | del configobj[section_name][option_name] | ||
| 326 | 1750 | self._set_configobj(configobj) | ||
| 327 | 1751 | |||
| 328 | 1583 | def _get_config_file(self): | 1752 | def _get_config_file(self): |
| 329 | 1584 | try: | 1753 | try: |
| 330 | 1585 | return StringIO(self._transport.get_bytes(self._filename)) | 1754 | return StringIO(self._transport.get_bytes(self._filename)) |
| 331 | @@ -1598,3 +1767,113 @@ | |||
| 332 | 1598 | configobj.write(out_file) | 1767 | configobj.write(out_file) |
| 333 | 1599 | out_file.seek(0) | 1768 | out_file.seek(0) |
| 334 | 1600 | self._transport.put_file(self._filename, out_file) | 1769 | self._transport.put_file(self._filename, out_file) |
| 335 | 1770 | |||
| 336 | 1771 | |||
| 337 | 1772 | class cmd_config(commands.Command): | ||
| 338 | 1773 | __doc__ = """Display, set or remove a configuration option. | ||
| 339 | 1774 | |||
| 340 | 1775 | Display the MATCHING configuration options mentioning their scope (the | ||
| 341 | 1776 | configuration file they are defined in). The active value that bzr will | ||
| 342 | 1777 | take into account is the first one displayed. | ||
| 343 | 1778 | |||
| 344 | 1779 | Setting a value is achieved by using name=value without spaces. The value | ||
| 345 | 1780 | is set in the most relevant scope and can be checked by displaying the | ||
| 346 | 1781 | option again. | ||
| 347 | 1782 | """ | ||
| 348 | 1783 | |||
| 349 | 1784 | aliases = ['conf'] | ||
| 350 | 1785 | takes_args = ['matching?'] | ||
| 351 | 1786 | |||
| 352 | 1787 | takes_options = [ | ||
| 353 | 1788 | 'directory', | ||
| 354 | 1789 | # FIXME: This should be a registry option so that plugins can register | ||
| 355 | 1790 | # their own config files (or not) -- vila 20101002 | ||
| 356 | 1791 | commands.Option('scope', help='Reduce the scope to the specified' | ||
| 357 | 1792 | ' configuration file', | ||
| 358 | 1793 | type=unicode), | ||
| 359 | 1794 | commands.Option('remove', help='Remove the option from' | ||
| 360 | 1795 | ' the configuration file'), | ||
| 361 | 1796 | ] | ||
| 362 | 1797 | |||
| 363 | 1798 | @commands.display_command | ||
| 364 | 1799 | def run(self, matching=None, directory=None, scope=None, remove=False): | ||
| 365 | 1800 | if directory is None: | ||
| 366 | 1801 | directory = '.' | ||
| 367 | 1802 | directory = urlutils.normalize_url(directory) | ||
| 368 | 1803 | if matching is None: | ||
| 369 | 1804 | self._show_config('*', directory) | ||
| 370 | 1805 | else: | ||
| 371 | 1806 | if remove: | ||
| 372 | 1807 | self._remove_config_option(matching, directory, scope) | ||
| 373 | 1808 | else: | ||
| 374 | 1809 | pos = matching.find('=') | ||
| 375 | 1810 | if pos == -1: | ||
| 376 | 1811 | self._show_config(matching, directory) | ||
| 377 | 1812 | else: | ||
| 378 | 1813 | self._set_config_option(matching[:pos], matching[pos+1:], | ||
| 379 | 1814 | directory, scope) | ||
| 380 | 1815 | |||
| 381 | 1816 | def _get_configs(self, directory, scope=None): | ||
| 382 | 1817 | """Iterate the configurations specified by ``directory`` and ``scope``. | ||
| 383 | 1818 | |||
| 384 | 1819 | :param directory: Where the configurations are derived from. | ||
| 385 | 1820 | |||
| 386 | 1821 | :param scope: A specific config to start from. | ||
| 387 | 1822 | """ | ||
| 388 | 1823 | if scope is not None: | ||
| 389 | 1824 | if scope == 'bazaar': | ||
| 390 | 1825 | yield GlobalConfig() | ||
| 391 | 1826 | elif scope == 'locations': | ||
| 392 | 1827 | yield LocationConfig(directory) | ||
| 393 | 1828 | elif scope == 'branch': | ||
| 394 | 1829 | (_, br, _) = bzrdir.BzrDir.open_containing_tree_or_branch( | ||
| 395 | 1830 | directory) | ||
| 396 | 1831 | yield br.get_config() | ||
| 397 | 1832 | else: | ||
| 398 | 1833 | try: | ||
| 399 | 1834 | (_, br, _) = bzrdir.BzrDir.open_containing_tree_or_branch( | ||
| 400 | 1835 | directory) | ||
| 401 | 1836 | yield br.get_config() | ||
| 402 | 1837 | except errors.NotBranchError: | ||
| 403 | 1838 | yield LocationConfig(directory) | ||
| 404 | 1839 | yield GlobalConfig() | ||
| 405 | 1840 | |||
| 406 | 1841 | def _show_config(self, matching, directory): | ||
| 407 | 1842 | # Turn the glob into a regexp | ||
| 408 | 1843 | matching_re = re.compile(fnmatch.translate(matching)) | ||
| 409 | 1844 | cur_conf_id = None | ||
| 410 | 1845 | for c in self._get_configs(directory): | ||
| 411 | 1846 | for (name, value, section, conf_id) in c._get_options(): | ||
| 412 | 1847 | if matching_re.search(name): | ||
| 413 | 1848 | if cur_conf_id != conf_id: | ||
| 414 | 1849 | self.outf.write('%s:\n' % (conf_id,)) | ||
| 415 | 1850 | cur_conf_id = conf_id | ||
| 416 | 1851 | self.outf.write(' %s = %s\n' % (name, value)) | ||
| 417 | 1852 | |||
| 418 | 1853 | def _set_config_option(self, name, value, directory, scope): | ||
| 419 | 1854 | for conf in self._get_configs(directory, scope): | ||
| 420 | 1855 | conf.set_user_option(name, value) | ||
| 421 | 1856 | break | ||
| 422 | 1857 | else: | ||
| 423 | 1858 | raise errors.NoSuchConfig(scope) | ||
| 424 | 1859 | |||
| 425 | 1860 | def _remove_config_option(self, name, directory, scope): | ||
| 426 | 1861 | removed = False | ||
| 427 | 1862 | for conf in self._get_configs(directory, scope): | ||
| 428 | 1863 | for (section_name, section, conf_id) in conf._get_sections(): | ||
| 429 | 1864 | if scope is not None and conf_id != scope: | ||
| 430 | 1865 | # Not the right configuration file | ||
| 431 | 1866 | continue | ||
| 432 | 1867 | if name in section: | ||
| 433 | 1868 | if conf_id != conf.config_id(): | ||
| 434 | 1869 | conf = self._get_configs(directory, conf_id).next() | ||
| 435 | 1870 | # We use the first section in the first config where the | ||
| 436 | 1871 | # option is defined to remove it | ||
| 437 | 1872 | conf.remove_user_option(name, section_name) | ||
| 438 | 1873 | removed = True | ||
| 439 | 1874 | break | ||
| 440 | 1875 | break | ||
| 441 | 1876 | else: | ||
| 442 | 1877 | raise errors.NoSuchConfig(scope) | ||
| 443 | 1878 | if not removed: | ||
| 444 | 1879 | raise errors.NoSuchConfigOption(name) | ||
| 445 | 1601 | 1880 | ||
| 446 | === modified file 'bzrlib/errors.py' | |||
| 447 | --- bzrlib/errors.py 2010-09-28 18:51:47 +0000 | |||
| 448 | +++ bzrlib/errors.py 2010-10-15 09:37:41 +0000 | |||
| 449 | @@ -2945,6 +2945,22 @@ | |||
| 450 | 2945 | self.user_encoding = osutils.get_user_encoding() | 2945 | self.user_encoding = osutils.get_user_encoding() |
| 451 | 2946 | 2946 | ||
| 452 | 2947 | 2947 | ||
| 453 | 2948 | class NoSuchConfig(BzrError): | ||
| 454 | 2949 | |||
| 455 | 2950 | _fmt = ('The "%(config_id)s" configuration does not exist.') | ||
| 456 | 2951 | |||
| 457 | 2952 | def __init__(self, config_id): | ||
| 458 | 2953 | BzrError.__init__(self, config_id=config_id) | ||
| 459 | 2954 | |||
| 460 | 2955 | |||
| 461 | 2956 | class NoSuchConfigOption(BzrError): | ||
| 462 | 2957 | |||
| 463 | 2958 | _fmt = ('The "%(option_name)s" configuration option does not exist.') | ||
| 464 | 2959 | |||
| 465 | 2960 | def __init__(self, option_name): | ||
| 466 | 2961 | BzrError.__init__(self, option_name=option_name) | ||
| 467 | 2962 | |||
| 468 | 2963 | |||
| 469 | 2948 | class NoSuchAlias(BzrError): | 2964 | class NoSuchAlias(BzrError): |
| 470 | 2949 | 2965 | ||
| 471 | 2950 | _fmt = ('The alias "%(alias_name)s" does not exist.') | 2966 | _fmt = ('The alias "%(alias_name)s" does not exist.') |
| 472 | 2951 | 2967 | ||
| 473 | === modified file 'bzrlib/tests/blackbox/__init__.py' | |||
| 474 | --- bzrlib/tests/blackbox/__init__.py 2010-07-28 07:05:19 +0000 | |||
| 475 | +++ bzrlib/tests/blackbox/__init__.py 2010-10-15 09:37:41 +0000 | |||
| 476 | @@ -54,6 +54,7 @@ | |||
| 477 | 54 | 'bzrlib.tests.blackbox.test_clean_tree', | 54 | 'bzrlib.tests.blackbox.test_clean_tree', |
| 478 | 55 | 'bzrlib.tests.blackbox.test_command_encoding', | 55 | 'bzrlib.tests.blackbox.test_command_encoding', |
| 479 | 56 | 'bzrlib.tests.blackbox.test_commit', | 56 | 'bzrlib.tests.blackbox.test_commit', |
| 480 | 57 | 'bzrlib.tests.blackbox.test_config', | ||
| 481 | 57 | 'bzrlib.tests.blackbox.test_conflicts', | 58 | 'bzrlib.tests.blackbox.test_conflicts', |
| 482 | 58 | 'bzrlib.tests.blackbox.test_debug', | 59 | 'bzrlib.tests.blackbox.test_debug', |
| 483 | 59 | 'bzrlib.tests.blackbox.test_deleted', | 60 | 'bzrlib.tests.blackbox.test_deleted', |
| 484 | 60 | 61 | ||
| 485 | === added file 'bzrlib/tests/blackbox/test_config.py' | |||
| 486 | --- bzrlib/tests/blackbox/test_config.py 1970-01-01 00:00:00 +0000 | |||
| 487 | +++ bzrlib/tests/blackbox/test_config.py 2010-10-15 09:37:41 +0000 | |||
| 488 | @@ -0,0 +1,204 @@ | |||
| 489 | 1 | # Copyright (C) 2010 Canonical Ltd | ||
| 490 | 2 | # | ||
| 491 | 3 | # This program is free software; you can redistribute it and/or modify | ||
| 492 | 4 | # it under the terms of the GNU General Public License as published by | ||
| 493 | 5 | # the Free Software Foundation; either version 2 of the License, or | ||
| 494 | 6 | # (at your option) any later version. | ||
| 495 | 7 | # | ||
| 496 | 8 | # This program is distributed in the hope that it will be useful, | ||
| 497 | 9 | # but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| 498 | 10 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
| 499 | 11 | # GNU General Public License for more details. | ||
| 500 | 12 | # | ||
| 501 | 13 | # You should have received a copy of the GNU General Public License | ||
| 502 | 14 | # along with this program; if not, write to the Free Software | ||
| 503 | 15 | # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA | ||
| 504 | 16 | |||
| 505 | 17 | |||
| 506 | 18 | """Black-box tests for bzr config.""" | ||
| 507 | 19 | |||
| 508 | 20 | import os | ||
| 509 | 21 | |||
| 510 | 22 | from bzrlib import ( | ||
| 511 | 23 | config, | ||
| 512 | 24 | errors, | ||
| 513 | 25 | tests, | ||
| 514 | 26 | ) | ||
| 515 | 27 | from bzrlib.tests import ( | ||
| 516 | 28 | script, | ||
| 517 | 29 | test_config as _t_config, | ||
| 518 | 30 | ) | ||
| 519 | 31 | |||
| 520 | 32 | class TestWithoutConfig(tests.TestCaseWithTransport): | ||
| 521 | 33 | |||
| 522 | 34 | def test_no_config(self): | ||
| 523 | 35 | out, err = self.run_bzr(['config']) | ||
| 524 | 36 | self.assertEquals('', out) | ||
| 525 | 37 | self.assertEquals('', err) | ||
| 526 | 38 | |||
| 527 | 39 | def test_all_variables_no_config(self): | ||
| 528 | 40 | out, err = self.run_bzr(['config', '*']) | ||
| 529 | 41 | self.assertEquals('', out) | ||
| 530 | 42 | self.assertEquals('', err) | ||
| 531 | 43 | |||
| 532 | 44 | def test_unknown_option(self): | ||
| 533 | 45 | self.run_bzr_error(['The "file" configuration option does not exist',], | ||
| 534 | 46 | ['config', '--remove', 'file']) | ||
| 535 | 47 | |||
| 536 | 48 | class TestConfigDisplay(tests.TestCaseWithTransport): | ||
| 537 | 49 | |||
| 538 | 50 | def setUp(self): | ||
| 539 | 51 | super(TestConfigDisplay, self).setUp() | ||
| 540 | 52 | _t_config.create_configs(self) | ||
| 541 | 53 | |||
| 542 | 54 | def test_bazaar_config(self): | ||
| 543 | 55 | self.bazaar_config.set_user_option('hello', 'world') | ||
| 544 | 56 | script.run_script(self, '''\ | ||
| 545 | 57 | $ bzr config -d tree | ||
| 546 | 58 | bazaar: | ||
| 547 | 59 | hello = world | ||
| 548 | 60 | ''') | ||
| 549 | 61 | |||
| 550 | 62 | def test_locations_config_for_branch(self): | ||
| 551 | 63 | self.locations_config.set_user_option('hello', 'world') | ||
| 552 | 64 | self.branch_config.set_user_option('hello', 'you') | ||
| 553 | 65 | script.run_script(self, '''\ | ||
| 554 | 66 | $ bzr config -d tree | ||
| 555 | 67 | locations: | ||
| 556 | 68 | hello = world | ||
| 557 | 69 | branch: | ||
| 558 | 70 | hello = you | ||
| 559 | 71 | ''') | ||
| 560 | 72 | |||
| 561 | 73 | def test_locations_config_outside_branch(self): | ||
| 562 | 74 | self.bazaar_config.set_user_option('hello', 'world') | ||
| 563 | 75 | self.locations_config.set_user_option('hello', 'world') | ||
| 564 | 76 | script.run_script(self, '''\ | ||
| 565 | 77 | $ bzr config | ||
| 566 | 78 | bazaar: | ||
| 567 | 79 | hello = world | ||
| 568 | 80 | ''') | ||
| 569 | 81 | |||
| 570 | 82 | |||
| 571 | 83 | class TestConfigSetOption(tests.TestCaseWithTransport): | ||
| 572 | 84 | |||
| 573 | 85 | def setUp(self): | ||
| 574 | 86 | super(TestConfigSetOption, self).setUp() | ||
| 575 | 87 | _t_config.create_configs(self) | ||
| 576 | 88 | |||
| 577 | 89 | def test_unknown_config(self): | ||
| 578 | 90 | self.run_bzr_error(['The "moon" configuration does not exist'], | ||
| 579 | 91 | ['config', '--scope', 'moon', 'hello=world']) | ||
| 580 | 92 | |||
| 581 | 93 | def test_bazaar_config_outside_branch(self): | ||
| 582 | 94 | script.run_script(self, '''\ | ||
| 583 | 95 | $ bzr config --scope bazaar hello=world | ||
| 584 | 96 | $ bzr config -d tree hello | ||
| 585 | 97 | bazaar: | ||
| 586 | 98 | hello = world | ||
| 587 | 99 | ''') | ||
| 588 | 100 | |||
| 589 | 101 | def test_bazaar_config_inside_branch(self): | ||
| 590 | 102 | script.run_script(self, '''\ | ||
| 591 | 103 | $ bzr config -d tree --scope bazaar hello=world | ||
| 592 | 104 | $ bzr config -d tree hello | ||
| 593 | 105 | bazaar: | ||
| 594 | 106 | hello = world | ||
| 595 | 107 | ''') | ||
| 596 | 108 | |||
| 597 | 109 | def test_locations_config_inside_branch(self): | ||
| 598 | 110 | script.run_script(self, '''\ | ||
| 599 | 111 | $ bzr config -d tree --scope locations hello=world | ||
| 600 | 112 | $ bzr config -d tree hello | ||
| 601 | 113 | locations: | ||
| 602 | 114 | hello = world | ||
| 603 | 115 | ''') | ||
| 604 | 116 | |||
| 605 | 117 | def test_branch_config_default(self): | ||
| 606 | 118 | script.run_script(self, '''\ | ||
| 607 | 119 | $ bzr config -d tree hello=world | ||
| 608 | 120 | $ bzr config -d tree hello | ||
| 609 | 121 | branch: | ||
| 610 | 122 | hello = world | ||
| 611 | 123 | ''') | ||
| 612 | 124 | |||
| 613 | 125 | def test_branch_config_forcing_branch(self): | ||
| 614 | 126 | script.run_script(self, '''\ | ||
| 615 | 127 | $ bzr config -d tree --scope branch hello=world | ||
| 616 | 128 | $ bzr config -d tree hello | ||
| 617 | 129 | branch: | ||
| 618 | 130 | hello = world | ||
| 619 | 131 | ''') | ||
| 620 | 132 | |||
| 621 | 133 | |||
| 622 | 134 | class TestConfigRemoveOption(tests.TestCaseWithTransport): | ||
| 623 | 135 | |||
| 624 | 136 | def setUp(self): | ||
| 625 | 137 | super(TestConfigRemoveOption, self).setUp() | ||
| 626 | 138 | _t_config.create_configs_with_file_option(self) | ||
| 627 | 139 | |||
| 628 | 140 | def test_unknown_config(self): | ||
| 629 | 141 | self.run_bzr_error(['The "moon" configuration does not exist'], | ||
| 630 | 142 | ['config', '--scope', 'moon', '--remove', 'file']) | ||
| 631 | 143 | |||
| 632 | 144 | def test_bazaar_config_outside_branch(self): | ||
| 633 | 145 | script.run_script(self, '''\ | ||
| 634 | 146 | $ bzr config --scope bazaar --remove file | ||
| 635 | 147 | $ bzr config -d tree file | ||
| 636 | 148 | locations: | ||
| 637 | 149 | file = locations | ||
| 638 | 150 | branch: | ||
| 639 | 151 | file = branch | ||
| 640 | 152 | ''') | ||
| 641 | 153 | |||
| 642 | 154 | def test_bazaar_config_inside_branch(self): | ||
| 643 | 155 | script.run_script(self, '''\ | ||
| 644 | 156 | $ bzr config -d tree --scope bazaar --remove file | ||
| 645 | 157 | $ bzr config -d tree file | ||
| 646 | 158 | locations: | ||
| 647 | 159 | file = locations | ||
| 648 | 160 | branch: | ||
| 649 | 161 | file = branch | ||
| 650 | 162 | ''') | ||
| 651 | 163 | |||
| 652 | 164 | def test_locations_config_inside_branch(self): | ||
| 653 | 165 | script.run_script(self, '''\ | ||
| 654 | 166 | $ bzr config -d tree --scope locations --remove file | ||
| 655 | 167 | $ bzr config -d tree file | ||
| 656 | 168 | branch: | ||
| 657 | 169 | file = branch | ||
| 658 | 170 | bazaar: | ||
| 659 | 171 | file = bazaar | ||
| 660 | 172 | ''') | ||
| 661 | 173 | |||
| 662 | 174 | def test_branch_config_default(self): | ||
| 663 | 175 | script.run_script(self, '''\ | ||
| 664 | 176 | $ bzr config -d tree --remove file | ||
| 665 | 177 | $ bzr config -d tree file | ||
| 666 | 178 | branch: | ||
| 667 | 179 | file = branch | ||
| 668 | 180 | bazaar: | ||
| 669 | 181 | file = bazaar | ||
| 670 | 182 | ''') | ||
| 671 | 183 | script.run_script(self, '''\ | ||
| 672 | 184 | $ bzr config -d tree --remove file | ||
| 673 | 185 | $ bzr config -d tree file | ||
| 674 | 186 | bazaar: | ||
| 675 | 187 | file = bazaar | ||
| 676 | 188 | ''') | ||
| 677 | 189 | |||
| 678 | 190 | def test_branch_config_forcing_branch(self): | ||
| 679 | 191 | script.run_script(self, '''\ | ||
| 680 | 192 | $ bzr config -d tree --scope branch --remove file | ||
| 681 | 193 | $ bzr config -d tree file | ||
| 682 | 194 | locations: | ||
| 683 | 195 | file = locations | ||
| 684 | 196 | bazaar: | ||
| 685 | 197 | file = bazaar | ||
| 686 | 198 | ''') | ||
| 687 | 199 | script.run_script(self, '''\ | ||
| 688 | 200 | $ bzr config -d tree --remove file | ||
| 689 | 201 | $ bzr config -d tree file | ||
| 690 | 202 | bazaar: | ||
| 691 | 203 | file = bazaar | ||
| 692 | 204 | ''') | ||
| 693 | 0 | 205 | ||
| 694 | === modified file 'bzrlib/tests/test_config.py' | |||
| 695 | --- bzrlib/tests/test_config.py 2010-09-28 16:28:45 +0000 | |||
| 696 | +++ bzrlib/tests/test_config.py 2010-10-15 09:37:41 +0000 | |||
| 697 | @@ -1471,6 +1471,200 @@ | |||
| 698 | 1471 | self.assertIs(None, bzrdir_config.get_default_stack_on()) | 1471 | self.assertIs(None, bzrdir_config.get_default_stack_on()) |
| 699 | 1472 | 1472 | ||
| 700 | 1473 | 1473 | ||
| 701 | 1474 | def create_configs(test): | ||
| 702 | 1475 | """Create configuration files for a given test. | ||
| 703 | 1476 | |||
| 704 | 1477 | This requires creating a tree (and populate the ``test.tree`` attribute and | ||
| 705 | 1478 | its associated branch and will populate the following attributes: | ||
| 706 | 1479 | |||
| 707 | 1480 | - branch_config: A BranchConfig for the associated branch. | ||
| 708 | 1481 | |||
| 709 | 1482 | - locations_config : A LocationConfig for the associated branch | ||
| 710 | 1483 | |||
| 711 | 1484 | - bazaar_config: A GlobalConfig. | ||
| 712 | 1485 | |||
| 713 | 1486 | The tree and branch are created in a 'tree' subdirectory so the tests can | ||
| 714 | 1487 | still use the test directory to stay outside of the branch. | ||
| 715 | 1488 | """ | ||
| 716 | 1489 | tree = test.make_branch_and_tree('tree') | ||
| 717 | 1490 | test.tree = tree | ||
| 718 | 1491 | test.branch_config = config.BranchConfig(tree.branch) | ||
| 719 | 1492 | test.locations_config = config.LocationConfig(tree.basedir) | ||
| 720 | 1493 | test.bazaar_config = config.GlobalConfig() | ||
| 721 | 1494 | |||
| 722 | 1495 | |||
| 723 | 1496 | def create_configs_with_file_option(test): | ||
| 724 | 1497 | """Create configuration files with a ``file`` option set in each. | ||
| 725 | 1498 | |||
| 726 | 1499 | This builds on ``create_configs`` and add one ``file`` option in each | ||
| 727 | 1500 | configuration with a value which allows identifying the configuration file. | ||
| 728 | 1501 | """ | ||
| 729 | 1502 | create_configs(test) | ||
| 730 | 1503 | test.bazaar_config.set_user_option('file', 'bazaar') | ||
| 731 | 1504 | test.locations_config.set_user_option('file', 'locations') | ||
| 732 | 1505 | test.branch_config.set_user_option('file', 'branch') | ||
| 733 | 1506 | |||
| 734 | 1507 | |||
| 735 | 1508 | class TestConfigGetOptions(tests.TestCaseWithTransport): | ||
| 736 | 1509 | |||
| 737 | 1510 | def setUp(self): | ||
| 738 | 1511 | super(TestConfigGetOptions, self).setUp() | ||
| 739 | 1512 | create_configs(self) | ||
| 740 | 1513 | |||
| 741 | 1514 | def assertOptions(self, expected, conf): | ||
| 742 | 1515 | actual = list(conf._get_options()) | ||
| 743 | 1516 | self.assertEqual(expected, actual) | ||
| 744 | 1517 | |||
| 745 | 1518 | # One variable in none of the above | ||
| 746 | 1519 | def test_no_variable(self): | ||
| 747 | 1520 | # Using branch should query branch, locations and bazaar | ||
| 748 | 1521 | self.assertOptions([], self.branch_config) | ||
| 749 | 1522 | |||
| 750 | 1523 | def test_option_in_bazaar(self): | ||
| 751 | 1524 | self.bazaar_config.set_user_option('file', 'bazaar') | ||
| 752 | 1525 | self.assertOptions([('file', 'bazaar', 'DEFAULT', 'bazaar')], | ||
| 753 | 1526 | self.bazaar_config) | ||
| 754 | 1527 | |||
| 755 | 1528 | def test_option_in_locations(self): | ||
| 756 | 1529 | self.locations_config.set_user_option('file', 'locations') | ||
| 757 | 1530 | self.assertOptions( | ||
| 758 | 1531 | [('file', 'locations', self.tree.basedir, 'locations')], | ||
| 759 | 1532 | self.locations_config) | ||
| 760 | 1533 | |||
| 761 | 1534 | def test_option_in_branch(self): | ||
| 762 | 1535 | self.branch_config.set_user_option('file', 'branch') | ||
| 763 | 1536 | self.assertOptions([('file', 'branch', 'DEFAULT', 'branch')], | ||
| 764 | 1537 | self.branch_config) | ||
| 765 | 1538 | |||
| 766 | 1539 | def test_option_in_bazaar_and_branch(self): | ||
| 767 | 1540 | self.bazaar_config.set_user_option('file', 'bazaar') | ||
| 768 | 1541 | self.branch_config.set_user_option('file', 'branch') | ||
| 769 | 1542 | self.assertOptions([('file', 'branch', 'DEFAULT', 'branch'), | ||
| 770 | 1543 | ('file', 'bazaar', 'DEFAULT', 'bazaar'),], | ||
| 771 | 1544 | self.branch_config) | ||
| 772 | 1545 | |||
| 773 | 1546 | def test_option_in_branch_and_locations(self): | ||
| 774 | 1547 | # Hmm, locations override branch :-/ | ||
| 775 | 1548 | self.locations_config.set_user_option('file', 'locations') | ||
| 776 | 1549 | self.branch_config.set_user_option('file', 'branch') | ||
| 777 | 1550 | self.assertOptions( | ||
| 778 | 1551 | [('file', 'locations', self.tree.basedir, 'locations'), | ||
| 779 | 1552 | ('file', 'branch', 'DEFAULT', 'branch'),], | ||
| 780 | 1553 | self.branch_config) | ||
| 781 | 1554 | |||
| 782 | 1555 | def test_option_in_bazaar_locations_and_branch(self): | ||
| 783 | 1556 | self.bazaar_config.set_user_option('file', 'bazaar') | ||
| 784 | 1557 | self.locations_config.set_user_option('file', 'locations') | ||
| 785 | 1558 | self.branch_config.set_user_option('file', 'branch') | ||
| 786 | 1559 | self.assertOptions( | ||
| 787 | 1560 | [('file', 'locations', self.tree.basedir, 'locations'), | ||
| 788 | 1561 | ('file', 'branch', 'DEFAULT', 'branch'), | ||
| 789 | 1562 | ('file', 'bazaar', 'DEFAULT', 'bazaar'),], | ||
| 790 | 1563 | self.branch_config) | ||
| 791 | 1564 | |||
| 792 | 1565 | |||
| 793 | 1566 | class TestConfigRemoveOption(tests.TestCaseWithTransport): | ||
| 794 | 1567 | |||
| 795 | 1568 | def setUp(self): | ||
| 796 | 1569 | super(TestConfigRemoveOption, self).setUp() | ||
| 797 | 1570 | create_configs_with_file_option(self) | ||
| 798 | 1571 | |||
| 799 | 1572 | def assertOptions(self, expected, conf): | ||
| 800 | 1573 | actual = list(conf._get_options()) | ||
| 801 | 1574 | self.assertEqual(expected, actual) | ||
| 802 | 1575 | |||
| 803 | 1576 | def test_remove_in_locations(self): | ||
| 804 | 1577 | self.locations_config.remove_user_option('file', self.tree.basedir) | ||
| 805 | 1578 | self.assertOptions( | ||
| 806 | 1579 | [('file', 'branch', 'DEFAULT', 'branch'), | ||
| 807 | 1580 | ('file', 'bazaar', 'DEFAULT', 'bazaar'),], | ||
| 808 | 1581 | self.branch_config) | ||
| 809 | 1582 | |||
| 810 | 1583 | def test_remove_in_branch(self): | ||
| 811 | 1584 | self.branch_config.remove_user_option('file') | ||
| 812 | 1585 | self.assertOptions( | ||
| 813 | 1586 | [('file', 'locations', self.tree.basedir, 'locations'), | ||
| 814 | 1587 | ('file', 'bazaar', 'DEFAULT', 'bazaar'),], | ||
| 815 | 1588 | self.branch_config) | ||
| 816 | 1589 | |||
| 817 | 1590 | def test_remove_in_bazaar(self): | ||
| 818 | 1591 | self.bazaar_config.remove_user_option('file') | ||
| 819 | 1592 | self.assertOptions( | ||
| 820 | 1593 | [('file', 'locations', self.tree.basedir, 'locations'), | ||
| 821 | 1594 | ('file', 'branch', 'DEFAULT', 'branch'),], | ||
| 822 | 1595 | self.branch_config) | ||
| 823 | 1596 | |||
| 824 | 1597 | |||
| 825 | 1598 | class TestConfigGetSections(tests.TestCaseWithTransport): | ||
| 826 | 1599 | |||
| 827 | 1600 | def setUp(self): | ||
| 828 | 1601 | super(TestConfigGetSections, self).setUp() | ||
| 829 | 1602 | create_configs(self) | ||
| 830 | 1603 | |||
| 831 | 1604 | def assertSectionNames(self, expected, conf, name=None): | ||
| 832 | 1605 | """Check which sections are returned for a given config. | ||
| 833 | 1606 | |||
| 834 | 1607 | If fallback configurations exist their sections can be included. | ||
| 835 | 1608 | |||
| 836 | 1609 | :param expected: A list of section names. | ||
| 837 | 1610 | |||
| 838 | 1611 | :param conf: The configuration that will be queried. | ||
| 839 | 1612 | |||
| 840 | 1613 | :param name: An optional section name that will be passed to | ||
| 841 | 1614 | get_sections(). | ||
| 842 | 1615 | """ | ||
| 843 | 1616 | sections = list(conf._get_sections(name)) | ||
| 844 | 1617 | self.assertLength(len(expected), sections) | ||
| 845 | 1618 | self.assertEqual(expected, [name for name, _, _ in sections]) | ||
| 846 | 1619 | |||
| 847 | 1620 | def test_bazaar_default_section(self): | ||
| 848 | 1621 | self.assertSectionNames(['DEFAULT'], self.bazaar_config) | ||
| 849 | 1622 | |||
| 850 | 1623 | def test_locations_default_section(self): | ||
| 851 | 1624 | # No sections are defined in an empty file | ||
| 852 | 1625 | self.assertSectionNames([], self.locations_config) | ||
| 853 | 1626 | |||
| 854 | 1627 | def test_locations_named_section(self): | ||
| 855 | 1628 | self.locations_config.set_user_option('file', 'locations') | ||
| 856 | 1629 | self.assertSectionNames([self.tree.basedir], self.locations_config) | ||
| 857 | 1630 | |||
| 858 | 1631 | def test_locations_matching_sections(self): | ||
| 859 | 1632 | loc_config = self.locations_config | ||
| 860 | 1633 | loc_config.set_user_option('file', 'locations') | ||
| 861 | 1634 | # We need to cheat a bit here to create an option in sections above and | ||
| 862 | 1635 | # below the 'location' one. | ||
| 863 | 1636 | parser = loc_config._get_parser() | ||
| 864 | 1637 | # locations.cong deals with '/' ignoring native os.sep | ||
| 865 | 1638 | location_names = self.tree.basedir.split('/') | ||
| 866 | 1639 | parent = '/'.join(location_names[:-1]) | ||
| 867 | 1640 | child = '/'.join(location_names + ['child']) | ||
| 868 | 1641 | parser[parent] = {} | ||
| 869 | 1642 | parser[parent]['file'] = 'parent' | ||
| 870 | 1643 | parser[child] = {} | ||
| 871 | 1644 | parser[child]['file'] = 'child' | ||
| 872 | 1645 | self.assertSectionNames([self.tree.basedir, parent], loc_config) | ||
| 873 | 1646 | |||
| 874 | 1647 | def test_branch_data_default_section(self): | ||
| 875 | 1648 | self.assertSectionNames([None], | ||
| 876 | 1649 | self.branch_config._get_branch_data_config()) | ||
| 877 | 1650 | |||
| 878 | 1651 | def test_branch_default_sections(self): | ||
| 879 | 1652 | # No sections are defined in an empty locations file | ||
| 880 | 1653 | self.assertSectionNames([None, 'DEFAULT'], | ||
| 881 | 1654 | self.branch_config) | ||
| 882 | 1655 | # Unless we define an option | ||
| 883 | 1656 | self.branch_config._get_location_config().set_user_option( | ||
| 884 | 1657 | 'file', 'locations') | ||
| 885 | 1658 | self.assertSectionNames([self.tree.basedir, None, 'DEFAULT'], | ||
| 886 | 1659 | self.branch_config) | ||
| 887 | 1660 | |||
| 888 | 1661 | def test_bazaar_named_section(self): | ||
| 889 | 1662 | # We need to cheat as the API doesn't give direct access to sections | ||
| 890 | 1663 | # other than DEFAULT. | ||
| 891 | 1664 | self.bazaar_config.set_alias('bazaar', 'bzr') | ||
| 892 | 1665 | self.assertSectionNames(['ALIASES'], self.bazaar_config, 'ALIASES') | ||
| 893 | 1666 | |||
| 894 | 1667 | |||
| 895 | 1474 | class TestAuthenticationConfigFile(tests.TestCase): | 1668 | class TestAuthenticationConfigFile(tests.TestCase): |
| 896 | 1475 | """Test the authentication.conf file matching""" | 1669 | """Test the authentication.conf file matching""" |
| 897 | 1476 | 1670 | ||
| 898 | 1477 | 1671 | ||
| 899 | === modified file 'doc/en/release-notes/bzr-2.3.txt' | |||
| 900 | --- doc/en/release-notes/bzr-2.3.txt 2010-10-15 07:36:59 +0000 | |||
| 901 | +++ doc/en/release-notes/bzr-2.3.txt 2010-10-15 09:37:41 +0000 | |||
| 902 | @@ -22,6 +22,11 @@ | |||
| 903 | 22 | new or mirrored branch without working trees. | 22 | new or mirrored branch without working trees. |
| 904 | 23 | (Matthew Gordon, #506730) | 23 | (Matthew Gordon, #506730) |
| 905 | 24 | 24 | ||
| 906 | 25 | * ``bzr config`` is a new command that displays the configuration options for | ||
| 907 | 26 | a given directory. It accepts a glob to match against multiple options at | ||
| 908 | 27 | once. It can also be used to set or delete a configuration option in any | ||
| 909 | 28 | configuration file. (Vincent Ladeuil) | ||
| 910 | 29 | |||
| 911 | 25 | * New shortcut url schemes ``ubuntu:`` and ``debianlp:`` access source | 30 | * New shortcut url schemes ``ubuntu:`` and ``debianlp:`` access source |
| 912 | 26 | branches on Launchpad. E.g. ``bzr branch ubuntu:foo`` gives you the source | 31 | branches on Launchpad. E.g. ``bzr branch ubuntu:foo`` gives you the source |
| 913 | 27 | branch for project ``foo`` in the current distroseries for Ubuntu while | 32 | branch for project ``foo`` in the current distroseries for Ubuntu while |
| 914 | 28 | 33 | ||
| 915 | === modified file 'doc/en/user-guide/configuring_bazaar.txt' | |||
| 916 | --- doc/en/user-guide/configuring_bazaar.txt 2010-10-08 10:50:51 +0000 | |||
| 917 | +++ doc/en/user-guide/configuring_bazaar.txt 2010-10-15 09:37:41 +0000 | |||
| 918 | @@ -70,6 +70,59 @@ | |||
| 919 | 70 | in the Bazaar User Reference. | 70 | in the Bazaar User Reference. |
| 920 | 71 | 71 | ||
| 921 | 72 | 72 | ||
| 922 | 73 | Looking at the active configuration | ||
| 923 | 74 | ----------------------------------- | ||
| 924 | 75 | |||
| 925 | 76 | To look at all the currently defined options, you can use the following | ||
| 926 | 77 | command:: | ||
| 927 | 78 | |||
| 928 | 79 | bzr config | ||
| 929 | 80 | |||
| 930 | 81 | ``bzr`` implements some rules to decide where to get the value of a | ||
| 931 | 82 | configuration option. | ||
| 932 | 83 | |||
| 933 | 84 | The current policy is to examine the existing configurations files in a | ||
| 934 | 85 | given order for matching definitions. | ||
| 935 | 86 | |||
| 936 | 87 | * ``locations.conf`` is searched first for a section whose name matches the | ||
| 937 | 88 | location considered (working tree, branch or remote branch), | ||
| 938 | 89 | |||
| 939 | 90 | * the current ``branch.conf`` is searched next, | ||
| 940 | 91 | |||
| 941 | 92 | * ``bazaar.conf`` is searched next, | ||
| 942 | 93 | |||
| 943 | 94 | * finally, some options can have default values generally defined in the | ||
| 944 | 95 | code itself and not displayed by ``bzr config`` (see `Configuration | ||
| 945 | 96 | Settings <../user-reference/index.html#configuration-settings>`_). | ||
| 946 | 97 | |||
| 947 | 98 | This is better understood by using ```bzr config`` with no arguments, which | ||
| 948 | 99 | will display some output of the form:: | ||
| 949 | 100 | |||
| 950 | 101 | locations: | ||
| 951 | 102 | post_commit_to = commits@example.com | ||
| 952 | 103 | news_merge_files = NEWS | ||
| 953 | 104 | branch: | ||
| 954 | 105 | parent_location = bzr+ssh://bazaar.launchpad.net/+branch/bzr/ | ||
| 955 | 106 | nickname = config-modify | ||
| 956 | 107 | push_location = bzr+ssh://bazaar.launchpad.net/~vila/bzr/config-modify/ | ||
| 957 | 108 | bazaar: | ||
| 958 | 109 | debug_flags = hpss, | ||
| 959 | 110 | |||
| 960 | 111 | Each configuration file is associated with a given scope whose name is | ||
| 961 | 112 | displayed before each set of defined options. | ||
| 962 | 113 | |||
| 963 | 114 | Modifying the active configuration | ||
| 964 | 115 | ---------------------------------- | ||
| 965 | 116 | |||
| 966 | 117 | To set an option to a given value use:: | ||
| 967 | 118 | |||
| 968 | 119 | bzr config opt=value | ||
| 969 | 120 | |||
| 970 | 121 | To remove an option use:: | ||
| 971 | 122 | |||
| 972 | 123 | bzr config --remove opt | ||
| 973 | 124 | |||
| 974 | 125 | |||
| 975 | 73 | Rule-based preferences | 126 | Rule-based preferences |
| 976 | 74 | ---------------------- | 127 | ---------------------- |
| 977 | 75 | 128 | ||
| 978 | 76 | 129 | ||
| 979 | === modified file 'doc/en/whats-new/whats-new-in-2.3.txt' | |||
| 980 | --- doc/en/whats-new/whats-new-in-2.3.txt 2010-10-13 07:04:50 +0000 | |||
| 981 | +++ doc/en/whats-new/whats-new-in-2.3.txt 2010-10-15 09:37:41 +0000 | |||
| 982 | @@ -97,6 +97,14 @@ | |||
| 983 | 97 | format, used by emacs and the standalone ``info`` reader. | 97 | format, used by emacs and the standalone ``info`` reader. |
| 984 | 98 | (Vincent Ladeuil, #219334) | 98 | (Vincent Ladeuil, #219334) |
| 985 | 99 | 99 | ||
| 986 | 100 | Configuration | ||
| 987 | 101 | ************* | ||
| 988 | 102 | |||
| 989 | 103 | ``bzr`` can be configure via environment variables, command-line options | ||
| 990 | 104 | and configurations files. We've started working on unifying this and give | ||
| 991 | 105 | access to more options. The first step is a new ``bzr config`` command that | ||
| 992 | 106 | can be used to display the active configuration options in the current | ||
| 993 | 107 | working tree or branch as well as the ability to set or remove an option. | ||
| 994 | 100 | 108 | ||
| 995 | 101 | Expected releases for the 2.3 series | 109 | Expected releases for the 2.3 series |
| 996 | 102 | ************************************ | 110 | ************************************ |
Epic cover letter. What a shame it's not updating the user documentation. :-) Perhaps you could paste and update some of it into there: we need the documentation, and checking how it's explained to the user is a good way to find out if the ui is actually sane.
This should also be mentioned in whatsnew.
And, I don't want to hijack your mp, but perhaps some of the other text could go into a developer document giving an overview of configurations?
> Section handling
That seems like a good description of the situation. I think locations.conf is on the right track by reserving the section headers to match _which_ configuration applies, not as part of the settings.
> I chose 'config' over 'configuration' as the later is already an help topic. Cheap shot :)
Probably the topic needs to be updated then.
> + ('cmd_config', ['conf'], 'bzrlib.config'),
I don't think people will type this often enough that saving two characters is worth it.
-from fnmatch import fnmatch
+import fnmatch
Not this again :-)
+ def id(self):
+ return 'bazaar'
'id' is of course a Python builtin. It's legal and not shadowing anything to put it as an instance attribute but I wonder if it's a good idea; maybe config_id would be better.
+ commands.
+ short_name='f', type=unicode),
Force it to do what? :)
If it's going to be "config --force ~/.bazaar/
OK, I see later on this is actually passing a kind of configuration scope.
+ if matching is None:
+ matching = '*'
+ self._show_
Why assign to 'matching' in here?
+ else:
+ if remove:
+ self._remove_
+ else:
+ pos = matching.find('=')
+ if pos == -1:
+ self._show_
+ else:
+ self._set_
+ directory, force)
+
I would unfold the 'remove' to one if/elif/else.
This seems like a very good case for wanting both a cli command and another layer that's just below the cli but not specific to that, that can be reused by other front ends or people scripting bzrlib in Python. I'd like to have a standard pattern for this. This code is actually fairly close, and seems to indicate perhaps we should keep that on Command objects and just make sure they're easy to use other than through run_bzr.
+ def test_locations_
+ self.bazaar_
+ self.locations_
+ script.
+$ bzr config
+bazaar:
+ hello = world
+''')
+
Now that scripts automatically strip consistent indentation, I think we should normally keep them indented inside the block, so that they don't mess up the Python structure.
I wonder if the output from config when showing more ...