summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorClement Tsang <34804052+ClementTsang@users.noreply.github.com>2023-04-28 00:00:19 -0400
committerClement Tsang <34804052+ClementTsang@users.noreply.github.com>2023-04-28 00:00:23 -0400
commitc99e98c6d3074f6a1527b448e75e2a42349fca04 (patch)
tree90c86dbccc6dc798aacac4e67a334d98e2ac6f25
parent48747b8bd2167899238f31c9e4dffad15f9234c0 (diff)
other: edit some comments
-rw-r--r--Cargo.toml2
-rw-r--r--src/bin/main.rs12
2 files changed, 9 insertions, 5 deletions
diff --git a/Cargo.toml b/Cargo.toml
index 767bba98..ee1cd21a 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -16,9 +16,9 @@ exclude = [
".cargo-husky/",
".github/",
"assets/",
- "scripts/",
"docs/",
"sample_configs/",
+ "scripts/",
".all-contributorsrc",
".cirrus.yml",
".markdownlint.json",
diff --git a/src/bin/main.rs b/src/bin/main.rs
index 3ffaf234..77709f5a 100644
--- a/src/bin/main.rs
+++ b/src/bin/main.rs
@@ -3,6 +3,8 @@
#![deny(clippy::unimplemented)]
#![deny(clippy::missing_safety_doc)]
#[allow(unused_imports)] // TODO: Deny unused imports.
+
+// Primarily used for debug purposes.
#[cfg(feature = "log")]
#[macro_use]
extern crate log;
@@ -35,6 +37,7 @@ use bottom::{
*,
};
+// Used for heap allocation debugging purposes.
// #[global_allocator]
// static ALLOC: dhat::Alloc = dhat::Alloc;
@@ -64,7 +67,7 @@ fn main() -> Result<()> {
CanvasColours::new(colour_scheme, &config)?
};
- // Create "app" struct, which will control most of the program and store settings/state
+ // Create an "app" struct, which will control most of the program and store settings/state
let mut app = build_app(
&matches,
&mut config,
@@ -144,9 +147,9 @@ fn main() -> Result<()> {
#[cfg(target_os = "freebsd")]
let _stderr_fd = {
// A really ugly band-aid to suppress stderr warnings on FreeBSD due to sysinfo.
- use std::fs::OpenOptions;
-
+ // For more information, see https://github.com/ClementTsang/bottom/issues/798.
use filedescriptor::{FileDescriptor, StdioDescriptor};
+ use std::fs::OpenOptions;
let path = OpenOptions::new().write(true).open("/dev/null")?;
FileDescriptor::redirect_stdio(&path, StdioDescriptor::Stderr)?
@@ -171,7 +174,8 @@ fn main() -> Result<()> {
if let Ok(recv) = receiver.recv_timeout(Duration::from_millis(TICK_RATE_IN_MILLISECONDS)) {
match recv {
BottomEvent::Resize => {
- try_drawing(&mut terminal, &mut app, &mut painter)?; // FIXME: This is bugged with frozen?
+ // FIXME: This is bugged with frozen?
+ try_drawing(&mut terminal, &mut app, &mut painter)?;
}
BottomEvent::KeyInput(event) => {
if handle_key_event_or_break(event, &mut app, &collection_thread_ctrl_sender) {