From: eugene.loh@oracle.com
To: dtrace@lists.linux.dev, dtrace-devel@oss.oracle.com
Subject: [PATCH v2 15/20] doc: Clean up profile unit table
Date: Tue, 21 Oct 2025 23:22:45 -0400 [thread overview]
Message-ID: <20251022032251.2010-10-eugene.loh@oracle.com> (raw)
In-Reply-To: <20251022032251.2010-1-eugene.loh@oracle.com>
From: Eugene Loh <eugene.loh@oracle.com>
There are two references to "Table 1" (which is not otherwise
identified), along with links to an undefined ID. Rework these
references.
While we're at it, convert the table from HTML to Markdown and break up
some longer lines, improving readability and maintainability of the
Markdown source file.
Signed-off-by: Eugene Loh <eugene.loh@oracle.com>
---
.../reference/dtrace_providers_profile.md | 95 ++++---------------
1 file changed, 20 insertions(+), 75 deletions(-)
diff --git a/doc/userguide/reference/dtrace_providers_profile.md b/doc/userguide/reference/dtrace_providers_profile.md
index da83e8561..762109d02 100644
--- a/doc/userguide/reference/dtrace_providers_profile.md
+++ b/doc/userguide/reference/dtrace_providers_profile.md
@@ -11,86 +11,31 @@ Such probes aren't associated with any particular point of execution, but rather
The `profile-*n*` probes fire at a fixed interval, at a high-interrupt level on all active CPUs.
-The units of *n* default to a frequency that's expressed as a rate of firing per second, but the value can also have an optional suffix , as shown in [Table 1](dtrace_providers_profile.md#dt_t1_prov), which specifies either a time interval or a frequency. The following table describes valid time suffixes for a `tick-` *n* probe.
+The units of *n* default to a frequency that's expressed as a rate of firing per second,
+but the value can also have an optional suffix, as shown in the following table,
+which specifies either a time interval or a frequency.
+The following table describes valid time suffixes for a `tick-` *n* probe.
+
+| Suffix | Time Units |
+| :--- | :--- |
+| `nsec` or `ns` | nanoseconds |
+| `usec` or `us` | microseconds |
+| `msec` or `ms` | milliseconds |
+| `sec` or `s` | seconds |
+| `min` or `m` | minutes |
+| `hour` or `h` | hours |
+| `day` or `d` | days |
+| `hz` | hertz \(frequency expressed as rate per second\) |
-<table><thead><tr><th>
-
-Suffix
-
-</th><th>
-
-Time Units
-
-</th></tr></thead><tbody><tr><td>
-
-`nsec` or `ns`
-
-</td><td>
-
-nanoseconds
-
-</td></tr><tr><td>
-
-`usec` or `us`
-
-</td><td>
-
-microseconds
-
-</td></tr><tr><td>
-
-`msec` or `ms`
-
-</td><td>
-
-milliseconds
-
-</td></tr><tr><td>
-
-`sec` or `s`
-
-</td><td>
-
-seconds
-
-</td></tr><tr><td>
-
-`min` or `m`
-
-</td><td>
-
-minutes
-
-</td></tr><tr><td>
-
-`hour` or `h`
-
-</td><td>
-
-hours
-
-</td></tr><tr><td>
-
-`day` or `d`
-
-</td><td>
-
-days
-
-</td></tr><tr><td>
-
-`hz`
-
-</td><td>
-
-hertz \(frequency expressed as rate per second\)
-
-</td></tr><tbody></table>
## tick-*n* Probes <a id="dt_ref_profile-tick-n_prov">
The `tick-*n*` probes fire at fixed intervals, at a high interrupt level on only one CPU per interval.
-Unlike `profile-*n*` probes, which fire on every CPU, `tick-*n*` probes fire on only one CPU per interval and the CPU on which they fire can change over time. The units of *n* default to a frequency expressed as a rate of firing per second, but the value can also have an optional time suffix as shown in [Table 1](dtrace_providers_profile.md#dt_t1_prov), which specifies either a time interval or a frequency.
+Unlike `profile-*n*` probes, which fire on every CPU,
+`tick-*n*` probes fire on only one CPU per interval and the CPU on which they fire can change over time.
+The units of *n* default to a frequency expressed as a rate of firing per second,
+but the value can also have an optional time suffix as shown in the earlier table,
+which specifies either a time interval or a frequency.
The `tick-*n*` probes have several uses, such as providing some periodic output or taking a periodic action.
--
2.47.3
next prev parent reply other threads:[~2025-10-22 3:23 UTC|newest]
Thread overview: 28+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-10-22 3:22 [PATCH v2 05/20] doc: Replace duplicate id eugene.loh
2025-10-22 3:22 ` [PATCH v2 06/20] doc: Clean up dangling anchor links eugene.loh
2025-10-23 19:53 ` Elena Zannoni
2025-10-22 3:22 ` [PATCH v2 08/20] doc: Fix anchor links for built-in variables eugene.loh
2025-10-23 19:26 ` Elena Zannoni
2025-10-22 3:22 ` [PATCH v2 09/20] doc: Fix anchor links for providers eugene.loh
2025-10-23 19:27 ` [DTrace-devel] " Elena Zannoni
2025-10-22 3:22 ` [PATCH v2 10/20] doc: Fix anchor links for explanation/ eugene.loh
2025-10-23 19:27 ` Elena Zannoni
2025-10-22 3:22 ` [PATCH v2 11/20] doc: Fix anchor links for how-to/ eugene.loh
2025-10-23 19:28 ` [DTrace-devel] " Elena Zannoni
2025-10-22 3:22 ` [PATCH v2 12/20] doc: Fix anchor links for reference/ eugene.loh
2025-10-23 19:28 ` [DTrace-devel] " Elena Zannoni
2025-10-22 3:22 ` [PATCH v2 13/20] doc: Clean up the table for string relational operators eugene.loh
2025-10-23 19:30 ` [DTrace-devel] " Elena Zannoni
2025-10-22 3:22 ` [PATCH v2 14/20] doc: Link to "Character Escape Sequences" table eugene.loh
2025-10-23 19:32 ` [DTrace-devel] " Elena Zannoni
2025-10-22 3:22 ` eugene.loh [this message]
2025-10-23 19:33 ` [DTrace-devel] [PATCH v2 15/20] doc: Clean up profile unit table Elena Zannoni
2025-10-22 3:22 ` [PATCH v2 16/20] doc: Clean up undefined anchor links eugene.loh
2025-10-23 19:34 ` Elena Zannoni
2025-10-22 3:22 ` [PATCH v2 17/20] doc: Add IP provider documentation eugene.loh
2025-10-22 3:22 ` [PATCH v2 18/20] doc: Add TCP " eugene.loh
2025-10-22 3:22 ` [PATCH v2 19/20] doc: Add UDP " eugene.loh
2025-10-22 3:22 ` [PATCH v2 20/20] doc: Add rawfbt " eugene.loh
2025-10-22 3:22 ` [PATCH 21/20] doc: Add blank line before section head so it is recognized eugene.loh
2025-10-23 19:35 ` [DTrace-devel] " Elena Zannoni
2025-10-23 19:23 ` [PATCH v2 05/20] doc: Replace duplicate id Elena Zannoni
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20251022032251.2010-10-eugene.loh@oracle.com \
--to=eugene.loh@oracle.com \
--cc=dtrace-devel@oss.oracle.com \
--cc=dtrace@lists.linux.dev \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox