[Qemu-devel] manpage errors

[Vagrant Cascadian <vagrant@freegeek.org>]

On Sat, Mar 13, 2010 at 01:05:03PM +0200, Blue Swirl wrote:
> On 3/12/10, Vagrant Cascadian <vagrant@freegeek.org> wrote:
> >  i found this spelling typo and the previous one by running lintian on the qemu
> >  packages i work on for debian:
> >
> >  http://lintian.debian.org/full/pkg-qemu-devel@lists.alioth.debian.org.html#qemu
>
> Perhaps the manual page errors should be fixed too,

i did look into that a bit, though it is a little tricky because it's got the
qemu-doc.texi and qemu-options.texi (texinfo?) layer of abstraction. for the
full details:

  LANG=C MANWIDTH=80 man --warnings -E UTF-8 -l ./qemu.1 >/dev/null
  <standard input>:730: warning [p 9, 4.8i, div `an-div', 0.2i]: can't break line
  <standard input>:730: warning [p 9, 5.0i]: can't break line
  <standard input>:735: warning [p 9, 5.8i, div `an-div', 0.2i]: can't break line
  <standard input>:735: warning [p 9, 6.0i]: can't break line
  <standard input>:869: warning [p 11, 5.2i, div `an-div', 0.2i]: can't break line
  <standard input>:869: warning [p 11, 5.3i]: can't break line
  <standard input>:890: warning [p 11, 8.3i, div `an-div', 0.2i]: can't break line
  <standard input>:890: warning [p 11, 8.5i]: can't break line
  <standard input>:953: warning [p 12, 5.8i, div `an-div', 0.2i]: can't break line
  <standard input>:953: warning [p 12, 6.0i]: can't break line
  <standard input>:1732: warning [p 22, 1.8i, div `an-div', 0.2i]: can't break line
  <standard input>:1732: warning [p 22, 2.0i]: can't break line
  
the generated manpage has several lines longer than 80 characters describing
commandline arguments, such as:

       -smbios
       type=1[,manufacturer=str][,product=str][,version=str][,serial=str][,uuid=uuid][,sku=str][,family=str]
           Specify SMBIOS type 1 fields
...
       -net
       nic[,vlan=n][,macaddr=mac][,model=type][,name=name][,addr=addr][,vectors=v]

and so on...

i don't know if there is a way to more succinctly describe those options that
gets all the details... or an easy way to generate the manpage to fix the
formatting issues with those long lines.

live well,
  vagrant