diff mbox

docs: correct descriptions of gnttab_max_{, maptrack}_frames

Message ID 1453204610-29131-1-git-send-email-ian.campbell@citrix.com
State New, archived
Headers show

Commit Message

Ian Campbell Jan. 19, 2016, 11:56 a.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) and
adjust the default for gnttab_max_maptrack_frames to match the normal
form.

Signed-off-by: Ian Campbell <ian.campbell@citrix.com>
---
v2: Use more prevalent form for specifying defaults.
---
 docs/misc/xen-command-line.markdown | 11 ++++++++---
 1 file changed, 8 insertions(+), 3 deletions(-)

Comments

Ian Campbell Jan. 19, 2016, 12:07 p.m. UTC | #1
On Tue, 2016-01-19 at 11:56 +0000, Ian Campbell wrote:

Should have been tagged, v2, sorry.

> 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) and
> adjust the default for gnttab_max_maptrack_frames to match the normal
> form.
> 
> Signed-off-by: Ian Campbell <ian.campbell@citrix.com>
> ---
> v2: Use more prevalent form for specifying defaults.
> ---
>  docs/misc/xen-command-line.markdown | 11 ++++++++---
>  1 file changed, 8 insertions(+), 3 deletions(-)
> 
> diff --git a/docs/misc/xen-command-line.markdown b/docs/misc/xen-command-
> line.markdown
> index 5ed0730..d267a04 100644
> --- a/docs/misc/xen-command-line.markdown
> +++ b/docs/misc/xen-command-line.markdown
> @@ -740,13 +740,18 @@ Specify which console gdbstub should use. See
> **console**.
>  ### gnttab\_max\_frames
>  > `= <integer>`
>  
> -Specify the maximum number of frames per grant table operation.
> +> Default: `32`
> +
> +Specify the maximum number of frames which any domain may use as part
> +of its grant table.
>  
>  ### gnttab\_max\_maptrack\_frames
>  > `= <integer>`
>  
> -Specify the maximum number of maptrack frames domain.
> -The default value is 8 times **gnttab\_max\_frames**.
> +> Default: `8 * gnttab_max_frames`
> +
> +Specify the maximum number of frames to use as part of a domains
> +maptrack array.
>  
>  ### gnttab\_max\_nr\_frames
>  > `= <integer>`
Jan Beulich Jan. 19, 2016, 1:06 p.m. UTC | #2
>>> On 19.01.16 at 12:56, <ian.campbell@citrix.com> wrote:
> -Specify the maximum number of maptrack frames domain.
> -The default value is 8 times **gnttab\_max\_frames**.
> +> Default: `8 * gnttab_max_frames`

No backslash escaping needed here?

In any case,
Acked-by: Jan Beulich <jbeulich@suse.com>
Ian Campbell Jan. 19, 2016, 1:10 p.m. UTC | #3
On Tue, 2016-01-19 at 06:06 -0700, Jan Beulich wrote:
> > > > On 19.01.16 at 12:56, <ian.campbell@citrix.com> wrote:
> > -Specify the maximum number of maptrack frames domain.
> > -The default value is 8 times **gnttab\_max\_frames**.
> > +> Default: `8 * gnttab_max_frames`
> 
> No backslash escaping needed here?

No, not sure if the is ">" or the `` escaping them but the backslashes
appeared in the output HTML when I tried it.
> 
> In any case,
> Acked-by: Jan Beulich <jbeulich@suse.com>

Thanks.

Ian.
Andrew Cooper Jan. 19, 2016, 2:06 p.m. UTC | #4
On 19/01/16 13:10, Ian Campbell wrote:
> On Tue, 2016-01-19 at 06:06 -0700, Jan Beulich wrote:
>>>>> On 19.01.16 at 12:56, <ian.campbell@citrix.com> wrote:
>>> -Specify the maximum number of maptrack frames domain.
>>> -The default value is 8 times **gnttab\_max\_frames**.
>>> +> Default: `8 * gnttab_max_frames`
>> No backslash escaping needed here?
> No, not sure if the is ">" or the `` escaping them but the backslashes
> appeared in the output HTML when I tried it.
>> In any case,
>> Acked-by: Jan Beulich <jbeulich@suse.com>
> Thanks.

Markdown is occasionally very lax, and occasionally very picky about its
backslashes.

I tend to insert them for piece of mind.

Either way, Reviewed-by: Andrew Cooper <andrew.cooper3@citrix.com>
Ian Campbell Jan. 19, 2016, 2:22 p.m. UTC | #5
On Tue, 2016-01-19 at 14:06 +0000, Andrew Cooper wrote:
> On 19/01/16 13:10, Ian Campbell wrote:
> > On Tue, 2016-01-19 at 06:06 -0700, Jan Beulich wrote:
> > > > > > On 19.01.16 at 12:56, <ian.campbell@citrix.com> wrote:
> > > > -Specify the maximum number of maptrack frames domain.
> > > > -The default value is 8 times **gnttab\_max\_frames**.
> > > > +> Default: `8 * gnttab_max_frames`
> > > No backslash escaping needed here?
> > No, not sure if the is ">" or the `` escaping them but the backslashes
> > appeared in the output HTML when I tried it.
> > > In any case,
> > > Acked-by: Jan Beulich <jbeulich@suse.com>
> > Thanks.
> 
> Markdown is occasionally very lax, and occasionally very picky about its
> backslashes.
> 
> I tend to insert them for piece of mind.

In this case they ended up in the output, which is wrong.

> 
> Either way, Reviewed-by: Andrew Cooper <andrew.cooper3@citrix.com>
Andrew Cooper Jan. 19, 2016, 2:26 p.m. UTC | #6
On 19/01/16 14:22, Ian Campbell wrote:
> On Tue, 2016-01-19 at 14:06 +0000, Andrew Cooper wrote:
>> On 19/01/16 13:10, Ian Campbell wrote:
>>> On Tue, 2016-01-19 at 06:06 -0700, Jan Beulich wrote:
>>>>>>> On 19.01.16 at 12:56, <ian.campbell@citrix.com> wrote:
>>>>> -Specify the maximum number of maptrack frames domain.
>>>>> -The default value is 8 times **gnttab\_max\_frames**.
>>>>> +> Default: `8 * gnttab_max_frames`
>>>> No backslash escaping needed here?
>>> No, not sure if the is ">" or the `` escaping them but the backslashes
>>> appeared in the output HTML when I tried it.
>>>> In any case,
>>>> Acked-by: Jan Beulich <jbeulich@suse.com>
>>> Thanks.
>> Markdown is occasionally very lax, and occasionally very picky about its
>> backslashes.
>>
>> I tend to insert them for piece of mind.
> In this case they ended up in the output, which is wrong.

Oh right yes.  `` is verbatim text.
Ian Campbell Jan. 19, 2016, 4:48 p.m. UTC | #7
On Tue, 2016-01-19 at 06:06 -0700, Jan Beulich wrote:
> > > > On 19.01.16 at 12:56, <ian.campbell@citrix.com> wrote:
> > -Specify the maximum number of maptrack frames domain.
> > -The default value is 8 times **gnttab\_max\_frames**.
> > +> Default: `8 * gnttab_max_frames`
> 
> No backslash escaping needed here?
> 
> In any case,
> Acked-by: Jan Beulich <jbeulich@suse.com>

Applied, thanks.

Ian.
diff mbox

Patch

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