Merge lp:~mabac/linaro-image-tools/display-version into lp:linaro-image-tools/11.11

[Mattias Backman]

Hi,

This branch enables the -v/--version option for linaro-media-create, linaro-android-media-create and linaro-hwpack-create.

The setup.py file is changed to get the version from __version__.py and do-release is changed to update the version in that py file.

Thanks,

Mattias

[Loïc Minier (lool)]

 overall happy with the changes, just some minor points:

On Mon, Oct 03, 2011, Mattias Backman wrote:
> === modified file 'do-release'
> --- do-release 2011-05-23 15:07:05 +0000
> +++ do-release 2011-10-03 08:48:54 +0000
> @@ -47,8 +47,8 @@
> die "Tag $version already exists"
> fi
>
> -log_i "Setting version to $version in setup.py"
> -sed -i "s/^\\([[:space:]]*version=\"\\)[^\"]*\",\$/\1$version\",/" setup.py
> +log_i "Setting version to $version in __version__.py"
> +sed -i "s/^\\(__version__\ =\ \"\\)[^\"]*\"\$/\1$version\"/" linaro_image_tools/__version__.py
>
> log_i "Committing $version"
> bzr commit -m "Release $version"
> @@ -68,8 +68,8 @@
> log_i "Signing tarball"
> gpg --armor --sign --detach-sig "../linaro-image-tools-$version.tar.gz"
>
> -log_i "Setting version to $version.1 in setup.py"
> -sed -i "s/^\\([[:space:]]*version=\"\\)[^\"]*\",\$/\1$version.1\",/" setup.py
> +log_i "Setting version to $version (devel) in __version__.py"
> +sed -i "s/^\\(__version__\ =\ \"\\)[^\"]*\"\$/\1$version.1 (devel)\"/" linaro_image_tools/__version__.py

 Might be worth factoring these seds into a set_version() function.

 The \\( \\) were to preserve spacing in setup.py which could happen
 within complex formatting, but given that version.py just holds the
 version = string, I think you could be more aggressive in your sed:
    sed -i "s/^version =.*/version = $version/" version.py
 which would make the sed much easier to read than it is in the current
 version!

> +__version__ = "2011.09.1 (devel)"

 Could we keep the version entirely numeric? I'd much prefer if that
 was the case because it would allow for e.g. easy version comparison if
 we needed that. For instance external scripts could verify the version
 of linaro-media-create, and dealing with alphanumeric is just a bit
 harder than splitting on . for major/minor version numbers.

    Thanks!
--
Loïc Minier

[Mattias Backman (mabac)]

>> -log_i "Setting version to $version.1 in setup.py"
>> -sed -i "s/^\\([[:space:]]*version=\"\\)[^\"]*\",\$/\1$version.1\",/" setup.py
>> +log_i "Setting version to $version (devel) in __version__.py"
>> +sed -i "s/^\\(__version__\ =\ \"\\)[^\"]*\"\$/\1$version.1 (devel)\"/" linaro_image_tools/__version__.py
>
>  Might be worth factoring these seds into a set_version() function.
>
>  The \\( \\) were to preserve spacing in setup.py which could happen
>  within complex formatting, but given that version.py just holds the
>  version = string, I think you could be more aggressive in your sed:
>    sed -i "s/^version =.*/version = $version/" version.py
>  which would make the sed much easier to read than it is in the current
>  version!

Sure, I'll be happy to simplify them, it took a lot of head scratching
for me to understand them now.

>
>> +__version__ = "2011.09.1 (devel)"
>
>  Could we keep the version entirely numeric?  I'd much prefer if that
>  was the case because it would allow for e.g. easy version comparison if
>  we needed that.  For instance external scripts could verify the version
>  of linaro-media-create, and dealing with alphanumeric is just a bit
>  harder than splitting on . for major/minor version numbers.

I have no problem with keeping the current .1 versioning. I think fabo
suggested the more clear distinction.

[lp:~mabac/linaro-image-tools/display-version]

442. By Mattias Backman on 2011-10-04

Move seds to function.

443. By Mattias Backman on 2011-10-04

Change version back to numeric only.

[Fathi Boudra (fboudra)]

> >> +__version__ = "2011.09.1 (devel)"
> >
> >  Could we keep the version entirely numeric?  I'd much prefer if that
> >  was the case because it would allow for e.g. easy version comparison if
> >  we needed that.  For instance external scripts could verify the version
> >  of linaro-media-create, and dealing with alphanumeric is just a bit
> >  harder than splitting on . for major/minor version numbers.
>
> I have no problem with keeping the current .1 versioning. I think fabo
> suggested the more clear distinction.

