[gnome-continuous-yocto/gnomeostree-3.28-rocko: 3918/8267] lib/oe/path: add warning comment about oe.path.remove() with wildcarded filenames

[Emmanuele Bassi <ebassi src gnome org>]

commit fff7563799f7ea049c290fc04484f96b69a744ca
Author: Paul Eggleton <paul eggleton linux intel com>
Date:   Thu Dec 22 15:19:57 2016 +1300

    lib/oe/path: add warning comment about oe.path.remove() with wildcarded filenames
    
    Add a warning in the doc comment for oe.path.remove() about using that
    function on paths that may contain wildcards in the actual
    file/directory names.
    
    (From OE-Core rev: 18cc0965741102bccc62dfb32ed7753cdacbadc7)
    
    Signed-off-by: Paul Eggleton <paul eggleton linux intel com>
    Signed-off-by: Ross Burton <ross burton intel com>
    Signed-off-by: Richard Purdie <richard purdie linuxfoundation org>

 meta/lib/oe/path.py |    9 ++++++++-
 1 files changed, 8 insertions(+), 1 deletions(-)
---
diff --git a/meta/lib/oe/path.py b/meta/lib/oe/path.py
index 804ecd5..d468540 100644
--- a/meta/lib/oe/path.py
+++ b/meta/lib/oe/path.py
@@ -92,7 +92,14 @@ def copyhardlinktree(src, dst):
         copytree(src, dst)
 
 def remove(path, recurse=True):
-    """Equivalent to rm -f or rm -rf"""
+    """
+    Equivalent to rm -f or rm -rf
+    NOTE: be careful about passing paths that may contain filenames with
+    wildcards in them (as opposed to passing an actual wildcarded path) -
+    since we use glob.glob() to expand the path. Filenames containing
+    square brackets are particularly problematic since the they may not
+    actually expand to match the original filename.
+    """
     for name in glob.glob(path):
         try:
             os.unlink(name)