refactor: rename to SelfWakes

Signed-off-by: hi-rustin <rustin.liu@gmail.com>
tokio-rs · Nov 29, 2023 · d161904 · d161904
1 parent c3eae4f
commit d161904
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 19 deletions.
diff --git a/README.md b/README.md
@@ -218,17 +218,16 @@ Options:
           
           Each linter is specified by its name, which is one of:
           
-          * `self-wake-percent` -- Warns when a task wakes itself more
-          than a certain percentage of its total wakeups.
+          * `self-wakes` -- Warns when a task wakes itself more than a
+          certain percentage of its total wakeups.
           
           * `lost-waker` -- Warns when a task is dropped without being
           woken.
           
           * `never-yielded` -- Warns when a task has never yielded.
           
-          [default: self-wake-percent lost-waker never-yielded]
-          [possible values: self-wake-percent, lost-waker,
-          never-yielded]
+          [default: self-wakes lost-waker never-yielded]
+          [possible values: self-wakes, lost-waker, never-yielded]
 
       --log-dir <LOG_DIRECTORY>
           Path to a directory to write the console's internal logs to.

diff --git a/tokio-console/console.example.toml b/tokio-console/console.example.toml
@@ -1,7 +1,7 @@
 default_target_addr = 'http://127.0.0.1:6669/'
 log = 'off'
 linters = [
-    'self-wake-percent',
+    'self-wakes',
     'lost-waker',
     'never-yielded',
 ]

diff --git a/tokio-console/src/config.rs b/tokio-console/src/config.rs
@@ -56,15 +56,15 @@ pub struct Config {
     ///
     /// Each linter is specified by its name, which is one of:
     ///
-    /// * `self-wake-percent` -- Warns when a task wakes itself more than a certain percentage of its total wakeups.
+    /// * `self-wakes` -- Warns when a task wakes itself more than a certain percentage of its total wakeups.
     ///
     /// * `lost-waker` -- Warns when a task is dropped without being woken.
     ///
     /// * `never-yielded` -- Warns when a task has never yielded.
     ///
     #[clap(long = "linters", value_delimiter = ',', num_args = 1..)]
     #[clap(default_values_t = vec![
-        KnownWarnings::SelfWakePercent,
+        KnownWarnings::SelfWakes,
         KnownWarnings::LostWaker,
         KnownWarnings::NeverYielded
     ])]
@@ -124,17 +124,15 @@ pub struct Config {
 #[derive(clap::ValueEnum, Clone, Debug, Deserialize, Serialize, PartialEq, Eq, PartialOrd, Ord)]
 #[serde(rename_all = "kebab-case")]
 pub(crate) enum KnownWarnings {
-    SelfWakePercent,
+    SelfWakes,
     LostWaker,
     NeverYielded,
 }
 
 impl From<&KnownWarnings> for warnings::Linter<Task> {
     fn from(warning: &KnownWarnings) -> Self {
         match warning {
-            KnownWarnings::SelfWakePercent => {
-                warnings::Linter::new(warnings::SelfWakePercent::default())
-            }
+            KnownWarnings::SelfWakes => warnings::Linter::new(warnings::SelfWakePercent::default()),
             KnownWarnings::LostWaker => warnings::Linter::new(warnings::LostWaker),
             KnownWarnings::NeverYielded => warnings::Linter::new(warnings::NeverYielded::default()),
         }
@@ -144,7 +142,7 @@ impl From<&KnownWarnings> for warnings::Linter<Task> {
 impl fmt::Display for KnownWarnings {
     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
         match self {
-            KnownWarnings::SelfWakePercent => write!(f, "self-wake-percent"),
+            KnownWarnings::SelfWakes => write!(f, "self-wakes"),
             KnownWarnings::LostWaker => write!(f, "lost-waker"),
             KnownWarnings::NeverYielded => write!(f, "never-yielded"),
         }
@@ -504,7 +502,7 @@ impl Default for Config {
                 filter::Targets::new().with_default(filter::LevelFilter::OFF),
             )),
             linters: vec![
-                KnownWarnings::SelfWakePercent,
+                KnownWarnings::SelfWakes,
                 KnownWarnings::LostWaker,
                 KnownWarnings::NeverYielded,
             ],

diff --git a/tokio-console/tests/cli-ui.stdout b/tokio-console/tests/cli-ui.stdout
@@ -47,17 +47,16 @@ Options:
 
           Each linter is specified by its name, which is one of:
 
-          * `self-wake-percent` -- Warns when a task wakes itself more
-          than a certain percentage of its total wakeups.
+          * `self-wakes` -- Warns when a task wakes itself more than a
+          certain percentage of its total wakeups.
 
           * `lost-waker` -- Warns when a task is dropped without being
           woken.
 
           * `never-yielded` -- Warns when a task has never yielded.
 
-          [default: self-wake-percent lost-waker never-yielded]
-          [possible values: self-wake-percent, lost-waker,
-          never-yielded]
+          [default: self-wakes lost-waker never-yielded]
+          [possible values: self-wakes, lost-waker, never-yielded]
 
       --log-dir <LOG_DIRECTORY>
           Path to a directory to write the console's internal logs to.