~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/plugins/news_merge/__init__.py

Merge cleanup into description

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
# Copyright (C) 2010 Canonical Ltd
 
2
#
 
3
# This program is free software; you can redistribute it and/or modify
 
4
# it under the terms of the GNU General Public License as published by
 
5
# the Free Software Foundation; either version 2 of the License, or
 
6
# (at your option) any later version.
 
7
#
 
8
# This program is distributed in the hope that it will be useful,
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
11
# GNU General Public License for more details.
 
12
#
 
13
# You should have received a copy of the GNU General Public License
 
14
# along with this program; if not, write to the Free Software
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
16
 
 
17
"""Merge hook for bzr's NEWS file.
 
18
 
 
19
To enable this plugin, add a section to your branch.conf or location.conf
 
20
like::
 
21
 
 
22
    [/home/user/code/bzr]
 
23
    news_merge_files = NEWS
 
24
    news_merge_files:policy = recurse
 
25
 
 
26
The news_merge_files config option takes a list of file paths, separated by
 
27
commas.
 
28
 
 
29
Limitations:
 
30
 
 
31
* if there's a conflict in more than just bullet points, this doesn't yet know
 
32
  how to resolve that, so bzr will fallback to the default line-based merge.
 
33
"""
 
34
 
 
35
# Since we are a built-in plugin we share the bzrlib version
 
36
from bzrlib import version_info
 
37
 
 
38
# Put most of the code in a separate module that we lazy-import to keep the
 
39
# overhead of this plugin as minimal as possible.
 
40
from bzrlib.lazy_import import lazy_import
 
41
lazy_import(globals(), """
 
42
from bzrlib.plugins.news_merge import news_merge as _mod_news_merge
 
43
""")
 
44
 
 
45
from bzrlib.merge import Merger
 
46
 
 
47
 
 
48
def news_merge_hook(merger):
 
49
    """Merger.merge_file_content hook for bzr-format NEWS files."""
 
50
    return _mod_news_merge.NewsMerger(merger)
 
51
 
 
52
 
 
53
def install_hook():
 
54
    Merger.hooks.install_named_hook(
 
55
        'merge_file_content', news_merge_hook, 'NEWS file merge')
 
56
install_hook()
 
57
 
 
58
 
 
59
def load_tests(basic_tests, module, loader):
 
60
    testmod_names = [
 
61
        'tests',
 
62
        ]
 
63
    basic_tests.addTest(loader.loadTestsFromModuleNames(
 
64
            ["%s.%s" % (__name__, tmn) for tmn in testmod_names]))
 
65
    return basic_tests
 
66