Confusing docs on python.archives

[Yik San Chan]

Hi community,

In https://ci.apache.org/projects/flink/flink-docs-stable/dev/python/python_config.html#python-options,

> For each archive file, a target directory is specified. If the target directory name is specified, the archive file will be extracted to a name can directory with the specified name. Otherwise, the archive file will be extracted to a directory with the same name of the archive file.

I don't get what does "the archive file will be extracted to a name can directory with the specified name" mean. Maybe there are typos?

best,

Yik San

[Dian Fu]

Hi Yik San,

It should be a typo issue. I guess it should be `If the target directory name is specified, the archive file will be extracted to a directory with the specified name.`

Regards,

Dian

2021年4月26日 下午8:57，Yik San Chan <[hidden email]> 写道：

Hi community,

In https://ci.apache.org/projects/flink/flink-docs-stable/dev/python/python_config.html#python-options,

> For each archive file, a target directory is specified. If the target directory name is specified, the archive file will be extracted to a name can directory with the specified name. Otherwise, the archive file will be extracted to a directory with the same name of the archive file.

I don't get what does "the archive file will be extracted to a name can directory with the specified name" mean. Maybe there are typos?

best,

Yik San

[Yik San Chan]

Hi Dian,

I wonder where can we specify the target directory?

Best,

Yik San

On Mon, Apr 26, 2021 at 9:19 PM Dian Fu <[hidden email]> wrote:

Hi Yik San,

It should be a typo issue. I guess it should be `If the target directory name is specified, the archive file will be extracted to a directory with the specified name.`

Regards,

Dian

2021年4月26日 下午8:57，Yik San Chan <[hidden email]> 写道：

Hi community,

In https://ci.apache.org/projects/flink/flink-docs-stable/dev/python/python_config.html#python-options,

> For each archive file, a target directory is specified. If the target directory name is specified, the archive file will be extracted to a name can directory with the specified name. Otherwise, the archive file will be extracted to a directory with the same name of the archive file.

I don't get what does "the archive file will be extracted to a name can directory with the specified name" mean. Maybe there are typos?

best,

Yik San

[Dian Fu]

There are multiple ways to specify the target directory depending on how to specify the python archives.

1) API: add_python_archive(“file:///path/to/py_env.zip", "myenv"), see [1] for more details, 

2) configuration: python.archives, e.g. file:///path/to/py_env.zip#myenv

3) command line arguments: -pyarch file:///path/to/py_env.zip#myenv

You can specify python archives via either of the above options and it will extract py_env.zip into directory myenv during execution.

[1] https://ci.apache.org/projects/flink/flink-docs-release-1.12/dev/python/table-api-users-guide/dependency_management.html

2021年4月27日 上午8:17，Yik San Chan <[hidden email]> 写道：

Hi Dian,

I wonder where can we specify the target directory?

Best,

Yik San

On Mon, Apr 26, 2021 at 9:19 PM Dian Fu <[hidden email]> wrote:

Hi Yik San,

It should be a typo issue. I guess it should be `If the target directory name is specified, the archive file will be extracted to a directory with the specified name.`

Regards,

Dian

2021年4月26日 下午8:57，Yik San Chan <[hidden email]> 写道：

Hi community,

In https://ci.apache.org/projects/flink/flink-docs-stable/dev/python/python_config.html#python-options,

> For each archive file, a target directory is specified. If the target directory name is specified, the archive file will be extracted to a name can directory with the specified name. Otherwise, the archive file will be extracted to a directory with the same name of the archive file.

I don't get what does "the archive file will be extracted to a name can directory with the specified name" mean. Maybe there are typos?

best,

Yik San

[Dian Fu]

For the command line arguments, it’s documented in https://ci.apache.org/projects/flink/flink-docs-release-1.11/ops/cli.html

2021年4月27日 上午10:19，Dian Fu <[hidden email]> 写道：

There are multiple ways to specify the target directory depending on how to specify the python archives.

1) API: add_python_archive(“file:///path/to/py_env.zip", "myenv"), see [1] for more details, 

2) configuration: python.archives, e.g. file:///path/to/py_env.zip#myenv

3) command line arguments: -pyarch file:///path/to/py_env.zip#myenv

You can specify python archives via either of the above options and it will extract py_env.zip into directory myenv during execution.

[1] https://ci.apache.org/projects/flink/flink-docs-release-1.12/dev/python/table-api-users-guide/dependency_management.html

2021年4月27日 上午8:17，Yik San Chan <[hidden email]> 写道：

Hi Dian,

I wonder where can we specify the target directory?

Best,

Yik San

On Mon, Apr 26, 2021 at 9:19 PM Dian Fu <[hidden email]> wrote:

Hi Yik San,

