[Qemu-devel] spelling typo (compatibilty) in hw/fw_cfg.c

[Qemu-devel] spelling typo (compatibilty) in hw/fw_cfg.c

[Vagrant Cascadian]

here's a trivial patch to fix the spelling of "compatibility":

diff --git a/hw/fw_cfg.c b/hw/fw_cfg.c
index fe6c543..22ebb50 100644
--- a/hw/fw_cfg.c
+++ b/hw/fw_cfg.c
@@ -179,7 +179,7 @@ static int get_uint32_as_uint16(QEMUFile *f, void *pv, size_t size)

 static void put_unused(QEMUFile *f, void *pv, size_t size)
 {
-    fprintf(stderr, "uint32_as_uint16 is only used for backward compatibilty.\n");
+    fprintf(stderr, "uint32_as_uint16 is only used for backward compatibility.\n");
     fprintf(stderr, "This functions shouldn't be called.\n");
 }


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

live well,
  vagrant

Re: [Qemu-devel] spelling typo (compatibilty) in hw/fw_cfg.c

[Blue Swirl]

On 3/12/10, Vagrant Cascadian <vagrant@freegeek.org> wrote:
> here's a trivial patch to fix the spelling of "compatibility":

Please add a Signed-off-by: line.

>
>  diff --git a/hw/fw_cfg.c b/hw/fw_cfg.c
>  index fe6c543..22ebb50 100644
>  --- a/hw/fw_cfg.c
>  +++ b/hw/fw_cfg.c
>  @@ -179,7 +179,7 @@ static int get_uint32_as_uint16(QEMUFile *f, void *pv, size_t size)
>
>   static void put_unused(QEMUFile *f, void *pv, size_t size)
>   {
>  -    fprintf(stderr, "uint32_as_uint16 is only used for backward compatibilty.\n");
>  +    fprintf(stderr, "uint32_as_uint16 is only used for backward compatibility.\n");
>      fprintf(stderr, "This functions shouldn't be called.\n");
>   }
>
>
>  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,

[Qemu-devel] manpage errors

[Vagrant Cascadian]

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 

[Qemu-devel] Re: manpage errors

[Blue Swirl]

[-- Attachment #1: Type: text/plain, Size: 2287 bytes --]

On 3/13/10, Vagrant Cascadian <vagrant@freegeek.org> wrote:
> 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.

How about this patch? I get no warnings anymore.

[-- Attachment #2: 0001-Fix-manpage-errors.patch --]
[-- Type: text/x-diff, Size: 4516 bytes --]

From cb53fa02e9465174ecd1ea7038a48539801b11c8 Mon Sep 17 00:00:00 2001
From: Blue Swirl <blauwirbel@gmail.com>
Date: Sun, 14 Mar 2010 09:49:40 +0000
Subject: [PATCH] Fix manpage errors

Split long unbreakable lines to smaller sections.

Spotted by Debian Lintian tool:
http://lintian.debian.org/full/pkg-qemu-devel@lists.alioth.debian.org.html#qemu

Signed-off-by: Blue Swirl <blauwirbel@gmail.com>
---
 qemu-doc.texi   |    2 +-
 qemu-options.hx |   12 ++++++------
 2 files changed, 7 insertions(+), 7 deletions(-)

diff --git a/qemu-doc.texi b/qemu-doc.texi
index 1494757..6647b7b 100644
--- a/qemu-doc.texi
+++ b/qemu-doc.texi
@@ -1504,7 +1504,7 @@ qemu-system-sparc -prom-env 'auto-boot?=false' \
  -prom-env 'boot-device=sd(0,2,0):d' -prom-env 'boot-args=linux single'
 @end example
 
-@item -M [SS-4|SS-5|SS-10|SS-20|SS-600MP|LX|Voyager|SPARCClassic|SPARCbook|SS-2|SS-1000|SS-2000]
+@item -M [SS-4|SS-5|SS-10|SS-20|SS-600MP|LX|Voyager|SPARCClassic] [|SPARCbook|SS-2|SS-1000|SS-2000]
 
 Set the emulated machine type. Default is SS-5.
 
diff --git a/qemu-options.hx b/qemu-options.hx
index fd50add..8450b45 100644
--- a/qemu-options.hx
+++ b/qemu-options.hx
@@ -852,7 +852,7 @@ Load SMBIOS entry from binary file.
 @findex -smbios
 Specify SMBIOS type 0 fields
 
-@item -smbios type=1[,manufacturer=@var{str}][,product=@var{str}][,version=@var{str}][,serial=@var{str}][,uuid=@var{uuid}][,sku=@var{str}][,family=@var{str}]
+@item -smbios type=1[,manufacturer=@var{str}][,product=@var{str}] [,version=@var{str}][,serial=@var{str}][,uuid=@var{uuid}][,sku=@var{str}] [,family=@var{str}]
 Specify SMBIOS type 1 fields
 ETEXI
 
@@ -932,7 +932,7 @@ DEF("netdev", HAS_ARG, QEMU_OPTION_netdev,
 #endif
     "socket],id=str[,option][,option][,...]\n")
 STEXI
-@item -net nic[,vlan=@var{n}][,macaddr=@var{mac}][,model=@var{type}][,name=@var{name}][,addr=@var{addr}][,vectors=@var{v}]
+@item -net nic[,vlan=@var{n}][,macaddr=@var{mac}][,model=@var{type}] [,name=@var{name}][,addr=@var{addr}][,vectors=@var{v}]
 @findex -net
 Create a new Network Interface Card and connect it to VLAN @var{n} (@var{n}
 = 0 is the default). The NIC is an e1000 by default on the PC
@@ -1063,7 +1063,7 @@ processed and applied to -net user. Mixing them with the new configuration
 syntax gives undefined results. Their use for new applications is discouraged
 as they will be removed from future versions.
 
-@item -net tap[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,ifname=@var{name}][,script=@var{file}][,downscript=@var{dfile}]
+@item -net tap[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,ifname=@var{name}] [,script=@var{file}][,downscript=@var{dfile}]
 Connect the host TAP network interface @var{name} to VLAN @var{n}, use
 the network script @var{file} to configure it and the network script
 @var{dfile} to deconfigure it. If @var{name} is not provided, the OS
@@ -1083,7 +1083,7 @@ qemu linux.img -net nic,vlan=0 -net tap,vlan=0,ifname=tap0 \
                -net nic,vlan=1 -net tap,vlan=1,ifname=tap1
 @end example
 
-@item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,listen=[@var{host}]:@var{port}][,connect=@var{host}:@var{port}]
+@item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}] [,listen=[@var{host}]:@var{port}][,connect=@var{host}:@var{port}]
 
 Connect the VLAN @var{n} to a remote VLAN in another QEMU virtual
 machine using a TCP socket connection. If @option{listen} is
@@ -1103,7 +1103,7 @@ qemu linux.img -net nic,macaddr=52:54:00:12:34:57 \
                -net socket,connect=127.0.0.1:1234
 @end example
 
-@item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,mcast=@var{maddr}:@var{port}]
+@item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}] [,mcast=@var{maddr}:@var{port}]
 
 Create a VLAN @var{n} shared with another QEMU virtual
 machines using a UDP multicast socket, effectively making a bus for
@@ -1143,7 +1143,7 @@ qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
 /path/to/linux ubd0=/path/to/root_fs eth0=mcast
 @end example
 
-@item -net vde[,vlan=@var{n}][,name=@var{name}][,sock=@var{socketpath}][,port=@var{n}][,group=@var{groupname}][,mode=@var{octalmode}]
+@item -net vde[,vlan=@var{n}][,name=@var{name}][,sock=@var{socketpath}] [,port=@var{n}][,group=@var{groupname}][,mode=@var{octalmode}]
 Connect VLAN @var{n} to PORT @var{n} of a vde switch running on host and
 listening for incoming connections on @var{socketpath}. Use GROUP @var{groupname}
 and MODE @var{octalmode} to change default ownership and permissions for
-- 
1.5.6.5

Re: [Qemu-devel] spelling typo (compatibilty) in hw/fw_cfg.c

[Vagrant Cascadian]

On Sat, Mar 13, 2010 at 01:05:03PM +0200, Blue Swirl wrote:
> On 3/12/10, Vagrant Cascadian <vagrant@freegeek.org> wrote:
> > here's a trivial patch to fix the spelling of "compatibility":
> 
> Please add a Signed-off-by: line.

hope this is what you're looking for:

Signed-off-by: Vagrant Cascadian <vagrant@freegeek.org>

> >
> >  diff --git a/hw/fw_cfg.c b/hw/fw_cfg.c
> >  index fe6c543..22ebb50 100644
> >  --- a/hw/fw_cfg.c
> >  +++ b/hw/fw_cfg.c
> >  @@ -179,7 +179,7 @@ static int get_uint32_as_uint16(QEMUFile *f, void *pv, size_t size)
> >
> >   static void put_unused(QEMUFile *f, void *pv, size_t size)
> >   {
> >  -    fprintf(stderr, "uint32_as_uint16 is only used for backward compatibilty.\n");
> >  +    fprintf(stderr, "uint32_as_uint16 is only used for backward compatibility.\n");
> >      fprintf(stderr, "This functions shouldn't be called.\n");
> >   }

live well,
  vagrant

Re: [Qemu-devel] spelling typo (compatibilty) in hw/fw_cfg.c

[Blue Swirl]

On 3/13/10, Vagrant Cascadian <vagrant@freegeek.org> wrote:
> On Sat, Mar 13, 2010 at 01:05:03PM +0200, Blue Swirl wrote:
>  > On 3/12/10, Vagrant Cascadian <vagrant@freegeek.org> wrote:
>  > > here's a trivial patch to fix the spelling of "compatibility":
>  >
>  > Please add a Signed-off-by: line.
>
>
> hope this is what you're looking for:
>
>  Signed-off-by: Vagrant Cascadian <vagrant@freegeek.org>

Yes. Thanks, applied.