Re: [PATCH v4 09/11] docs: liveupdate: Add documentation for VM and guest_memfd preservation

[email protected] writes:

> Thank you for your contribution! Sashiko AI review found 1 potential issue(s) to consider:
> - [Low] Mismatched kernel-doc section titles cause Sphinx build warnings and missing documentation.
> --
>
> --- Patch [9]: [PATCH v4 09/11] docs: liveupdate: Add documentation for VM and guest_memfd preservation ---
> commit a930d2f58a9edc06bdcfd10fb383e97d7fe3996c
> Author: Tarun Sahu <[email protected]>
>
> docs: liveupdate: Add documentation for VM and guest_memfd preservation
>     
> Add Documentation/liveupdate/vmm.rst detailing VMM requirements, scope,
> ordering constraints, and kernel-doc inclusions for KVM VM and
> guest_memfd preservation via Live Update Orchestrator (LUO).
>
>> diff --git a/Documentation/liveupdate/vmm.rst b/Documentation/liveupdate/vmm.rst
>> new file mode 100644
>> index 0000000000000..b8e8fb2b63c21
>> --- /dev/null
>> +++ b/Documentation/liveupdate/vmm.rst
>> @@ -0,0 +1,107 @@
>> +.. SPDX-License-Identifier: GPL-2.0-or-later
>> +
>> +=============================
>> +VM & Guest_Memfd Preservation
>> +=============================
>> +
>> +.. kernel-doc:: virt/kvm/kvm_luo.c
>> +   :doc: KVM VM Preservation via LUO
>> +
>> +.. kernel-doc:: virt/kvm/guest_memfd_luo.c
>> +   :doc: Guest_Memfd Preservation via LUO
>
> [Severity: Low]
> Does this section title exactly match the DOC: title in
> virt/kvm/guest_memfd_luo.c?
>
> If the source file uses "Guestmemfd Preservation via LUO" without the
> underscore, this directive will fail to find the documentation and generate a
> Sphinx build warning.


I will correct it. Good find!
>
> [ ... ]
>
>> +VM & Guest_Memfd Preservation ABI
>> +=================================
>> +
>> +.. kernel-doc:: include/linux/kho/abi/kvm.h
>> +   :doc: DOC: guest_memfd Live Update ABI
>
> [Severity: Low]
> Does this section title match the actual title in include/linux/kho/abi/kvm.h?
>
> If the source file uses "KVM and guest_memfd Live Update ABI", this mismatch
> will cause empty sections in the generated documentation.
>
> Also, should the literal "DOC: " prefix be omitted here? The directive
> typically only expects the text that follows the prefix.
>
>> +
>> +.. kernel-doc:: include/linux/kho/abi/kvm.h
>> +   :internal:
>> +
>> +See Also
>
> -- 
> Sashiko AI review · https://sashiko.dev/#/patchset/[email protected]?part=9