[Qemu-devel] [PATCH] spellcheck the documentation

[Qemu-devel] [PATCH] spellcheck the documentation

[Mark Glines]

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

Hi,

This patch fixes some spelling errors.  I tried to focus on actual
errors (like thoses -> those, priviledge -> privilege), leaving things
like differences in UK/US spellings (like symbolised/symbolized)
alone.  Hope it's helpful.

Mark

[-- Attachment #2: spellcheck_docs.diff --]
[-- Type: text/x-patch, Size: 8478 bytes --]

# 
# old_revision [2b7f01e6f3aca4dd64ba04e986a1a4b2271f17ea]
# 
# patch "qemu-doc.texi"
#  from [b177fec0d24ce05f136e2798a12044b21d91fd88]
#    to [05125ff074558272198207397bc3aa3ee2236c1d]
# 
# patch "qemu-img.texi"
#  from [5b40c5c5b3a5d3942ada9c6aa876c1971c3d7da0]
#    to [de4e8365b70de68f81e44cd0a87f4fd9c343c434]
# 
============================================================
--- qemu-doc.texi	b177fec0d24ce05f136e2798a12044b21d91fd88
+++ qemu-doc.texi	05125ff074558272198207397bc3aa3ee2236c1d
@@ -366,7 +366,7 @@ @section Invocation
 
 @item -net user[,vlan=n][,hostname=name]
 Use the user mode network stack which requires no administrator
-priviledge to run.  @option{hostname=name} can be used to specify the client
+privilege to run.  @option{hostname=name} can be used to specify the client
 hostname reported by the builtin DHCP server.
 
 @item -net tap[,vlan=n][,fd=h][,ifname=name][,script=file]
@@ -421,7 +421,8 @@ @section Invocation
 @item
 mcast support is compatible with User Mode Linux (argument @option{eth@var{N}=mcast}), see
 @url{http://user-mode-linux.sf.net}.
-@item Use @option{fd=h} to specify an already opened UDP multicast socket.
+@item
+Use @option{fd=h} to specify an already opened UDP multicast socket.
 @end enumerate
 
 Example:
@@ -574,7 +575,7 @@ @section Invocation
 @item COMn
 [Windows only] Use host serial port @var{n}
 @item udp:[remote_host]:remote_port[@@[src_ip]:src_port]
-This implements UDP Net Console.  When @var{remote_host} or @var{src_ip} are not specified they default to @code{0.0.0.0}.  When not using a specifed @var{src_port} a random port is automatically chosen.
+This implements UDP Net Console.  When @var{remote_host} or @var{src_ip} are not specified they default to @code{0.0.0.0}.  When not using a specified @var{src_port} a random port is automatically chosen.
 
 If you just want a simple readonly console you can use @code{netcat} or
 @code{nc}, by starting qemu with: @code{-serial udp::4555} and nc as:
@@ -607,7 +608,7 @@ @section Invocation
 the @var{server} option QEMU will wait for a client socket application
 to connect to the port before continuing, unless the @code{nowait}
 option was specified.  The @code{nodelay} option disables the Nagle buffering
-algoritm.  If @var{host} is omitted, 0.0.0.0 is assumed. Only
+algorithm.  If @var{host} is omitted, 0.0.0.0 is assumed. Only
 one TCP connection at a time is accepted. You can use @code{telnet} to
 connect to the corresponding character device.
 @table @code
@@ -690,7 +691,7 @@ @section Invocation
 Force hard disk 0 physical geometry (1 <= @var{c} <= 16383, 1 <=
 @var{h} <= 16, 1 <= @var{s} <= 63) and optionally force the BIOS
 translation mode (@var{t}=none, lba or auto). Usually QEMU can guess
-all thoses parameters. This option is useful for old MS-DOS disk
+all those parameters. This option is useful for old MS-DOS disk
 images.
 
 @item -L path
@@ -923,7 +924,7 @@ @subsection Commands
 is the number of items to be dumped.
 
 @item format
-can be x (hexa), d (signed decimal), u (unsigned decimal), o (octal),
+can be x (hex), d (signed decimal), u (unsigned decimal), o (octal),
 c (char) or i (asm instruction).
 
 @item size
@@ -1112,7 +1113,7 @@ @subsubsection Linux
 @subsubsection Linux
 
 On Linux, you can directly use the host device filename instead of a
-disk image filename provided you have enough proviledge to access
+disk image filename provided you have enough privileges to access
 it. For example, use @file{/dev/cdrom} to access to the CDROM or
 @file{/dev/fd0} for the floppy.
 
@@ -1139,7 +1140,7 @@ @subsubsection Windows
 
 @table @code
 @item CD
-The prefered syntax is the drive letter (e.g. @file{d:}). The
+The preferred syntax is the drive letter (e.g. @file{d:}). The
 alternate syntax @file{\\.\d:} is supported. @file{/dev/cdrom} is
 supported as an alias to the first CDROM drive.
 
@@ -1203,11 +1204,11 @@ @section Network emulation
 @node pcsys_network
 @section Network emulation
 
-QEMU can simulate several networks cards (NE2000 boards on the PC
+QEMU can simulate several network cards (NE2000 boards on the PC
 target) and can connect them to an arbitrary number of Virtual Local
 Area Networks (VLANs). Host TAP devices can be connected to any QEMU
 VLAN. VLAN can be connected between separate instances of QEMU to
-simulate large networks. For simpler usage, a non priviledged user mode
+simulate large networks. For simpler usage, a non privileged user mode
 network stack can replace the TAP device to have a basic network
 connection.
 
@@ -1247,7 +1248,7 @@ @subsection Using the user mode network 
 
 By using the option @option{-net user} (default configuration if no
 @option{-net} option is specified), QEMU uses a completely user mode
-network stack (you don't need root priviledge to use the virtual
+network stack (you don't need root privilege to use the virtual
 network). The virtual network configuration is the following:
 
 @example
@@ -1270,7 +1271,7 @@ @subsection Using the user mode network 
 10.0.2.x from the QEMU virtual DHCP server.
 
 Note that @code{ping} is not supported reliably to the internet as it
-would require root priviledges. It means you can only ping the local
+would require root privileges. It means you can only ping the local
 router (10.0.2.2).
 
 When using the built-in TFTP server, the router is also the TFTP
@@ -1459,7 +1460,7 @@ @subsection Linux
 When using a 2.6 guest Linux kernel, verify that the 4G/4G patch is
 not activated because QEMU is slower with this patch. The QEMU
 Accelerator Module is also much slower in this case. Earlier Fedora
-Core 3 Linux kernel (< 2.6.9-1.724_FC3) were known to incorporte this
+Core 3 Linux kernel (< 2.6.9-1.724_FC3) were known to incorporate this
 patch by default. Newer kernels don't have it.
 
 @subsection Windows
@@ -1541,7 +1542,7 @@ @chapter QEMU System emulator for non PC
 
 QEMU is a generic emulator and it emulates many non PC
 machines. Most of the options are similar to the PC emulator. The
-differences are mentionned in the following sections.
+differences are mentioned in the following sections.
 
 @menu
 * QEMU PowerPC System emulator::
@@ -1753,8 +1754,8 @@ @section ARM System emulator invocation
 @item
 PCI host bridge.  Note the emulated PCI bridge only provides access to
 PCI memory space.  It does not provide access to PCI IO space.
-This means some devices (eg. ne2k_pci NIC) are not useable, and others
-(eg. rtl8139 NIC) are only useable when the guest drivers use the memory
+This means some devices (eg. ne2k_pci NIC) are not usable, and others
+(eg. rtl8139 NIC) are only usable when the guest drivers use the memory
 mapped control registers.
 @item
 PCI OHCI USB controller.
@@ -1838,9 +1839,9 @@ @section Supported Operating Systems
 
 @itemize @minus
 @item
-Linux (refered as qemu-linux-user)
+Linux (referred as qemu-linux-user)
 @item
-Mac OS X/Darwin (refered as qemu-darwin-user)
+Mac OS X/Darwin (referred as qemu-darwin-user)
 @end itemize
 
 @node Linux User space emulator
@@ -2098,7 +2099,7 @@ @subsection GCC version
 Linux distribution includes a gcc 4.x compiler, you can usually
 install an older version (it is invoked by @code{gcc32} or
 @code{gcc34}). The QEMU configure script automatically probes for
-these older versions so that usally you don't have to do anything.
+these older versions so that usually you don't have to do anything.
 
 @node Windows
 @section Windows
@@ -2150,7 +2151,7 @@ @section Cross compilation for Windows w
 ./configure --enable-mingw32
 @end example
 If necessary, you can change the cross-prefix according to the prefix
-choosen for the MinGW tools with --cross-prefix. You can also use
+chosen for the MinGW tools with --cross-prefix. You can also use
 --prefix to set the Win32 install path.
 
 @item You can install QEMU in the installation directory by typing 
============================================================
--- qemu-img.texi	5b40c5c5b3a5d3942ada9c6aa876c1971c3d7da0
+++ qemu-img.texi	de4e8365b70de68f81e44cd0a87f4fd9c343c434
@@ -89,7 +89,7 @@
 @item convert [-c] [-e] [-f @var{fmt}] @var{filename} [-O @var{output_fmt}] @var{output_filename}
 
 Convert the disk image @var{filename} to disk image @var{output_filename}
-using format @var{output_fmt}. It can be optionnaly encrypted
+using format @var{output_fmt}. It can be optionally encrypted
 (@code{-e} option) or compressed (@code{-c} option).
 
 Only the format @code{qcow} supports encryption or compression. The

Re: [Qemu-devel] [PATCH] spellcheck the documentation

[Mark Glines]

On Sun, 20 May 2007 06:29:33 -0700
Mark Glines <mark@glines.org> wrote:

> -@item Use @option{fd=h} to specify an already opened UDP multicast socket.
> +@item
> +Use @option{fd=h} to specify an already opened UDP multicast socket.

Forgot to mention, the above patch fixes the following error I get at
the bottom of the qemu.1 manpage:

POD ERRORS
       Hey! The above document had some coding errors, which are explained
       below:

       Around line 386:
           Expected ’=item 3’



Mark

Re: [Qemu-devel] [PATCH] spellcheck the documentation

[Stefan Weil]

Was Mark's patch lost? It should be added to CVS...
Stefan

Mark Glines schrieb:
> Hi,
>
> This patch fixes some spelling errors. I tried to focus on actual
> errors (like thoses -> those, priviledge -> privilege), leaving things
> like differences in UK/US spellings (like symbolised/symbolized)
> alone. Hope it's helpful.
>
> Mark