NextERP/documentation
5
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[IMP] developer/modules: deprecate 'active' and detail 'auto_install'

Browse Source 
1. `active` is just a deprecated field that means exactly the same as
   `auto_install`.
2. `auto_install` can be a list.

See 6cb3140ea8/odoo/modules/module.py (L348-L352)

Original PR: https://github.com/odoo/documentation/pull/1109

closes odoo/documentation#1427

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: Antoine Vandevenne (anv) <anv@odoo.com>
This commit is contained in:
Jairo Llopis 2021-08-24 07:00:13 +00:00 committed by Antoine Vandevenne (anv)
parent beb92c9f18
commit 03a54e5b37
1 changed files with 11 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
content/developer/reference/addons/module.rst
View File

@ -85,17 +85,24 @@ Available manifest fields are:
``demo`` (``list(str)``)
List of data files which are only installed or updated in *demonstration
mode*
``auto_install`` (``bool``, default: ``False``)
``auto_install`` (``bool`` or ``list(str)``, default: ``False``)
If ``True``, this module will automatically be installed if all of its
dependencies are installed.
It is generally used for "link modules" implementing synergic integration
It is generally used for "link modules" implementing synergetic integration
between two otherwise independent modules.
For instance ``sale_crm`` depends on both ``sale`` and ``crm`` and is set
to ``auto_install``. When both ``sale`` and ``crm`` are installed, it
automatically adds CRM campaigns tracking to sale orders without either
``sale`` or ``crm`` being aware of one another
``sale`` or ``crm`` being aware of one another.
If it is a list, it must contain a subset of the dependencies. This module will automatically be
installed as soon as all the dependencies in the subset are installed. The remaining
dependencies will be automatically installed as well. If the list is empty, this module will
always be automatically installed regardless of its dependencies and these will be installed as
well.
``external_dependencies`` (``dict(key=list(str))``)
A dictionary containing python and/or binary dependencies.
@ -140,7 +147,7 @@ Available manifest fields are:
These hooks should only be used when setup/cleanup required for this module
is either extremely difficult or impossible through the api.
``active`` (``bool``)
This indicates whether this module must install automatically or not.
Deprecated. Replaced by ``auto_install``.
.. _semantic versioning: https://semver.org
.. _existing categories: