Skip to content

Commit 97af76c

Browse files
committed
Updated docs. Fixed a non-standard-conforming global option
1 parent d6c1383 commit 97af76c

File tree

3 files changed

+22
-3
lines changed

3 files changed

+22
-3
lines changed

README.rst

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -177,9 +177,16 @@ You can auto confirm the prompt. In this case no preview will be shown.
177177
$ tmuxp convert --yes filename
178178
179179
180-
Debug Info
180+
Debugging Helpers
181181
----------
182182
183+
The `load` command provides a way to log output to a log file for debugging
184+
purposes.
185+
186+
.. code-block:: sh
187+
188+
$ tmuxp load --log-file <log-file-name> .
189+
183190
Collect system info to submit with a Github issue:
184191
185192
.. code-block:: sh
@@ -192,6 +199,7 @@ Collect system info to submit with a Github issue:
192199
193200
# ... so on
194201
202+
195203
Docs / Reading material
196204
-----------------------
197205

docs/cli.rst

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -184,12 +184,23 @@ are created, the last session is named from the terminal.
184184
185185
$ tmxup load -s <new_session_name> <filename1> ...
186186
187+
The output of the ``load`` command can be logged to a file for
188+
debugging purposes. the log level can be controlled with the global
189+
``--log-level`` option (defaults to INFO).
190+
191+
.. code-block:: bash
192+
193+
$ tmuxp load <filename> --log-file <log_filename>
194+
$ tmuxp --log-level <LEVEL> load <filename> --log-file <log_filename>
195+
196+
187197
.. _cli_debug_info:
188198

189199
Debug Info
190200
----------
191201

192-
Use to collect all relevant information for submitting an issue to the project.
202+
Use to collect all relevant information for submitting an issue to
203+
the project.
193204

194205
.. code-block:: bash
195206

tmuxp/cli.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -623,7 +623,7 @@ def load_workspace(
623623
@click.group(context_settings={'obj': {}})
624624
@click.version_option(__version__, '-V', '--version', message='%(prog)s %(version)s')
625625
@click.option(
626-
'--log_level',
626+
'--log-level',
627627
default='INFO',
628628
help='Log level (DEBUG, INFO, WARNING, ERROR, CRITICAL)',
629629
)

0 commit comments

Comments
 (0)