Skip to content

Commit 8a27f96

Browse files
hdshawkw
authored andcommitted
docs(console): update screenshots in README (#421)
The screenshots in the README, which are also used in in the `tokio-console` page on docs.rs were a bit outdated. The UI has changed a bit since they were created. This change updates the screenshots to be based on the latest UI from the `main` branch. All previous versions of `tokio-console` on docs.rs reference the images on the main branch, so it is important that they remain unchanged. The new screenshots have been added to a sub-directory of the `assets` directory named after the next version: `tokio-console-0.1.8`.
1 parent 993a3d9 commit 8a27f96

File tree

6 files changed

+7
-7
lines changed

6 files changed

+7
-7
lines changed
445 KB
Loading
224 KB
Loading

Diff for: assets/tokio-console-0.1.8/resources_list.png

618 KB
Loading

Diff for: assets/tokio-console-0.1.8/task_details.png

358 KB
Loading

Diff for: assets/tokio-console-0.1.8/tasks_list.png

447 KB
Loading

Diff for: tokio-console/README.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -100,20 +100,20 @@ See [here][cli-ref] for a complete list of all command-line arguments.
100100
When the console CLI is launched, it displays a list of all [asynchronous tasks]
101101
in the program:
102102

103-
![tasks list](https://raw.githubusercontent.com/tokio-rs/console/main/assets/tasks_list.png)
103+
![tasks list](https://raw.githubusercontent.com/tokio-rs/console/main/assets/tokio-console-0.1.8/tasks_list.png)
104104

105105
Using the <kbd>&#8593;</kbd> and <kbd>&#8595;</kbd> arrow keys, an individual task can be highlighted.
106106
Pressing<kbd>enter</kbd> while a task is highlighted displays details about that
107107
task:
108108

109-
![task details](https://raw.githubusercontent.com/tokio-rs/console/main/assets/details2.png)
109+
![task details](https://raw.githubusercontent.com/tokio-rs/console/main/assets/tokio-console-0.1.8/task_details.png)
110110

111111
Pressing the <kbd>escape</kbd> key returns to the task list.
112112

113113
The <kbd>r</kbd> key switches from the list of tasks to a list of [resources],
114114
such as synchronization primitives, I/O resources, et cetera:
115115

116-
![resource list](https://raw.githubusercontent.com/tokio-rs/console/main/assets/resources.png)
116+
![resource list](https://raw.githubusercontent.com/tokio-rs/console/main/assets/tokio-console-0.1.8/resources_list.png)
117117

118118

119119
Pressing the <kbd>t</kbd> key switches the view back to the task list.
@@ -122,13 +122,13 @@ Like the task list view, the resource list view can be navigated using the
122122
<kbd>&#8593;</kbd> and <kbd>&#8595;</kbd> arrow keys. Pressing <kbd>enter</kbd>
123123
while a resource is highlighted displays details about that resource:
124124

125-
![resource details --- oneshot](https://raw.githubusercontent.com/tokio-rs/console/main/assets/resource_details1.png)
125+
![resource details --- sleep](https://raw.githubusercontent.com/tokio-rs/console/main/assets/tokio-console-0.1.8/resource_details_sleep.png)
126126

127127
The resource details view lists the tasks currently waiting on that resource.
128-
This may be a single task, as in the [`tokio::sync::oneshot`] channel above, or
129-
a large number of tasks, such as this [`tokio::sync::Semaphore`]:
128+
This may be a single task, as in the [`tokio::time::Sleep`] above, or
129+
a large number of tasks, such as this private `tokio::sync::batch_semaphore::Semaphore`:
130130

131-
![resource details --- semaphore](https://raw.githubusercontent.com/tokio-rs/console/main/assets/resource_details2.png)
131+
![resource details --- semaphore](https://raw.githubusercontent.com/tokio-rs/console/main/assets/tokio-console-0.1.8/resource_details_semaphore.png)
132132

133133
Like the task details view, pressing the <kbd>escape</kbd> key while viewing a resource's details
134134
returns to the resource list.

0 commit comments

Comments
 (0)