Re: [PATCH] docs: fix documentation about default scheduler

[Andrew Cooper <andrew.cooper3@citrix.com>]

On 11/11/2020 10:12, George Dunlap wrote:
>
>> On Nov 10, 2020, at 6:51 PM, Roger Pau Monne <roger.pau@citrix.com> wrote:
>>
>> Fix the command line document to account for the default scheduler not
>> being credit anymore likely, and the fact that it's selectable from
>> Kconfig and thus different builds could end up with different default
>> schedulers.
>>
>> Fixes: dafd936dddbd ('Make credit2 the default scheduler')
>> Signed-off-by: Roger Pau Monné <roger.pau@citrix.com>
>> ---
>> Changes since v1:
>> - Point that the default scheduler is being selected by Kconfig,
>>   don't mention the default Kconfig selection.
>> ---
>> docs/misc/xen-command-line.pandoc | 2 +-
>> 1 file changed, 1 insertion(+), 1 deletion(-)
>>
>> diff --git a/docs/misc/xen-command-line.pandoc b/docs/misc/xen-command-line.pandoc
>> index 4ae9391fcd..eb1db25f92 100644
>> --- a/docs/misc/xen-command-line.pandoc
>> +++ b/docs/misc/xen-command-line.pandoc
>> @@ -1876,7 +1876,7 @@ with read and write permissions.
>> ### sched
>>> `= credit | credit2 | arinc653 | rtds | null`
>> -> Default: `sched=credit`
>> +> Default: selectable via Kconfig.  Depends on enabled schedulers.
> Sorry for not weighing in earlier; but this basically makes this documentation useless.

No.  It is the only half useable version, by being the only version
which isn't misleading.

It would however be far better to name the CONFIG_ variable (we do
elsewhere in this doc) in question so people can actually figure out
what they've got in front of them.

~Andrew