summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorVo Minh Thu <vmt@openerp.com>2013-02-22 16:36:49 +0100
committerVo Minh Thu <vmt@openerp.com>2013-02-22 16:36:49 +0100
commit687fc9afac3cab2d765f3bae65772430588d9abd (patch)
tree863ff5098902612ea97c189cbd354dc5a85d841e
parenta2f5e9d201f94938d432174d869b1a662f6b1093 (diff)
[DOC] report.
bzr revid: vmt@openerp.com-20130222153649-h4quh4r8ptz465s1
-rw-r--r--doc/03_module_dev.rst1
-rw-r--r--doc/report-declaration.rst23
2 files changed, 24 insertions, 0 deletions
diff --git a/doc/03_module_dev.rst b/doc/03_module_dev.rst
index 72f035be4d0..c5f965e4b93 100644
--- a/doc/03_module_dev.rst
+++ b/doc/03_module_dev.rst
@@ -13,3 +13,4 @@ Modules
03_module_dev_04
03_module_dev_05
03_module_dev_06
+ report-declaration
diff --git a/doc/report-declaration.rst b/doc/report-declaration.rst
new file mode 100644
index 00000000000..2a40c96ec61
--- /dev/null
+++ b/doc/report-declaration.rst
@@ -0,0 +1,23 @@
+.. _report-declaration:
+
+Report declaration
+==================
+
+.. versionadded:: 7.1
+
+Before version 7.1, report declaration could be done in two different ways:
+either via a ``<report>`` tag in XML, or via such a tag and a class
+instanciation in a Python module. Instanciating a class in a Python module was
+necessary when a custom parser was used.
+
+In version 7.1, the recommended way to register a report is to use only the
+``<report>`` XML tag. The tag can now support an additional ``parser``
+attribute. The value for that attibute must be a fully-qualified class name,
+without the leading ``openerp.addons.`` namespace.
+
+.. note::
+ The rational to deprecate the manual class instanciation is to make all
+ reports visible in the database, have a unique way to declare reports
+ instead of two, and remove the need to maintain a registry of reports in
+ memory.
+