diff mbox

docs: correct descriptions of gnttab_max_{, maptrack}_frames

Message ID 1453123167-22217-1-git-send-email-ian.campbell@citrix.com (mailing list archive)
State New, archived
Headers show

Commit Message

Ian Campbell Jan. 18, 2016, 1:19 p.m. UTC
gnttab_max_frames incorrectly referred to numbers of grant tab
operations and gnttab_max_maptrack_frames was confusingly worded.

Add the default for gnttab_max_frames while here (it's currently the
same on all arches since no arch uses the available arch override).

Signed-off-by: Ian Campbell <ian.campbell@citrix.com>
---
 docs/misc/xen-command-line.markdown | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)

Comments

Jan Beulich Jan. 18, 2016, 1:48 p.m. UTC | #1
>>> On 18.01.16 at 14:19, <ian.campbell@citrix.com> wrote:
> gnttab_max_frames incorrectly referred to numbers of grant tab
> operations and gnttab_max_maptrack_frames was confusingly worded.
> 
> Add the default for gnttab_max_frames while here (it's currently the
> same on all arches since no arch uses the available arch override).
> 
> Signed-off-by: Ian Campbell <ian.campbell@citrix.com>

Acked-by: Jan Beulich <jbeulich@suse.com>
Andrew Cooper Jan. 18, 2016, 1:53 p.m. UTC | #2
On 18/01/16 13:19, Ian Campbell wrote:
> gnttab_max_frames incorrectly referred to numbers of grant tab
> operations and gnttab_max_maptrack_frames was confusingly worded.
>
> Add the default for gnttab_max_frames while here (it's currently the
> same on all arches since no arch uses the available arch override).
>
> Signed-off-by: Ian Campbell <ian.campbell@citrix.com>
> ---
>  docs/misc/xen-command-line.markdown | 7 ++++---
>  1 file changed, 4 insertions(+), 3 deletions(-)
>
> diff --git a/docs/misc/xen-command-line.markdown b/docs/misc/xen-command-line.markdown
> index 5ed0730..8d46892 100644
> --- a/docs/misc/xen-command-line.markdown
> +++ b/docs/misc/xen-command-line.markdown
> @@ -740,13 +740,14 @@ Specify which console gdbstub should use. See **console**.
>  ### gnttab\_max\_frames
>  > `= <integer>`

> Default: `32`

Is the prevailing style for indicating defaults.

Otherwise, Reviewed-by: Andrew Cooper <andrew.cooper3@citrix.com>

>  
> -Specify the maximum number of frames per grant table operation.
> +Specify the maximum number of frames which any domain may use as part
> +of its grant table. The default value is 32.
>  
>  ### gnttab\_max\_maptrack\_frames
>  > `= <integer>`
>  
> -Specify the maximum number of maptrack frames domain.
> -The default value is 8 times **gnttab\_max\_frames**.
> +Specify the maximum number of frames to use as part of a domains
> +maptrack array. The default value is 8 times **gnttab\_max\_frames**.
>  
>  ### gnttab\_max\_nr\_frames
>  > `= <integer>`
diff mbox

Patch

diff --git a/docs/misc/xen-command-line.markdown b/docs/misc/xen-command-line.markdown
index 5ed0730..8d46892 100644
--- a/docs/misc/xen-command-line.markdown
+++ b/docs/misc/xen-command-line.markdown
@@ -740,13 +740,14 @@  Specify which console gdbstub should use. See **console**.
 ### gnttab\_max\_frames
 > `= <integer>`
 
-Specify the maximum number of frames per grant table operation.
+Specify the maximum number of frames which any domain may use as part
+of its grant table. The default value is 32.
 
 ### gnttab\_max\_maptrack\_frames
 > `= <integer>`
 
-Specify the maximum number of maptrack frames domain.
-The default value is 8 times **gnttab\_max\_frames**.
+Specify the maximum number of frames to use as part of a domains
+maptrack array. The default value is 8 times **gnttab\_max\_frames**.
 
 ### gnttab\_max\_nr\_frames
 > `= <integer>`