From 93d67187664fc43814955fbf94511bbfb2cf6eca Mon Sep 17 00:00:00 2001 From: Clement Tsang <34804052+ClementTsang@users.noreply.github.com> Date: Thu, 11 Apr 2024 00:46:35 +0000 Subject: [PATCH] other: update a bunch of argument descriptions and some arg/config names (#1441) * other: update a bunch of argument descriptions and some arg/config names * update docs * changelog --- CHANGELOG.md | 5 + .../configuration/command-line-options.md | 118 ++-- .../configuration/config-file/flags.md | 4 +- sample_configs/default_config.toml | 4 +- sample_configs/demo_config.toml | 2 +- schema/nightly/bottom.json | 4 +- src/app.rs | 6 +- src/canvas/widgets/cpu_graph.rs | 4 +- src/constants.rs | 4 +- src/options.rs | 10 +- src/options/args.rs | 522 +++++++++--------- src/options/args.template | 8 - src/options/config.rs | 4 +- src/options/config/layout.rs | 23 +- 14 files changed, 343 insertions(+), 375 deletions(-) delete mode 100644 src/options/args.template diff --git a/CHANGELOG.md b/CHANGELOG.md index 62f09a1a..9c60d394 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -19,6 +19,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - [#1376](https://github.com/ClementTsang/bottom/pull/1376): Group together related command-line arguments in `-h` and `--help`. - [#1411](https://github.com/ClementTsang/bottom/pull/1411): Add `time` as a default column. - [#1436](https://github.com/ClementTsang/bottom/pull/1436): Use actual "swap" value for Windows. +- [#1441](https://github.com/ClementTsang/bottom/pull/1441): The following arguments have changed names: + - `--left_legend/-l` is now `--cpu_left_legend`. +- [#1441](https://github.com/ClementTsang/bottom/pull/1441): The following config arguments have changed names: + - `expanded_on_startup` is now `expanded`. + - `left_legend` is now `cpu_left_legend`. ### Bug Fixes diff --git a/docs/content/configuration/command-line-options.md b/docs/content/configuration/command-line-options.md index e0c6286b..9d95fc96 100644 --- a/docs/content/configuration/command-line-options.md +++ b/docs/content/configuration/command-line-options.md @@ -5,76 +5,76 @@ see information on these options by running `btm -h`, or run `btm --help` to dis ## General Options -| Option | Behaviour | -| ------------------------------------- | --------------------------------------------------- | -| `--autohide_time` | Temporarily shows the time scale in graphs. | -| `-b`, `--basic` | Hides graphs and uses a more basic look. | -| `-C`, `--config ` | Sets the location of the config file. | -| `-t`, `--default_time_value