[PATCH v2 15/20] doc: Clean up profile unit table

eugene.loh
2025-10-22T03:23:27Z

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\) |

-
-
-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\)
-
-
## tick-*n* Probes

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