Patchwork Documentation: Update chapter on installation

login
register
mail settings
Submitter Stefan Weil
Date March 28, 2010, 9:50 a.m.
Message ID <1269769819-7521-1-git-send-email-weil@mail.berlios.de>
Download mbox | patch
Permalink /patch/48776/
State New
Headers show

Comments

Stefan Weil - March 28, 2010, 9:50 a.m.
* Replace broken links by link to QEMU wiki.

* Separate sections for Linux / Windows / Mac OS X
  are no longer needed: the wiki link will provide
  additional links, so we don't need them here.

* Add hint for (Open) Solaris.

Signed-off-by: Stefan Weil <weil@mail.berlios.de>
---
 qemu-doc.texi   |   38 +++++++++++---------------------------
 qemu-options.hx |    8 ++++----
 2 files changed, 15 insertions(+), 31 deletions(-)
Aurelien Jarno - April 9, 2010, 7:47 p.m.
On Sun, Mar 28, 2010 at 11:50:19AM +0200, Stefan Weil wrote:
> * Replace broken links by link to QEMU wiki.
> 
> * Separate sections for Linux / Windows / Mac OS X
>   are no longer needed: the wiki link will provide
>   additional links, so we don't need them here.
> 
> * Add hint for (Open) Solaris.

Whats the reason for the change disk_image -> disk image?

