diff mbox series

[2/2] docs: kvm: fix rst formatting

Message ID 20200624202200.28209-3-walling@linux.ibm.com (mailing list archive)
State New, archived
Headers show
Series s390: Add API Docs for DIAGNOSE 0x318 and fix rst | expand

Commit Message

Collin Walling June 24, 2020, 8:22 p.m. UTC
KVM_CAP_S390_VCPU_RESETS and KVM_CAP_S390_PROTECTED needed
just a little bit of rst touch-up

Signed-off-by: Collin Walling <walling@linux.ibm.com>
---
 Documentation/virt/kvm/api.rst | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)

Comments

Cornelia Huck June 25, 2020, 6:34 a.m. UTC | #1
On Wed, 24 Jun 2020 16:22:00 -0400
Collin Walling <walling@linux.ibm.com> wrote:

> KVM_CAP_S390_VCPU_RESETS and KVM_CAP_S390_PROTECTED needed
> just a little bit of rst touch-up
> 

Fixes: 7de3f1423ff9 ("KVM: s390: Add new reset vcpu API")
Fixes: 04ed89dc4aeb ("KVM: s390: protvirt: Add KVM api documentation")

> Signed-off-by: Collin Walling <walling@linux.ibm.com>
> ---
>  Documentation/virt/kvm/api.rst | 7 ++++---
>  1 file changed, 4 insertions(+), 3 deletions(-)
> 
> diff --git a/Documentation/virt/kvm/api.rst b/Documentation/virt/kvm/api.rst
> index 056608e8f243..2d1572d92616 100644
> --- a/Documentation/virt/kvm/api.rst
> +++ b/Documentation/virt/kvm/api.rst
> @@ -6134,16 +6134,17 @@ in CPUID and only exposes Hyper-V identification. In this case, guest
>  thinks it's running on Hyper-V and only use Hyper-V hypercalls.
>  
>  8.22 KVM_CAP_S390_VCPU_RESETS
> +-----------------------------
>  
> -Architectures: s390
> +:Architectures: s390
>  
>  This capability indicates that the KVM_S390_NORMAL_RESET and
>  KVM_S390_CLEAR_RESET ioctls are available.
>  
>  8.23 KVM_CAP_S390_PROTECTED
> +---------------------------
>  
> -Architecture: s390
> -
> +:Architecture: s390
>  
>  This capability indicates that the Ultravisor has been initialized and
>  KVM can therefore start protected VMs.

Reviewed-by: Cornelia Huck <cohuck@redhat.com>
Janosch Frank June 25, 2020, 7:07 a.m. UTC | #2
On 6/25/20 8:34 AM, Cornelia Huck wrote:
> On Wed, 24 Jun 2020 16:22:00 -0400
> Collin Walling <walling@linux.ibm.com> wrote:
> 
>> KVM_CAP_S390_VCPU_RESETS and KVM_CAP_S390_PROTECTED needed
>> just a little bit of rst touch-up
>>
> 
> Fixes: 7de3f1423ff9 ("KVM: s390: Add new reset vcpu API")
> Fixes: 04ed89dc4aeb ("KVM: s390: protvirt: Add KVM api documentation")

Do we really do that for documentation changes?


> 
>> Signed-off-by: Collin Walling <walling@linux.ibm.com>
>> ---
>>  Documentation/virt/kvm/api.rst | 7 ++++---
>>  1 file changed, 4 insertions(+), 3 deletions(-)
>>
>> diff --git a/Documentation/virt/kvm/api.rst b/Documentation/virt/kvm/api.rst
>> index 056608e8f243..2d1572d92616 100644
>> --- a/Documentation/virt/kvm/api.rst
>> +++ b/Documentation/virt/kvm/api.rst
>> @@ -6134,16 +6134,17 @@ in CPUID and only exposes Hyper-V identification. In this case, guest
>>  thinks it's running on Hyper-V and only use Hyper-V hypercalls.
>>  
>>  8.22 KVM_CAP_S390_VCPU_RESETS
>> +-----------------------------
>>  
>> -Architectures: s390
>> +:Architectures: s390
>>  
>>  This capability indicates that the KVM_S390_NORMAL_RESET and
>>  KVM_S390_CLEAR_RESET ioctls are available.
>>  
>>  8.23 KVM_CAP_S390_PROTECTED
>> +---------------------------
>>  
>> -Architecture: s390
>> -
>> +:Architecture: s390
>>  
>>  This capability indicates that the Ultravisor has been initialized and
>>  KVM can therefore start protected VMs.
> 
> Reviewed-by: Cornelia Huck <cohuck@redhat.com>
>
David Hildenbrand June 25, 2020, 7:08 a.m. UTC | #3
On 25.06.20 09:07, Janosch Frank wrote:
> On 6/25/20 8:34 AM, Cornelia Huck wrote:
>> On Wed, 24 Jun 2020 16:22:00 -0400
>> Collin Walling <walling@linux.ibm.com> wrote:
>>
>>> KVM_CAP_S390_VCPU_RESETS and KVM_CAP_S390_PROTECTED needed
>>> just a little bit of rst touch-up
>>>
>>
>> Fixes: 7de3f1423ff9 ("KVM: s390: Add new reset vcpu API")
>> Fixes: 04ed89dc4aeb ("KVM: s390: protvirt: Add KVM api documentation")
> 
> Do we really do that for documentation changes?

