Re: [DTrace-devel] [PATCH 04/20] doc: Convert stability attribute tables to Markdown for readability
Elena Zannoni <[email protected]>
| Newsgroups | dev.linux.lists.dtrace |
|---|---|
| Organization | Oracle USA Inc. |
| Message-ID | <[email protected]> |
Reviewed-by: Elena Zannoni <[email protected]> On 9/26/25 1:05 PM, eugene.loh--- via DTrace-devel wrote: > From: Eugene Loh <[email protected]> > > Signed-off-by: Eugene Loh <[email protected]> > --- > .../reference/dtrace_providers_cpc.md | 104 ++---------------- > .../reference/dtrace_providers_dtrace.md | 104 ++---------------- > .../reference/dtrace_providers_fbt.md | 104 ++---------------- > .../reference/dtrace_providers_io.md | 104 ++---------------- > .../reference/dtrace_providers_lockstat.md | 104 ++---------------- > .../reference/dtrace_providers_pid.md | 104 ++---------------- > .../reference/dtrace_providers_proc.md | 104 ++---------------- > .../reference/dtrace_providers_profile.md | 104 ++---------------- > .../reference/dtrace_providers_rawtp.md | 104 ++---------------- > .../reference/dtrace_providers_sched.md | 104 ++---------------- > .../reference/dtrace_providers_sdt.md | 104 ++---------------- > .../reference/dtrace_providers_syscall.md | 104 ++---------------- > 12 files changed, 84 insertions(+), 1164 deletions(-) > > diff --git a/doc/userguide/reference/dtrace_providers_cpc.md b/doc/userguide/reference/dtrace_providers_cpc.md > index 5128d8e8b..39b2ca6f5 100644 > --- a/doc/userguide/reference/dtrace_providers_cpc.md > +++ b/doc/userguide/reference/dtrace_providers_cpc.md > @@ -60,100 +60,10 @@ cpc:::cycles-all-50000000 > > The `cpc` provider uses DTrace's stability mechanism to describe its stabilities. These values are listed in the following table. > > -<table><thead><tr><th> > - > -Element > - > -</th><th> > - > -Name Stability > - > -</th><th> > - > -Data Stability > - > -</th><th> > - > -Dependency Class > - > -</th></tr></thead><tbody><tr><td> > - > -Provider > - > -</td><td> > - > -Evolving > - > -</td><td> > - > -Evolving > - > -</td><td> > - > -Common > - > -</td></tr><tr><td> > - > -Module > - > -</td><td> > - > -Private > - > -</td><td> > - > -Private > - > -</td><td> > - > -Unknown > - > -</td></tr><tr><td> > - > -Function > - > -</td><td> > - > -Private > - > -</td><td> > - > -Private > - > -</td><td> > - > -Unknown > - > -</td></tr><tr><td> > - > -Name > - > -</td><td> > - > -Evolving > - > -</td><td> > - > -Evolving > - > -</td><td> > - > -CPU > - > -</td></tr><tr><td> > - > -Arguments > - > -</td><td> > - > -Evolving > - > -</td><td> > - > -Evolving > - > -</td><td> > - > -Common > - > -</td></tr><tbody></table> > +| Element | Name Stability | Data Stability | Dependency Class | > +| :--- | :--- | :--- | :--- | > +| Provider | Evolving | Evolving | Common | > +| Module | Private | Private | Unknown | > +| Function | Private | Private | Unknown | > +| Name | Evolving | Evolving | CPU | > +| Arguments | Evolving | Evolving | Common | > diff --git a/doc/userguide/reference/dtrace_providers_dtrace.md b/doc/userguide/reference/dtrace_providers_dtrace.md > index 1680c2a72..ef62c5040 100644 > --- a/doc/userguide/reference/dtrace_providers_dtrace.md > +++ b/doc/userguide/reference/dtrace_providers_dtrace.md > @@ -315,100 +315,10 @@ If the actions that are taken in the `ERROR` probe cause an error, that error is > > The `dtrace` provider uses DTrace's stability mechanism to describe its stabilities. These values are listed in the following table. > > -<table><thead><tr><th> > - > -Element > - > -</th><th> > - > -Name Stability > - > -</th><th> > - > -Data Stability > - > -</th><th> > - > -Dependency Class > - > -</th></tr></thead><tbody><tr><td> > - > -Provider > - > -</td><td> > - > -Stable > - > -</td><td> > - > -Stable > - > -</td><td> > - > -Common > - > -</td></tr><tr><td> > - > -Module > - > -</td><td> > - > -Private > - > -</td><td> > - > -Private > - > -</td><td> > - > -Unknown > - > -</td></tr><tr><td> > - > -Function > - > -</td><td> > - > -Private > - > -</td><td> > - > -Private > - > -</td><td> > - > -Unknown > - > -</td></tr><tr><td> > - > -Name > - > -</td><td> > - > -Stable > - > -</td><td> > - > -Stable > - > -</td><td> > - > -Common > - > -</td></tr><tr><td> > - > -Arguments > - > -</td><td> > - > -Stable > - > -</td><td> > - > -Stable > - > -</td><td> > - > -Common > - > -</td></tr><tbody></table> > +| Element | Name Stability | Data Stability | Dependency Class | > +| :--- | :--- | :--- | :--- | > +| Provider | Stable | Stable | Common | > +| Module | Private | Private | Unknown | > +| Function | Private | Private | Unknown | > +| Name | Stable | Stable | Common | > +| Arguments | Stable | Stable | Common | > diff --git a/doc/userguide/reference/dtrace_providers_fbt.md b/doc/userguide/reference/dtrace_providers_fbt.md > index 727614434..885d59230 100644 > --- a/doc/userguide/reference/dtrace_providers_fbt.md > +++ b/doc/userguide/reference/dtrace_providers_fbt.md > @@ -78,100 +78,10 @@ The output shows the internal kernel functions that are making calls to the `kme > > The `fbt` provider uses DTrace's stability mechanism to describe its stabilities. These stability values are listed in the following table. > > -<table><thead><tr><th> > - > -Element > - > -</th><th> > - > -Name Stability > - > -</th><th> > - > -Data Stability > - > -</th><th> > - > -Dependency Class > - > -</th></tr></thead><tbody><tr><td> > - > -Provider > - > -</td><td> > - > -Evolving > - > -</td><td> > - > -Evolving > - > -</td><td> > - > -Common > - > -</td></tr><tr><td> > - > -Module > - > -</td><td> > - > -Private > - > -</td><td> > - > -Private > - > -</td><td> > - > -Unknown > - > -</td></tr><tr><td> > - > -Function > - > -</td><td> > - > -Private > - > -</td><td> > - > -Private > - > -</td><td> > - > -ISA > - > -</td></tr><tr><td> > - > -Name > - > -</td><td> > - > -Evolving > - > -</td><td> > - > -Evolving > - > -</td><td> > - > -Common > - > -</td></tr><tr><td> > - > -Arguments > - > -</td><td> > - > -Private > - > -</td><td> > - > -Private > - > -</td><td> > - > -ISA > - > -</td></tr><tbody></table> > +| Element | Name Stability | Data Stability | Dependency Class | > +| :--- | :--- | :--- | :--- | > +| Provider | Evolving | Evolving | Common | > +| Module | Private | Private | Unknown | > +| Function | Private | Private | ISA | > +| Name | Evolving | Evolving | Common | > +| Arguments | Private | Private | ISA | > diff --git a/doc/userguide/reference/dtrace_providers_io.md b/doc/userguide/reference/dtrace_providers_io.md > index ff1d12887..a458ab284 100644 > --- a/doc/userguide/reference/dtrace_providers_io.md > +++ b/doc/userguide/reference/dtrace_providers_io.md > @@ -521,100 +521,10 @@ The previous output shows that the USB drive \(`sdc1`\) is clearly the limiting > > The `io` provider uses DTrace's stability mechanism to describe its stabilities. These values are listed in the following table. > > -<table><thead><tr><th> > - > -Element > - > -</th><th> > - > -Name Stability > - > -</th><th> > - > -Data Stability > - > -</th><th> > - > -Dependency Class > - > -</th></tr></thead><tbody><tr><td> > - > -Provider > - > -</td><td> > - > -Evolving > - > -</td><td> > - > -Evolving > - > -</td><td> > - > -ISA > - > -</td></tr><tr><td> > - > -Module > - > -</td><td> > - > -Private > - > -</td><td> > - > -Private > - > -</td><td> > - > -Unknown > - > -</td></tr><tr><td> > - > -Function > - > -</td><td> > - > -Private > - > -</td><td> > - > -Private > - > -</td><td> > - > -Unknown > - > -</td></tr><tr><td> > - > -Name > - > -</td><td> > - > -Evolving > - > -</td><td> > - > -Evolving > - > -</td><td> > - > -ISA > - > -</td></tr><tr><td> > - > -Arguments > - > -</td><td> > - > -Evolving > - > -</td><td> > - > -Evolving > - > -</td><td> > - > -ISA > - > -</td></tr><tbody></table> > +| Element | Name Stability | Data Stability | Dependency Class | > +| :--- | :--- | :--- | :--- | > +| Provider | Evolving | Evolving | ISA | > +| Module | Private | Private | Unknown | > +| Function | Private | Private | Unknown | > +| Name | Evolving | Evolving | ISA | > +| Arguments | Evolving | Evolving | ISA | > diff --git a/doc/userguide/reference/dtrace_providers_lockstat.md b/doc/userguide/reference/dtrace_providers_lockstat.md > index 1cf06a5db..98affd838 100644 > --- a/doc/userguide/reference/dtrace_providers_lockstat.md > +++ b/doc/userguide/reference/dtrace_providers_lockstat.md > @@ -275,100 +275,10 @@ It might be surprising that so many locks are acquired with the `date` command. > > The `lockstat` provider uses DTrace's stability mechanism to describe its stabilities. These values are listed in the following table. > > -<table><thead><tr><th> > - > -Element > - > -</th><th> > - > -Name Stability > - > -</th><th> > - > -Data Stability > - > -</th><th> > - > -Dependency Class > - > -</th></tr></thead><tbody><tr><td> > - > -Provider > - > -</td><td> > - > -Evolving > - > -</td><td> > - > -Evolving > - > -</td><td> > - > -ISA > - > -</td></tr><tr><td> > - > -Module > - > -</td><td> > - > -Private > - > -</td><td> > - > -Private > - > -</td><td> > - > -Unknown > - > -</td></tr><tr><td> > - > -Function > - > -</td><td> > - > -Private > - > -</td><td> > - > -Private > - > -</td><td> > - > -Unknown > - > -</td></tr><tr><td> > - > -Name > - > -</td><td> > - > -Evolving > - > -</td><td> > - > -Evolving > - > -</td><td> > - > -ISA > - > -</td></tr><tr><td> > - > -Arguments > - > -</td><td> > - > -Evolving > - > -</td><td> > - > -Evolving > - > -</td><td> > - > -ISA > - > -</td></tr><tbody></table> > +| Element | Name Stability | Data Stability | Dependency Class | > +| :--- | :--- | :--- | :--- | > +| Provider | Evolving | Evolving | ISA | > +| Module | Private | Private | Unknown | > +| Function | Private | Private | Unknown | > +| Name | Evolving | Evolving | ISA | > +| Arguments | Evolving | Evolving | ISA | > diff --git a/doc/userguide/reference/dtrace_providers_pid.md b/doc/userguide/reference/dtrace_providers_pid.md > index e403d6c94..c0c7bbb9a 100644 > --- a/doc/userguide/reference/dtrace_providers_pid.md > +++ b/doc/userguide/reference/dtrace_providers_pid.md > @@ -177,100 +177,10 @@ We probe on the chosen instruction, using both a relative offset `foo:4`, and an > > The `pid` provider uses DTrace's stability mechanism to describe its stabilities. These values are listed in the following table. > > -<table><thead><tr><th> > - > -Element > - > -</th><th> > - > -Name Stability > - > -</th><th> > - > -Data Stability > - > -</th><th> > - > -Dependency Class > - > -</th></tr></thead><tbody><tr><td> > - > -Provider > - > -</td><td> > - > -Evolving > - > -</td><td> > - > -Evolving > - > -</td><td> > - > -ISA > - > -</td></tr><tr><td> > - > -Module > - > -</td><td> > - > -Private > - > -</td><td> > - > -Private > - > -</td><td> > - > -Unknown > - > -</td></tr><tr><td> > - > -Function > - > -</td><td> > - > -Private > - > -</td><td> > - > -Private > - > -</td><td> > - > -Unknown > - > -</td></tr><tr><td> > - > -Name > - > -</td><td> > - > -Evolving > - > -</td><td> > - > -Evolving > - > -</td><td> > - > -ISA > - > -</td></tr><tr><td> > - > -Arguments > - > -</td><td> > - > -Private > - > -</td><td> > - > -Private > - > -</td><td> > - > -Unknown > - > -</td></tr><tbody></table> > +| Element | Name Stability | Data Stability | Dependency Class | > +| :--- | :--- | :--- | :--- | > +| Provider | Evolving | Evolving | ISA | > +| Module | Private | Private | Unknown | > +| Function | Private | Private | Unknown | > +| Name | Evolving | Evolving | ISA | > +| Arguments | Private | Private | Unknown | > diff --git a/doc/userguide/reference/dtrace_providers_proc.md b/doc/userguide/reference/dtrace_providers_proc.md > index 24b18fc78..40903775d 100644 > --- a/doc/userguide/reference/dtrace_providers_proc.md > +++ b/doc/userguide/reference/dtrace_providers_proc.md > @@ -695,100 +695,10 @@ Running this script results in output similar to the following: > > The `proc` provider uses DTrace's stability mechanism to describe its stabilities. These values are listed in the following table. > > -<table><thead><tr><th> > - > -Element > - > -</th><th> > - > -Name Stability > - > -</th><th> > - > -Data Stability > - > -</th><th> > - > -Dependency Class > - > -</th></tr></thead><tbody><tr><td> > - > -Provider > - > -</td><td> > - > -Evolving > - > -</td><td> > - > -Evolving > - > -</td><td> > - > -ISA > - > -</td></tr><tr><td> > - > -Module > - > -</td><td> > - > -Private > - > -</td><td> > - > -Private > - > -</td><td> > - > -Unknown > - > -</td></tr><tr><td> > - > -Function > - > -</td><td> > - > -Private > - > -</td><td> > - > -Private > - > -</td><td> > - > -Unknown > - > -</td></tr><tr><td> > - > -Name > - > -</td><td> > - > -Evolving > - > -</td><td> > - > -Evolving > - > -</td><td> > - > -ISA > - > -</td></tr><tr><td> > - > -Arguments > - > -</td><td> > - > -Evolving > - > -</td><td> > - > -Evolving > - > -</td><td> > - > -ISA > - > -</td></tr><tbody></table> > +| Element | Name Stability | Data Stability | Dependency Class | > +| :--- | :--- | :--- | :--- | > +| Provider | Evolving | Evolving | ISA | > +| Module | Private | Private | Unknown | > +| Function | Private | Private | Unknown | > +| Name | Evolving | Evolving | ISA | > +| Arguments | Evolving | Evolving | ISA | > diff --git a/doc/userguide/reference/dtrace_providers_profile.md b/doc/userguide/reference/dtrace_providers_profile.md > index 2fcc13213..bcc8c64d2 100644 > --- a/doc/userguide/reference/dtrace_providers_profile.md > +++ b/doc/userguide/reference/dtrace_providers_profile.md > @@ -156,100 +156,10 @@ A time interval that's too short causes the machine to continuously field time-b > > The `profile` provider uses DTrace's stability mechanism to describe its stabilities. These stability values are listed in the following table. > > -<table><thead><tr><th> > - > -Element > - > -</th><th> > - > -Name Stability > - > -</th><th> > - > -Data Stability > - > -</th><th> > - > -Dependency Class > - > -</th></tr></thead><tbody><tr><td> > - > -Provider > - > -</td><td> > - > -Evolving > - > -</td><td> > - > -Evolving > - > -</td><td> > - > -Common > - > -</td></tr><tr><td> > - > -Module > - > -</td><td> > - > -Unstable > - > -</td><td> > - > -Unstable > - > -</td><td> > - > -Unknown > - > -</td></tr><tr><td> > - > -Function > - > -</td><td> > - > -Private > - > -</td><td> > - > -Private > - > -</td><td> > - > -Unknown > - > -</td></tr><tr><td> > - > -Name > - > -</td><td> > - > -Evolving > - > -</td><td> > - > -Evolving > - > -</td><td> > - > -Common > - > -</td></tr><tr><td> > - > -Arguments > - > -</td><td> > - > -Evolving > - > -</td><td> > - > -Evolving > - > -</td><td> > - > -Common > - > -</td></tr><tbody></table> > +| Element | Name Stability | Data Stability | Dependency Class | > +| :--- | :--- | :--- | :--- | > +| Provider | Evolving | Evolving | Common | > +| Module | Unstable | Unstable | Unknown | > +| Function | Private | Private | Unknown | > +| Name | Evolving | Evolving | Common | > +| Arguments | Evolving | Evolving | Common | > diff --git a/doc/userguide/reference/dtrace_providers_rawtp.md b/doc/userguide/reference/dtrace_providers_rawtp.md > index 39f4f00f5..d85dd45a8 100644 > --- a/doc/userguide/reference/dtrace_providers_rawtp.md > +++ b/doc/userguide/reference/dtrace_providers_rawtp.md > @@ -21,100 +21,10 @@ sudo dtrace -lvP rawtp > > The `rawtp` provider uses DTrace's stability mechanism to describe its stabilities. These stability values are listed in the following table. > > -<table><thead><tr><th> > - > -Element > - > -</th><th> > - > -Name Stability > - > -</th><th> > - > -Data Stability > - > -</th><th> > - > -Dependency Class > - > -</th></tr></thead><tbody><tr><td> > - > -Provider > - > -</td><td> > - > -Evolving > - > -</td><td> > - > -Evolving > - > -</td><td> > - > -ISA > - > -</td></tr><tr><td> > - > -Module > - > -</td><td> > - > -Private > - > -</td><td> > - > -Private > - > -</td><td> > - > -Unknown > - > -</td></tr><tr><td> > - > -Function > - > -</td><td> > - > -Private > - > -</td><td> > - > -Private > - > -</td><td> > - > -Unknown > - > -</td></tr><tr><td> > - > -Name > - > -</td><td> > - > -Private > - > -</td><td> > - > -Private > - > -</td><td> > - > -ISA > - > -</td></tr><tr><td> > - > -Arguments > - > -</td><td> > - > -Private > - > -</td><td> > - > -Private > - > -</td><td> > - > -ISA > - > -</td></tr><tbody></table> > +| Element | Name Stability | Data Stability | Dependency Class | > +| :--- | :--- | :--- | :--- | > +| Provider | Evolving | Evolving | ISA | > +| Module | Private | Private | Unknown | > +| Function | Private | Private | Unknown | > +| Name | Private | Private | ISA | > +| Arguments | Private | Private | ISA | > diff --git a/doc/userguide/reference/dtrace_providers_sched.md b/doc/userguide/reference/dtrace_providers_sched.md > index d4cd546ce..68bcdf715 100644 > --- a/doc/userguide/reference/dtrace_providers_sched.md > +++ b/doc/userguide/reference/dtrace_providers_sched.md > @@ -814,100 +814,10 @@ The output histogram named `tick` shows that the clock tick is firing at a 1 mil > > The `sched` provider uses DTrace's stability mechanism to describe its stabilities. These values are listed in the following table. > > -<table><thead><tr><th> > - > -Element > - > -</th><th> > - > -Name Stability > - > -</th><th> > - > -Data Stability > - > -</th><th> > - > -Dependency Class > - > -</th></tr></thead><tbody><tr><td> > - > -Provider > - > -</td><td> > - > -Evolving > - > -</td><td> > - > -Evolving > - > -</td><td> > - > -ISA > - > -</td></tr><tr><td> > - > -Module > - > -</td><td> > - > -Private > - > -</td><td> > - > -Private > - > -</td><td> > - > -Unknown > - > -</td></tr><tr><td> > - > -Function > - > -</td><td> > - > -Private > - > -</td><td> > - > -Private > - > -</td><td> > - > -Unknown > - > -</td></tr><tr><td> > - > -Name > - > -</td><td> > - > -Evolving > - > -</td><td> > - > -Evolving > - > -</td><td> > - > -ISA > - > -</td></tr><tr><td> > - > -Arguments > - > -</td><td> > - > -Evolving > - > -</td><td> > - > -Evolving > - > -</td><td> > - > -ISA > - > -</td></tr><tbody></table> > +| Element | Name Stability | Data Stability | Dependency Class | > +| :--- | :--- | :--- | :--- | > +| Provider | Evolving | Evolving | ISA | > +| Module | Private | Private | Unknown | > +| Function | Private | Private | Unknown | > +| Name | Evolving | Evolving | ISA | > +| Arguments | Evolving | Evolving | ISA | > diff --git a/doc/userguide/reference/dtrace_providers_sdt.md b/doc/userguide/reference/dtrace_providers_sdt.md > index 212d3f886..442911fc7 100644 > --- a/doc/userguide/reference/dtrace_providers_sdt.md > +++ b/doc/userguide/reference/dtrace_providers_sdt.md > @@ -42,100 +42,10 @@ The arguments for each `sdt` probe are the arguments that are specified in the k > > The `sdt` provider uses DTrace's stability mechanism to describe its stabilities. These values are listed in the following table. > > -<table><thead><tr><th> > - > -Element > - > -</th><th> > - > -Name Stability > - > -</th><th> > - > -Data Stability > - > -</th><th> > - > -Dependency Class > - > -</th></tr></thead><tbody><tr><td> > - > -Provider > - > -</td><td> > - > -Evolving > - > -</td><td> > - > -Evolving > - > -</td><td> > - > -ISA > - > -</td></tr><tr><td> > - > -Module > - > -</td><td> > - > -Private > - > -</td><td> > - > -Private > - > -</td><td> > - > -Unknown > - > -</td></tr><tr><td> > - > -Function > - > -</td><td> > - > -Private > - > -</td><td> > - > -Private > - > -</td><td> > - > -Unknown > - > -</td></tr><tr><td> > - > -Name > - > -</td><td> > - > -Private > - > -</td><td> > - > -Private > - > -</td><td> > - > -ISA > - > -</td></tr><tr><td> > - > -Arguments > - > -</td><td> > - > -Private > - > -</td><td> > - > -Private > - > -</td><td> > - > -ISA > - > -</td></tr><tbody></table> > +| Element | Name Stability | Data Stability | Dependency Class | > +| :--- | :--- | :--- | :--- | > +| Provider | Evolving | Evolving | ISA | > +| Module | Private | Private | Unknown | > +| Function | Private | Private | Unknown | > +| Name | Private | Private | ISA | > +| Arguments | Private | Private | ISA | > diff --git a/doc/userguide/reference/dtrace_providers_syscall.md b/doc/userguide/reference/dtrace_providers_syscall.md > index 3eaac4897..880b7de69 100644 > --- a/doc/userguide/reference/dtrace_providers_syscall.md > +++ b/doc/userguide/reference/dtrace_providers_syscall.md > @@ -21,100 +21,10 @@ For `entry` probes, the arguments, `arg0` ... `arg*n*`, are arguments to the sys > > The `syscall` provider uses DTrace's stability mechanism to describe its stabilities. These stability values are listed in the following table. > > -<table><thead><tr><th> > - > -Element > - > -</th><th> > - > -Name Stability > - > -</th><th> > - > -Data Stability > - > -</th><th> > - > -Dependency Class > - > -</th></tr></thead><tbody><tr><td> > - > -Provider > - > -</td><td> > - > -Evolving > - > -</td><td> > - > -Evolving > - > -</td><td> > - > -Common > - > -</td></tr><tr><td> > - > -Module > - > -</td><td> > - > -Private > - > -</td><td> > - > -Private > - > -</td><td> > - > -Unknown > - > -</td></tr><tr><td> > - > -Function > - > -</td><td> > - > -Private > - > -</td><td> > - > -Private > - > -</td><td> > - > -Instruction set architecture \(ISA\) > - > -</td></tr><tr><td> > - > -Name > - > -</td><td> > - > -Evolving > - > -</td><td> > - > -Evolving > - > -</td><td> > - > -Common > - > -</td></tr><tr><td> > - > -Arguments > - > -</td><td> > - > -Private > - > -</td><td> > - > -Private > - > -</td><td> > - > -ISA > - > -</td></tr><tbody></table> > +| Element | Name Stability | Data Stability | Dependency Class | > +| :--- | :--- | :--- | :--- | > +| Provider | Evolving | Evolving | Common | > +| Module | Private | Private | Unknown | > +| Function | Private | Private | ISA | > +| Name | Evolving | Evolving | Common | > +| Arguments | Private | Private | ISA |