diff options
| author | 哇呜哇呜呀咦耶 <pingao777@gmail.com> | 2022-11-13 22:25:37 +0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-11-13 23:25:37 +0900 |
| commit | 8626e7ab40f39dc01cea17b43408f7f6d30fd7e4 (patch) | |
| tree | 88ed5ad5e247ecb6dc7042dc13dcb5cf756e2db4 | |
| parent | 342d1629d08f429a8cb56150401f169c7f1e6b97 (diff) | |
update log path (#1927)
| -rw-r--r-- | CONTRIBUTING.md | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 87eca0941..0c79ec0f4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -84,7 +84,7 @@ Once you do, in the repository root: To re-run the tests after you've changed something in the code base, be sure to repeat steps 2 and 3. ## Debugging / Troubleshooting while developing -Zellij uses the excellent [`log`](https://crates.io/crates/log) crate to handle its internal logging. The output of these logs will go to `/tmp/zellij-<UID>/zellij-log/zellij.log`. +Zellij uses the excellent [`log`](https://crates.io/crates/log) crate to handle its internal logging. The output of these logs will go to `/$temp_dir/zellij-<UID>/zellij-log/zellij.log` which `$temp_dir` refers to [std::env::temp_dir()](https://doc.rust-lang.org/std/env/fn.temp_dir.html). On most of operating systems it points to `/tmp`, but there are exceptions, such as `/var/folders/dr/xxxxxxxxxxxxxx/T/` for Mac. Example: ```rust @@ -94,7 +94,7 @@ log::info!("my variable is: {:?}", my_variable); Note that the output is truncated at 100KB. This can be adjusted for the purposes of debugging through the `LOG_MAX_BYTES` constant, at the time of writing here: https://github.com/zellij-org/zellij/blob/main/zellij-utils/src/logging.rs#L24 -When running Zellij with the `--debug` flag, Zellij will dump a copy of all bytes received over the pty for each pane in: `/tmp/zellij-<UID>/zellij-log/zellij-<pane_id>.log`. These might be useful when troubleshooting terminal issues. +When running Zellij with the `--debug` flag, Zellij will dump a copy of all bytes received over the pty for each pane in: `/$temp_dir/zellij-<UID>/zellij-log/zellij-<pane_id>.log`. These might be useful when troubleshooting terminal issues. ## How we treat clippy lints |