[syslinux] [PATCH][git-pull] doc/syslinux.txt: CONFIG and LOCALBOOT

[Gene Cumm]

On Tue, Mar 1, 2011 at 13:20, Ferenc Wagner <wferi at niif.hu> wrote:
> Gene Cumm <gene.cumm at gmail.com> writes:
>
>> git://git.zytor.com/users/genec/syslinux.git
>>
>> Branch doc-syslinux-for-hpa
>>
>> Expand upon the explanation of the usage of CONFIG (including a new
>> directory).  Edit LOCALBOOT to include the fact that all variants
>> understand LOCALBOOT type -1.  Compact the PXELINUX section to one
>> paragraph.
>>
>> diff --git a/doc/syslinux.txt b/doc/syslinux.txt
>> index f5e1898..b6d3ec2 100644
>> --- a/doc/syslinux.txt
>> +++ b/doc/syslinux.txt
>> @@ -241,15 +241,17 @@ LABEL label
>>          Append nothing.  APPEND with a single hyphen as argument in a
>>          LABEL section can be used to override a global APPEND.
>>
>> -    LOCALBOOT type                     [ISOLINUX, PXELINUX]
>> -       On PXELINUX, specifying "LOCALBOOT 0" instead of a "KERNEL"
>> -       option means invoking this particular label will cause a local
>> -       disk boot instead of booting a kernel.
>> -
>> -       The argument 0 means perform a normal boot.  The argument 4
>> +    LOCALBOOT type
>> +       Attempt a different local boot method.  The special value -1
>
> Different to what?

Good point.  Perhaps "Call the BIOS to attempt another boot method."

> Also, the explanation of the special -1 should stay at the end in my
> opinion.

The reason I moved it is that I believe it's the only value that
applies to all variants.  As such, it doesn't belong with the ISOLINUX
paragraph.

Based on HPA's comment, I think that it may be better to change the
ISOLINUX paragraph to be about everything but PXELINUX and move it to
be the second paragraph since it covers more variants.  Perhaps the
wording of local disk (floppy, hdd, cd) or non-network variants or
just stating "For everything but PXELINUX"?

>> +       causes the boot loader to report failure to the BIOS, which, on
>> +       recent BIOSes, should mean that the next boot device in the
>> +       boot sequence should be activated.  Values other than those
>> +       documented may produce undesired results.
>> +
>> +       On PXELINUX, "type" 0 means perform a normal boot.  "type" 4
>
> What makes a boot "normal"?  Do you mean disk boot?  Doesn't it depend
> on the boot device order configured in the BIOS?  In other words, how is
> this different to -1?
> --
> Thanks,
> Feri.

Good point.  I think the issue may be how to explain it in easier
terms.  Currently, any value but -1 LOCALBOOT value in PXELINUX calls
the PXE stack with the corresponding value.  The PXE standard defines
these values and the BIOS decides how to select the next device.

-- 
-Gene