Pārlūkot izejas kodu

Use colon to separate module and object in listing

Make the list a bit easier to handle in scripts (colon does not have
special regex meaning).

Also im human-readable contexts, dot makes it more likely to confuse the
string with with filename (eg. `foo.bar`.)  But then again, it's better
for humans to go a bit further and decorate the reference, eg.
`foo:bar()` or `foo:$BAZ`.  (Doing that in default output would make
them hard to parse, though.)
Alois Mahdal 6 gadus atpakaļ
vecāks
revīzija
0b9e7139e3

+ 8
- 8
src/include-bash/sfdoc.sh Parādīt failu

@@ -76,11 +76,11 @@ sfdoc__ls() {
76 76
     case $otype in
77 77
             f)
78 78
                 grep -HE '^[[:alnum:]_]+\(\) \{' "$mpath" \
79
-                  | sed -e 's|(.*||; s|\.sh:|.|; s|^.*/||'
79
+                  | sed -e 's|(.*||; s|\.sh:|:|; s|^.*/||'
80 80
                 ;;
81 81
             v)
82 82
                 grep -HE '^[[:alnum:]_]+=' "$mpath" \
83
-                  | sed -e 's|=.*||; s|\.sh:|.|; s|^.*/||'
83
+                  | sed -e 's|=.*||; s|\.sh:|:|; s|^.*/||'
84 84
                 ;;
85 85
             *)
86 86
                 warn "bug: invalid object type: $otype"
