From 9b9c6e312c4f8790fabef09e065232b33df5229a Mon Sep 17 00:00:00 2001 From: ridiculousfish Date: Mon, 17 Jun 2019 09:07:43 -0700 Subject: [PATCH] Improve the docs from DEBUG_LEVEL to CATEGORY_GLOB This stuff still isn't documented properly. --- sphinx_doc_src/cmds/fish.rst | 2 +- sphinx_doc_src/cmds/fish_indent.rst | 2 +- sphinx_doc_src/cmds/fish_key_reader.rst | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/sphinx_doc_src/cmds/fish.rst b/sphinx_doc_src/cmds/fish.rst index db2dd60db..177e781b9 100644 --- a/sphinx_doc_src/cmds/fish.rst +++ b/sphinx_doc_src/cmds/fish.rst @@ -20,7 +20,7 @@ The following options are available: - ``-C`` or ``--init-command=COMMANDS`` evaluate the specified commands after reading the configuration, before running the command specified by ``-c`` or reading interactive input -- ``-d`` or ``--debug=DEBUG_LEVEL`` specify the verbosity level of fish. A higher number means higher verbosity. The default level is 1. +- ``-d`` or ``--debug=CATEGORY_GLOB`` enables debug output and specifies a glob for matching debug categories (like ``fish -d``). Defaults to empty. - ``-o`` or ``--debug-output=path`` Specify a file path to receive the debug output. The default is stderr. diff --git a/sphinx_doc_src/cmds/fish_indent.rst b/sphinx_doc_src/cmds/fish_indent.rst index 0049f84f3..73919a5b6 100644 --- a/sphinx_doc_src/cmds/fish_indent.rst +++ b/sphinx_doc_src/cmds/fish_indent.rst @@ -26,7 +26,7 @@ The following options are available: - ``--html`` outputs HTML, which supports syntax highlighting if the appropriate CSS is defined. The CSS class names are the same as the variable names, such as ``fish_color_command``. -- ``-d`` or ``--debug=DEBUG_LEVEL`` enables debug output and specifies a verbosity level (like ``fish -d``). Defaults to 0. +- ``-d`` or ``--debug=CATEGORY_GLOB`` enables debug output and specifies a glob for matching debug categories (like ``fish -d``). Defaults to empty. - ``-D`` or ``--debug-stack-frames=DEBUG_LEVEL`` specify how many stack frames to display when debug messages are written. The default is zero. A value of 3 or 4 is usually sufficient to gain insight into how a given debug call was reached but you can specify a value up to 128. diff --git a/sphinx_doc_src/cmds/fish_key_reader.rst b/sphinx_doc_src/cmds/fish_key_reader.rst index 83869cf68..7d5e4d3d1 100644 --- a/sphinx_doc_src/cmds/fish_key_reader.rst +++ b/sphinx_doc_src/cmds/fish_key_reader.rst @@ -20,7 +20,7 @@ The following options are available: - ``-c`` or ``--continuous`` begins a session where multiple key sequences can be inspected. By default the program exits after capturing a single key sequence. -- ``-d`` or ``--debug=DEBUG_LEVEL`` enables debug output and specifies a verbosity level (like ``fish -d``). Defaults to 0. +- ``-d`` or ``--debug=CATEGORY_GLOB`` enables debug output and specifies a glob for matching debug categories (like ``fish -d``). Defaults to empty. - ``-D`` or ``--debug-stack-frames=DEBUG_LEVEL`` specify how many stack frames to display when debug messages are written. The default is zero. A value of 3 or 4 is usually sufficient to gain insight into how a given debug call was reached but you can specify a value up to 128.