[PATCH v2 0/1] SpellCheck plugin inspects fewer files when run on Linux

[PATCH v2 0/1] SpellCheck plugin inspects fewer files when run on Linux

[Kun Qin]

REF: https://bugzilla.tianocore.org/show_bug.cgi?id=3454

This patch series is a follow up of previous submission:
https://edk2.groups.io/g/devel/message/76427

v2 patch change includes feedback for v1 series:
a. Adding "Reviewed-by" tags;
b. Adding "Signed-Off-by" tags for myself;

Patch v2 branch: https://github.com/kuqin12/edk2/tree/exp_shell_v2

Cc: Sean Brogan <sean.brogan@microsoft.com>
Cc: Bret Barkelew <Bret.Barkelew@microsoft.com>
Cc: Michael D Kinney <michael.d.kinney@intel.com>
Cc: Liming Gao <gaoliming@byosoft.com.cn>

Sean Brogan (1):
  Pytool: SpellCheck: Defer path expansion in cspell parameters

 .pytool/Plugin/SpellCheck/SpellCheck.py | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

-- 
2.31.1.windows.1

[PATCH v2 1/1] Pytool: SpellCheck: Defer path expansion in cspell parameters

[Kun Qin]

From: Sean Brogan <sean.brogan@microsoft.com>

REF: https://bugzilla.tianocore.org/show_bug.cgi?id=3454

On Linux the shell expands the wildcard paths and causes multiple files
to be missed. This change adds additional quotes to defer expansion in
order to bring parity in cspell result.

Cc: Sean Brogan <sean.brogan@microsoft.com>
Cc: Bret Barkelew <Bret.Barkelew@microsoft.com>
Cc: Michael D Kinney <michael.d.kinney@intel.com>
Cc: Liming Gao <gaoliming@byosoft.com.cn>

Signed-off-by: Sean Brogan <sean.brogan@microsoft.com>
Signed-off-by: Kun Qin <kuqin12@gmail.com>
Reviewed-by: Sean Brogan <sean.brogan@microsoft.com>
Reviewed-by: Bret Barkelew <bret.barkelew@microsoft.com>
---

Notes:
    v2:
    - Added reviewed-by tags [Bret]
    - Added reviewed-by tag [Sean]
    - Added signed-off-by tag from Kun [Sean]

 .pytool/Plugin/SpellCheck/SpellCheck.py | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/.pytool/Plugin/SpellCheck/SpellCheck.py b/.pytool/Plugin/SpellCheck/SpellCheck.py
index 9ad57632a6e8..05c471d91ba1 100644
--- a/.pytool/Plugin/SpellCheck/SpellCheck.py
+++ b/.pytool/Plugin/SpellCheck/SpellCheck.py
@@ -134,7 +134,8 @@ class SpellCheck(ICiBuildPlugin):
         #
         relpath = os.path.relpath(abs_pkg_path)
         cpsell_paths = " ".join(
-            [f"{relpath}/**/{x}" for x in package_relative_paths_to_spell_check])
+            # Double quote each path to defer expansion to cspell parameters
+            [f'"{relpath}/**/{x}"' for x in package_relative_paths_to_spell_check])
 
         # Make the config file
         config_file_path = os.path.join(
-- 
2.31.1.windows.1

回复: [PATCH v2 1/1] Pytool: SpellCheck: Defer path expansion in cspell parameters

[gaoliming]

Reviewed-by: Liming Gao <gaoliming@byosoft.com.cn>

> -----邮件原件-----
> 发件人: Kun Qin <kuqin12@gmail.com>
> 发送时间: 2021年6月16日 0:54
> 收件人: devel@edk2.groups.io
> 抄送: Sean Brogan <sean.brogan@microsoft.com>; Bret Barkelew
> <Bret.Barkelew@microsoft.com>; Michael D Kinney
> <michael.d.kinney@intel.com>; Liming Gao <gaoliming@byosoft.com.cn>;
> Bret Barkelew <bret.barkelew@microsoft.com>
> 主题: [PATCH v2 1/1] Pytool: SpellCheck: Defer path expansion in cspell
> parameters
> 
> From: Sean Brogan <sean.brogan@microsoft.com>
> 
> REF: https://bugzilla.tianocore.org/show_bug.cgi?id=3454
> 
> On Linux the shell expands the wildcard paths and causes multiple files
> to be missed. This change adds additional quotes to defer expansion in
> order to bring parity in cspell result.
> 
> Cc: Sean Brogan <sean.brogan@microsoft.com>
> Cc: Bret Barkelew <Bret.Barkelew@microsoft.com>
> Cc: Michael D Kinney <michael.d.kinney@intel.com>
> Cc: Liming Gao <gaoliming@byosoft.com.cn>
> 
> Signed-off-by: Sean Brogan <sean.brogan@microsoft.com>
> Signed-off-by: Kun Qin <kuqin12@gmail.com>
> Reviewed-by: Sean Brogan <sean.brogan@microsoft.com>
> Reviewed-by: Bret Barkelew <bret.barkelew@microsoft.com>
> ---
> 
> Notes:
>     v2:
>     - Added reviewed-by tags [Bret]
>     - Added reviewed-by tag [Sean]
>     - Added signed-off-by tag from Kun [Sean]
> 
>  .pytool/Plugin/SpellCheck/SpellCheck.py | 3 ++-
>  1 file changed, 2 insertions(+), 1 deletion(-)
> 
> diff --git a/.pytool/Plugin/SpellCheck/SpellCheck.py
> b/.pytool/Plugin/SpellCheck/SpellCheck.py
> index 9ad57632a6e8..05c471d91ba1 100644
> --- a/.pytool/Plugin/SpellCheck/SpellCheck.py
> +++ b/.pytool/Plugin/SpellCheck/SpellCheck.py
> @@ -134,7 +134,8 @@ class SpellCheck(ICiBuildPlugin):
>          #
>          relpath = os.path.relpath(abs_pkg_path)
>          cpsell_paths = " ".join(
> -            [f"{relpath}/**/{x}" for x in
> package_relative_paths_to_spell_check])
> +            # Double quote each path to defer expansion to cspell
> parameters
> +            [f'"{relpath}/**/{x}"' for x in
> package_relative_paths_to_spell_check])
> 
>          # Make the config file
>          config_file_path = os.path.join(
> --
> 2.31.1.windows.1