Commit 39db0580 authored by Michal Čihař's avatar Michal Čihař

Document usage of system() (issue #221)

parent 23053995
...@@ -245,6 +245,9 @@ Before using any scripts, you need to list them in ...@@ -245,6 +245,9 @@ Before using any scripts, you need to list them in
:setting:`PRE_COMMIT_SCRIPTS` configuration variable. Then you can enable them :setting:`PRE_COMMIT_SCRIPTS` configuration variable. Then you can enable them
at :ref:`subproject` configuration as :guilabel:`Pre commit script`. at :ref:`subproject` configuration as :guilabel:`Pre commit script`.
The hook script is executed using system() call, so it is evaluated in a shell.
It is passed single parameter consisting of file name of current translation.
The script can also generate additional file to be included in the commit. This The script can also generate additional file to be included in the commit. This
can be configured as :guilabel:`Extra commit file` at :ref:`subproject` can be configured as :guilabel:`Extra commit file` at :ref:`subproject`
configuration. You can use following format strings in the filename: configuration. You can use following format strings in the filename:
......
...@@ -228,6 +228,10 @@ For example you can allow script which does some cleanup: ...@@ -228,6 +228,10 @@ For example you can allow script which does some cleanup:
'/usr/local/bin/cleanup-translation', '/usr/local/bin/cleanup-translation',
) )
.. note::
The hook is executed using system() call, so it is evaluated in a shell.
.. seealso:: :ref:`processing` .. seealso:: :ref:`processing`
.. setting:: REGISTRATION_OPEN .. setting:: REGISTRATION_OPEN
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment