Error in gnttab documentation

Error in gnttab documentation

[Rafał Wojdyła]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Hi all,

There is an erroneous statement in the public header grant_table.h
regarding GNTTABOP_map_grant_ref:

"On error, <handle> is a negative status code." [1]

This is not the case. Only the gnttab_map_grant_ref.status field is
set on errors most of the time. [2]

[1]
http://xenbits.xen.org/gitweb/?p=xen.git;a=blob;f=xen/include/public/gra
nt_table.h;h=c8619ed50dda6d3b1bdc73faeb5622f5eccad1ac;hb=refs/heads/mast
er#l324

[2]
http://xenbits.xen.org/gitweb/?p=xen.git;a=blob;f=xen/common/grant_table
.c;h=dfb45f8d6661fc60379abd29597bc23e55d674ff;hb=refs/heads/master#l591

- -- 
Rafał Wojdyła
Qubes Tools for Windows developer
https://www.qubes-os.org/
-----BEGIN PGP SIGNATURE-----

iQEcBAEBAgAGBQJVLsBLAAoJEIWi9rB2GrW7aiEH/RW+sYzjOglvWhak36piSfo2
YXjrwWFWOHzLglGzgq7cPXNGa/4LxZekvL5mGaph0vvjKPRuda9harbJeS02YLpr
9lX1pw497559DmnJTLn5z2aC3V5htdVKb8k3yqX7DFXJCx2bUBS06jK49YdkroX/
TIF9QLN4qObxhyrqSkArsOm7Pv/t/Y4Ad/ELgYewMUDCst9EKgpqC1Cijfqd5mzJ
6mwwr2rGEQPcdrz4unBQiiqMik0W2BDxR74GERmfqvNIdIga10v7oMh6o+inlr98
YIb8ETDg7OIIn/ZT58AIAvrfcEkVz1qXGmlxloJzt/8iP4S5hazLJm/k+dxg1lQ=
=7bM3
-----END PGP SIGNATURE-----

_______________________________________________
Xen-devel mailing list
Xen-devel@lists.xen.org
http://lists.xen.org/xen-devel

Re: Error in gnttab documentation

[Jan Beulich]

>>> On 15.04.15 at 21:47, <omeg@invisiblethingslab.com> wrote:
> There is an erroneous statement in the public header grant_table.h
> regarding GNTTABOP_map_grant_ref:
> 
> "On error, <handle> is a negative status code." [1]
> 
> This is not the case. Only the gnttab_map_grant_ref.status field is
> set on errors most of the time. [2]

First of all - why didn't you simply send a patch to correct this? And
then - why do you say "most of the time"? Is there any path which
fails to do so, or sets .handle to some error indicator? I can't seem
to be able to spot any...

Jan

> [1]
> http://xenbits.xen.org/gitweb/?p=xen.git;a=blob;f=xen/include/public/gra 
> nt_table.h;h=c8619ed50dda6d3b1bdc73faeb5622f5eccad1ac;hb=refs/heads/mast
> er#l324
> 
> [2]
> http://xenbits.xen.org/gitweb/?p=xen.git;a=blob;f=xen/common/grant_table 
> .c;h=dfb45f8d6661fc60379abd29597bc23e55d674ff;hb=refs/heads/master#l591
> 
> - -- 
> Rafał Wojdyła
> Qubes Tools for Windows developer
> https://www.qubes-os.org/ 


_______________________________________________
Xen-devel mailing list
Xen-devel@lists.xen.org
http://lists.xen.org/xen-devel

Re: Error in gnttab documentation

[Ian Campbell]

On Wed, 2015-04-15 at 21:47 +0200, Rafał Wojdyła wrote:
> Hi all,
> 
> There is an erroneous statement in the public header grant_table.h
> regarding GNTTABOP_map_grant_ref:
> 
> "On error, <handle> is a negative status code." [1]
> 
> This is not the case. Only the gnttab_map_grant_ref.status field is
> set on errors most of the time.

Are you saying we should do s/<handle>/<status>/ on that sentence? If so
is there any chance you could you send a patch please?

Ian.



_______________________________________________
Xen-devel mailing list
Xen-devel@lists.xen.org
http://lists.xen.org/xen-devel

Re: Error in gnttab documentation

[Rafał Wojdyła]

On 2015-04-16 11:04, Ian Campbell wrote:
> On Wed, 2015-04-15 at 21:47 +0200, Rafał Wojdyła wrote:
>> Hi all,
>>
>> There is an erroneous statement in the public header grant_table.h
>> regarding GNTTABOP_map_grant_ref:
>>
>> "On error, <handle> is a negative status code." [1]
>>
>> This is not the case. Only the gnttab_map_grant_ref.status field is
>> set on errors most of the time.
> 
> Are you saying we should do s/<handle>/<status>/ on that sentence? If so
> is there any chance you could you send a patch please?
> 
> Ian.
> 
Of course, patch sent. Sorry, I should have done that sooner.

-- 
Rafał Wojdyła
Qubes Tools for Windows developer

_______________________________________________
Xen-devel mailing list
Xen-devel@lists.xen.org
http://lists.xen.org/xen-devel