Bug 162961

Summary: [handbook] [patch] Update VirtualBox section in handbook
Product: Documentation Reporter: Beat Gaetzi <beat>
Component: Books & ArticlesAssignee: Manolis Kiagias <manolis>
Status: Closed FIXED    
Severity: Affects Only Me    
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   
Attachments:
Description Flags
virtualization-virtualbox-chapter.patch
none
patch-vb-chapter.diff.txt none

Description Beat Gaetzi freebsd_committer freebsd_triage 2011-11-30 07:30:11 UTC
	- Attached patch updates the VirtualBox section of the virtualisation
	  chapter in the handbook. This work was done by Eric Newberry during
	  the Google Code-In contest so please give him the credit for this
	  update:
	  https://google-melange.appspot.com/gci/task/view/google/gci2011/7137268
Comment 1 sonic2000gr 2011-11-30 22:16:14 UTC
Hi,

Nice work!

I made some fixes to this and uploaded a revised patch here:

http://people.freebsd.org/~manolis/patches/virtualization-virtualbox-chapter-patch-new.txt 
<http://people.freebsd.org/%7Emanolis/patches/virtualization-virtualbox-chapter-patch-new.txt>

and a build (without images) here:

http://people.freebsd.org/~manolis/patches/virtualization-guest.html 
<http://people.freebsd.org/%7Emanolis/patches/virtualization-guest.html>

Main changes are:
- Use passive voice in some places to avoid "you" references
- Improve markup in several places (filenames, devices, man pages etc). 
There maybe also a few other places (i.e. vboxvideo_drv should probably 
not be tagged using <command>)
- Some minor language fixes to match the Handbook style in general

This also needs a complete whitespace patch on top, but this can wait 
until any remaining  issues are fixed. Please post followups to this if 
you have any comments.
Comment 2 Manolis Kiagias freebsd_committer freebsd_triage 2011-12-01 16:50:10 UTC
Responsible Changed
From-To: freebsd-doc->manolis

Over to me
Comment 3 sonic2000gr 2011-12-01 17:52:14 UTC
Here is the latest version of the patch, with few more minor fixes and a 
complete whitespace overhaul:

http://people.freebsd.org/~manolis/patches/virtualization-virtualbox-chapter-patch-new.txt

A test build is here:

http://www.freebsdgr.org/all/en_US.ISO8859-1/books/handbook/virtualization-guest.html

If there are no objections / fixes, this goes in tomorrow :)
Comment 4 Beat Gaetzi freebsd_committer freebsd_triage 2011-12-01 18:05:42 UTC
Thanks for your work. Looks good to me.

Beat
Comment 5 Warren Block 2011-12-01 19:53:57 UTC
On Thu, 1 Dec 2011, Manolis Kiagias wrote:

> Here is the latest version of the patch, with few more minor fixes and a 
> complete whitespace overhaul:
>
> http://people.freebsd.org/~manolis/patches/virtualization-virtualbox-chapter-patch-new.txt
>
> A test build is here:
>
> http://www.freebsdgr.org/all/en_US.ISO8859-1/books/handbook/virtualization-guest.html
>
> If there are no objections / fixes, this goes in tomorrow :)

A few quick suggestions:

--- virtualization-virtualbox-chapter-patch-new.txt.orig	2011-12-01 12:41:46.000000000 -0700
+++ virtualization-virtualbox-chapter-patch-new.txt	2011-12-01 12:52:28.000000000 -0700
@@ -7,7 +7,7 @@
       </sect2>
  +
  +    <sect2 id="virtualization-guest-virtualbox-guest-additions">
-+      <title>&virtualbox; Guest Additions on &os; Guest</title>
++      <title>&virtualbox; Guest Additions on a &os; Guest</title>
  +
  +      <para>The <application>&virtualbox;</application> guest additions
  +	provide support for:</para>
@@ -44,7 +44,7 @@
  +
  +      <screen>&prompt.root; <userinput>cd /usr/ports/emulators/virtualbox-ose-additions && make install clean</userinput></screen>
  +
-+      <para>Add the following lines to <filename>/etc/rc.conf</filename>:</para>
++      <para>Add these lines to <filename>/etc/rc.conf</filename>:</para>
  +
  +      <programlisting>vboxguest_enable="YES"
  +vboxservice_enable="YES"</programlisting>
@@ -55,8 +55,8 @@
  +      <programlisting>vboxservice_flags="--disable-timesync"</programlisting>
  +
  +      <para>The <literal>vboxvideo_drv</literal> should be recognized by
-+	<command>Xorg -configure</command>.  If not, use something like this
-+	in your <filename>xorg.conf</filename> file for the
++	<command>Xorg -configure</command>.  If not, modify
++	<filename>xorg.conf</filename> for the
  +	<application>&virtualbox;</application> video card:</para>
  +
  +      <programlisting>Section "Device"
@@ -71,8 +71,8 @@
  +	BusID "PCI:0:2:0"
  +EndSection</programlisting>
  +
