Skip to contentSkip to conversation

scripts/sphinx-pre-install: add how to exit virtualenv usage message

PATCH Applied Shuah Khan 2 participants 2 messages Sep 19, 2019 – Oct 1, 2019

lore
Share & tools
lore

Shuah Khan

author
#0 lore raw

PATCH v2 1/1 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.

---
Changes since v1:
Changed the message based on Mauro's review comments.

 scripts/sphinx-pre-install | 8 ++++++++
 1 file changed, 8 insertions(+)
scripts/sphinx-pre-install +8 -0
index 3b638c0e1a4f..013099cd120d 100755
@@ -645,6 +645,12 @@ sub check_distros()
 # Common dependencies
 #
 
+sub deactivate_help()
+{
+	printf "\tIf you want to exit the virtualenv, you can use:\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);
 		}
Signature · 1 line
2.20.1
#1 lore raw
Quoted 7 lines · On Wed, 18 Sep 2019 18:37:54 -0600 Shuah Khan <[email protected]> wrote:

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

---
Changes since v1:
Changed the message based on Mauro's review comments.

Applied, thanks.

jon