Re: [PATCH v2 0/2] genpt documentation fixes

Randy Dunlap
2025-11-07T19:16:39Z

On 11/7/25 12:12 AM, Bagas Sanjaya wrote:
> Hi,
>
> Here are fixes for two htmldocs warnings in generic radix page table
> documentation. The first one is reported in linux-next [1], and the
> second one is also found when making htmldocs locally to reproduce the
> former.
>
> Enjoy!
>
> Changes since v1 [2]:
>
> - s/to set/to read/ (Randy)

That's not quite what I said (wrote):

> @@ -354,6 +354,7 @@ static inline unsigned int pt_max_sw_bit(struct pt_common *common);
> /**
> * pt_test_sw_bit_acquire() - Read a software bit in an item
> * @pts: Entry to set
> + * @bitnr: Bit to set

| Shouldn't both of these (above) to "to read" instead of "to set"?

No changes to pt_set_sw_bit_release() [which should say "to set" in 2 places].

>
> [1]: https://lore.kernel.org/linux-next/20251106143925.578e411b@canb.auug.org.au/
> [2]: https://lore.kernel.org/linux-doc/20251106073845.36445-1-bagasdotme@gmail.com/
>
> Bagas Sanjaya (2):
> Documentation: genpt: Don't use code block marker before iommu_amdv1.c
> include listing
> iommupt: Describe @bitnr parameter
>
> Documentation/driver-api/generic_pt.rst | 2 +-
> drivers/iommu/generic_pt/pt_common.h | 2 ++
> 2 files changed, 3 insertions(+), 1 deletion(-)
>
>
> base-commit: 75d9ef7cf1e694e5c0fb387be99f04acc7f864a4
--
~Randy