@@ -130,7 +130,7 @@ __sfdoc__export_as_markdown() {
130 130
     echo
131 131
     __sfdoc__get_doc | __sfdoc__md_escapes
132 132
     echo
133
-    for variable in $(sfdoc__ls v "$MPath" | cut -d. -f2);
133
+    for variable in $(sfdoc__ls v "$MPath" | cut -d: -f2);
134 134
     do
135 135
         debug -v variable
136 136
         $vheader_done || {
@@ -145,7 +145,7 @@ __sfdoc__export_as_markdown() {
145 145
         __sfdoc__get_doc "v:$variable" | __sfdoc__md_escapes
146 146
         echo
147 147
     done
148
-    for function in $(sfdoc__ls f "$MPath" | cut -d. -f2);
148
+    for function in $(sfdoc__ls f "$MPath" | cut -d: -f2);
149 149
     do
150 150
         debug -v function
151 151
         $fheader_done || {
@@ -184,7 +184,7 @@ __sfdoc__export_as_pod() {
184 184
     echo
185 185
     __sfdoc__get_doc
186 186
     echo
187
-    for variable in $(sfdoc__ls v "$MPath" | cut -d. -f2);
187
+    for variable in $(sfdoc__ls v "$MPath" | cut -d: -f2);
188 188
     do
189 189
         debug -v variable
190 190
         $vheader_done || {
@@ -206,7 +206,7 @@ __sfdoc__export_as_pod() {
206 206
         echo "=back"
207 207
         echo
208 208
     }
209
-    for function in $(sfdoc__ls f "$MPath" | cut -d. -f2);
209
+    for function in $(sfdoc__ls f "$MPath" | cut -d: -f2);
210 210
     do
211 211
         debug -v function
212 212
         $fheader_done || {
@@ -351,8 +351,8 @@ __sfdoc__filter_hidden() {
351 351
     $SFDOC_SHOW_HIDDEN && cat && return
352 352
     case $what in
353 353
         m)  grep -v ^_ ;;
354
-        v)  grep -v \\._ ;;
355
-        f)  grep -v \\._ ;;
354
+        v)  grep -v :_ ;;
355
+        f)  grep -v :_ ;;
356 356
         *)  warn "bug: invalid object type: $otype" ;;
357 357
     esac
358 358
 }

+ 2
- 2
tests/sfdoc/oracle/lsf_tricky.stdout Parādīt failu

@@ -1,2 +1,2 @@
1
-tricky.tricky_foo
2
-tricky.tricky_other_function
1
+tricky:tricky_foo
2
+tricky:tricky_other_function

+ 3
- 3
tests/sfdoc/oracle/lsv_tricky.stdout Parādīt failu

@@ -1,3 +1,3 @@
1
-tricky.TRICKY_DEBUG
2
-tricky.TRICKY_LIMIT
3
-tricky.TRICKY_REVERSED
1
+tricky:TRICKY_DEBUG
2
+tricky:TRICKY_LIMIT
3
+tricky:TRICKY_REVERSED

+ 5
- 5
tests/sfdoc/oracle/lsx_tricky.stdout Parādīt failu

@@ -1,5 +1,5 @@
1
-tricky.TRICKY_DEBUG
2
-tricky.TRICKY_LIMIT
3
-tricky.TRICKY_REVERSED
4
-tricky.tricky_foo
5
-tricky.tricky_other_function
1
+tricky:TRICKY_DEBUG
2
+tricky:TRICKY_LIMIT
3
+tricky:TRICKY_REVERSED
4
+tricky:tricky_foo
5
+tricky:tricky_other_function

+ 93
- 93
tests/shellfu_api/oracle/functions.stdout Parādīt failu

@@ -1,93 +1,93 @@
1
-_pretty_color.__shellfu__pretty_color__init
2
-_pretty_color._pretty__debug
3
-_pretty_color._pretty__die
4
-_pretty_color._pretty__mkhelp
5
-_pretty_color._pretty__mkusage
6
-_pretty_color._pretty__think
7
-_pretty_color._pretty__warn
8
-_pretty_html._pretty__debug
9
-_pretty_html._pretty__die
10
-_pretty_html._pretty__mkhelp
11
-_pretty_html._pretty__mkusage
12
-_pretty_html._pretty__think
13
-_pretty_html._pretty__warn
14
-_pretty_journald._pretty__debug
15
-_pretty_journald._pretty__die
16
-_pretty_journald._pretty__mkhelp
17
-_pretty_journald._pretty__mkusage
18
-_pretty_journald._pretty__think
19
-_pretty_journald._pretty__warn
20
-_pretty_notify._pretty__debug
21
-_pretty_notify._pretty__die
22
-_pretty_notify._pretty__mkhelp
23
-_pretty_notify._pretty__mkusage
24
-_pretty_notify._pretty__think
25
-_pretty_notify._pretty__warn
26
-_pretty_plain._pretty__debug
27
-_pretty_plain._pretty__die
28
-_pretty_plain._pretty__mkhelp
29
-_pretty_plain._pretty__mkusage
30
-_pretty_plain._pretty__think
31
-_pretty_plain._pretty__warn
32
-charmenu.charmenu
33
-exit.exit_error
34
-exit.exit_no
35
-exit.exit_ok
36
-exit.exit_panic
37
-exit.exit_usage
38
-inigrep._inigrep__fltcmt
39
-inigrep._inigrep__fltkey
40
-inigrep._inigrep__fltlst
41
-inigrep._inigrep__fltsct
42
-inigrep._inigrep__query
43
-inigrep._inigrep__validate_ks
44
-inigrep.inigrep
45
-mdfmt._mdfmt__fmttype
46
-mdfmt._mdfmt__indent
47
-mdfmt._mdfmt__join
48
-mdfmt._mdfmt__quote
49
-mdfmt._mdfmt__width
50
-mdfmt.mdfmt
51
-pretty.__shellfu_pretty__init
52
-pretty._pretty__cat
53
-pretty._pretty__echo
54
-pretty._pretty__echo_args
55
-pretty._pretty__echo_cmd
56
-pretty._pretty__echo_files
57
-pretty._pretty__echo_help
58
-pretty._pretty__echo_lines
59
-pretty._pretty__echo_trace
60
-pretty._pretty__echo_usage
61
-pretty._pretty__echo_vars
62
-pretty._pretty__get_caller
63
-pretty._pretty__get_frontend
64
-pretty._pretty__is_excluded
65
-pretty._pretty__is_frontend
66
-pretty._pretty__is_internal
67
-pretty._pretty__is_word
68
-pretty.debug
69
-pretty.debug_pipe
70
-pretty.die
71
-pretty.echos
72
-pretty.mkhelp
73
-pretty.mkusage
74
-pretty.think
75
-pretty.warn
76
-sfdoc.__sfdoc__export_as_manpage
77
-sfdoc.__sfdoc__export_as_markdown
78
-sfdoc.__sfdoc__export_as_pod
79
-sfdoc.__sfdoc__filter_body
80
-sfdoc.__sfdoc__filter_doc
81
-sfdoc.__sfdoc__filter_fdoc
82
-sfdoc.__sfdoc__filter_fun
83
-sfdoc.__sfdoc__filter_hidden
84
-sfdoc.__sfdoc__filter_mdoc
85
-sfdoc.__sfdoc__filter_var
86
-sfdoc.__sfdoc__filter_vdoc
87
-sfdoc.__sfdoc__get_doc
88
-sfdoc.__sfdoc__get_part
89
-sfdoc.__sfdoc__md_escapes
90
-sfdoc.__sfdoc__strip_doc
91
-sfdoc.sfdoc__export
92
-sfdoc.sfdoc__ls
93
-sfdoc.sfdoc__ls_m
1
+_pretty_color:__shellfu__pretty_color__init
2
+_pretty_color:_pretty__debug
3
+_pretty_color:_pretty__die
4
+_pretty_color:_pretty__mkhelp
5
+_pretty_color:_pretty__mkusage
6
+_pretty_color:_pretty__think
7
+_pretty_color:_pretty__warn
8
+_pretty_html:_pretty__debug
9
+_pretty_html:_pretty__die
10
+_pretty_html:_pretty__mkhelp
11
+_pretty_html:_pretty__mkusage
12
+_pretty_html:_pretty__think
13
+_pretty_html:_pretty__warn
14
+_pretty_journald:_pretty__debug
15
+_pretty_journald:_pretty__die
16
+_pretty_journald:_pretty__mkhelp
17
+_pretty_journald:_pretty__mkusage
18
+_pretty_journald:_pretty__think
19
+_pretty_journald:_pretty__warn
20
+_pretty_notify:_pretty__debug
21
+_pretty_notify:_pretty__die
22
+_pretty_notify:_pretty__mkhelp
23
+_pretty_notify:_pretty__mkusage
24
+_pretty_notify:_pretty__think
25
+_pretty_notify:_pretty__warn
26
+_pretty_plain:_pretty__debug
27
+_pretty_plain:_pretty__die
28
+_pretty_plain:_pretty__mkhelp
29
+_pretty_plain:_pretty__mkusage
30
+_pretty_plain:_pretty__think
31
+_pretty_plain:_pretty__warn
32
+charmenu:charmenu
33
+exit:exit_error
34
+exit:exit_no
35
+exit:exit_ok
36
+exit:exit_panic
37
+exit:exit_usage
38
+inigrep:_inigrep__fltcmt
39
+inigrep:_inigrep__fltkey
40
+inigrep:_inigrep__fltlst
41
+inigrep:_inigrep__fltsct
42
+inigrep:_inigrep__query
43
+inigrep:_inigrep__validate_ks
44
+inigrep:inigrep
45
+mdfmt:_mdfmt__fmttype
46
+mdfmt:_mdfmt__indent
47
+mdfmt:_mdfmt__join
48
+mdfmt:_mdfmt__quote
49
+mdfmt:_mdfmt__width
50
+mdfmt:mdfmt
51
+pretty:__shellfu_pretty__init
52
+pretty:_pretty__cat
53
+pretty:_pretty__echo
54
+pretty:_pretty__echo_args
55
+pretty:_pretty__echo_cmd
56
+pretty:_pretty__echo_files
57
+pretty:_pretty__echo_help
58
+pretty:_pretty__echo_lines
59
+pretty:_pretty__echo_trace
60
+pretty:_pretty__echo_usage
61
+pretty:_pretty__echo_vars
62
+pretty:_pretty__get_caller
63
+pretty:_pretty__get_frontend
64
+pretty:_pretty__is_excluded
65
+pretty:_pretty__is_frontend
66
+pretty:_pretty__is_internal
67
+pretty:_pretty__is_word
68
+pretty:debug
69
+pretty:debug_pipe
70
+pretty:die
71
+pretty:echos
72
+pretty:mkhelp
73
+pretty:mkusage
74
+pretty:think
75
+pretty:warn
76
+sfdoc:__sfdoc__export_as_manpage
77
+sfdoc:__sfdoc__export_as_markdown
78
+sfdoc:__sfdoc__export_as_pod
79
+sfdoc:__sfdoc__filter_body
80
+sfdoc:__sfdoc__filter_doc
81
+sfdoc:__sfdoc__filter_fdoc
82
+sfdoc:__sfdoc__filter_fun
83
+sfdoc:__sfdoc__filter_hidden
84
+sfdoc:__sfdoc__filter_mdoc
85
+sfdoc:__sfdoc__filter_var
86
+sfdoc:__sfdoc__filter_vdoc
87
+sfdoc:__sfdoc__get_doc
88
+sfdoc:__sfdoc__get_part
89
+sfdoc:__sfdoc__md_escapes
90
+sfdoc:__sfdoc__strip_doc
91
+sfdoc:sfdoc__export
92
+sfdoc:sfdoc__ls
93
+sfdoc:sfdoc__ls_m

+ 36
- 36
tests/shellfu_api/oracle/variables.stdout Parādīt failu

@@ -1,36 +1,36 @@
1
-_pretty_color._PRETTY_COLOR_DEBUG
2
-_pretty_color._PRETTY_COLOR_DIE
3
-_pretty_color._PRETTY_COLOR_OFF
4
-_pretty_color._PRETTY_COLOR_THINK
5
-_pretty_color._PRETTY_COLOR_USAGE_IS
6
-_pretty_color._PRETTY_COLOR_WARN
7
-charmenu.CHARMENU_FILE
8
-exit.EXIT_ERROR
9
-exit.EXIT_NO
10
-exit.EXIT_OK
11
-exit.EXIT_PANIC
12
-exit.EXIT_USAGE
13
-mdfmt.MDFMT_WIDTH
14
-pretty.PRETTY
15
-pretty.PRETTY_DEBUG
16
-pretty.PRETTY_DEBUG_EXCLUDE
17
-pretty.PRETTY_USAGE
18
-pretty.PRETTY_VERBOSE
19
-sfdoc.SFDOC_SHOW_HIDDEN
20
-termcolors.TERMCOLORS_BLACK
21
-termcolors.TERMCOLORS_BLUE
22
-termcolors.TERMCOLORS_CYAN
23
-termcolors.TERMCOLORS_GREEN
24
-termcolors.TERMCOLORS_LBLACK
25
-termcolors.TERMCOLORS_LBLUE
26
-termcolors.TERMCOLORS_LCYAN
27
-termcolors.TERMCOLORS_LGREEN
28
-termcolors.TERMCOLORS_LMAGENTA
29
-termcolors.TERMCOLORS_LRED
30
-termcolors.TERMCOLORS_LWHITE
31
-termcolors.TERMCOLORS_LYELLOW
32
-termcolors.TERMCOLORS_MAGENTA
33
-termcolors.TERMCOLORS_NONE
34
-termcolors.TERMCOLORS_RED
35
-termcolors.TERMCOLORS_WHITE
36
-termcolors.TERMCOLORS_YELLOW
1
+_pretty_color:_PRETTY_COLOR_DEBUG
2
+_pretty_color:_PRETTY_COLOR_DIE
3
+_pretty_color:_PRETTY_COLOR_OFF
4
+_pretty_color:_PRETTY_COLOR_THINK
5
+_pretty_color:_PRETTY_COLOR_USAGE_IS
6
+_pretty_color:_PRETTY_COLOR_WARN
7
+charmenu:CHARMENU_FILE
8
+exit:EXIT_ERROR
9
+exit:EXIT_NO
10
+exit:EXIT_OK
11
+exit:EXIT_PANIC
12
+exit:EXIT_USAGE
13
+mdfmt:MDFMT_WIDTH
14
+pretty:PRETTY
15
+pretty:PRETTY_DEBUG
16
+pretty:PRETTY_DEBUG_EXCLUDE
17
+pretty:PRETTY_USAGE
18
+pretty:PRETTY_VERBOSE
19
+sfdoc:SFDOC_SHOW_HIDDEN
20
+termcolors:TERMCOLORS_BLACK
21
+termcolors:TERMCOLORS_BLUE
22
+termcolors:TERMCOLORS_CYAN
23
+termcolors:TERMCOLORS_GREEN
24
+termcolors:TERMCOLORS_LBLACK
25
+termcolors:TERMCOLORS_LBLUE
26
+termcolors:TERMCOLORS_LCYAN
27
+termcolors:TERMCOLORS_LGREEN
28
+termcolors:TERMCOLORS_LMAGENTA
29
+termcolors:TERMCOLORS_LRED
30
+termcolors:TERMCOLORS_LWHITE
31
+termcolors:TERMCOLORS_LYELLOW
32
+termcolors:TERMCOLORS_MAGENTA
33
+termcolors:TERMCOLORS_NONE
34
+termcolors:TERMCOLORS_RED
35
+termcolors:TERMCOLORS_WHITE
36
+termcolors:TERMCOLORS_YELLOW