Had a similar discussion recently, I prefer to just mention the commits
in the commit message like "Introduced in commit ...".
David Hildenbrand June 25, 2020, 7:09 a.m. UTC | #4
On 24.06.20 22:22, Collin Walling wrote:
> KVM_CAP_S390_VCPU_RESETS and KVM_CAP_S390_PROTECTED needed
> just a little bit of rst touch-up
> 
> Signed-off-by: Collin Walling <walling@linux.ibm.com>
> ---
>  Documentation/virt/kvm/api.rst | 7 ++++---
>  1 file changed, 4 insertions(+), 3 deletions(-)
> 
> diff --git a/Documentation/virt/kvm/api.rst b/Documentation/virt/kvm/api.rst
> index 056608e8f243..2d1572d92616 100644
> --- a/Documentation/virt/kvm/api.rst
> +++ b/Documentation/virt/kvm/api.rst
> @@ -6134,16 +6134,17 @@ in CPUID and only exposes Hyper-V identification. In this case, guest
>  thinks it's running on Hyper-V and only use Hyper-V hypercalls.
>  
>  8.22 KVM_CAP_S390_VCPU_RESETS
> +-----------------------------
>  
> -Architectures: s390
> +:Architectures: s390
>  
>  This capability indicates that the KVM_S390_NORMAL_RESET and
>  KVM_S390_CLEAR_RESET ioctls are available.
>  
>  8.23 KVM_CAP_S390_PROTECTED
> +---------------------------
>  
> -Architecture: s390
> -
> +:Architecture: s390
>  
>  This capability indicates that the Ultravisor has been initialized and
>  KVM can therefore start protected VMs.
> 

Reviewed-by: David Hildenbrand <david@redhat.com>
Cornelia Huck June 25, 2020, 7:09 a.m. UTC | #5
On Thu, 25 Jun 2020 09:07:43 +0200
Janosch Frank <frankja@linux.ibm.com> wrote:

> On 6/25/20 8:34 AM, Cornelia Huck wrote:
> > On Wed, 24 Jun 2020 16:22:00 -0400
> > Collin Walling <walling@linux.ibm.com> wrote:
> >   
> >> KVM_CAP_S390_VCPU_RESETS and KVM_CAP_S390_PROTECTED needed
> >> just a little bit of rst touch-up
> >>  
> > 
> > Fixes: 7de3f1423ff9 ("KVM: s390: Add new reset vcpu API")
> > Fixes: 04ed89dc4aeb ("KVM: s390: protvirt: Add KVM api documentation")  
> 
> Do we really do that for documentation changes?

Feel free to keep it or leave it :)
Collin Walling June 25, 2020, 2:43 p.m. UTC | #6
On 6/25/20 3:09 AM, Cornelia Huck wrote:
> On Thu, 25 Jun 2020 09:07:43 +0200
> Janosch Frank <frankja@linux.ibm.com> wrote:
> 
>> On 6/25/20 8:34 AM, Cornelia Huck wrote:
>>> On Wed, 24 Jun 2020 16:22:00 -0400
>>> Collin Walling <walling@linux.ibm.com> wrote:
>>>   
>>>> KVM_CAP_S390_VCPU_RESETS and KVM_CAP_S390_PROTECTED needed
>>>> just a little bit of rst touch-up
>>>>  
>>>
>>> Fixes: 7de3f1423ff9 ("KVM: s390: Add new reset vcpu API")
>>> Fixes: 04ed89dc4aeb ("KVM: s390: protvirt: Add KVM api documentation")  
>>
>> Do we really do that for documentation changes?
> 
> Feel free to keep it or leave it :)
> 

I'm indifferent. I suppose I'll go with David's suggestion of
"Introduced in commit..."

Thanks for all the feedback. Will sent out v2 shortly.
diff mbox series

Patch

diff --git a/Documentation/virt/kvm/api.rst b/Documentation/virt/kvm/api.rst
index 056608e8f243..2d1572d92616 100644
--- a/Documentation/virt/kvm/api.rst
+++ b/Documentation/virt/kvm/api.rst
@@ -6134,16 +6134,17 @@  in CPUID and only exposes Hyper-V identification. In this case, guest
 thinks it's running on Hyper-V and only use Hyper-V hypercalls.
 
 8.22 KVM_CAP_S390_VCPU_RESETS
+-----------------------------
 
-Architectures: s390
+:Architectures: s390
 
 This capability indicates that the KVM_S390_NORMAL_RESET and
 KVM_S390_CLEAR_RESET ioctls are available.
 
 8.23 KVM_CAP_S390_PROTECTED
+---------------------------
 
-Architecture: s390
-
+:Architecture: s390
 
 This capability indicates that the Ultravisor has been initialized and
 KVM can therefore start protected VMs.