Merge lp:~jr/bzr-builddeb/larstiq-rename into lp:bzr-builddeb

[Jonathan Riddell]

Rename "larstiq" property to "top_level". "larstiq" is meaningless to readers of the code, it's just named after a user on launchpad, use a variable name with meaning to make code more readable.

[Jelmer Vernooij (jelmer)]

This looks good, though I have to add that LarstiQ isn't just some Launchpad user, he is one of the early maintainers of bzr in Debian and was release manager for a couple of bzr releases.

(having "top_level" in quotes in the comments doesn't seem correct anymore?)

review: Approve

=== modified file '__init__.py'
--- __init__.py	2011-06-24 11:37:57 +0000
+++ __init__.py	2011-09-29 10:36:25 +0000
@@ -140,7 +140,7 @@
     t = branch.repository.revision_tree(revid)
     config = debuild_config(t, False)
     try:
-        (changelog, larstiq) = find_changelog(t, config.build_type == BUILD_TYPE_MERGE)
+        (changelog, top_level) = find_changelog(t, config.build_type == BUILD_TYPE_MERGE)
     except MissingChangelogError:
         # Not a debian package
         return None

=== modified file 'cmds.py'
--- cmds.py	2011-09-09 13:20:42 +0000
+++ cmds.py	2011-09-29 10:36:25 +0000
@@ -351,7 +351,7 @@
             if build_type is None:
                 build_type = config.build_type
             contains_upstream_source = tree_contains_upstream_source(tree)
-            (changelog, larstiq) = find_changelog(tree, not contains_upstream_source)
+            (changelog, top_level) = find_changelog(tree, not contains_upstream_source)
             if build_type is None:
                 build_type = guess_build_type(tree, changelog.version,
                     contains_upstream_source)
@@ -396,8 +396,8 @@
             elif not native and config.upstream_branch is not None:
                 upstream_sources.append(LazyUpstreamBranchSource(config.upstream_branch))
             upstream_sources.extend([
-                GetOrigSourceSource(tree, larstiq),
-                UScanSource(tree, larstiq),
+                GetOrigSourceSource(tree, top_level),
+                UScanSource(tree, top_level),
                 ])
             if build_type == BUILD_TYPE_SPLIT:
                 upstream_sources.append(SelfSplitSource(tree))
@@ -413,7 +413,7 @@
                 distiller_cls = FullSourceDistiller
 
             distiller = distiller_cls(tree, upstream_provider,
-                    larstiq=larstiq, use_existing=use_existing,
+                    top_level=top_level, use_existing=use_existing,
                     is_working_tree=working_tree)
 
             build_source_dir = os.path.join(build_dir,
@@ -604,7 +604,7 @@
     def _get_changelog_info(self, tree, last_version, package, distribution):
         current_version = last_version
         try:
-            (changelog, larstiq) = find_changelog(tree, False, max_blocks=2)
+            (changelog, top_level) = find_changelog(tree, False, max_blocks=2)
             if last_version is None:
                 current_version = changelog.version.upstream_version
             if package is None:
@@ -614,7 +614,7 @@
                 if distribution is not None:
                     note("Using distribution %s" % distribution)
         except MissingChangelogError:
-            larstiq = False
+            top_level = False
             changelog = None
         if distribution is None:
             note("No distribution specified, and no changelog, "
@@ -631,7 +631,7 @@
             raise BzrCommandError("Unknown target distribution: %s" \
                         % distribution)
         return (current_version, package, distribution, distribution_name,
-                changelog, larstiq)
+                changelog, top_level)
 
     def run(self, location=None, upstream_branch=None, version=None,
             distribution=None, package=None,
@@ -647,7 +647,7 @@
                         "command.")
             config = debuild_config(tree, tree)
             (current_version, package, distribution, distribution_name,
-             changelog, larstiq) = self._get_changelog_info(tree, last_version,
+             changelog, top_level) = self._get_changelog_info(tree, last_version,
                  package, distribution)
             contains_upstream_source = tree_contains_upstream_source(tree)
             if changelog is None:
@@ -702,7 +702,7 @@
                             " branch source")
                     primary_upstream_source = upstream_branch_source
                 else:
-                    primary_upstream_source = UScanSource(tree, larstiq)
+                    primary_upstream_source = UScanSource(tree, top_level)
 
             if revision is not None:
                 if upstream_branch is None:
@@ -869,7 +869,7 @@
             dbs = DistributionBranchSet()
             dbs.add_branch(db)
             try:
-                (changelog, larstiq) = find_changelog(tree, False)
+                (changelog, top_level) = find_changelog(tree, False)
                 last_version = changelog.version
             except MissingChangelogError:
                 last_version = None
@@ -1034,7 +1034,7 @@
             except KeyError:
                 command_list = ["/bin/sh"]
             give_instruction = True
-        (changelog, larstiq) = find_changelog(t, True)
+        (changelog, top_level) = find_changelog(t, True)
         build_dir = config.build_dir
         if build_dir is None:
             build_dir = default_build_dir
@@ -1046,11 +1046,11 @@
                 changelog.version.upstream_version, orig_dir,
                 [PristineTarSource(t, t.branch),
                  AptSource(),
-                 GetOrigSourceSource(t, larstiq),
-                 UScanSource(t, larstiq) ])
+                 GetOrigSourceSource(t, top_level),
+                 UScanSource(t, top_level) ])
 
         distiller = MergeModeDistiller(t, upstream_provider,
-                larstiq=larstiq)
+                top_level=top_level)
 
         build_source_dir = os.path.join(build_dir,
                 changelog.package + "-" + changelog.version.upstream_version)
