Merge lp:~jelmer/bzr-builddeb/move-config-to-debian-dir into lp:bzr-builddeb

[Jelmer Vernooij]

Move versioned configuration to debian/bzr-builddeb.conf and local configuration to debian/bzr-builddeb.conf.local.

[James Westby (james-w)]

241 if needs_add:
242 os.mkdir(dirname)

It looks like that would still create .bzr-builddeb?

Also, what do you think about moving local.conf as discussed on IRC?

Thanks,

James

=== modified file '__init__.py'
--- __init__.py	2011-10-07 10:57:44 +0000
+++ __init__.py	2011-10-11 14:49:23 +0000
@@ -57,6 +57,8 @@
     from bzrlib.config import config_dir
     return os.path.join(config_dir(), 'builddeb.conf')
 local_conf = os.path.join(builddeb_dir, 'local.conf')
+new_local_conf = 'debian/local.conf.local'
+new_conf = 'debian/bzr-builddeb.conf'
 
 default_build_dir = '../build-area'
 default_orig_dir = '..'
 
=== modified file 'config.py'
--- config.py	2011-10-07 10:57:44 +0000
+++ config.py	2011-10-11 14:49:23 +0000
@@ -56,7 +56,9 @@
 class DebBuildConfig(object):
   """Holds the configuration settings for builddeb. These are taken from
   a hierarchy of config files. .bzr-builddeb/local.conf then 
-  ~/.bazaar/builddeb.conf, finally .bzr-builddeb/default.conf. The value is 
+  debian/bzr-builddeb.conf.local, 
+  ~/.bazaar/builddeb.conf, debian/bzr-builddeb.conf, 
+  finally .bzr-builddeb/default.conf. The value is 
   taken from the first file in which it is specified."""
 
   section = 'BUILDDEB'
 
=== modified file 'debian/changelog'
--- debian/changelog	2011-10-08 21:45:17 +0000
+++ debian/changelog	2011-10-11 14:49:23 +0000
@@ -17,7 +17,10 @@
 
   [ Jelmer Vernooij ]
   * Support .tar.xz Debian files rather than .tar.lzma.
+  * Move .bzr-builddeb/default.conf to debian/bzr-builddeb.conf. LP:
+    #793137
 
+<<<<<<< TREE
   [ Martin Packman ]
   * Support non-ascii characters in changelog entry when determining
     commit message. LP: #853664
@@ -26,6 +29,9 @@
   * Use more complete control file during examples. Closes: #642818
 
  -- Jelmer Vernooij <[e-mail]>  Sat, 01 Oct 2011 21:27:05 +0200
+=======
+ -- Jelmer Vernooij <[e-mail]>  Wed, 28 Sep 2011 15:15:14 +0200
+>>>>>>> MERGE-SOURCE
 
 bzr-builddeb (2.7.8) unstable; urgency=low
 
 
=== modified file 'doc/user_manual/configuration.rst'
--- doc/user_manual/configuration.rst	2011-10-07 11:14:44 +0000
+++ doc/user_manual/configuration.rst	2011-10-11 14:49:23 +0000
@@ -6,7 +6,8 @@
 
   * .bzr-builddeb/local.conf (in the package directory)
   * ~/.bazaar/builddeb.conf
-  * .bzr-builddeb/default.conf (in the package directory)
+  * debian/bzr-builddeb.conf (in the package directory)
+  * .bzr-builddeb/default.conf (in the package directory, deprecated)
 
 The last of these should be used for values that will be used by all users of
 the package, for instance 'merge = True'. The others are for the user to add
@@ -138,7 +139,7 @@
     (Defaults to ``fakeroot debian/rules binary``). Will only be read from
     the config file in your home directory.
 
-The idea is that certain options can be set in ``.bzr-builddeb/default.conf`` 
+The idea is that certain options can be set in ``debian/bzr-builddeb.conf`` 
 that apply to the package on all systems, or that there is a default that is 
 wanted that differs from the default provided. ``merge = True`` is a perfect 
 example of this.
 
=== modified file 'doc/user_manual/hooks.rst'
--- doc/user_manual/hooks.rst	2011-02-27 16:15:50 +0000
+++ doc/user_manual/hooks.rst	2011-10-11 14:49:23 +0000
@@ -48,7 +48,7 @@
 Hooks are set by editing the configuration files. The normal precedence
 rules for these files are followed (see `configuration`_ for details). This
 means that you should set hooks needed to build the package in
-``.bzr-builddeb/default.conf``, and any hooks that you would like to run
+``debian/bzr-builddeb.conf``, and any hooks that you would like to run
 that would not be appropriate for everyone in ``.bzr-builddeb/local.conf``.
 Note however that the latter overrides the formula, so your local hooks should
 run all necessary commands from the default hooks that are necessary to build
 
=== modified file 'doc/user_manual/merge.rst'
--- doc/user_manual/merge.rst	2011-10-03 11:03:46 +0000
+++ doc/user_manual/merge.rst	2011-10-11 14:49:23 +0000
@@ -48,14 +48,13 @@
 
 Now you have a branch that you will create the package in you need to tell
 `bzr-builddeb` that it will be built in merge mode. To do this you need to
-create the configuration file ``.bzr-builddeb/default.conf``. This contains
+create the configuration file ``debian/bzr-builddeb.conf``. This contains
 the default options for the package. The file starts with a ``[BUILDDEB]``
 header which states that the file is for use by `bzr-builddeb`. The option
 we are interested in is the ``merge`` option. The commands to do this are::
 
-  $ mkdir .bzr-builddeb/
-  $ echo -e '[BUILDDEB]\nmerge = True' > .bzr-builddeb/default.conf
-  $ bzr add .bzr-builddeb/default.conf
+  $ echo -e '[BUILDDEB]\nmerge = True' > debian/bzr-builddeb.conf
+  $ bzr add debian/bzr-builddeb.conf
 
 Now you should add the packaging files to the branch. You have a choice
 here, either you can add a ``debian/`` directory containing the files,
 
=== modified file 'doc/user_manual/native.rst'
--- doc/user_manual/native.rst	2009-02-18 22:50:44 +0000
+++ doc/user_manual/native.rst	2011-10-11 14:49:23 +0000
@@ -53,14 +53,13 @@
 
 Now you have a branch that you will create the package in you need to tell
 `bzr-builddeb` that it will be a native package. To do this you need to
-create the configuration file ``.bzr-builddeb/default.conf``. This contains
+create the configuration file ``debian/bzr-builddeb.conf``. This contains
 the default options for the package. The file starts with a ``[BUILDDEB]``
 header which states that the file is for use by `bzr-builddeb`. The option
 we are interested in is the ``native`` option. The commands to do this are::
 
-  $ mkdir .bzr-builddeb/
-  $ echo -e '[BUILDDEB]\nnative = True' > .bzr-builddeb/default.conf
-  $ bzr add .bzr-builddeb/default.conf
+  $ echo -e '[BUILDDEB]\nnative = True' > debian/bzr-builddeb.conf
+  $ bzr add dbian/bzr-builddeb.conf
 
 Now you are ready to create the package. Add all of the files for the
 package, and the packaging in ``debian/``, and then you can add the files
 
=== modified file 'doc/user_manual/split.rst'
--- doc/user_manual/split.rst	2009-02-18 18:36:18 +0000
+++ doc/user_manual/split.rst	2011-10-11 14:49:23 +0000
@@ -60,14 +60,14 @@
 which will create a branch and add all of your current code to it.
 
 The next step is to tell `bzr-builddeb` that it is a split mode package. To
-do this create the configuration file ``.bzr-builddeb/default.conf`` in the
+do this create the configuration file ``debian/bzr-builddeb.conf`` in the
 branch. This contains the options that are default for building the package.
 The file starts with a ``[BUILDDEB]`` header to identify the options that
 the plugin should use, and the option that you need to set is ``split``.
 The following commands will set up the configuration files for you::
 
-  $ echo -e '[BUILDDEB]\nsplit = True' > .bzr-builddeb/default.conf
-  $ bzr add .bzr-builddeb/default.conf
+  $ echo -e '[BUILDDEB]\nsplit = True' > debian/bzr-builddeb.conf
+  $ bzr add debian/bzr-builddeb.conf
 
 When you are happy with the code you can commit, and then build the package.
 `bzr-builddeb` will see that it is a split mode package and create the
 
