Sfoglia il codice sorgente

Add note on name conflict when using -v from __echo frontends

Alois Mahdal 9 anni fa
parent
commit
0e537853e5
1 ha cambiato i file con 23 aggiunte e 0 eliminazioni
  1. 23
    0
      README

+ 23
- 0
README Vedi File

7
 NOTES
7
 NOTES
8
 -----
8
 -----
9
 
9
 
10
+ *  if when using `debug -v` you stumble on a variable name
11
+    that is *really* used internally by pretty.sh, routines
12
+    pick up the internal ones which may easily confuse you.
13
+    Examples are `src` or `caller`.
14
+
15
+    You can circumvent this by composing the debug string
16
+    yourself, e.g.:
17
+
18
+        debug "src='$src'"
19
+
20
+    in place of
21
+
22
+        debug -v src
23
+
24
+    This will be solved in the future (1.0.0?) probably by
25
+    refactoring the internal names to some long, ugly but
26
+    "safe" names.  Now, however, readability of the internal
27
+    code is of higher priority.
28
+
29
+    Note that there is no risk damage to data integrity, it's
30
+    just that the routine is unable to show you desired value.
31
+
32
+
10
  *  if `debug -v "x*:` is used, `x*` apparently tries to match
33
  *  if `debug -v "x*:` is used, `x*` apparently tries to match
11
     *filenames* first, and only if there is no match, it goes
34
     *filenames* first, and only if there is no match, it goes
12
     on to match variable names.  This does not seem to affect
35
     on to match variable names.  This does not seem to affect