This is an automated email from the ASF dual-hosted git repository.
rabbah pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/openwhisk-runtime-go.git
The following commit(s) were added to refs/heads/master by this push:
new 73ac36c Update ENVVARS.md (#140)
73ac36c is described below
commit 73ac36cf021c6ef333b6399ed430a196b1cc495c
Author: rodric rabbah <[email protected]>
AuthorDate: Wed Feb 24 09:06:16 2021 -0500
Update ENVVARS.md (#140)
---
docs/ENVVARS.md | 20 ++++++++------------
1 file changed, 8 insertions(+), 12 deletions(-)
diff --git a/docs/ENVVARS.md b/docs/ENVVARS.md
index 22210b1..5c6c072 100644
--- a/docs/ENVVARS.md
+++ b/docs/ENVVARS.md
@@ -19,32 +19,28 @@
# Environment Variables
-## Enviroment variables that control behaviour of the proxy
+## Environment variables that control the behavior of the proxy
The following variables are usually set in the Dockerfile
`OW_COMPILER` points to the compiler script to use to compile actions.
-`OW_SAVE_JAR` enables checking that an upload file is a jar (that is itself a
zip file) and it will not expand it if there is a subdirectory names "META-INF"
(so it is a jar file). Used to support uploading of Java jars.
+`OW_SAVE_JAR` enables checking that an uploaded file is a jar (that is itself
a zip file) and it will not expand it if there is a subdirectory named
"META-INF" (so it is a jar file). Used to support uploading of Java jars.
-`OW_WAIT_FOR_ACK` enables waiting for an acknowledgement in the actionloop
protocol. It should be enabled in all the newer runtimes. Do not enable in
existing runtimes as it would break existing actions built for that runtime.
+`OW_WAIT_FOR_ACK` enables waiting for an acknowledgment in the action loop
protocol. It should be enabled in all the newer runtimes. Do not enable in
existing runtimes as it would break existing actions built for that runtime.
-`OW_EXECUTION_ENV` enables detection and verification of the compilation
environent. The compiler is expected to create a file named `exec.env` in the
same folder as the `exec` file to be run. If this variable is set, before
starting an action, the init will check that the content of the `exec.env`,
trimmed of spaces and new lines, is the same, to ensure an action is executed
in the right execution environment.
+`OW_EXECUTION_ENV` enables detection and verification of the compilation
environment. The compiler is expected to create a file named `exec.env` in the
same folder as the `exec` file to be run. If this variable is set, before
starting an action, the initialization will check that the content of the
`exec.env`, trimmed of spaces and new lines, is the same, to ensure an action
is executed in the right execution environment.
-`OW_LOG_INIT_ERROR` enables logging of compilation error; the default
behaviour is to return errors in the answer of the init.
+`OW_LOG_INIT_ERROR` enables logging of compilation error; the default behavior
is to return errors in the result from initialization.
## Environment variables propagated to actions and to the compilation script
The proxy itself sets the following environment variables:
-`__OW_EXECUTION_ENV` is the same value that the proxy receive as
`OW_EXECUTION_ENV`
+`__OW_EXECUTION_ENV` is the same value that the proxy receives as
`OW_EXECUTION_ENV`
`__OW_WAIT_FOR_ACK` is set if the proxy has the variable `OW_WAIT_FOR_ACK` set.
-Any other environment variable set in the Dockerfile that starts with `__OW_`
are propagated to the proxy and can override also the values set by the proxy.
-
-Furthermore, actions receive their own environment variables and the values
set overrides the variables set from the proxy and in the environment.
-
-
-
+Any other environment variables set in the Dockerfile that start with `__OW_`
are propagated to the proxy and can override the values set by the proxy.
+Furthermore, actions receive their own environment variables and such values
override the variables set from the proxy and in the environment.