=== modified file 'import_dsc.py'
--- import_dsc.py	2011-09-27 00:48:16 +0000
+++ import_dsc.py	2011-10-11 14:49:23 +0000
@@ -451,23 +451,24 @@
 
     def _default_config_for_tree(self, tree):
         # FIXME: shouldn't go to configobj directly
-        path = '.bzr-builddeb/default.conf'
-        c_fileid = tree.path2id(path)
-        config = None
-        if c_fileid is not None:
-            tree.lock_read()
+        for path in ('debian/bzr-builddeb.conf', '.bzr-builddeb/default.conf',):
+            c_fileid = tree.path2id(path)
+            if c_fileid is not None:
+                break
+        else:
+            return None, None
+        tree.lock_read()
+        try:
+            config = ConfigObj(tree.get_file(c_fileid, path))
             try:
-                config = ConfigObj(tree.get_file(c_fileid, path))
-                try:
-                    config['BUILDDEB']
-                except KeyError:
-                    config['BUILDDEB'] = {}
-            finally:
-                tree.unlock()
-        return config
+                config['BUILDDEB']
+            except KeyError:
+                config['BUILDDEB'] = {}
+        finally:
+            tree.unlock()
+        return c_fileid, config
 
-    def _is_tree_native(self, tree):
-        config = self._default_config_for_tree(tree)
+    def _is_tree_native(self, config):
         if config is not None:
             try:
                 current_value = config['BUILDDEB']['native']
@@ -486,7 +487,8 @@
         """
         revid = self.revid_of_version(version)
         rev_tree = self.branch.repository.revision_tree(revid)
-        if self._is_tree_native(rev_tree):
+        config_fileid, current_config = self._default_config_for_tree(rev_tree)
+        if self._is_tree_native(current_config):
             return True
         rev = self.branch.repository.get_revision(revid)
         try:
@@ -918,22 +920,20 @@
 
     def _mark_native_config(self, native):
         poss_native_tree = self.branch.basis_tree()
-        current_native = self._is_tree_native(poss_native_tree)
-        current_config = self._default_config_for_tree(poss_native_tree)
-        dirname = os.path.join(self.tree.basedir, '.bzr-builddeb')
+        config_fileid, current_config = self._default_config_for_tree(poss_native_tree)
+        current_native = self._is_tree_native(current_config)
         if current_config is not None:
             # Add that back to the current tree
-            if not os.path.exists(dirname):
-                os.mkdir(dirname)
-            current_config.filename = os.path.join(dirname,
-                    'default.conf')
+            current_config.filename = os.path.join(self.tree.basedir,
+                poss_native_tree.id2path(config_fileid))
+            dir_path = osutils.dirname(current_config.filename)
+            if not os.path.exists(dir_path):
+                os.mkdir(dir_path)
             current_config.write()
-            dir_id = poss_native_tree.path2id('.bzr-builddeb')
-            file_id = poss_native_tree.path2id(
-                    '.bzr-builddeb/default.conf')
-            self.tree.add(['.bzr-builddeb/',
-                    '.bzr-builddeb/default.conf'],
-                    ids=[dir_id, file_id])
+            dirname = osutils.dirname(poss_native_tree.id2path(config_fileid))
+            dir_id = poss_native_tree.path2id(dirname)
+            self.tree.add([dirname, poss_native_tree.id2path(config_fileid)],
+                    ids=[dir_id, config_fileid])
         if native != current_native:
             if current_config is None:
                 needs_add = True
@@ -949,17 +949,15 @@
                         del current_config['BUILDDEB']
                 if len(current_config) == 0:
                     self.tree.remove(['.bzr-builddeb',
-                            '.bzr-builddeb/default.conf'],
+                            '.bzr-builddeb/default.conf',
+                            'debian/bzr-builddeb.conf'],
                             keep_files=False)
                 else:
-                    if needs_add:
-                        os.mkdir(dirname)
-                    current_config.filename = os.path.join(dirname,
-                            'default.conf')
+                    current_config.filename = os.path.join(
+                        self.tree.basedir, 'debian', 'bzr-builddeb.conf')
                     current_config.write()
                     if needs_add:
-                        self.tree.add(['.bzr-builddeb/',
-                                '.bzr-builddeb/default.conf'])
+                        self.tree.add(['debian', 'debian/bzr-builddeb.conf'])
 
     def import_debian(self, debian_part, version, parents, md5,
             native=False, timestamp=None, file_ids_from=None):
 
=== modified file 'tests/test_import_dsc.py'
--- tests/test_import_dsc.py	2011-09-26 23:40:46 +0000
+++ tests/test_import_dsc.py	2011-10-11 14:49:23 +0000
@@ -1196,7 +1196,8 @@
         self.addCleanup(self.tree1.unlock)
         self.assertTrue(self.db1.is_version_native(version))
         revtree = self.tree1.branch.repository.revision_tree(rh1[0])
-        self.assertTrue(self.db1._is_tree_native(revtree))
+        config_fileid, current_config = self.db1._default_config_for_tree(revtree)
+        self.assertTrue(self.db1._is_tree_native(current_config))
 
     def test_import_native_two(self):
         version1 = Version("1.0")
@@ -1288,8 +1289,7 @@
         self.assertEqual(rev_tree1.get_parent_ids(), [rh1[0]])
         self.assertEqual(rev_tree2.get_parent_ids(), [rh1[1]])
         self.check_changes(rev_tree2.changes_from(rev_tree1),
-                added=["NEWS", ".bzr-builddeb/",
-                    ".bzr-builddeb/default.conf"],
+                added=["NEWS", "debian/bzr-builddeb.conf"],
                 removed=["BUGS"], modified=["debian/changelog", "COPYING"])
         self.assertEqual(self.db1.revid_of_version(version1), rh1[1])
         self.assertEqual(self.db1.revid_of_version(version2), rh1[2])
@@ -1329,14 +1329,12 @@
         self.assertEqual(up_rev_tree1.get_parent_ids(), [rh1[0]])
         self.check_changes(rev_tree2.changes_from(rev_tree1),
                 added=["NEWS"],
-                removed=["BUGS", ".bzr-builddeb/",
-                    ".bzr-builddeb/default.conf"],
+                removed=["BUGS", "debian/bzr-builddeb.conf"],
                 modified=["debian/changelog", "COPYING"])
         self.check_changes(up_rev_tree1.changes_from(rev_tree1),
                 added=["NEWS"],
                 removed=["debian/", "debian/changelog", "debian/control",
-                        "BUGS", "README", ".bzr-builddeb/",
-                        ".bzr-builddeb/default.conf"],
+                        "BUGS", "README", "debian/bzr-builddeb.conf"],
                 modified=["COPYING"])
         self.check_changes(rev_tree2.changes_from(up_rev_tree1),
                 added=["debian/", "debian/changelog", "debian/control",
 
=== modified file 'util.py'
--- util.py	2011-09-29 10:11:07 +0000
+++ util.py	2011-10-11 14:49:23 +0000
@@ -55,6 +55,7 @@
     default_conf,
     local_conf,
     global_conf,
+    new_conf,
     )
 from bzrlib.plugins.builddeb.config import (
     DebBuildConfig,
@@ -533,14 +534,25 @@
     """
     config_files = []
     user_config = None
+    if (working_tree and tree.has_filename(new_local_conf)):
+        if tree.path2id(new_local_conf) is None:
+            config_files.append((tree.get_file_byname(new_local_conf), True,
+                        "local.conf"))
+        else:
+            warning('Not using configuration from %s as it is versioned.',
+                    new_local_conf)
     if (working_tree and tree.has_filename(local_conf)):
         if tree.path2id(local_conf) is None:
             config_files.append((tree.get_file_byname(local_conf), True,
                         "local.conf"))
         else:
-            warning('Not using configuration from %s as it is versioned.')
+            warning('Not using configuration from %s as it is versioned.',
+                    local_conf)
     config_files.append((global_conf(), True))
     user_config = global_conf()
+    if tree.path2id(new_conf):
+        config_files.append((tree.get_file(tree.path2id(new_conf)), False,
+                    "bzr-builddeb.conf"))
     if tree.path2id(default_conf):
         config_files.append((tree.get_file(tree.path2id(default_conf)), False,
                     "default.conf"))