diff options
| author | Gerald Combs <gerald@wireshark.org> | 2018-07-19 15:06:07 -0700 |
|---|---|---|
| committer | Anders Broman <a.broman58@gmail.com> | 2018-07-20 06:42:38 +0000 |
| commit | 61dd06ed9f56a15adaf8b4f141d2f7e47670196b (patch) | |
| tree | 02789ab05ca2dcd2cb8efe8f9447d403aa89178b /docbook | |
| parent | 381ea0973f09669eb70506ec9fa9cc14bf69db0d (diff) | |
Lua: Switch from disable_lua to enable_lua.
Deprecate "disable_lua" in favor of "enable_lua". Configuration options
typically use "true" or a similar value to enable features. Using
"disable_lua = false" to enable Lua seems odd.
Change-Id: I224acad0559d409ea0a28b5555d1eb898564328c
Reviewed-on: https://code.wireshark.org/review/28773
Reviewed-by: Gerald Combs <gerald@wireshark.org>
Petri-Dish: Gerald Combs <gerald@wireshark.org>
Tested-by: Petri Dish Buildbot
Reviewed-by: Anders Broman <a.broman58@gmail.com>
Diffstat (limited to 'docbook')
| -rw-r--r-- | docbook/wsluarm.asciidoc | 24 |
1 files changed, 13 insertions, 11 deletions
diff --git a/docbook/wsluarm.asciidoc b/docbook/wsluarm.asciidoc index ab3c96bf88..7861a7d8c1 100644 --- a/docbook/wsluarm.asciidoc +++ b/docbook/wsluarm.asciidoc @@ -20,21 +20,23 @@ the Department of Computer Science. In Wireshark Lua can be used to write dissectors, taps, and capture file readers and writers. -Wireshark’s Lua interpreter starts by loading `init.lua` that is located in the -global configuration directory of Wireshark. Lua is enabled by default. To -disable Lua the line variable _$$disable_lua$$_ should be set to _true_ in -`init.lua`. - -After loading _init.lua_ from the data directory if Lua is enabled Wireshark -will try to load a file named `init.lua` in the user’s directory. - -Wireshark will also load all files with `.lua` suffix from both the global and -the personal plugins directory. +Wireshark’s Lua interpreter starts by loading a file named `init.lua` in +Wireshark's global configuration directory. It is enabled by default. To +disable Lua the line variable _$$enable_lua$$_ should be set to _false_ +in _init.lua_. Wireshark 2.6 and earlier enabled and disabled Lua using +the variable _$$disable_lua$$_. It is still supported, but is deprecated +and support may be removed in a future release. _$$enable_lua$$_ takes +precedence over _$$disable_lua$$_. + +If Lua is enabled Wireshark will then try to load a file named _init.lua_ +in the user’s personal configuration directory. Wireshark will also load +all files with a _.lua_ suffix from both the global and the personal +plugins directory. The command line option _$$-X lua_script:$$++file.lua++_ can be used to load Lua scripts as well. -The Lua code will be executed once after all the protocol dissectors have being +The Lua code will be executed once after all the protocol dissectors have been initialized and before reading any file. [[wslua_dissector_example]] |