[syslinux] RFC:documents for new modules; Interest in rewriting exiting documentation

Gene Cumm gene.cumm at gmail.com
Sun Sep 2 09:02:40 PDT 2012


On Sun, Sep 2, 2012 at 9:26 AM, Bernd Blaauw <bblaauw at home.nl> wrote:
> Op 2-9-2012 13:39, Gene Cumm schreef:
>
>> https://github.com/geneC/syslinux/blob/master/doc/pxechn.txt
>
>
> Line width might be an issue (seeing scrollbars in browser) and possibly
> unclear which GPL version(s) are meant (at bottom of doc).

Therein is a debate: long lines in the original and let AsciiDoc
handle making a cleaner text file OR wrap reasonably (probably closer
to 72-76 characters).

Thanks for noting the lack of version.  This reference does need
further qualification.

> As for cptime:
> - replace 'file' by 'single file' ? (if that's a limitation)

It will process multiple files but with the same options for each
file, in the order specified (hence the "'FILE'..." with the
ellipsis).

> - (absolute/relative) path support or only current dir?
> - how does CHMOD or ACLs influence if cptime can find/read a file?

Same rules as the rest of Syslinux as I only use standard *nix file
calls.  I actually compiled it as cptime.lnx for initial testing.

> Documentation looks pretty clear, including the format/flow you've used.

Thanks.  I've tried to follow the man page styling for AsciiDoc.

> Something like MEMDISK documentation would be the real challenge to see if
> you're happy with used document style.

That would probably be another idea.

> with best regards,
>
> Bernd Blaauw

Thanks for the feedback.

-- 
-Gene



More information about the Syslinux mailing list