-+      <para>To use <literal>vboxmouse_drv</literal> please adjust the mouse
-+	section in your <filename>xorg.conf</filename> like this:</para>
++      <para>To use <literal>vboxmouse_drv</literal>, adjust the mouse
++	section in <filename>xorg.conf</filename>:</para>
  +
  +      <programlisting>Section "InputDevice"
  +	Identifier "Mouse0"
@@ -127,7 +127,7 @@
  -	may be installed using the following commands:</para>
  +	in <filename role="package">emulators/virtualbox-ose</filename>.
  +	As &virtualbox; is very actively developed, make sure your ports
-+	tree is up to date before installing.  Install using the following
++	tree is up to date before installing.  Install using these
  +	commands:</para>

         <screen>&prompt.root; <userinput>cd /usr/ports/emulators/virtualbox-ose</userinput>
@@ -142,7 +142,7 @@
  -	the functions provided by the &man.sysctl.3; library.</para>
  +      <para>To use the kernel modules that allow bridged or host-only
  +	networking, add the following to <filename>/etc/rc.conf</filename>
-+	and reboot your computer:</para>
++	and reboot the computer:</para>

  -      <para>When using an older version of the port, follow the instructions
  -	below to make sure <filename class="directory">proc</filename> is
@@ -170,28 +170,28 @@
  +      <programlisting>vboxnet_enable="YES"</programlisting>

         <para>The <groupname>vboxusers</groupname> group is created during
- 	the installation of <application>&virtualbox;</application>.
+ 	installation of <application>&virtualbox;</application>.
  @@ -1066,6 +1156,21 @@

         <screen>&prompt.root; <userinput>pw groupmod vboxusers -m <replaceable>yourusername</replaceable></userinput></screen>

  +      <para>The default permissions for <filename
  +	  class="devicefile">/dev/vboxnetctl</filename> are restrictive and
-+	will need to be changed for bridged networking.</para>
++	need to be changed for bridged networking.</para>
  +
  +      <para>To test it temporarily:</para>
  +
  +      <screen>&prompt.root; <userinput>chown root:vboxusers /dev/vboxnetctl</userinput>
  +&prompt.root; <userinput>chmod 0660 /dev/vboxnetctl</userinput></screen>
  +
-+      <para>To make the permissions change permanent, add the following
++      <para>To make the permissions change permanent, add these
  +	lines to <filename>/etc/devfs.conf</filename>:
  +
  +      <programlisting>own     vboxnetctl root:vboxusers
  +perm    vboxnetctl 0660</programlisting>
  +
         <para>To launch <application>&virtualbox;</application>, either select
- 	the <guimenuitem>Sun VirtualBox</guimenuitem> item from your
+ 	the <guimenuitem>Sun VirtualBox</guimenuitem> item from the
   	graphic environment's menu, or type the following in a
  @@ -1081,6 +1186,71 @@
   	visit the relevant page in the &os; wiki, at <ulink
Comment 6 sonic2000gr 2011-12-01 20:53:58 UTC
On 1/12/2011 9:53 μμ, Warren Block wrote:
> On Thu, 1 Dec 2011, Manolis Kiagias wrote:
>
>> Here is the latest version of the patch, with few more minor fixes 
>> and a complete whitespace overhaul:
>>
>> http://people.freebsd.org/~manolis/patches/virtualization-virtualbox-chapter-patch-new.txt 
>>
>>
>> A test build is here:
>>
>> http://www.freebsdgr.org/all/en_US.ISO8859-1/books/handbook/virtualization-guest.html 
>>
>>
>> If there are no objections / fixes, this goes in tomorrow :)
>
> A few quick suggestions:

Thanks, this looks fine. I will integrate it tomorrow.
Comment 7 dfilter service freebsd_committer freebsd_triage 2011-12-02 17:22:09 UTC
manolis     2011-12-02 17:22:01 UTC

  FreeBSD doc repository

  Modified files:
    en_US.ISO8859-1/books/handbook/virtualization chapter.sgml 
  Log:
  Update the VirtualBox sections with new info:
  
  - FreeBSD Guest Additions
  - Guest CD/DVD support
  - Guest USB support
  
  The information comes mostly from the FreeBSD wiki and was converted for the
  Documentation Project by Eric Newberry as part of the Google Code-in contest.
  Eric's mentors were beat and decke. Thank you all for this nice work!
  
  PR:             docs/162961
  Authored by:    Eric Newberry
  Submitted by:   beat
  Reviewed by:    beat, wblock
  
  Revision  Changes    Path
  1.26      +201 -31   doc/en_US.ISO8859-1/books/handbook/virtualization/chapter.sgml
_______________________________________________
cvs-all@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/cvs-all
To unsubscribe, send any mail to "cvs-all-unsubscribe@freebsd.org"
Comment 8 Manolis Kiagias freebsd_committer freebsd_triage 2011-12-02 17:37:42 UTC
State Changed
From-To: open->closed

Changes committed, thanks!