Mirrors/bottom
2
0
Fork 0
mirror of https://github.com/ClementTsang/bottom synced 2024-11-22 04:03:06 +00:00
Code Issues Projects Releases Packages Wiki Activity

docs: update changelog + docs for default expansion feature (#928)

Browse source
This commit is contained in:
Clement Tsang 2022-12-07 04:28:43 -05:00 committed by GitHub
parent c38313abeb
commit 07fd2152f4
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
5 changed files with 6 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
CHANGELOG.md
View file

@ -35,6 +35,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- [#881](https://github.com/ClementTsang/bottom/pull/881): Add pasting to the search bar. - [#881](https://github.com/ClementTsang/bottom/pull/881): Add pasting to the search bar.
- [#892](https://github.com/ClementTsang/bottom/pull/892): Add custom retention periods for data. - [#892](https://github.com/ClementTsang/bottom/pull/892): Add custom retention periods for data.
- [#899](https://github.com/ClementTsang/bottom/pull/899): Add non-normalized CPU usage to processes. - [#899](https://github.com/ClementTsang/bottom/pull/899): Add non-normalized CPU usage to processes.
- [#919](https://github.com/ClementTsang/bottom/pull/919): Add an option to expand the default widget on startup.
## [0.6.8] - 2022-02-01 ## [0.6.8] - 2022-02-01

1
docs/content/configuration/command-line-flags.md
View file

@ -46,3 +46,4 @@ The following flags can be provided to bottom in the command line to change the
| `--enable_gpu_memory` | Enable collecting and displaying GPU memory usage. | | `--enable_gpu_memory` | Enable collecting and displaying GPU memory usage. |
| `--retention` | How much data is stored at once in terms of time. | | `--retention` | How much data is stored at once in terms of time. |
| `-n`, `--unnormalized_cpu` | Show process CPU% without normalizing over the number of cores. | | `-n`, `--unnormalized_cpu` | Show process CPU% without normalizing over the number of cores. |
| `-e`, `--expanded` | Expand the default widget upon starting the app. |

1
docs/content/configuration/config-file/flags.md
View file

@ -39,3 +39,4 @@ Most of the [command line flags](../../command-line-flags) have config file equi
| `enable_gpu_memory` | Boolean | Shows the GPU memory widget. | | `enable_gpu_memory` | Boolean | Shows the GPU memory widget. |
| `retention` | String (human readable time, such as "10m", "1h", etc.) | How much data is stored at once in terms of time. | | `retention` | String (human readable time, such as "10m", "1h", etc.) | How much data is stored at once in terms of time. |
| `unnormalized_cpu` | Boolean | Show process CPU% without normalizing over the number of cores. | | `unnormalized_cpu` | Boolean | Show process CPU% without normalizing over the number of cores. |
| `expanded_on_startup` | Boolean | Expand the default widget upon starting the app. |

2
sample_configs/default_config.toml
View file

@ -43,7 +43,7 @@
# Override layout default widget # Override layout default widget
#default_widget_type = "proc" #default_widget_type = "proc"
#default_widget_count = 1 #default_widget_count = 1
# Expand selected widget upon starting the app # Expand the default widget upon starting the app.
#expanded_on_startup = true #expanded_on_startup = true
# Use basic mode # Use basic mode
#basic = false #basic = false

4
src/clap.rs
View file

@ -319,8 +319,8 @@ use CPU (3) as the default instead.
let expanded_on_startup = Arg::new("expanded_on_startup") let expanded_on_startup = Arg::new("expanded_on_startup")
.long("expanded") .long("expanded")
.short('e') .short('e')
.help("Expand selected widget upon starting the app.") .help("Expand the default widget upon starting the app.")
.long_help("Expand selected widget upon starting the app. Same as pressing \"e\" inside the app. Use with \"default_widget_type\" and \"default_widget_count\" to select desired expanded widget. This flag has no effect in basic mode (--basic)"); .long_help("Expand the default widget upon starting the app. Same as pressing \"e\" inside the app. Use with \"default_widget_type\" and \"default_widget_count\" to select desired expanded widget. This flag has no effect in basic mode (--basic)");
let rate = Arg::new("rate") let rate = Arg::new("rate")
.short('r') .short('r')