I don't have a strong opinion. "devel" is still better for human readable version.
easy comparison is a valid use case. feel free to use a version entirely numeric, no objections.

=== modified file 'do-release'
--- do-release	2011-05-23 15:07:05 +0000
+++ do-release	2011-10-04 10:56:25 +0000
@@ -22,6 +22,11 @@
     exit 1
 }
 
+set_version() {
+    log_i "Setting version to $1 in __version__.py"
+    sed -i "s/^__version__ =.*/__version__ = \"$1\"/" linaro_image_tools/__version__.py
+}
+
 version="$1"
 
 if [ -z "$version" ]; then
@@ -47,8 +52,7 @@
     die "Tag $version already exists"
 fi
 
-log_i "Setting version to $version in setup.py"
-sed -i "s/^\\([[:space:]]*version=\"\\)[^\"]*\",\$/\1$version\",/" setup.py
+set_version $version
 
 log_i "Committing $version"
 bzr commit -m "Release $version"
@@ -68,8 +72,7 @@
 log_i "Signing tarball"
 gpg --armor --sign --detach-sig "../linaro-image-tools-$version.tar.gz"
 
-log_i "Setting version to $version.1 in setup.py"
-sed -i "s/^\\([[:space:]]*version=\"\\)[^\"]*\",\$/\1$version.1\",/" setup.py
+set_version "$version.1"
 
-log_i "Committing $version"
+log_i "Committing $version.1"
 bzr commit -m "Post-release version bump to $version.1"

=== modified file 'linaro-hwpack-create'
--- linaro-hwpack-create	2011-05-25 15:47:02 +0000
+++ linaro-hwpack-create	2011-10-04 10:56:25 +0000
@@ -27,9 +27,10 @@
 from linaro_image_tools.hwpack.builder import (
     ConfigFileMissing, HardwarePackBuilder)
 
+from linaro_image_tools.__version__ import __version__
 
 if __name__ == '__main__':
-    parser = argparse.ArgumentParser()
+    parser = argparse.ArgumentParser(version='%(prog)s ' + __version__)
     parser.add_argument(
         "CONFIG_FILE",
         help="The configuration file to take the hardware pack information "

=== added file 'linaro_image_tools/__version__.py'
--- linaro_image_tools/__version__.py	1970-01-01 00:00:00 +0000
+++ linaro_image_tools/__version__.py	2011-10-04 10:56:25 +0000
@@ -0,0 +1,1 @@
+__version__ = "2011.09.1"

=== modified file 'linaro_image_tools/media_create/__init__.py'
--- linaro_image_tools/media_create/__init__.py	2011-08-19 14:04:54 +0000
+++ linaro_image_tools/media_create/__init__.py	2011-10-04 10:56:25 +0000
@@ -21,6 +21,7 @@
 
 from linaro_image_tools.media_create.boards import board_configs
 from linaro_image_tools.media_create.android_boards import android_board_configs
+from linaro_image_tools.__version__ import __version__
 
 
 KNOWN_BOARDS = board_configs.keys()
@@ -47,7 +48,7 @@
 
 def get_args_parser():
     """Get the ArgumentParser for the arguments given on the command line."""
-    parser = argparse.ArgumentParser()
+    parser = argparse.ArgumentParser(version='%(prog)s ' + __version__)
     group = parser.add_mutually_exclusive_group(required=True)
     group.add_argument(
         '--mmc', dest='device', help='The storage device to use.')
@@ -128,7 +129,7 @@
 
 def get_android_args_parser():
     """Get the ArgumentParser for the arguments given on the command line."""
-    parser = argparse.ArgumentParser()
+    parser = argparse.ArgumentParser(version='%(prog)s ' + __version__)
     group = parser.add_mutually_exclusive_group(required=True)
     group.add_argument(
         '--mmc', dest='device', help='The storage device to use.')

=== modified file 'setup.py'
--- setup.py	2011-09-23 07:41:58 +0000
+++ setup.py	2011-10-04 10:56:25 +0000
@@ -2,10 +2,12 @@
 
 # https://launchpad.net/python-distutils-extra
 import DistUtilsExtra.auto
+from linaro_image_tools.__version__ import __version__
+
 
 DistUtilsExtra.auto.setup(
         name="linaro-image-tools",
-        version="2011.09.1",
+        version=__version__,
         description="Tools to create and write Linaro images",
         url="https://launchpad.net/linaro-image-tools",
         license="GPL v3 or later",