It should be a typo issue. I guess it should be `If the target directory name is specified, the archive file will be extracted to a directory with the specified name.`

Regards,

Dian

2021年4月26日 下午8:57，Yik San Chan <[hidden email]> 写道：

Hi community,

In https://ci.apache.org/projects/flink/flink-docs-stable/dev/python/python_config.html#python-options,

> For each archive file, a target directory is specified. If the target directory name is specified, the archive file will be extracted to a name can directory with the specified name. Otherwise, the archive file will be extracted to a directory with the same name of the archive file.

I don't get what does "the archive file will be extracted to a name can directory with the specified name" mean. Maybe there are typos?

best,

Yik San

[Yik San Chan]

Hi Dian,

As a follow-up, I fix the docs here https://github.com/apache/flink/pull/15783

Best,

Yik San

On Tue, Apr 27, 2021 at 10:20 AM Dian Fu <[hidden email]> wrote:

For the command line arguments, it’s documented in https://ci.apache.org/projects/flink/flink-docs-release-1.11/ops/cli.html

2021年4月27日 上午10:19，Dian Fu <[hidden email]> 写道：

There are multiple ways to specify the target directory depending on how to specify the python archives.

1) API: add_python_archive(“file:///path/to/py_env.zip", "myenv"), see [1] for more details, 

2) configuration: python.archives, e.g. file:///path/to/py_env.zip#myenv

3) command line arguments: -pyarch file:///path/to/py_env.zip#myenv

You can specify python archives via either of the above options and it will extract py_env.zip into directory myenv during execution.

[1] https://ci.apache.org/projects/flink/flink-docs-release-1.12/dev/python/table-api-users-guide/dependency_management.html

2021年4月27日 上午8:17，Yik San Chan <[hidden email]> 写道：

Hi Dian,

I wonder where can we specify the target directory?

Best,

Yik San

On Mon, Apr 26, 2021 at 9:19 PM Dian Fu <[hidden email]> wrote:

Hi Yik San,

It should be a typo issue. I guess it should be `If the target directory name is specified, the archive file will be extracted to a directory with the specified name.`

Regards,

Dian

2021年4月26日 下午8:57，Yik San Chan <[hidden email]> 写道：

Hi community,

In https://ci.apache.org/projects/flink/flink-docs-stable/dev/python/python_config.html#python-options,

> For each archive file, a target directory is specified. If the target directory name is specified, the archive file will be extracted to a name can directory with the specified name. Otherwise, the archive file will be extracted to a directory with the same name of the archive file.

I don't get what does "the archive file will be extracted to a name can directory with the specified name" mean. Maybe there are typos?

best,

Yik San

[Dian Fu]

Thank you a lot~

2021年4月27日 下午5:38，Yik San Chan <[hidden email]> 写道：

Hi Dian,

As a follow-up, I fix the docs here https://github.com/apache/flink/pull/15783

Best,

Yik San

On Tue, Apr 27, 2021 at 10:20 AM Dian Fu <[hidden email]> wrote:

For the command line arguments, it’s documented in https://ci.apache.org/projects/flink/flink-docs-release-1.11/ops/cli.html

2021年4月27日 上午10:19，Dian Fu <[hidden email]> 写道：

There are multiple ways to specify the target directory depending on how to specify the python archives.

1) API: add_python_archive(“file:///path/to/py_env.zip", "myenv"), see [1] for more details, 

2) configuration: python.archives, e.g. file:///path/to/py_env.zip#myenv

3) command line arguments: -pyarch file:///path/to/py_env.zip#myenv

You can specify python archives via either of the above options and it will extract py_env.zip into directory myenv during execution.

[1] https://ci.apache.org/projects/flink/flink-docs-release-1.12/dev/python/table-api-users-guide/dependency_management.html

2021年4月27日 上午8:17，Yik San Chan <[hidden email]> 写道：

Hi Dian,

I wonder where can we specify the target directory?

Best,

Yik San

On Mon, Apr 26, 2021 at 9:19 PM Dian Fu <[hidden email]> wrote:

Hi Yik San,

It should be a typo issue. I guess it should be `If the target directory name is specified, the archive file will be extracted to a directory with the specified name.`

Regards,

Dian

2021年4月26日 下午8:57，Yik San Chan <[hidden email]> 写道：

Hi community,

In https://ci.apache.org/projects/flink/flink-docs-stable/dev/python/python_config.html#python-options,

> For each archive file, a target directory is specified. If the target directory name is specified, the archive file will be extracted to a name can directory with the specified name. Otherwise, the archive file will be extracted to a directory with the same name of the archive file.

I don't get what does "the archive file will be extracted to a name can directory with the specified name" mean. Maybe there are typos?

best,

Yik San