Update and rename MantenerFIFO to MantenerFIFO.md
[vsorcdistro/.git] / pbr / tests / testpackage / CHANGES.txt
1 Changelog
2 ===========
3
4 0.3 (unreleased)
5 ------------------
6
7 - The ``glob_data_files`` hook became a pre-command hook for the install_data
8   command instead of being a setup-hook.  This is to support the additional
9   functionality of requiring data_files with relative destination paths to be
10   install relative to the package's install path (i.e. site-packages).
11
12 - Dropped support for and deprecated the easier_install custom command.
13   Although it should still work, it probably won't be used anymore for
14   stsci_python packages.
15
16 - Added support for the ``build_optional_ext`` command, which replaces/extends
17   the default ``build_ext`` command.  See the README for more details.
18
19 - Added the ``tag_svn_revision`` setup_hook as a replacement for the
20   setuptools-specific tag_svn_revision option to the egg_info command.  This
21   new hook is easier to use than the old tag_svn_revision option: It's
22   automatically enabled by the presence of ``.dev`` in the version string, and
23   disabled otherwise.
24
25 - The ``svn_info_pre_hook`` and ``svn_info_post_hook`` have been replaced with
26   ``version_pre_command_hook`` and ``version_post_command_hook`` respectively.
27   However, a new ``version_setup_hook``, which has the same purpose, has been
28   added.  It is generally easier to use and will give more consistent results
29   in that it will run every time setup.py is run, regardless of which command
30   is used.  ``stsci.distutils`` itself uses this hook--see the `setup.cfg` file
31   and `stsci/distutils/__init__.py` for example usage.
32
33 - Instead of creating an `svninfo.py` module, the new ``version_`` hooks create
34   a file called `version.py`.  In addition to the SVN info that was included
35   in `svninfo.py`, it includes a ``__version__`` variable to be used by the
36   package's `__init__.py`.  This allows there to be a hard-coded
37   ``__version__`` variable included in the source code, rather than using
38   pkg_resources to get the version.
39
40 - In `version.py`, the variables previously named ``__svn_version__`` and
41   ``__full_svn_info__`` are now named ``__svn_revision__`` and
42   ``__svn_full_info__``.
43
44 - Fixed a bug when using stsci.distutils in the installation of other packages
45   in the ``stsci.*`` namespace package.  If stsci.distutils was not already
46   installed, and was downloaded automatically by distribute through the
47   setup_requires option, then ``stsci.distutils`` would fail to import.  This
48   is because the way the namespace package (nspkg) mechanism currently works,
49   all packages belonging to the nspkg *must* be on the import path at initial
50   import time.
51
52   So when installing stsci.tools, for example, if ``stsci.tools`` is imported
53   from within the source code at install time, but before ``stsci.distutils``
54   is downloaded and added to the path, the ``stsci`` package is already
55   imported and can't be extended to include the path of ``stsci.distutils``
56   after the fact.  The easiest way of dealing with this, it seems, is to
57   delete ``stsci`` from ``sys.modules``, which forces it to be reimported, now
58   the its ``__path__`` extended to include ``stsci.distutil``'s path.
59
60
61 0.2.2 (2011-11-09)
62 ------------------
63
64 - Fixed check for the issue205 bug on actual setuptools installs; before it
65   only worked on distribute.  setuptools has the issue205 bug prior to version
66   0.6c10.
67
68 - Improved the fix for the issue205 bug, especially on setuptools.
69   setuptools, prior to 0.6c10, did not back of sys.modules either before
70   sandboxing, which causes serious problems.  In fact, it's so bad that it's
71   not enough to add a sys.modules backup to the current sandbox: It's in fact
72   necessary to monkeypatch setuptools.sandbox.run_setup so that any subsequent
73   calls to it also back up sys.modules.
74
75
76 0.2.1 (2011-09-02)
77 ------------------
78
79 - Fixed the dependencies so that setuptools is requirement but 'distribute'
80   specifically.  Previously installation could fail if users had plain
81   setuptools installed and not distribute
82
83 0.2 (2011-08-23)
84 ------------------
85
86 - Initial public release