> Signed-off-by: Stefan Weil <weil@mail.berlios.de>
> ---
>  qemu-doc.texi   |   38 +++++++++++---------------------------
>  qemu-options.hx |    8 ++++----
>  2 files changed, 15 insertions(+), 31 deletions(-)
> 
> diff --git a/qemu-doc.texi b/qemu-doc.texi
> index 34182ae..b3a3a9a 100644
> --- a/qemu-doc.texi
> +++ b/qemu-doc.texi
> @@ -122,33 +122,17 @@ Alpha, ColdFire(m68k), CRISv32 and MicroBlaze CPUs are supported.
>  
>  If you want to compile QEMU yourself, see @ref{compilation}.
>  
> -@menu
> -* install_linux::   Linux
> -* install_windows:: Windows
> -* install_mac::     Macintosh
> -@end menu
> +Precompiled packages are available for most Linux distributions,
> +so you just have to install it.
>  
> -@node install_linux
> -@section Linux
> -@cindex installation (Linux)
> +For other operating systems (Max OS X, Open Solaris, Windows),
> +binaries are provided by user groups or individuals.
>  
> -If a precompiled package is available for your distribution - you just
> -have to install it. Otherwise, see @ref{compilation}.
> -
> -@node install_windows
> -@section Windows
> -@cindex installation (Windows)
> -
> -Download the experimental binary installer at
> -@url{http://www.free.oszoo.org/@/download.html}.
> -TODO (no longer available)
> -
> -@node install_mac
> -@section Mac OS X
> +See @url{http://wiki.qemu.org/Download} for links to binary distributions
> +and some @ref{disk images} for testing.
>  
> -Download the experimental binary installer at
> -@url{http://www.free.oszoo.org/@/download.html}.
> -TODO (no longer available)
> +QEMU @ref{disk images} for several guest operating systems are also available
> +from the FreeOsZoo project (@url{http://www.oszoo.org/}).
>  
>  @node QEMU PC System emulator
>  @chapter QEMU PC System emulator
> @@ -160,7 +144,7 @@ TODO (no longer available)
>  * sec_invocation::     Invocation
>  * pcsys_keys::         Keys
>  * pcsys_monitor::      QEMU Monitor
> -* disk_images::        Disk Images
> +* disk images::        Disk Images
>  * pcsys_network::      Network emulation
>  * direct_linux_boot::  Direct Linux Boot
>  * pcsys_usb::          USB emulation
> @@ -386,7 +370,7 @@ The monitor understands integers expressions for every integer
>  argument. You can use register names to get the value of specifics
>  CPU registers by prefixing them with @emph{$}.
>  
> -@node disk_images
> +@node disk images
>  @section Disk Images
>  
>  Since version 0.6.1, QEMU supports many disk image formats, including
> @@ -763,7 +747,7 @@ Pointer device that uses absolute coordinates (like a touchscreen).
>  This means qemu is able to report the mouse position without having
>  to grab the mouse.  Also overrides the PS/2 mouse emulation when activated.
>  @item disk:@var{file}
> -Mass storage device based on @var{file} (@pxref{disk_images})
> +Mass storage device based on @var{file} (@pxref{disk images})
>  @item host:@var{bus.addr}
>  Pass through the host device identified by @var{bus.addr}
>  (Linux only)
> diff --git a/qemu-options.hx b/qemu-options.hx
> index e2a5ca6..3cfadd9 100644
> --- a/qemu-options.hx
> +++ b/qemu-options.hx
> @@ -80,7 +80,7 @@ STEXI
>  @item -fdb @var{file}
>  @findex -fda
>  @findex -fdb
> -Use @var{file} as floppy disk 0/1 image (@pxref{disk_images}). You can
> +Use @var{file} as floppy disk 0/1 image (@pxref{disk images}). You can
>  use the host floppy by using @file{/dev/fd0} as filename (@pxref{host_drives}).
>  ETEXI
>  
> @@ -99,7 +99,7 @@ STEXI
>  @findex -hdb
>  @findex -hdc
>  @findex -hdd
> -Use @var{file} as hard disk 0, 1, 2 or 3 image (@pxref{disk_images}).
> +Use @var{file} as hard disk 0, 1, 2 or 3 image (@pxref{disk images}).
>  ETEXI
>  
>  DEF("cdrom", HAS_ARG, QEMU_OPTION_cdrom,
> @@ -126,7 +126,7 @@ Define a new drive. Valid options are:
>  
>  @table @option
>  @item file=@var{file}
> -This option defines which disk image (@pxref{disk_images}) to use with
> +This option defines which disk image (@pxref{disk images}) to use with
>  this drive. If the filename contains comma, you must double it
>  (for instance, "file=my,,file" to use file "my,file").
>  @item if=@var{interface}
> @@ -300,7 +300,7 @@ STEXI
>  @findex -snapshot
>  Write to temporary files instead of disk image files. In this case,
>  the raw disk image you use is not written back. You can however force
> -the write back by pressing @key{C-a s} (@pxref{disk_images}).
> +the write back by pressing @key{C-a s} (@pxref{disk images}).
>  ETEXI
>  
>  DEF("m", HAS_ARG, QEMU_OPTION_m,
> -- 
> 1.7.0
> 
> 
> 
>
Stefan Weil - April 10, 2010, 7:21 a.m.
Aurelien Jarno schrieb:
> On Sun, Mar 28, 2010 at 11:50:19AM +0200, Stefan Weil wrote:
>   
>> * Replace broken links by link to QEMU wiki.
>>
>> * Separate sections for Linux / Windows / Mac OS X
>>   are no longer needed: the wiki link will provide
>>   additional links, so we don't need them here.
>>
>> * Add hint for (Open) Solaris.
>>     
>
> Whats the reason for the change disk_image -> disk image?
>   

It_simply_looks_better. The reversed question is more interesting:
why was it called disk_image?



>   
>> Signed-off-by: Stefan Weil <weil@mail.berlios.de>
>> ---
>>  qemu-doc.texi   |   38 +++++++++++---------------------------
>>  qemu-options.hx |    8 ++++----
>>  2 files changed, 15 insertions(+), 31 deletions(-)
>>
>> diff --git a/qemu-doc.texi b/qemu-doc.texi
>> index 34182ae..b3a3a9a 100644
>> --- a/qemu-doc.texi
>> +++ b/qemu-doc.texi
>> @@ -122,33 +122,17 @@ Alpha, ColdFire(m68k), CRISv32 and MicroBlaze CPUs are supported.
>>  
>>  If you want to compile QEMU yourself, see @ref{compilation}.
>>  
>> -@menu
>> -* install_linux::   Linux
>> -* install_windows:: Windows
>> -* install_mac::     Macintosh
>> -@end menu
>> +Precompiled packages are available for most Linux distributions,
>> +so you just have to install it.
>>  
>> -@node install_linux
>> -@section Linux
>> -@cindex installation (Linux)
>> +For other operating systems (Max OS X, Open Solaris, Windows),
>> +binaries are provided by user groups or individuals.
>>  
>> -If a precompiled package is available for your distribution - you just
>> -have to install it. Otherwise, see @ref{compilation}.
>> -
>> -@node install_windows
>> -@section Windows
>> -@cindex installation (Windows)
>> -
>> -Download the experimental binary installer at
>> -@url{http://www.free.oszoo.org/@/download.html}.
>> -TODO (no longer available)
>> -
>> -@node install_mac
>> -@section Mac OS X
>> +See @url{http://wiki.qemu.org/Download} for links to binary distributions
>> +and some @ref{disk images} for testing.
>>  
>> -Download the experimental binary installer at
>> -@url{http://www.free.oszoo.org/@/download.html}.
>> -TODO (no longer available)
>> +QEMU @ref{disk images} for several guest operating systems are also available
>> +from the FreeOsZoo project (@url{http://www.oszoo.org/}).
>>  
>>  @node QEMU PC System emulator
>>  @chapter QEMU PC System emulator
>> @@ -160,7 +144,7 @@ TODO (no longer available)
>>  * sec_invocation::     Invocation
>>  * pcsys_keys::         Keys
>>  * pcsys_monitor::      QEMU Monitor
>> -* disk_images::        Disk Images
>> +* disk images::        Disk Images
>>  * pcsys_network::      Network emulation
>>  * direct_linux_boot::  Direct Linux Boot
>>  * pcsys_usb::          USB emulation
>> @@ -386,7 +370,7 @@ The monitor understands integers expressions for every integer
>>  argument. You can use register names to get the value of specifics
>>  CPU registers by prefixing them with @emph{$}.
>>  
>> -@node disk_images
>> +@node disk images
>>  @section Disk Images
>>  
>>  Since version 0.6.1, QEMU supports many disk image formats, including
>> @@ -763,7 +747,7 @@ Pointer device that uses absolute coordinates (like a touchscreen).
>>  This means qemu is able to report the mouse position without having
>>  to grab the mouse.  Also overrides the PS/2 mouse emulation when activated.
>>  @item disk:@var{file}
>> -Mass storage device based on @var{file} (@pxref{disk_images})
>> +Mass storage device based on @var{file} (@pxref{disk images})
>>  @item host:@var{bus.addr}
>>  Pass through the host device identified by @var{bus.addr}
>>  (Linux only)
>> diff --git a/qemu-options.hx b/qemu-options.hx
>> index e2a5ca6..3cfadd9 100644
>> --- a/qemu-options.hx
>> +++ b/qemu-options.hx
>> @@ -80,7 +80,7 @@ STEXI
>>  @item -fdb @var{file}
>>  @findex -fda
>>  @findex -fdb
>> -Use @var{file} as floppy disk 0/1 image (@pxref{disk_images}). You can
>> +Use @var{file} as floppy disk 0/1 image (@pxref{disk images}). You can
>>  use the host floppy by using @file{/dev/fd0} as filename (@pxref{host_drives}).
>>  ETEXI
>>  
>> @@ -99,7 +99,7 @@ STEXI
>>  @findex -hdb
>>  @findex -hdc
>>  @findex -hdd
>> -Use @var{file} as hard disk 0, 1, 2 or 3 image (@pxref{disk_images}).
>> +Use @var{file} as hard disk 0, 1, 2 or 3 image (@pxref{disk images}).
>>  ETEXI
>>  
>>  DEF("cdrom", HAS_ARG, QEMU_OPTION_cdrom,
>> @@ -126,7 +126,7 @@ Define a new drive. Valid options are:
>>  
>>  @table @option
>>  @item file=@var{file}
>> -This option defines which disk image (@pxref{disk_images}) to use with
>> +This option defines which disk image (@pxref{disk images}) to use with
>>  this drive. If the filename contains comma, you must double it
>>  (for instance, "file=my,,file" to use file "my,file").
>>  @item if=@var{interface}
>> @@ -300,7 +300,7 @@ STEXI
>>  @findex -snapshot
>>  Write to temporary files instead of disk image files. In this case,
>>  the raw disk image you use is not written back. You can however force
>> -the write back by pressing @key{C-a s} (@pxref{disk_images}).
>> +the write back by pressing @key{C-a s} (@pxref{disk images}).
>>  ETEXI
>>  
>>  DEF("m", HAS_ARG, QEMU_OPTION_m,
>> -- 
>> 1.7.0
>>
>>
>>
>>
>>     
>
>
Aurelien Jarno - April 10, 2010, 7:37 a.m.
On Sat, Apr 10, 2010 at 09:21:54AM +0200, Stefan Weil wrote:
> Aurelien Jarno schrieb:
> > On Sun, Mar 28, 2010 at 11:50:19AM +0200, Stefan Weil wrote:
> >   
> >> * Replace broken links by link to QEMU wiki.
> >>
> >> * Separate sections for Linux / Windows / Mac OS X
> >>   are no longer needed: the wiki link will provide
> >>   additional links, so we don't need them here.
> >>
> >> * Add hint for (Open) Solaris.
> >>     
> >
> > Whats the reason for the change disk_image -> disk image?
> >   
> 
> It_simply_looks_better. The reversed question is more interesting:
> why was it called disk_image?
> 

To be consistent with all the other links?
Stefan Weil - April 10, 2010, 7:56 a.m.
Aurelien Jarno schrieb:
> On Sat, Apr 10, 2010 at 09:21:54AM +0200, Stefan Weil wrote:
>> Aurelien Jarno schrieb:
>>> On Sun, Mar 28, 2010 at 11:50:19AM +0200, Stefan Weil wrote:
>>>
>>>> * Replace broken links by link to QEMU wiki.
>>>>
>>>> * Separate sections for Linux / Windows / Mac OS X
>>>> are no longer needed: the wiki link will provide
>>>> additional links, so we don't need them here.
>>>>
>>>> * Add hint for (Open) Solaris.
>>>>
>>> Whats the reason for the change disk_image -> disk image?
>>>
>> It_simply_looks_better. The reversed question is more interesting:
>> why was it called disk_image?
>>
>
> To be consistent with all the other links?

I think that earlier versions of texinfo did not support
links which contain spaces.

Those underscores look bad when a link is not only used
in link lists but also in plain text: would you prefer to create
a disk_image or a disk image?
Aurelien Jarno - April 10, 2010, 10:28 a.m.
On Sat, Apr 10, 2010 at 09:56:00AM +0200, Stefan Weil wrote:
> Aurelien Jarno schrieb:
> > On Sat, Apr 10, 2010 at 09:21:54AM +0200, Stefan Weil wrote:
> >> Aurelien Jarno schrieb:
> >>> On Sun, Mar 28, 2010 at 11:50:19AM +0200, Stefan Weil wrote:
> >>>
> >>>> * Replace broken links by link to QEMU wiki.
> >>>>
> >>>> * Separate sections for Linux / Windows / Mac OS X
> >>>> are no longer needed: the wiki link will provide
> >>>> additional links, so we don't need them here.
> >>>>
> >>>> * Add hint for (Open) Solaris.
> >>>>
> >>> Whats the reason for the change disk_image -> disk image?
> >>>
> >> It_simply_looks_better. The reversed question is more interesting:
> >> why was it called disk_image?
> >>
> >
> > To be consistent with all the other links?
> 
> I think that earlier versions of texinfo did not support
> links which contain spaces.
> 
> Those underscores look bad when a link is not only used
> in link lists but also in plain text: would you prefer to create
> a disk_image or a disk image?
> 

That's an argument, but I still don't see the point of changing only one
link and leave the others with an underscore, moreover in an unrelated
patch and without writing anything about that in the description.
Stefan Weil - April 10, 2010, 11:03 a.m.
Aurelien Jarno schrieb:
> On Sat, Apr 10, 2010 at 09:56:00AM +0200, Stefan Weil wrote:
>> Aurelien Jarno schrieb:
>>> On Sat, Apr 10, 2010 at 09:21:54AM +0200, Stefan Weil wrote:
>>>> Aurelien Jarno schrieb:
>>>>> On Sun, Mar 28, 2010 at 11:50:19AM +0200, Stefan Weil wrote:
>>>>>
>>>>>> * Replace broken links by link to QEMU wiki.
>>>>>>
>>>>>> * Separate sections for Linux / Windows / Mac OS X
>>>>>> are no longer needed: the wiki link will provide
>>>>>> additional links, so we don't need them here.
>>>>>>
>>>>>> * Add hint for (Open) Solaris.
>>>>>>
>>>>> Whats the reason for the change disk_image -> disk image?
>>>>>
>>>> It_simply_looks_better. The reversed question is more interesting:
>>>> why was it called disk_image?
>>>>
>>> To be consistent with all the other links?
>> I think that earlier versions of texinfo did not support
>> links which contain spaces.
>>
>> Those underscores look bad when a link is not only used
>> in link lists but also in plain text: would you prefer to create
>> a disk_image or a disk image?
>>
>
> That's an argument, but I still don't see the point of changing only one
> link and leave the others with an underscore, moreover in an unrelated
> patch and without writing anything about that in the description.
>

This new part of the documentation was the reason for this change:

+QEMU @ref{disk images} for several guest operating systems are also
available
+from the FreeOsZoo project (@url{http://www.oszoo.org/}).

In a first version, it looked like "QEMU disk_images for several",
and I wanted to improve that. I thought this was obvious, so I did
not mention it in the change description.

If link address and texual representation were separate in texinfo
(like they are in html), there would be no need to change the link.
Alas, I don't know whether texinfo supports this kind of separation.

Patch

diff --git a/qemu-doc.texi b/qemu-doc.texi
index 34182ae..b3a3a9a 100644
--- a/qemu-doc.texi
+++ b/qemu-doc.texi
@@ -122,33 +122,17 @@  Alpha, ColdFire(m68k), CRISv32 and MicroBlaze CPUs are supported.
 
 If you want to compile QEMU yourself, see @ref{compilation}.
 
-@menu
-* install_linux::   Linux
-* install_windows:: Windows
-* install_mac::     Macintosh
-@end menu
+Precompiled packages are available for most Linux distributions,
+so you just have to install it.
 
-@node install_linux
-@section Linux
-@cindex installation (Linux)
+For other operating systems (Max OS X, Open Solaris, Windows),
+binaries are provided by user groups or individuals.
 
-If a precompiled package is available for your distribution - you just
-have to install it. Otherwise, see @ref{compilation}.
-
-@node install_windows
-@section Windows
-@cindex installation (Windows)
-
-Download the experimental binary installer at
-@url{http://www.free.oszoo.org/@/download.html}.
-TODO (no longer available)
-
-@node install_mac
-@section Mac OS X
+See @url{http://wiki.qemu.org/Download} for links to binary distributions
+and some @ref{disk images} for testing.
 
-Download the experimental binary installer at
-@url{http://www.free.oszoo.org/@/download.html}.
-TODO (no longer available)
+QEMU @ref{disk images} for several guest operating systems are also available
+from the FreeOsZoo project (@url{http://www.oszoo.org/}).
 
 @node QEMU PC System emulator
 @chapter QEMU PC System emulator
@@ -160,7 +144,7 @@  TODO (no longer available)
 * sec_invocation::     Invocation
 * pcsys_keys::         Keys
 * pcsys_monitor::      QEMU Monitor
-* disk_images::        Disk Images
+* disk images::        Disk Images
 * pcsys_network::      Network emulation
 * direct_linux_boot::  Direct Linux Boot
 * pcsys_usb::          USB emulation
@@ -386,7 +370,7 @@  The monitor understands integers expressions for every integer
 argument. You can use register names to get the value of specifics
 CPU registers by prefixing them with @emph{$}.
 
-@node disk_images
+@node disk images
 @section Disk Images
 
 Since version 0.6.1, QEMU supports many disk image formats, including
@@ -763,7 +747,7 @@  Pointer device that uses absolute coordinates (like a touchscreen).
 This means qemu is able to report the mouse position without having
 to grab the mouse.  Also overrides the PS/2 mouse emulation when activated.
 @item disk:@var{file}
-Mass storage device based on @var{file} (@pxref{disk_images})
+Mass storage device based on @var{file} (@pxref{disk images})
 @item host:@var{bus.addr}
 Pass through the host device identified by @var{bus.addr}
 (Linux only)
diff --git a/qemu-options.hx b/qemu-options.hx
index e2a5ca6..3cfadd9 100644
--- a/qemu-options.hx
+++ b/qemu-options.hx
@@ -80,7 +80,7 @@  STEXI
 @item -fdb @var{file}
 @findex -fda
 @findex -fdb
-Use @var{file} as floppy disk 0/1 image (@pxref{disk_images}). You can
+Use @var{file} as floppy disk 0/1 image (@pxref{disk images}). You can
 use the host floppy by using @file{/dev/fd0} as filename (@pxref{host_drives}).
 ETEXI
 
@@ -99,7 +99,7 @@  STEXI
 @findex -hdb
 @findex -hdc
 @findex -hdd
-Use @var{file} as hard disk 0, 1, 2 or 3 image (@pxref{disk_images}).
+Use @var{file} as hard disk 0, 1, 2 or 3 image (@pxref{disk images}).
 ETEXI
 
 DEF("cdrom", HAS_ARG, QEMU_OPTION_cdrom,
@@ -126,7 +126,7 @@  Define a new drive. Valid options are:
 
 @table @option
 @item file=@var{file}
-This option defines which disk image (@pxref{disk_images}) to use with
+This option defines which disk image (@pxref{disk images}) to use with
 this drive. If the filename contains comma, you must double it
 (for instance, "file=my,,file" to use file "my,file").
 @item if=@var{interface}
@@ -300,7 +300,7 @@  STEXI
 @findex -snapshot
 Write to temporary files instead of disk image files. In this case,
 the raw disk image you use is not written back. You can however force
-the write back by pressing @key{C-a s} (@pxref{disk_images}).
+the write back by pressing @key{C-a s} (@pxref{disk images}).
 ETEXI
 
 DEF("m", HAS_ARG, QEMU_OPTION_m,