docs: update the README file
authorArtem Bityutskiy <artem.bityutskiy@intel.com>
Thu, 7 Nov 2013 15:23:55 +0000 (17:23 +0200)
committerArtem Bityutskiy <artem.bityutskiy@intel.com>
Thu, 7 Nov 2013 15:23:55 +0000 (17:23 +0200)
Change-Id: I1ddec192e3bd2c1de88665991af920cb2294cfa7
Signed-off-by: Artem Bityutskiy <artem.bityutskiy@intel.com>
docs/README

index 3199511c598765ab73bd86a283b686cb5b0184e1..99eb1ea48818b7269f38bcdcc86c25cb26f81ff4 100644 (file)
@@ -51,12 +51,18 @@ The project structure
 | - .coveragerc          | lists files to include into test coverage report    |
 | - TODO                 | Just a list of things to be done for the project.   |
 | - make_a_release.sh    | Most people may ignore this script. It is used by   |
-|                        | maintainer when creating a new release.
+|                        | maintainer when creating a new release.             |
 | - tests/               | Contains the project unit-tests.                    |
 |   | - test_api_base.py | Tests the base API modules: 'BmapCreate.py' and     |
 |   |                    | 'BmapCopy.py'.                                      |
 |   | - test_fiemap.py   | Tests the 'Fiemap.py' module.                       |
+|   | - test_compat.py   | Tests that new BmapCopy implementations support old |
+|   |                    | bmap formats, and old BmapCopy implementations      |
+|   |                    | support new compatible bmap fomrats.                |
 |   | - helpers.py       | Helper functions shared between the unit-tests.     |
+|   | - test-data/       | Data files for the unit-tests                       |
+|   | - oldcodebase/     | Copies of old BmapCopy implementations for bmap     |
+|   |                    | format forward-compatibility verification.          |
 | - bmaptools/           | The API modules which implement all the bmap        |
 |   |                    | functionality.                                      |
 |   | - BmapCreate.py    | Creates a bmap for a given file.                    |