[syslinux] [PATCH v2] Documentation: introduce the working directory

[Paul Bolle]

On Sat, 2011-01-15 at 12:28 +0100, Ferenc Wagner wrote:
> Paul Bolle <pebolle at tiscali.nl> writes:
> > If a /boot/syslinux directory or /syslinux directory is used, is it used
> > as a working directory too?
> 
> When any Syslinux variant starts up, its working directory is set to the
> installation directory, ie. where ldlinux.sys/isolinux.bin/pxelinux.0
> was loaded from.

I see.

> > -This will alter the boot sector on the disk and copy a file named
> > -LDLINUX.SYS into its root directory (or a subdirectory, if the -d
> > -option is specified.)
> > +This will alter the boot sector of that device. A file named ldlinux.sys
> > +will be copied into its root directory. That root directory will be the working
> > +directory of ldlinux.sys. (If the -d option is given, that file will be copied
> > +into the specified subdirectory and that subdirectory will be the working
> > +directory of ldlinux.sys.)
> 
> In my opinion the original text is better.  The working directory stuff
> could be discussed later.

If I read your comments correctly, the working directory doesn't really
need to be discussed at all. So perhaps that concept can be left
implicit.

> >  The Syslinux loader does not need to know about the kernel file in
> > -advance; all that is required is that it is a file located in the root
> > -directory on the disk.
> > +advance; all that is required is that it is a file located in its working
> > +directory.
> 
> Neither is true.  What's actually needed is that the file must reside in
> the same filesystem.

OK.

> Of course, if some file is in the working
> directory, one can access it without supplying its path.  Basically,
> Syslinux works as if PATH=. (ie. working directory only).

But let's not clutter the manual with that detail.

> >  All the configurable defaults in SYSLINUX can be changed by putting a
> > -file called "syslinux.cfg" in the root directory of the boot disk.
> > +file called "syslinux.cfg" in its working directory.
> 
> Rather in its installation directory.

OK.

> Which coincides with the working
> directory at startup, but loading a new config file via the CONFIG
> directive or config.c32 can change that.  The text in 5e50b4d4 or in the
> corresponding 4.00 changelog should be molded into the documentation of
> CONFIG to make this clear.

Cleaning up the configuration syntax is another (and bigger) job. My
suggestion would regarding that (sub)section would be to move it into
its own manual, ie a (new) man/syslinux.cfg(5). But I'll leave that for
another day.

> >  Starting with version 3.35, the configuration file can also be in
> >  either the /boot/syslinux or /syslinux directories (searched in that
> 
> I wonder if this part is still relevant...  No time for experiments.

Even if it's not relevant, I would prefer the manual to describe the
current release only. Users of a pre-3.35 version should use the
corresponding pre-3.35 manual.

> >  Any file that SYSLINUX uses can be marked hidden, system or readonly
> >  if so is convenient; SYSLINUX ignores all file attributes.  The
> >  SYSLINUX installed automatically sets the readonly/hidden/system
>            /
>     installer

Thanks. But I guess "SYSLINUX automatically sets [...]" is clear enough.

> >  All the configurable defaults in \s-1SYSLINUX\s+1 can be changed by putting a
> >  file called
> >  .B syslinux.cfg
> > -in the install directory of the boot disk. This
> > +in the ldlinux.sys working directory. This
> 
> Again, I find the original text clearer...

But s/install/installation/.

> > -installed automatically sets the readonly attribute on LDLINUX.SYS.
> > +installed automatically sets the readonly attribute on ldlinux.sys.
>      /
> installer

Thanks again. (But see above.)

> Thanks for tackling this, hope you don't get discouraged by my
> comments.

That's how collective writing sometimes goes: unless one is an
outstanding author with a good grasp of the subject, chances are that
you'll receive comments and that you'll have to write a few versions
before your edits are accepted. I guess I should be glad my attempt
wasn't rejected outright.


Paul Bolle