[PATCH v8 02/15] genpt: Add Documentation/ files

[Randy Dunlap]

Hi Jason,

On 11/4/25 10:30 AM, Jason Gunthorpe wrote:
> Add some general description and pull in the kdoc comments from the source
> file to index most of the useful functions.
> 
> Reviewed-by: Kevin Tian <kevin.tian at intel.com>
> Reviewed-by: Pasha Tatashin <pasha.tatashin at soleen.com>
> Reviewed-by: Samiullah Khawaja <skhawaja at google.com>
> Tested-by: Alejandro Jimenez <alejandro.j.jimenez at oracle.com>
> Tested-by: Pasha Tatashin <pasha.tatashin at soleen.com>
> Signed-off-by: Jason Gunthorpe <jgg at nvidia.com>
> ---
>  Documentation/driver-api/generic_pt.rst | 142 ++++++++++++++++++++++++
>  Documentation/driver-api/index.rst      |   1 +
>  2 files changed, 143 insertions(+)
>  create mode 100644 Documentation/driver-api/generic_pt.rst
> 
> diff --git a/Documentation/driver-api/generic_pt.rst b/Documentation/driver-api/generic_pt.rst
> new file mode 100644
> index 00000000000000..210d1229aa1c1f
> --- /dev/null
> +++ b/Documentation/driver-api/generic_pt.rst
> @@ -0,0 +1,142 @@
> +.. SPDX-License-Identifier: GPL-2.0
> +
> +========================
> +Generic Radix Page Table
> +========================
> +
> +.. kernel-doc:: include/linux/generic_pt/common.h
> +	:doc: Generic Radix Page Table
> +
> +.. kernel-doc:: drivers/iommu/generic_pt/pt_defs.h
> +	:doc: Generic Page Table Language
> +
> +-----
> +Usage
> +-----

See Documentations/doc-guide/sphinx.rst for the usual order
of heading adornments. Section beginning:

* Please stick to this order of heading adornments:

-- 
~Randy