Mercurial > hg > nginx-site
changeset 2405:dbf68c949522
Documented the "process" global object.
author | Yaroslav Zhuravlev <yar@nginx.com> |
---|---|
date | Wed, 03 Jul 2019 20:16:49 +0300 |
parents | 65961cddec7c |
children | e79e32d19ae4 |
files | xml/en/docs/njs/changes.xml xml/en/docs/njs/compatibility.xml xml/en/docs/njs/reference.xml xml/index.xml xml/ru/docs/njs/compatibility.xml xml/ru/docs/njs/reference.xml |
diffstat | 6 files changed, 136 insertions(+), 6 deletions(-) [+] |
line wrap: on
line diff
--- a/xml/en/docs/njs/changes.xml Fri Jun 28 07:48:34 2019 +0000 +++ b/xml/en/docs/njs/changes.xml Wed Jul 03 20:16:49 2019 +0300 @@ -9,7 +9,7 @@ <article name="Changes" link="/en/docs/njs/changes.html" lang="en" - rev="20" + rev="21" toc="no"> <section id="njs0.3.3" name="Changes with 0.3.3"> @@ -72,7 +72,9 @@ <listitem> <para> Feature: -added “process” global object. +added +<link doc="reference.xml" id="global_process"><literal>process</literal></link> +global object. </para> </listitem>
--- a/xml/en/docs/njs/compatibility.xml Fri Jun 28 07:48:34 2019 +0000 +++ b/xml/en/docs/njs/compatibility.xml Wed Jul 03 20:16:49 2019 +0300 @@ -9,7 +9,7 @@ <article name="Compatibility" link="/en/docs/njs/compatibility.html" lang="en" - rev="16" + rev="17" toc="no"> <section> @@ -515,6 +515,19 @@ (<link doc="changes.xml" id="njs0.3.2">0.3.2</link>) </listitem> +<listitem> +Global objects +(<link doc="changes.xml" id="njs0.3.3">0.3.3</link>): +<list type="bullet"> + +<listitem> +<link doc="reference.xml" id="process"><literal>process</literal></link> +</listitem> + +</list> +</listitem> + + </list> </para>
--- a/xml/en/docs/njs/reference.xml Fri Jun 28 07:48:34 2019 +0000 +++ b/xml/en/docs/njs/reference.xml Wed Jul 03 20:16:49 2019 +0300 @@ -9,7 +9,7 @@ <article name="Reference" link="/en/docs/njs/reference.html" lang="en" - rev="28"> + rev="29"> <section id="summary"> @@ -371,6 +371,56 @@ <section id="core" name="Core"> +<section id="core_global" name="Global"> + + +<section id="process" name="Process"> + +<para> +The <literal>process</literal> object is a global object +that provides information about the current process +(<link doc="changes.xml" id="njs0.3.3">0.3.3</link>). +</para> + + +<para> +<list type="tag"> + +<tag-name id="process_argv"><literal>process.argv</literal></tag-name> +<tag-desc> +Returns an array that contains the command line arguments +passed when the current process was launched. +</tag-desc> + +<tag-name id="process_env"><literal>process.env</literal></tag-name> +<tag-desc> +Returns an object containing the user environment. +<note> +By default, nginx removes all environment variables inherited +from its parent process except the TZ variable. +Use the <link doc="../ngx_core_module.xml" id="env"/> directive +to preserve some of the inherited variables. +</note> +</tag-desc> + +<tag-name id="process_pid"><literal>process.pid</literal></tag-name> +<tag-desc> +Returns the PID of the current process. +</tag-desc> + +<tag-name id="process_ppid"><literal>process.ppid</literal></tag-name> +<tag-desc> +Returns the PID of the current parent process. +</tag-desc> + +</list> +</para> + +</section> + +</section> + + <section id="core_object" name="Object"> <para>
--- a/xml/index.xml Fri Jun 28 07:48:34 2019 +0000 +++ b/xml/index.xml Wed Jul 03 20:16:49 2019 +0300 @@ -17,7 +17,9 @@ <event date="2019-06-25"> <para> <link doc="en/docs/njs/index.xml">njs-0.3.3</link> -version has been released, featuring “process” global object +version has been released, featuring +<link doc="en/docs/njs/reference.xml" id="process">process</link> +global object and <link doc="en/docs/njs/changes.xml" id="njs0.3.3">more</link>. </para> </event>
--- a/xml/ru/docs/njs/compatibility.xml Fri Jun 28 07:48:34 2019 +0000 +++ b/xml/ru/docs/njs/compatibility.xml Wed Jul 03 20:16:49 2019 +0300 @@ -9,7 +9,7 @@ <article name="Совместимость" link="/ru/docs/njs/compatibility.html" lang="ru" - rev="16" + rev="17" toc="no"> <section> @@ -494,6 +494,19 @@ (<link doc="changes.xml" id="njs0.3.2">0.3.2</link>) </listitem> +<listitem> +Глобальные объекты +(<link doc="changes.xml" id="njs0.3.3">0.3.3</link>): +<list type="bullet"> + +<listitem> +<link doc="reference.xml" id="process"><literal>process</literal></link> +</listitem> + +</list> +</listitem> + + </list> </para>
--- a/xml/ru/docs/njs/reference.xml Fri Jun 28 07:48:34 2019 +0000 +++ b/xml/ru/docs/njs/reference.xml Wed Jul 03 20:16:49 2019 +0300 @@ -384,6 +384,56 @@ <section id="core" name="Core"> +<section id="core_global" name="Global"> + + +<section id="process" name="Process"> + +<para> +Объект <literal>process</literal> является глобальным объектом, +предоставляющим информацию о текущем процессе +(<link doc="changes.xml" id="njs0.3.3">0.3.3</link>). +</para> + + +<para> +<list type="tag"> + +<tag-name id="process_argv"><literal>process.argv</literal></tag-name> +<tag-desc> +Возвращает массив, содержащий аргументы командной строки, +передаваемые в момент запуска текущего процесса. +</tag-desc> + +<tag-name id="process_env"><literal>process.env</literal></tag-name> +<tag-desc> +Возвращает объект, содержащий переменные окружения пользователя. +<note> +По умолчанию nginx удаляет все переменные окружения, унаследованные +от своего родительского процесса, кроме переменной TZ. +Для сохранения части унаследованных переменных +необходимо использовать директиву <link doc="../ngx_core_module.xml" id="env"/>. +</note> +</tag-desc> + +<tag-name id="process_pid"><literal>process.pid</literal></tag-name> +<tag-desc> +Возвращает PID текущего процесса. +</tag-desc> + +<tag-name id="process_ppid"><literal>process.ppid</literal></tag-name> +<tag-desc> +Возвращает PID текущего родительского процесса. +</tag-desc> + +</list> +</para> + +</section> + +</section> + + <section id="string" name="Строка"> <para>