[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]

[Libguestfs] Trailing spaces in POD files



IMHO trailing spaces should be permitted in POD files.  Currently
they are prevented by the git upload hook.

The reason to allow them in POD files is because indentation is
used to indicate blocks of preformatted text (the equivalent of
<pre> in HTML).  To keep code together in the output if it
contains blank lines you have to add a line containing a single
space.

For an example of where this is currently wrong, because we're not
allowed to have trailing spaces, see the preformatted code block
here:

  http://libguestfs.org/guestfs.3.html#handles

I have no idea how the git hook is implemented or whether we can
make it give an exception to POD files.  (Jim?)

Rich.

-- 
Richard Jones, Virtualization Group, Red Hat http://people.redhat.com/~rjones
New in Fedora 11: Fedora Windows cross-compiler. Compile Windows
programs, test, and build Windows installers. Over 70 libraries supprt'd
http://fedoraproject.org/wiki/MinGW http://www.annexia.org/fedora_mingw


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]