diff options
| author | Donatas Abraitis <donatas@opensourcerouting.org> | 2024-01-07 12:29:08 +0100 |
|---|---|---|
| committer | Donatas Abraitis <donatas@opensourcerouting.org> | 2024-01-07 13:14:56 +0100 |
| commit | 8c382a675e73278d2b1de61ba5f05232af8cb245 (patch) | |
| tree | 4c7c460dd5ec77107ec284fac1cb4b103968e25a /doc | |
| parent | Merge pull request #15105 from donaldsharp/event_thread_mishap (diff) | |
| download | frr-8c382a675e73278d2b1de61ba5f05232af8cb245.tar.xz frr-8c382a675e73278d2b1de61ba5f05232af8cb245.zip | |
doc: Rename `show thread ...` to `show event ...`
Signed-off-by: Donatas Abraitis <donatas@opensourcerouting.org>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/developer/process-architecture.rst | 8 | ||||
| -rw-r--r-- | doc/user/basic.rst | 6 |
2 files changed, 7 insertions, 7 deletions
diff --git a/doc/developer/process-architecture.rst b/doc/developer/process-architecture.rst index 06ee6a3c3..1f990059a 100644 --- a/doc/developer/process-architecture.rst +++ b/doc/developer/process-architecture.rst @@ -87,7 +87,7 @@ are given by integer macros in :file:`frrevent.h` and are: ``EVENT_EXECUTE`` Just before a task is run its type is changed to this. This is used to show - ``X`` as the type in the output of :clicmd:`show thread cpu`. + ``X`` as the type in the output of :clicmd:`show event cpu`. The programmer never has to work with these types explicitly. Each type of task is created and queued via special-purpose functions (actually macros, but @@ -238,14 +238,14 @@ proceeding. In addition, the existing commands to show statistics and other information for tasks within the event driven model have been expanded to handle multiple -pthreads; running :clicmd:`show thread cpu` will display the usual event +pthreads; running :clicmd:`show event cpu` will display the usual event breakdown, but it will do so for each pthread running in the program. For example, :ref:`bgpd` runs a dedicated I/O pthread and shows the following -output for :clicmd:`show thread cpu`: +output for :clicmd:`show event cpu`: :: - frr# show thread cpu + frr# show event cpu Thread statistics for bgpd: diff --git a/doc/user/basic.rst b/doc/user/basic.rst index bbf24c5ee..24978b2f7 100644 --- a/doc/user/basic.rst +++ b/doc/user/basic.rst @@ -673,20 +673,20 @@ Terminal Mode Commands .. _common-show-commands: -.. clicmd:: show thread cpu [r|w|t|e|x] +.. clicmd:: show event cpu [r|w|t|e|x] This command displays system run statistics for all the different event types. If no options is specified all different run types are displayed together. Additionally you can ask to look at (r)ead, (w)rite, (t)imer, (e)vent and e(x)ecute thread event types. -.. clicmd:: show thread poll +.. clicmd:: show event poll This command displays FRR's poll data. It allows a glimpse into how we are setting each individual fd for the poll command at that point in time. -.. clicmd:: show thread timers +.. clicmd:: show event timers This command displays FRR's timer data for timers that will pop in the future. |