Re: [DTrace-devel] [PATCH 21/20] doc: Add blank line before section head so it is recognized

Elena Zannoni
2025-10-23T19:35:32Z

Reviewed-by: Elena Zannoni <elena.zannoni@oracle.com>

On 10/21/25 9:22 PM, eugene.loh--- via DTrace-devel wrote:
> From: Eugene Loh <eugene.loh@oracle.com>
>
> Signed-off-by: Eugene Loh <eugene.loh@oracle.com>
> ---
> .../reference/dtrace-ref-TypesOperatorsandExpressions.md | 1 +
> doc/userguide/reference/dtrace-ref-speculation.md | 1 +
> doc/userguide/reference/dtrace_providers_proc.md | 2 ++
> doc/userguide/reference/dtrace_providers_sched.md | 2 ++
> doc/userguide/reference/dtrace_stability_reference.md | 1 +
> 5 files changed, 7 insertions(+)
>
> diff --git a/doc/userguide/reference/dtrace-ref-TypesOperatorsandExpressions.md b/doc/userguide/reference/dtrace-ref-TypesOperatorsandExpressions.md
> index bb1c49949..ef0910b90 100644
> --- a/doc/userguide/reference/dtrace-ref-TypesOperatorsandExpressions.md
> +++ b/doc/userguide/reference/dtrace-ref-TypesOperatorsandExpressions.md
> @@ -1151,6 +1151,7 @@ Dereferences a pointer to an object.
> Accesses a member of a structure or union type.
>
>
> +
> ## Type and Constant Definitions
>
> This section describes how to declare type aliases and named constants in D. It also discusses D type and namespace management for program and OS types and identifiers.
> diff --git a/doc/userguide/reference/dtrace-ref-speculation.md b/doc/userguide/reference/dtrace-ref-speculation.md
> index 30c5e6eaa..f93053275 100644
> --- a/doc/userguide/reference/dtrace-ref-speculation.md
> +++ b/doc/userguide/reference/dtrace-ref-speculation.md
> @@ -74,6 +74,7 @@ ID
> Discards the speculative buffer that's associated with ID.
>
>
> +
> ## How to use speculation
>
> The following example illustrates how to use speculation. All speculation functions must be used together for speculation to work correctly.
> diff --git a/doc/userguide/reference/dtrace_providers_proc.md b/doc/userguide/reference/dtrace_providers_proc.md
> index cf64bc28f..d799efd72 100644
> --- a/doc/userguide/reference/dtrace_providers_proc.md
> +++ b/doc/userguide/reference/dtrace_providers_proc.md
> @@ -357,6 +357,7 @@ Probe
> —
>
>
> +
> ### lwpsinfo\_t
>
> Several `proc` probes have arguments of type `lwpsinfo_t`. Detailed information about this data structure can be found in `/usr/lib64/dtrace/*version*/procfs.d`. Some structure members, while still recognized for historical reasons, aren't implemented. The definition of the `lwpsinfo_t` structure is as follows:
> @@ -475,6 +476,7 @@ The thread is a zombie.
> The equivalent Linux task state is `EXIT_ZOMBIE`, `EXIT_DEAD`, or `TASK_DEAD`.
>
>
> +
> ### psinfo\_t
>
> Several `proc` probes have an argument of type `psinfo_t`. Detailed information about this data structure can be found in `/usr/lib64/dtrace/*version*/procfs.d`. The definition of the `psinfo_t` structure, is as follows:
> diff --git a/doc/userguide/reference/dtrace_providers_sched.md b/doc/userguide/reference/dtrace_providers_sched.md
> index 42f318e77..652f2917c 100644
> --- a/doc/userguide/reference/dtrace_providers_sched.md
> +++ b/doc/userguide/reference/dtrace_providers_sched.md
> @@ -76,6 +76,7 @@ Fires as a part of clock tick-based accounting. In clock tick-based accounting,
> Fires immediately before the current thread wakes a thread sleeping on a synchronization object. Here, `args[0]` and `args[1]` refer to the sleeping thread, as an `lwpsinfo_t *` and `psinfo_t *`, respectively. The type and address of the synchronization object are contained in the `pr_stype` and `pr_wchan` members of the `lwpsinfo_t` of the sleeping thread. The meaning of this address is a private implementation detail, but the address value might be treated as a token unique to the synchronization object.
>
>
> +
> ## sched Probe Arguments
>
> Many of these probes refer to a particular thread. For these probes, the thread's `lwpsinfo_t` is pointed to by `args[0]` and the `psinfo_t` of the process containing the thread by `args[1]`. A few probes refer to a particular CPU. Its `cpuinfo_t` is pointed to by `args[2]`. Only `enqueue` has an `args[3]`, and that argument is a Boolean, as described. The `argN` values are implementation specific. Instead, use `args[]` to access the probe arguments.
> @@ -243,6 +244,7 @@ Probe
> —
>
>
> +
> ### lwpsinfo\_t and psinfo\_t
>
> The `lwpsinfo_t` and `psinfo_t` structures are described in [Proc Provider](dtrace_providers_proc.md).
> diff --git a/doc/userguide/reference/dtrace_stability_reference.md b/doc/userguide/reference/dtrace_stability_reference.md
> index f90b91de3..fb3238ec4 100644
> --- a/doc/userguide/reference/dtrace_stability_reference.md
> +++ b/doc/userguide/reference/dtrace_stability_reference.md
> @@ -146,6 +146,7 @@ Standard
> The interface complies with an industry standard. The corresponding documentation for the interface describes the standard to which the interface conforms. Standards are typically controlled by a standards development organization. Changes can be made to the interface in accordance with approved changes to the standard. This stability level can also apply to interfaces that have been adopted \(without a formal standard\) by an industry convention. Availability is provided for only the specified versions of a standard; availability in later versions isn't guaranteed.
>
>
> +
> ## Dependency Classes
>
> Dependency classes are used to describe architectural dependencies for interfaces in DTrace.