summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorOlivier Dony <odo@openerp.com>2016-09-02 13:24:09 +0200
committerOlivier Dony <odo@openerp.com>2016-09-05 11:57:50 +0200
commit4339196e5231aa734a0154e2f4e88b2e54f27d48 (patch)
treea5e140610e000ced1fccea3cf24358efc6f06883 /doc
parentc0566b289608f2ebb97ece4683440a551c8db9b9 (diff)
[IMP] support v10 manifest file naming convention
- As of v10, manifest files should be named `__manifest__.py` - For backwards-compatibility, __openerp__.py manifest files will still be supported for the time being - Limited refactoring, to add support for the 2 different naming conventions - All textual references to __openerp_.py updated in documentation and examples
Diffstat (limited to 'doc')
-rw-r--r--doc/howtos/backend.rst8
-rw-r--r--doc/howtos/backend/exercise-access-rights6
-rw-r--r--doc/howtos/backend/exercise-basic-action6
-rw-r--r--doc/howtos/backend/exercise-creation4
-rw-r--r--doc/howtos/backend/exercise-dashboard6
-rw-r--r--doc/howtos/backend/exercise-model-inheritance6
-rw-r--r--doc/howtos/backend/exercise-report6
-rw-r--r--doc/howtos/backend/exercise-state-workflow6
-rw-r--r--doc/howtos/themes.rst16
-rw-r--r--doc/howtos/web.rst6
-rw-r--r--doc/howtos/website.rst2
-rw-r--r--doc/howtos/website/basic-acl6
-rw-r--r--doc/howtos/website/course-product6
-rw-r--r--doc/howtos/website/module-empty4
-rw-r--r--doc/howtos/website/product-dependency6
-rw-r--r--doc/howtos/website/teachers-menu6
-rw-r--r--doc/howtos/website/website-support6
-rw-r--r--doc/reference/guidelines.rst2
-rw-r--r--doc/reference/module.rst2
19 files changed, 55 insertions, 55 deletions
diff --git a/doc/howtos/backend.rst b/doc/howtos/backend.rst
index 4904c64618d..b362624a274 100644
--- a/doc/howtos/backend.rst
+++ b/doc/howtos/backend.rst
@@ -303,7 +303,7 @@ action more easily.
#. Create ``openacademy/views/openacademy.xml`` with an action and
the menus triggering the action
- #. Add it to the ``data`` list of ``openacademy/__openerp__.py``
+ #. Add it to the ``data`` list of ``openacademy/__manifest__.py``
.. patch::
@@ -687,7 +687,7 @@ instead of a single view its ``arch`` field is composed of any number of
#. Create a file ``openacademy/partner.py`` and import it in
``__init__.py``
#. Create a file ``openacademy/views/partner.xml`` and add it to
- ``__openerp__.py``
+ ``__manifest__.py``
.. patch::
@@ -1374,7 +1374,7 @@ rights are usually created by a CSV file named after its model:
hold the OpenAcademy Manager group
#. Edit the file ``openacademy/security/ir.model.access.csv`` with
the access rights to the models
- #. Finally update ``openacademy/__openerp__.py`` to add the new data
+ #. Finally update ``openacademy/__manifest__.py`` to add the new data
files to it
.. patch::
@@ -1688,7 +1688,7 @@ Dashboards
.. note:: Available dashboard styles are ``1``, ``1-1``, ``1-2``,
``2-1`` and ``1-1-1``
- #. Update ``openacademy/__openerp__.py`` to reference the new data
+ #. Update ``openacademy/__manifest__.py`` to reference the new data
file
.. patch::
diff --git a/doc/howtos/backend/exercise-access-rights b/doc/howtos/backend/exercise-access-rights
index 552afd72bd6..e653cbadcd5 100644
--- a/doc/howtos/backend/exercise-access-rights
+++ b/doc/howtos/backend/exercise-access-rights
@@ -1,10 +1,10 @@
# HG changeset patch
# Parent 303a5f4f011822dcb42b5833d579eabd3f03f4bf
-Index: addons/openacademy/__openerp__.py
+Index: addons/openacademy/__manifest__.py
===================================================================
---- addons.orig/openacademy/__openerp__.py 2014-08-26 17:26:18.143783102 +0200
-+++ addons/openacademy/__openerp__.py 2014-08-26 17:26:18.135783102 +0200
+--- addons.orig/openacademy/__manifest__.py 2014-08-26 17:26:18.143783102 +0200
++++ addons/openacademy/__manifest__.py 2014-08-26 17:26:18.135783102 +0200
@@ -25,7 +25,8 @@
# always loaded
diff --git a/doc/howtos/backend/exercise-basic-action b/doc/howtos/backend/exercise-basic-action
index ac84e344d6a..f5e5e9be9d5 100644
--- a/doc/howtos/backend/exercise-basic-action
+++ b/doc/howtos/backend/exercise-basic-action
@@ -1,9 +1,9 @@
# HG changeset patch
# Parent 16e4cb131d9f7f3a72a8a1b0bc46c2ce9ac76435
-Index: addons/openacademy/__openerp__.py
+Index: addons/openacademy/__manifest__.py
===================================================================
---- addons.orig/openacademy/__openerp__.py 2014-08-26 17:25:53.519783468 +0200
-+++ addons/openacademy/__openerp__.py 2014-08-26 17:25:53.511783468 +0200
+--- addons.orig/openacademy/__manifest__.py 2014-08-26 17:25:53.519783468 +0200
++++ addons/openacademy/__manifest__.py 2014-08-26 17:25:53.511783468 +0200
@@ -27,6 +27,7 @@
'data': [
# 'security/ir.model.access.csv',
diff --git a/doc/howtos/backend/exercise-creation b/doc/howtos/backend/exercise-creation
index 6325efeb226..80911aa160e 100644
--- a/doc/howtos/backend/exercise-creation
+++ b/doc/howtos/backend/exercise-creation
@@ -1,9 +1,9 @@
# HG changeset patch
# Parent 0000000000000000000000000000000000000000
-Index: addons/openacademy/__openerp__.py
+Index: addons/openacademy/__manifest__.py
===================================================================
--- /dev/null 1970-01-01 00:00:00.000000000 +0000
-+++ addons/openacademy/__openerp__.py 2014-08-26 17:25:49.787783523 +0200
++++ addons/openacademy/__manifest__.py 2014-08-26 17:25:49.787783523 +0200
@@ -0,0 +1,35 @@
+# -*- coding: utf-8 -*-
+{
diff --git a/doc/howtos/backend/exercise-dashboard b/doc/howtos/backend/exercise-dashboard
index bf175edc7d3..b1092479669 100644
--- a/doc/howtos/backend/exercise-dashboard
+++ b/doc/howtos/backend/exercise-dashboard
@@ -1,10 +1,10 @@
# HG changeset patch
# Parent 643813940cbea07bec792f9e1c60022a9292fa90
-Index: addons/openacademy/__openerp__.py
+Index: addons/openacademy/__manifest__.py
===================================================================
---- addons.orig/openacademy/__openerp__.py 2014-08-26 17:26:21.535783052 +0200
-+++ addons/openacademy/__openerp__.py 2014-08-26 17:26:21.531783052 +0200
+--- addons.orig/openacademy/__manifest__.py 2014-08-26 17:26:21.535783052 +0200
++++ addons/openacademy/__manifest__.py 2014-08-26 17:26:21.531783052 +0200
@@ -21,7 +21,7 @@
'version': '0.1',
diff --git a/doc/howtos/backend/exercise-model-inheritance b/doc/howtos/backend/exercise-model-inheritance
index a3529403d55..941ce0442df 100644
--- a/doc/howtos/backend/exercise-model-inheritance
+++ b/doc/howtos/backend/exercise-model-inheritance
@@ -10,10 +10,10 @@ Index: addons/openacademy/__init__.py
from . import controllers
from . import models
+from . import partner
-Index: addons/openacademy/__openerp__.py
+Index: addons/openacademy/__manifest__.py
===================================================================
---- addons.orig/openacademy/__openerp__.py 2014-08-26 17:26:01.227783353 +0200
-+++ addons/openacademy/__openerp__.py 2014-08-26 17:26:01.223783354 +0200
+--- addons.orig/openacademy/__manifest__.py 2014-08-26 17:26:01.227783353 +0200
++++ addons/openacademy/__manifest__.py 2014-08-26 17:26:01.223783354 +0200
@@ -28,6 +28,7 @@
# 'security/ir.model.access.csv',
'templates.xml',
diff --git a/doc/howtos/backend/exercise-report b/doc/howtos/backend/exercise-report
index 43055c7a8db..b06e3fbf6ee 100644
--- a/doc/howtos/backend/exercise-report
+++ b/doc/howtos/backend/exercise-report
@@ -1,10 +1,10 @@
# HG changeset patch
# Parent c140f0a861a08881d8737bca0ffb83904a2059a3
-Index: addons/openacademy/__openerp__.py
+Index: addons/openacademy/__manifest__.py
===================================================================
---- addons.orig/openacademy/__openerp__.py 2014-08-29 08:39:43.975536806 +0200
-+++ addons/openacademy/__openerp__.py 2014-08-29 08:39:52.000000000 +0200
+--- addons.orig/openacademy/__manifest__.py 2014-08-29 08:39:43.975536806 +0200
++++ addons/openacademy/__manifest__.py 2014-08-29 08:39:52.000000000 +0200
@@ -31,6 +31,7 @@
'views/openacademy.xml',
'views/partner.xml',
diff --git a/doc/howtos/backend/exercise-state-workflow b/doc/howtos/backend/exercise-state-workflow
index 062f8b46a6b..6178913d164 100644
--- a/doc/howtos/backend/exercise-state-workflow
+++ b/doc/howtos/backend/exercise-state-workflow
@@ -2,9 +2,9 @@
# Parent c72382bf0c5794135fa318f6ba59899b2277d8c5
# Parent 82f902dbb7aab4d3ddd9caaa9170536afa9d274d
-diff --git a/openacademy/__openerp__.py b/openacademy/__openerp__.py
---- a/openacademy/__openerp__.py
-+++ b/openacademy/__openerp__.py
+diff --git a/openacademy/__manifest__.py b/openacademy/__manifest__.py
+--- a/openacademy/__manifest__.py
++++ b/openacademy/__manifest__.py
@@ -29,6 +29,7 @@
'templates.xml',
'views/openacademy.xml',
diff --git a/doc/howtos/themes.rst b/doc/howtos/themes.rst
index cce149a847f..a3a3b18212f 100644
--- a/doc/howtos/themes.rst
+++ b/doc/howtos/themes.rst
@@ -205,9 +205,9 @@ Odoo’s themes are packaged like modules. Even if you are designing a very simp
Create a folder and name it like this: ``theme_`` followed by your
theme's name.
-``__openerp__.py``
+``__manifest__.py``
Create an empty document and save it to your folder as
- ``__openerp__.py``. This will contain the configuration info for
+ ``__manifest__.py``. This will contain the configuration info for
your theme.
``__init__.py``
@@ -229,10 +229,10 @@ The final result should be something like this:
.. image:: theme_tutorial_assets/img/folder.jpg
-Edit ``__openerp__.py``
+Edit ``__manifest__.py``
-----------------------
-Open the ``__openerp__.py`` you created and copy/paste the following:
+Open the ``__manifest__.py`` you created and copy/paste the following:
.. code-block:: python
@@ -349,7 +349,7 @@ target css rules to that element and avoid these affecting other content on the
The second xpath will add a welcome message just after the navigation menu.
The last step is to add layout.xml to the list of xml files used by
-the theme. To do that, edit your ``__openerp__.py`` file like this
+the theme. To do that, edit your ``__manifest__.py`` file like this
.. code-block:: python
@@ -457,7 +457,7 @@ can fill with snippets. To achieve this, just create a ``div`` with
You can create as many snippet areas as you like and place them anywhere in your pages.
-Our page is almost ready. Now all we have to do is add **pages.xml** in our **__openerp__.py** file
+Our page is almost ready. Now all we have to do is add **pages.xml** in our **__manifest__.py** file
.. code-block:: python
@@ -560,7 +560,7 @@ assets*".
Placing it after the last one, we ensure that our file will
be loaded at the end and take priority.
-Finally add **assets.xml** in your **__openerp__.py** file.
+Finally add **assets.xml** in your **__manifest__.py** file.
Update your theme
@@ -717,7 +717,7 @@ the attribute will automatically be applied to the element.
Since ``select_class`` method avoids multiple selections, the last "empty"
option will reset the snippet to default.
-Add **options.xml** to ``__openerp__.py`` and update your theme.
+Add **options.xml** to ``__manifest__.py`` and update your theme.
.. image:: theme_tutorial_assets/img/restart.png
diff --git a/doc/howtos/web.rst b/doc/howtos/web.rst
index d58091e964e..9c99b02d2ce 100644
--- a/doc/howtos/web.rst
+++ b/doc/howtos/web.rst
@@ -55,7 +55,7 @@ If you browse the ``petstore`` folder, you should see the following content:
| `-- mice.jpg
|-- __init__.py
|-- oepetstore.message_of_the_day.csv
- |-- __openerp__.py
+ |-- __manifest__.py
|-- petstore_data.xml
|-- petstore.py
|-- petstore.xml
@@ -103,7 +103,7 @@ sub-folders are conventional and not strictly necessary.
Which only prints a small message in the browser's console.
-The files in the ``static`` folder, need to be defined within the module in order for them to be loaded correctly. Everything in ``src/xml`` is defined in ``__openerp__.py`` while the contents of ``src/css`` and ``src/js`` are defined in ``petstore.xml``, or a similar file.
+The files in the ``static`` folder, need to be defined within the module in order for them to be loaded correctly. Everything in ``src/xml`` is defined in ``__manifest__.py`` while the contents of ``src/css`` and ``src/js`` are defined in ``petstore.xml``, or a similar file.
.. warning::
@@ -127,7 +127,7 @@ The files in the ``static`` folder, need to be defined within the module in orde
This will reload the web client with optimizations disabled, making
development and debugging significantly more comfortable.
-.. todo:: qweb files hooked via __openerp__.py, but js and CSS use bundles
+.. todo:: qweb files hooked via __manifest__.py, but js and CSS use bundles
Odoo JavaScript Module
======================
diff --git a/doc/howtos/website.rst b/doc/howtos/website.rst
index 00391df0929..43c3a9a998a 100644
--- a/doc/howtos/website.rst
+++ b/doc/howtos/website.rst
@@ -88,7 +88,7 @@ own :ref:`QWeb <reference/qweb>` templating system which integrates with other
features.
Create a template and ensure the template file is registered in the
-``__openerp__.py`` manifest, and alter the controller to use our template:
+``__manifest__.py`` manifest, and alter the controller to use our template:
.. patch::
diff --git a/doc/howtos/website/basic-acl b/doc/howtos/website/basic-acl
index fa2483909e2..c31576ce159 100644
--- a/doc/howtos/website/basic-acl
+++ b/doc/howtos/website/basic-acl
@@ -2,9 +2,9 @@
# Parent 91c0cc5b319e7bf240d359817b8bd044769a4f5c
# Parent 0a9ec16d98785205f25868bc23485569a1444cf3
-diff --git a/academy/__openerp__.py b/academy/__openerp__.py
---- a/academy/__openerp__.py
-+++ b/academy/__openerp__.py
+diff --git a/academy/__manifest__.py b/academy/__manifest__.py
+--- a/academy/__manifest__.py
++++ b/academy/__manifest__.py
@@ -24,7 +24,7 @@
# always loaded
diff --git a/doc/howtos/website/course-product b/doc/howtos/website/course-product
index ce433605baf..b6f9bfedff7 100644
--- a/doc/howtos/website/course-product
+++ b/doc/howtos/website/course-product
@@ -2,9 +2,9 @@
# Parent 2ee7212e5de4702dff08d9b5e4268e7dc261d038
# Parent 4ca7b848bb60c3573de7ed41a28b4b65186a5725
-diff --git a/academy/__openerp__.py b/academy/__openerp__.py
---- a/academy/__openerp__.py
-+++ b/academy/__openerp__.py
+diff --git a/academy/__manifest__.py b/academy/__manifest__.py
+--- a/academy/__manifest__.py
++++ b/academy/__manifest__.py
@@ -27,6 +27,7 @@
'security/ir.model.access.csv',
'templates.xml',
diff --git a/doc/howtos/website/module-empty b/doc/howtos/website/module-empty
index 744dc7c9ab5..8a144e05d09 100644
--- a/doc/howtos/website/module-empty
+++ b/doc/howtos/website/module-empty
@@ -10,10 +10,10 @@ new file mode 100644
+# -*- coding: utf-8 -*-
+import controllers
+import models
-diff --git a/academy/__openerp__.py b/academy/__openerp__.py
+diff --git a/academy/__manifest__.py b/academy/__manifest__.py
new file mode 100644
--- /dev/null
-+++ b/academy/__openerp__.py
++++ b/academy/__manifest__.py
@@ -0,0 +1,34 @@
+# -*- coding: utf-8 -*-
+{
diff --git a/doc/howtos/website/product-dependency b/doc/howtos/website/product-dependency
index 1998b876984..e835628a16d 100644
--- a/doc/howtos/website/product-dependency
+++ b/doc/howtos/website/product-dependency
@@ -2,9 +2,9 @@
# Parent 6106208621f01d5aea67727f09adf5c5b2a38642
# Parent ae97cfb61fd0e1a47727a9d8ed4a702116254eff
-diff --git a/academy/__openerp__.py b/academy/__openerp__.py
---- a/academy/__openerp__.py
-+++ b/academy/__openerp__.py
+diff --git a/academy/__manifest__.py b/academy/__manifest__.py
+--- a/academy/__manifest__.py
++++ b/academy/__manifest__.py
@@ -20,7 +20,7 @@
'version': '0.1',
diff --git a/doc/howtos/website/teachers-menu b/doc/howtos/website/teachers-menu
index da659bde1ba..27fd53b09aa 100644
--- a/doc/howtos/website/teachers-menu
+++ b/doc/howtos/website/teachers-menu
@@ -2,9 +2,9 @@
# Parent c8cc9e66a2701dad6589ff1d950e1cb7738d0854
# Parent 44a09b8865d418cda8b7c46dfb70fadc86e22184
-diff --git a/academy/__openerp__.py b/academy/__openerp__.py
---- a/academy/__openerp__.py
-+++ b/academy/__openerp__.py
+diff --git a/academy/__manifest__.py b/academy/__manifest__.py
+--- a/academy/__manifest__.py
++++ b/academy/__manifest__.py
@@ -26,6 +26,7 @@
'data': [
'security/ir.model.access.csv',
diff --git a/doc/howtos/website/website-support b/doc/howtos/website/website-support
index 33b401c0144..c3deb4f6896 100644
--- a/doc/howtos/website/website-support
+++ b/doc/howtos/website/website-support
@@ -2,9 +2,9 @@
# Parent 7ae0db4c2ddf5d0f7f58db2af8976fcec905cc4e
# Parent 06f959831b14dd5d2e0a57d3e14bf919e18f8e3a
-diff --git a/academy/__openerp__.py b/academy/__openerp__.py
---- a/academy/__openerp__.py
-+++ b/academy/__openerp__.py
+diff --git a/academy/__manifest__.py b/academy/__manifest__.py
+--- a/academy/__manifest__.py
++++ b/academy/__manifest__.py
@@ -20,7 +20,7 @@
'version': '0.1',
diff --git a/doc/reference/guidelines.rst b/doc/reference/guidelines.rst
index 5ae52963b42..8a1831c469d 100644
--- a/doc/reference/guidelines.rst
+++ b/doc/reference/guidelines.rst
@@ -95,7 +95,7 @@ The complete tree should look like
addons/<my_module_name>/
|-- __init__.py
- |-- __openerp__.py
+ |-- __manifest__.py
|-- controllers/
| |-- __init__.py
| |-- <inherited_module_name>.py
diff --git a/doc/reference/module.rst b/doc/reference/module.rst
index d4ce37a1862..010e10e2095 100644
--- a/doc/reference/module.rst
+++ b/doc/reference/module.rst
@@ -14,7 +14,7 @@ Manifest
The manifest file serves to declare a python package as an Odoo module
and to specify module metadata.
-It is a file called ``__openerp__.py`` and contains a single Python
+It is a file called ``__manifest__.py`` and contains a single Python
dictionary, where each key specifies module metadatum.
::