diff mbox series

[v1,1/1] Documentation: kvm: Fix a section number

Message ID 20250414165146.2279450-1-xin@zytor.com (mailing list archive)
State New
Headers show
Series [v1,1/1] Documentation: kvm: Fix a section number | expand

Commit Message

Xin Li April 14, 2025, 4:51 p.m. UTC
The previous section is 7.41, thus this should be 7.42.

Signed-off-by: Xin Li (Intel) <xin@zytor.com>
---
 Documentation/virt/kvm/api.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)


base-commit: 8ffd015db85fea3e15a77027fda6c02ced4d2444

Comments

Jonathan Corbet April 14, 2025, 5:05 p.m. UTC | #1
"Xin Li (Intel)" <xin@zytor.com> writes:

> The previous section is 7.41, thus this should be 7.42.
>
> Signed-off-by: Xin Li (Intel) <xin@zytor.com>
> ---
>  Documentation/virt/kvm/api.rst | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/Documentation/virt/kvm/api.rst b/Documentation/virt/kvm/api.rst
> index 47c7c3f92314..58478b470860 100644
> --- a/Documentation/virt/kvm/api.rst
> +++ b/Documentation/virt/kvm/api.rst
> @@ -8478,7 +8478,7 @@ ENOSYS for the others.
>  When enabled, KVM will exit to userspace with KVM_EXIT_SYSTEM_EVENT of
>  type KVM_SYSTEM_EVENT_SUSPEND to process the guest suspend request.
>  
> -7.37 KVM_CAP_ARM_WRITABLE_IMP_ID_REGS
> +7.42 KVM_CAP_ARM_WRITABLE_IMP_ID_REGS
>  -------------------------------------

The fix seems fine but ... I have to ask ... do the section numbers buy
anything here?  We have a documentation system that can do nice
cross-references when needed, so I'm not sure that these numbers add
anything other than a bit of manual maintenance hassle.

Thanks,

jon
Xin Li April 14, 2025, 5:21 p.m. UTC | #2
On 4/14/2025 10:05 AM, Jonathan Corbet wrote:
>> -7.37 KVM_CAP_ARM_WRITABLE_IMP_ID_REGS
>> +7.42 KVM_CAP_ARM_WRITABLE_IMP_ID_REGS
>>   -------------------------------------
> The fix seems fine but ... I have to ask ... do the section numbers buy
> anything here?  We have a documentation system that can do nice
> cross-references when needed, so I'm not sure that these numbers add
> anything other than a bit of manual maintenance hassle.

So you prefer to get rid of the section numbering?

Looks it makes it simpler to maintain the documentation.  But that would
anyway be another serial patches, right?

Thanks!
     Xin
Jonathan Corbet April 14, 2025, 5:48 p.m. UTC | #3
Xin Li <xin@zytor.com> writes:

> On 4/14/2025 10:05 AM, Jonathan Corbet wrote:
>>> -7.37 KVM_CAP_ARM_WRITABLE_IMP_ID_REGS
>>> +7.42 KVM_CAP_ARM_WRITABLE_IMP_ID_REGS
>>>   -------------------------------------
>> The fix seems fine but ... I have to ask ... do the section numbers buy
>> anything here?  We have a documentation system that can do nice
>> cross-references when needed, so I'm not sure that these numbers add
>> anything other than a bit of manual maintenance hassle.
>
> So you prefer to get rid of the section numbering?
>
> Looks it makes it simpler to maintain the documentation.  But that would
> anyway be another serial patches, right?

*I* would prefer it, but that call is really up to the KVM folks, not
me.  Their preference far outweighs mine on this ... I'm just venting :)

Thanks,

jon
Xin Li April 14, 2025, 5:59 p.m. UTC | #4
On 4/14/2025 10:48 AM, Jonathan Corbet wrote:
> Xin Li <xin@zytor.com> writes:
> 
>> On 4/14/2025 10:05 AM, Jonathan Corbet wrote:
>>>> -7.37 KVM_CAP_ARM_WRITABLE_IMP_ID_REGS
>>>> +7.42 KVM_CAP_ARM_WRITABLE_IMP_ID_REGS
>>>>    -------------------------------------
>>> The fix seems fine but ... I have to ask ... do the section numbers buy
>>> anything here?  We have a documentation system that can do nice
>>> cross-references when needed, so I'm not sure that these numbers add
>>> anything other than a bit of manual maintenance hassle.
>>
>> So you prefer to get rid of the section numbering?
>>
>> Looks it makes it simpler to maintain the documentation.  But that would
>> anyway be another serial patches, right?
> 
> *I* would prefer it, but that call is really up to the KVM folks, not
> me.  Their preference far outweighs mine on this ... I'm just venting :)

/facepalm
diff mbox series

Patch

diff --git a/Documentation/virt/kvm/api.rst b/Documentation/virt/kvm/api.rst
index 47c7c3f92314..58478b470860 100644
--- a/Documentation/virt/kvm/api.rst
+++ b/Documentation/virt/kvm/api.rst
@@ -8478,7 +8478,7 @@  ENOSYS for the others.
 When enabled, KVM will exit to userspace with KVM_EXIT_SYSTEM_EVENT of
 type KVM_SYSTEM_EVENT_SUSPEND to process the guest suspend request.
 
-7.37 KVM_CAP_ARM_WRITABLE_IMP_ID_REGS
+7.42 KVM_CAP_ARM_WRITABLE_IMP_ID_REGS
 -------------------------------------
 
 :Architectures: arm64