-
Notifications
You must be signed in to change notification settings - Fork 32
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
136 additions
and
47 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,47 +1,136 @@ | ||
| GLPI dev tools | ||
| ============== | ||
|
|
||
| Differents tools are available on the tools folder. | ||
| You can found here some documentation about them. | ||
|
|
||
| * locale\extract_template.sh : | ||
| * locale\move_to_po.php : | ||
| * locale\update_mo.pl : | ||
| * locale\update_po.pl : | ||
| * HEADER : copyright header file (should be used with modify_headers.pl) | ||
| * autoupdatelocales.sh : Probably obsolete | ||
| * check_dict.pl : | ||
| * check_functions.pl : | ||
| * checkforms.php : Check forms opened / closed | ||
| * checkfunction.php : Check for obsolete function usage | ||
| * cleanhistory.php : Purge history with some criteria | ||
| * cliinstall.php : GLPI install using PHP cli | ||
| * cliupdate.php : GLPI update using PHP cli | ||
| * convert_search_options.php : An utility script to convert old getSearchOptions array to new ones #1396 | ||
| * diff_plugin_locale.php : Probably obsolete | ||
| * find_twin_in_dict.sh : Check duplicates key in language template | ||
| * findtableswithoutclass.php : | ||
| * fix_utf8_bomfiles.sh : | ||
| * fk_generate.php : | ||
| * genapidoc.sh : Generate GLPI phpdoc using apigen | ||
| * generate_bigdump.php & generate_bigdump.function.php : generate and populate a complete glpi DB | ||
| * genphpcov.sh : | ||
| * getsearchoptions.php : | ||
| * glpiuser.php : | ||
| * ldap-glpi.ldif : An LDAP export | ||
| * ldap-schema.txt : An LDAP export | ||
| * ldapsync.php : | ||
| * make_release.sh : Script for making an GLPI release tarball | ||
| * modify_headers.pl : Update copyright header (use HEADER file) | ||
| * notincludedlanguages.php : Get all po files not used in GLPI | ||
| * php.vim : Probably obsolete | ||
| * test_langfiles.php : | ||
| * testmail.php : | ||
| * testunit.php : | ||
| * update_registered_ids.php : Purge history with some criteria | ||
|
|
||
|
|
||
| Old tools | ||
| ^^^^^^^^^ | ||
| These files aren't any longer used, but are still on the tools folder actually | ||
| * phpunit\* : tests | ||
| Tools | ||
| ===== | ||
|
|
||
| Differents tools are available on the ``tools`` folder; here is an non exhaustive list of provided features. | ||
|
|
||
| locale/ | ||
| ------- | ||
|
|
||
| The locale directory contains several scripts used to maintain :doc:`translations <translations>` along with Transifex services: | ||
|
|
||
| * ``extract_template.sh`` is used to extract translated string to the POT file (before sending it to Transifex), | ||
| * ``locale\update_mo.pl`` compiles MO files from PO file (after they've been updated from transifex). | ||
|
|
||
| cliinstall.php | ||
| -------------- | ||
|
|
||
| Installs a GLPI database from command line. | ||
|
|
||
| You have to specify both user and database name at last, using ``--user`` and ``--db`` parameters. | ||
|
|
||
| You can also add extra parameters: | ||
|
|
||
| * ``--host`` let you specify database host. It defaults to `localhost`, | ||
| * ``--pass`` let you specify database user's password. It defaults to no password, | ||
| * ``--lang`` let you specify language that will be used. It defaults to ``en_GB``, | ||
| * ``--tests`` | ||
| * ``--force`` will force the installation even if database is already populated, **all existing data will be lost**. | ||
|
|
||
| You can get the usage by simply calling the script: | ||
|
|
||
| .. code-block:: bash | ||
| $ php tools/cliinstall.php | ||
| usage: tools/cliinstall.php [ --host=<dbhost> ] --db=<dbname> --user=<dbuser> [ --pass=<dbpassword> ] [ --lang=xx_XX] [ --tests ] [ --force ] | ||
| cliupdate.php | ||
| ------------- | ||
|
|
||
| Let you update your GLPI database from command line. The script does not take any argument, just call it and you're done: | ||
|
|
||
| .. code-block:: bash | ||
| $ php tools/cliupdate.php | ||
| Current GLPI Data version: 9.2 | ||
| Current GLPI Code version: 9.2 | ||
| Default GLPI Language: en_GB | ||
| No migration needed. | ||
| genapidoc.sh | ||
| ------------ | ||
|
|
||
| Generate GLPI phpdoc using `apigen <http://www.apigen.org/>`_. ``apigen`` command must be available in your path. | ||
|
|
||
| Generated documentation will be available in the ``api`` directory. Note that you can also look at the `online version <https://forge.glpi-project.org/apidoc/>`_. | ||
|
|
||
| convert_search_options.php | ||
| -------------------------- | ||
|
|
||
| Search options have changed in GLPI 9.2 (see `PR #1396 <https://github.com/glpi-project/glpi/issues/1396>`_). This script is a helper to convert existing search options to new way. | ||
|
|
||
| .. note:: | ||
|
|
||
| The script output can probably **not be used as is**; but it would probably help you a lot! | ||
|
|
||
| make_release.sh | ||
| --------------- | ||
|
|
||
| Builds GLPI release tarball: | ||
|
|
||
| * install and cleanup third party libraries, | ||
| * remove files and directories that should not be part of tarball, | ||
| * minify CSS an Javascript files, | ||
| * ... | ||
|
|
||
| modify_headers.pl | ||
| ----------------- | ||
|
|
||
| Update copyright header based on the contents of the ``HEADER`` file. | ||
|
|
||
| getsearchoptions.php | ||
| -------------------- | ||
|
|
||
| This script is designed to be called from a browser, not from the command line. It will display existing search options for an item specified with the ``type`` argument. | ||
|
|
||
| For example, open ``http://localhost/glpi/tools/getsearchoptions.php?type=Computer``, and you will see search options for `Computer` type. | ||
|
|
||
| Not yet documented... | ||
| --------------------- | ||
|
|
||
| .. note:: | ||
|
|
||
| Following scripts are not yet documented... Feel free to open a pull request to add them! | ||
|
|
||
| * autoupdatelocales.sh: Probably obsolete | ||
| * check_dict.pl | ||
| * check_functions.pl | ||
| * checkforms.php: Check forms opened / closed | ||
| * checkfunction.php: Check for obsolete function usage | ||
| * cleanhistory.php: Purge history with some criteria | ||
| * diff_plugin_locale.php: Probably obsolete | ||
| * find_twin_in_dict.sh: Check duplicates key in language template | ||
| * findtableswithoutclass.php | ||
| * fix_utf8_bomfiles.sh | ||
| * fk_generate.php | ||
| * genphpcov.sh | ||
| * glpiuser.php | ||
| * ldap-glpi.ldif: An LDAP export | ||
| * ldap-schema.txt: An LDAP export | ||
| * ldapsync.php | ||
| * notincludedlanguages.php: Get all po files not used in GLPI | ||
| * test_langfiles.php | ||
| * testmail.php | ||
| * testunit.php | ||
| * update_registered_ids.php: Purge history with some criteria | ||
|
|
||
| Out of date | ||
| ----------- | ||
|
|
||
| .. warning:: | ||
|
|
||
| Those tools are outdated, and kept for reference, or need some work to be working again. Use them at your own risks, or do not use them at all :) | ||
|
|
||
| phpunit/ | ||
| ^^^^^^^^ | ||
|
|
||
| This directory contains a set of unit tests that have not really been integrated in the project. Since, some unit tests have been rewritten, but not everything has been ported :/ | ||
|
|
||
| php.vim | ||
| ^^^^^^^ | ||
|
|
||
| A vimfile for autocompletion and highlithing in VIM. This one is very outaded; it should be replaced with a most recent version, or being removed. | ||
|
|
||
| generate_bigdump.php | ||
| ^^^^^^^^^^^^^^^^^^^^ | ||
|
|
||
| This script is designed to generate many data in your GLPI instance. It relies on the ``generate_bigdump.function.php`` file. |