@@ -1071,7 +1071,7 @@
             raise BzrCommandError('Not updating the working tree as the '
                     'command failed.')
         note("Copying debian/ back")
-        if larstiq:
+        if top_level:
             destination = ''
         else:
             destination = 'debian/'
@@ -1113,7 +1113,7 @@
             config = debuild_config(t, t)
             if merge is None:
                 merge = (config.build_type == BUILD_TYPE_MERGE)
-            (changelog, larstiq) = find_changelog(t, merge)
+            (changelog, top_level) = find_changelog(t, merge)
             if changelog.distributions == 'UNRELEASED':
                 if not force:
                     raise BzrCommandError("The changelog still targets "

=== modified file 'properties.py'
--- properties.py	2008-08-27 01:13:12 +0000
+++ properties.py	2011-09-29 10:36:25 +0000
@@ -22,11 +22,11 @@
 class BuildProperties(object):
   """Properties of this specific build"""
 
-  def __init__(self, changelog, build_dir, tarball_dir, larstiq):
+  def __init__(self, changelog, build_dir, tarball_dir, top_level):
     self._changelog = changelog
     self._build_dir = build_dir
     self._tarball_dir = tarball_dir
-    self._larstiq = larstiq
+    self._top_level = top_level
   
   def package(self):
     return self._changelog.package
@@ -58,7 +58,7 @@
   def tarball_dir(self):
     return self._tarball_dir
 
-  def larstiq(self):
-    return self._larstiq
+  def top_level(self):
+    return self._top_level
 
 # vim: ts=2 sts=2 sw=2

=== modified file 'source_distiller.py'
--- source_distiller.py	2011-06-15 18:44:09 +0000
+++ source_distiller.py	2011-09-29 10:36:25 +0000
@@ -41,21 +41,21 @@
 
     supports_use_existing = False
 
-    def __init__(self, tree, upstream_provider, larstiq=False,
+    def __init__(self, tree, upstream_provider, top_level=False,
             use_existing=False, is_working_tree=False):
         """Create a SourceDistiller to distill from the specified tree.
 
         :param tree: The tree to use as the source.
         :param upstream_provider: an UpstreamProvider to provide the upstream
             tarball if needed.
-        :param larstiq: if the tree is in the "LarstiQ" layout.
+        :param top_level: if the tree is in the top level directory instead of inside debian/.
         :param use_existing: whether the distiller should re-use an existing
             target if the distiller supports it.
         :param is_working_tree: if `tree` is a working tree.
         """
         self.tree = tree
         self.upstream_provider = upstream_provider
-        self.larstiq = larstiq
+        self.top_level = top_level
         self.use_existing = use_existing
         if not self.supports_use_existing:
             assert not self.use_existing, "distiller doesn't support use_existing"
@@ -138,7 +138,7 @@
         basetempdir = tempfile.mkdtemp(prefix='builddeb-merge-debian-')
         try:
             tempdir = os.path.join(basetempdir,"export")
-            if self.larstiq:
+            if self.top_level
                 os.makedirs(tempdir)
                 export_dir = os.path.join(tempdir, 'debian')
             else:

=== modified file 'util.py'
--- util.py	2011-09-09 13:20:42 +0000
+++ util.py	2011-09-29 10:36:25 +0000
@@ -129,7 +129,7 @@
     'max_blocks' defaults to 1 to try and prevent old broken
     changelog entries from causing the command to fail, 
 
-    "larstiq" is a subset of "merge" mode. It indicates that the
+    "top_level" is a subset of "merge" mode. It indicates that the
     '.bzr' dir is at the same level as 'changelog' etc., rather
     than being at the same level as 'debian/'.
 
@@ -137,26 +137,27 @@
     :param merge: whether this is a "merge" package.
     :param max_blocks: Number of max_blocks to parse (defaults to 1). Use None
         to parse the entire changelog.
-    :return: (changelog, larstiq) where changelog is the Changelog,
-        and larstiq is a boolean indicating whether the file is at
-        'changelog' if merge was given, False otherwise.
+    :return: (changelog, top_level) where changelog is the Changelog,
+        and top_level is a boolean indicating whether the file is
+        located at 'changelog' (rather than 'debian/changelog') if
+        merge was given, False otherwise.
     """
     changelog_file = 'debian/changelog'
-    larstiq = False
+    top_level = False
     t.lock_read()
     try:
         if not t.has_filename(changelog_file):
             if merge:
                 # Assume LarstiQ's layout (.bzr in debian/)
                 changelog_file = 'changelog'
-                larstiq = True
+                top_level = True
                 if not t.has_filename(changelog_file):
                     raise MissingChangelogError('"debian/changelog" or '
                             '"changelog"')
             else:
                 raise MissingChangelogError('"debian/changelog"')
         elif merge and t.has_filename('changelog'):
-            # If it is a "larstiq" package and debian is a symlink to
+            # If it is a "top_level" package and debian is a symlink to
             # "." then it will have found debian/changelog. Try and detect
             # this.
             debian_file_id = t.path2id('debian')
@@ -164,7 +165,7 @@
                 t.kind(debian_file_id) == 'symlink' and 
                 t.get_symlink_target(t.path2id('debian')) == '.'):
                 changelog_file = 'changelog'
-                larstiq = True
+                top_level = True
         mutter("Using '%s' to get package information", changelog_file)
         changelog_id = t.path2id(changelog_file)
         if changelog_id is None:
@@ -177,7 +178,7 @@
         changelog.parse_changelog(contents, max_blocks=max_blocks, allow_empty_author=True)
     except ChangelogParseError, e:
         raise UnparseableChangelog(str(e))
-    return changelog, larstiq
+    return changelog, top_level
 
 
 def strip_changelog_message(changes):
@@ -583,7 +584,7 @@
     Ubuntu.
     """
     try:
-        cl, larstiq = find_changelog(tree, merge, max_blocks=None)
+        cl, top_level = find_changelog(tree, merge, max_blocks=None)
     except UnparseableChangelog:
         raise UnableToFindPreviousUpload()
     return _find_previous_upload(cl)