diff --git a/README.md b/README.md index 65882ac..8cab272 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ # odoo-openupgrade-wizard -Odoo Openupgrade Wizard is a tool that helps developpers to make major +Odoo Openupgrade Wizard is a tool that helps developers to make major upgrade of Odoo Community Edition. (formely OpenERP). It works with Openupgrade OCA tools. (https://github.com/oca/openupgrade) @@ -130,7 +130,7 @@ modules.csv * ``log`` folder will contains all the log of the ``odoo-openupgrade-wizard`` and the logs of the odoo instance that will be executed. -* ``filestore`` folder will contains the filestore of the odoo database(s) +* ``filestore`` folder will contains the filestore of the odoo database(s). * ``postgres_data`` folder will be used by postgres docker image to store database. @@ -151,12 +151,12 @@ modules.csv Repo files are pre-generated. You can update them with your custom settings. (custom branches, extra PRs, git shallow options, etc...) - - ``extra_python_requirements.txt`` enumerates the list of extra python librairies + - ``extra_python_requirements.txt`` enumerates the list of extra python libraries required to run the odoo instance. The syntax should respect the ``pip install -r`` command. (See : https://pip.pypa.io/en/stable/reference/requirements-file-format/) - - ``extra_debian_requirements.txt`` enumerates the list of extra system librairies + - ``extra_debian_requirements.txt`` enumerates the list of extra system libraries required to run the odoo instance. - ``odoo.conf`` file. Add here extra configuration required for your custom modules. @@ -170,7 +170,7 @@ extra repositories, or dependencies... **Note:** - In your repos.yml, preserve ``openupgrade`` and ``server-tools`` repositories - to have all the features of the librairies available. + to have all the features of the libraries available. - In your repos.yml file, the odoo project should be in ``./src/odoo`` and the openupgrade project should be in ``./src/openupgrade/`` folder. @@ -181,7 +181,7 @@ extra repositories, or dependencies... **Prerequites:** init + being in a git repository. (if not, you can simply run ``git init``) if you already have a repos.yml file on github / gitlab, it can be convenient to -synchronize the repository, instead of copy past the ``repos.yml`` manually. +synchronize the repository, instead of copy paste the ``repos.yml`` manually. In that case, you can add extra values, in the ``config.yml`` file in the section @@ -242,7 +242,7 @@ For each module and each version, this command tries to parse the according ``__manifest__.py`` file (and, if possible the according ``setup.py`` file). Finally, it overwrite the requirements.txt files present in each env folder. (python and debian requirements). -For exemple, here is the content of the ``addons_python_requirements.txt`` file, +For example, here is the content of the ``addons_python_requirements.txt`` file, when ``barcodes_generator_abstract`` and ``l10n_fr_siret`` are installed (for V16). ``` @@ -259,9 +259,13 @@ python-stdnum>=1.18 **Prerequites:** init + get-code +```shell +odoo-openupgrade-wizard docker-build +``` + This will build local docker images that will be used in the following steps. -At this end of this step executing the following command should show a docker image per version. +At the end of this step executing the following command should show a docker image per version. ```shell @@ -375,10 +379,10 @@ odoo-openupgrade-wizard generate-module-analysis\ --modules MODULE_LIST ``` -Realize an analyze between the target version (in parameter via the step argument) +Realize an analysis between the target version (in parameter via the step argument) and the previous version. It will generate analysis_file.txt files present in OpenUpgrade project. -You can also use this fonction to analyze differences for custom / OCA modules +You can also use this function to analyze differences for custom / OCA modules between several versions, in case of refactoring. @@ -414,7 +418,7 @@ Execute an SQL Request on the target database. **Optional arguments** -* If no ``database`` is provided, default ``postgres`` database will be used. exemple: +* If no ``database`` is provided, default ``postgres`` database will be used. example: ```shell odoo-openupgrade-wizard psql --command "\l"; @@ -524,7 +528,7 @@ For example, the project path is `/path/to/myproject` (where you run the **Optional arguments** -* To chose the database format use `--database-format`. Format can be +* To choose the database format use `--database-format`. Format can be one of the following: - `p` for plain sql text - `c` for custom compressed backup of `pg_dump` @@ -533,7 +537,7 @@ For example, the project path is `/path/to/myproject` (where you run the See also https://www.postgresql.org/docs/current/app-pgdump.html The default database format is `c`. -* To chose the filestore format use `--filestore-format`. Format can be +* To choose the filestore format use `--filestore-format`. Format can be one of the following: - `d` copy of the directory structure - `t` tar version of the directory structure (not compressed)