2019-09-18 00:46:45

by Shuah Khan

Subject: [PATCH] scripts/sphinx-pre-install: add how to exit virtualenv usage message

Add usage message on how to exit the virtualenv after documentation
work is done.

Signed-off-by: Shuah Khan <[email protected]>
---
scripts/sphinx-pre-install | 8 ++++++++
1 file changed, 8 insertions(+)

diff --git a/scripts/sphinx-pre-install b/scripts/sphinx-pre-install
index 3b638c0e1a4f..932547791e3c 100755
--- a/scripts/sphinx-pre-install
+++ b/scripts/sphinx-pre-install
@@ -645,6 +645,12 @@ sub check_distros()
# Common dependencies
#

+sub deactivate_help()
+{
+ printf "\tWhen work is done exit the virtualenv:\n";
+ printf "\tdeactivate\n";
+}
+
sub check_needs()
{
# Check for needed programs/tools
@@ -686,6 +692,7 @@ sub check_needs()
if ($need_sphinx && scalar @activates > 0 && $activates[0] ge $min_activate) {
printf "\nNeed to activate a compatible Sphinx version on virtualenv with:\n";
printf "\t. $activates[0]\n";
+ deactivate_help();
exit (1);
} else {
my $rec_activate = "$virtenv_dir/bin/activate";
@@ -697,6 +704,7 @@ sub check_needs()
printf "\t$virtualenv $virtenv_dir\n";
printf "\t. $rec_activate\n";
printf "\tpip install -r $requirement_file\n";
+ deactivate_help();

$need++ if (!$rec_sphinx_upgrade);
}
--
2.20.1

2019-09-18 15:07:00

by Mauro Carvalho Chehab

Subject: Re: [PATCH] scripts/sphinx-pre-install: add how to exit virtualenv usage message

Hi Shuah,

Em Tue, 17 Sep 2019 16:48:05 -0600
Shuah Khan <[email protected]> escreveu:

> Add usage message on how to exit the virtualenv after documentation
> work is done.

Good idea.

>
> Signed-off-by: Shuah Khan <[email protected]>
> ---
> scripts/sphinx-pre-install | 8 ++++++++
> 1 file changed, 8 insertions(+)
>
> diff --git a/scripts/sphinx-pre-install b/scripts/sphinx-pre-install
> index 3b638c0e1a4f..932547791e3c 100755
> --- a/scripts/sphinx-pre-install
> +++ b/scripts/sphinx-pre-install
> @@ -645,6 +645,12 @@ sub check_distros()
> # Common dependencies
> #
>
> +sub deactivate_help()
> +{
> + printf "\tWhen work is done exit the virtualenv:\n";
> + printf "\tdeactivate\n";

I would change the message to something like:

If you want to exit the virtualenv, you can use:

deactivate

Btw, at least here, I recently noticed a conflict between the
virtenv and scripts/spdxcheck.py. Running deactivate solves it.

Regards,
Mauro



> +}
> +
> sub check_needs()
> {
> # Check for needed programs/tools
> @@ -686,6 +692,7 @@ sub check_needs()
> if ($need_sphinx && scalar @activates > 0 && $activates[0] ge $min_activate) {
> printf "\nNeed to activate a compatible Sphinx version on virtualenv with:\n";
> printf "\t. $activates[0]\n";
> + deactivate_help();
> exit (1);
> } else {
> my $rec_activate = "$virtenv_dir/bin/activate";
> @@ -697,6 +704,7 @@ sub check_needs()
> printf "\t$virtualenv $virtenv_dir\n";
> printf "\t. $rec_activate\n";
> printf "\tpip install -r $requirement_file\n";
> + deactivate_help();
>
> $need++ if (!$rec_sphinx_upgrade);
> }



Thanks,
Mauro