Re: [edk2] [patch edk2-wiki] Update ECC wiki page

[Gao, Liming]

Reviewed-by: Liming Gao 

> -Original Message-
> From: edk2-devel [mailto:edk2-devel-boun...@lists.01.org] On Behalf Of Bi, 
> Dandan
> Sent: Monday, February 18, 2019 3:36 PM
> To: edk2-devel@lists.01.org
> Cc: Gao, Liming 
> Subject: [edk2] [patch edk2-wiki] Update ECC wiki page
> 
> Update ECC wiki page to record how to solve the
> problem “ModuleNotFoundError: No module named 'antlr4'”
> when run ECC tool with python3.x.
> 
> Cc: Liming Gao 
> Cc: Bob Feng 
> Contributed-under: TianoCore Contribution Agreement 1.1
> Signed-off-by: Dandan Bi 
> ---
>  ECC-tool.md | 15 ---
>  1 file changed, 12 insertions(+), 3 deletions(-)
> 
> diff --git a/ECC-tool.md b/ECC-tool.md
> index eaf4137..03dbb30 100644
> --- a/ECC-tool.md
> +++ b/ECC-tool.md
> @@ -12,18 +12,27 @@ Steps to run ECC tool:
>  **1). Enter edk2 directory, run: **edksetup.bat (**on Windows**)
>**Enter edk2 directory, run: **source edksetup.sh (**on 
> Linux**)
> 
>  **2). Then in edk2 directory, you can type "Ecc" to run ECC tool 
> directly**.
> 
> -**3). If you meet following error:**
> +**3). If you meet following errors:**
> +**Error 1:**
>  **import antlr3**
>  **ImportError: No module named antlr3**
> 
> -Since ECC depends on antlr V3.0.1, you can download it from 
> http://www.antlr3.org/download/Python/ 
> +This error may be met when you run ECC tool with python 2.x, then ECC 
> depends on antlr V3.0.1, you can download it from
> http://www.antlr3.org/download/Python/ 
>  After download and extract it, you can enter the antlr tool directory and 
> run: 
>  **C:\Python27\python.exe setup.py install** to install it.(**on Windows**) 
> 
> -**python setup.py install**" to install it, root access may be 
> required.(**on Linux**) 
> +**python setup.py install** to install it, root access may be required.(**on 
> Linux**) 
> +
> +**Error 2:**
> +**import antlr4 as antlr** 
> +**ModuleNotFoundError: No module named 'antlr4'** 
> +
> +This error may be met when you run ECC tool with python 3.x, then ECC 
> depends on antlr4, you can install it through following
> command.
> +**py -3 -m pip install antlr4-python3-runtime** to install it.(**on 
> Windows**) 
> +**sudo python3 -m pip install antlr4-python3-runtime** to install it. (**on 
> Linux**) 
> 
>  **4). You can type "Ecc -h/Ecc --help" to get the help info of ECC 
> tool**.
> 
>  **5). Common usage model:**
>  **Ecc -c config file  -e exception file  -t  the target directory which need 
> to be scanned by ECC -r the ECC scan result csv file**
> --
> 2.18.0.windows.1
> 
> ___
> edk2-devel mailing list
> edk2-devel@lists.01.org
> https://lists.01.org/mailman/listinfo/edk2-devel
___
edk2-devel mailing list
edk2-devel@lists.01.org
https://lists.01.org/mailman/listinfo/edk2-devel

[edk2] [patch edk2-wiki] Update ECC wiki page

[Dandan Bi]

Update ECC wiki page to record how to solve the
problem “ModuleNotFoundError: No module named 'antlr4'”
when run ECC tool with python3.x.

Cc: Liming Gao 
Cc: Bob Feng 
Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Dandan Bi 
---
 ECC-tool.md | 15 ---
 1 file changed, 12 insertions(+), 3 deletions(-)

diff --git a/ECC-tool.md b/ECC-tool.md
index eaf4137..03dbb30 100644
--- a/ECC-tool.md
+++ b/ECC-tool.md
@@ -12,18 +12,27 @@ Steps to run ECC tool:
 **1). Enter edk2 directory, run: **edksetup.bat (**on Windows**)
   **Enter edk2 directory, run: **source edksetup.sh (**on Linux**)
 
 **2). Then in edk2 directory, you can type "Ecc" to run ECC tool 
directly**.
 
-**3). If you meet following error:**
+**3). If you meet following errors:**
+**Error 1:**
 **import antlr3**
 **ImportError: No module named antlr3**
 
-Since ECC depends on antlr V3.0.1, you can download it from 
http://www.antlr3.org/download/Python/ 
+This error may be met when you run ECC tool with python 2.x, then ECC depends 
on antlr V3.0.1, you can download it from 
http://www.antlr3.org/download/Python/ 
 After download and extract it, you can enter the antlr tool directory and run: 

 **C:\Python27\python.exe setup.py install** to install it.(**on Windows**) 
-**python setup.py install**" to install it, root access may be required.(**on 
Linux**) 
+**python setup.py install** to install it, root access may be required.(**on 
Linux**) 
+
+**Error 2:**
+**import antlr4 as antlr** 
+**ModuleNotFoundError: No module named 'antlr4'** 
+
+This error may be met when you run ECC tool with python 3.x, then ECC depends 
on antlr4, you can install it through following command.
+**py -3 -m pip install antlr4-python3-runtime** to install it.(**on Windows**) 

+**sudo python3 -m pip install antlr4-python3-runtime** to install it. (**on 
Linux**) 
 
 **4). You can type "Ecc -h/Ecc --help" to get the help info of ECC tool**.
 
 **5). Common usage model:**
 **Ecc -c config file  -e exception file  -t  the target directory which need 
to be scanned by ECC -r the ECC scan result csv file**
-- 
2.18.0.windows.1

___
edk2-devel mailing list
edk2-devel@lists.01.org
https://lists.01.org/mailman/listinfo/edk2-devel