Fix: Update lf-activate-env code comment 45/70445/2
authorAnil Belur <abelur@linuxfoundation.org>
Mon, 8 Aug 2022 11:58:24 +0000 (21:58 +1000)
committerGuillaume Lambert <guillaume.lambert@orange.com>
Wed, 10 Aug 2022 09:27:21 +0000 (09:27 +0000)
Fix lf-activate-env code comment. The comment suggests
using  just the version number ``--python <x.y>``, however
as per the code the correct format as per the code is
``--python python<x.y>``

Also update the fix in the 9915b0bb42077428478e2.

Change-Id: Ic135036ded75f0b16525ef78bdec9e90c72a5c44
Issue-ID: RELENG-4348
Signed-off-by: Anil Belur <abelur@linuxfoundation.org>
jenkins-init-scripts/lf-env.sh
releasenotes/notes/fix-docs-lf-activate-env-a1e6fb274186f86d.yaml [new file with mode: 0644]
shell/logs-deploy.sh

index d0ea625..a1bd350 100644 (file)
@@ -108,7 +108,7 @@ lf-boolean () {
 #   or
 #   lf-activate-venv lftools
 #   or
-#   lf-activate-venv --python 3.6 git-review
+#   lf-activate-venv --python python3.8 git-review
 #
 # DESCRIPTION
 #   This function will create a new Python Virtual Environment (venv) and
diff --git a/releasenotes/notes/fix-docs-lf-activate-env-a1e6fb274186f86d.yaml b/releasenotes/notes/fix-docs-lf-activate-env-a1e6fb274186f86d.yaml
new file mode 100644 (file)
index 0000000..fcfac5d
--- /dev/null
@@ -0,0 +1,6 @@
+---
+fixes:
+  - |
+    Fix lf-activate-env code comment. The comment suggests using
+    just the version number ``--python <x.y>``, however as per the
+    code the correct format as per the code is ``--python python<x.y>``
index 79f8db4..d797fa7 100644 (file)
@@ -12,7 +12,7 @@ echo "---> logs-deploy.sh"
 
 # shellcheck disable=SC1090
 source ~/lf-env.sh
-lf-activate-venv --python 3.8 lftools
+lf-activate-venv --python python3.8 lftools
 
 # Ensure we fail the job if any steps fail
 # Disable 'globbing'