Imported Upstream version 3.1.0-dfsgupstream/3.1.0-dfsg

4 files changed, 72 insertions, 34 deletions

diff --git a/doc/ReadMe-Solaris.txt b/doc/ReadMe-Solaris.txt
index f1c391184..b09db0d78 100644
--- a/doc/ReadMe-Solaris.txt
+++ b/doc/ReadMe-Solaris.txt
@@ -5,22 +5,23 @@ Sun VirtualBox for OpenSolaris (TM) Operating System
 Upgrading:
 ----------
 
-If you have an existing VirtualBox installation and you are upgrading to a newer version of
-VirtualBox, please uninstall the previous version completely before installing a newer one.
+If you have an existing VirtualBox installation and you are upgrading to
+a newer version of VirtualBox, please uninstall the previous version
+completely before installing a newer one.
 
-You should uninstall BOTH the VirtualBox base package as well as the VirtualBox kernel
-interface package before installing the new ones.
+You should uninstall BOTH the VirtualBox base package as well as the
+VirtualBox kernel interface package before installing the new ones.
 
-Please refer to the "Uninstallation" section at the end of this document for the details.
+Please refer to the "Uninstalling" section at the end of this document
+for details.
 
  +--------+
  |  NOTE  |
  +--------+
- VirtualBox 2.2 includes experimental USB support and requires OpenSolaris build 109 or
- higher. VirtualBox USB support on Solaris 10 is not supported due to limitations in the kernel.
 
- "USB Filters" is not currently supported on any Solaris host due to restrictions in the
- kernel/USB sub-system. USB devices are granted to the guest using "Devices->USB Devices" menu.
+ VirtualBox 3.1 includes experimental USB support and requires OpenSolaris
+ build 124 or higher. VirtualBox USB support on Solaris 10 is not supported
+ due to limitations in the kernel.
 
 
 Installing:
@@ -30,41 +31,34 @@ After extracting the contents of the tar.gz file perform the following steps:
 
 1. Login as root using the "su" command.
 
-2. Install the packages (in this order):
+2. Install the VirtualBox package:
 
-   (*) First, the VirtualBox kernel interface package:
+      pkgadd -d VirtualBox-@VBOX_VERSION_STRING@-SunOS-r@VBOX_SVN_REV@.pkg
 
-        pkgadd -G -d VirtualBoxKern-@VBOX_VERSION_STRING@-SunOS-r@VBOX_SVN_REV@.pkg
+      To perform an unattended (non-interactive) installation of this
+      package, add "-n -a autoresponse SUNWvbox" (without quotes)
+      to the end of the above pkgadd command.
 
-        To perform an unattended (non-interactive) installation of this package add
-        "-n -a autoresponse SUNWvboxkern" (without quotes) to the end of the above pkgadd command.
+3. For each package, the installer will ask you to "Select package(s) you
+   wish to process". In response, type "1".
 
-   (*) Next, the main VirtualBox package:
+4. Type "y" when asked about continuing the installation.
 
-        pkgadd -d VirtualBox-@VBOX_VERSION_STRING@-SunOS-r@VBOX_SVN_REV@.pkg
-
-        To perform an unattended (non-interactive) installation of this package add
-        "-n -a autoresponse SUNWvbox" (without quotes) to the end of the above pkgadd command.
-
-3. For each package the installer would ask you to "Select package(s) you wish to process"
-        For this type "1" or "all".
-
-4. Then type "y" when asked about continuing with the installation.
-
-Now all the necessary files would be installed on your system. Start VirtualBox by typing
-VirtualBox from the terminal.
+At this point, all the required files should be installed on your system.
+You can launch VirtualBox by running 'VirtualBox' from the terminal.
 
 
 Uninstalling:
 -------------
 
-To remove VirtualBox from your system perform the following steps:
+To remove VirtualBox from your system, perform the following steps:
 
 1. Login as root using the "su" command.
 
-2. Run the command:
+2. To remove VirtualBox, run the command:
         pkgrm SUNWvbox
 
-To remove the VirtualBox kernel interface module run the command:
+3. To remove the VirtualBox kernel interface module, run the command:
         pkgrm SUNWvboxkern
+    * Only required if you're uninstalling VirtualBox versions 3.0.x or lower.
 
diff --git a/doc/VBox-CodingGuidelines.cpp b/doc/VBox-CodingGuidelines.cpp
index 446852af7..45f88ead1 100644
--- a/doc/VBox-CodingGuidelines.cpp
+++ b/doc/VBox-CodingGuidelines.cpp
@@ -1,4 +1,4 @@
-/* $Id: VBox-CodingGuidelines.cpp $ */
+/* $Id: VBox-CodingGuidelines.cpp 21449 2009-07-09 16:24:17Z vboxsync $ */
 /** @file
  * VBox - Coding Guidelines.
  */
@@ -115,6 +115,9 @@
  *      - Headers in /include/VBox shall not contain any slash-slash C++
  *        comments, only ANSI C comments!
  *
+ *      - Comments on \#else indicates what begins while the comment on a
+ *        \#endif indicates what ended.
+ *
  *
  * (1) It is common practice on Unix to have a single symbol namespace for an
  *     entire process. If one is careless symbols might be resolved in a
@@ -126,7 +129,6 @@
  *     OTOH, we do perhaps have a bit too detailed graining of this in VMM...
  *
  *
- *
  * @subsection sec_vbox_guideline_compulsory_sub64  64-bit and 32-bit
  *
  * Here are some amendments which address 64-bit vs. 32-bit portability issues.
@@ -197,6 +199,43 @@
  *        @endcode
  *
  *
+ * @subsection sec_vbox_guideline_compulsory_cppmain   C++ guidelines for Main
+ *
+ * Main is currently (2009) full of hard-to-maintain code that uses complicated
+ * templates. The new mid-term goal for Main is to have less custom templates
+ * instead of more for the following reasons:
+ *
+ *  -  Template code is harder to read and understand. Custom templates create
+ *     territories which only the code writer understands.
+ *
+ *  -  Errors in using templates create terrible C++ compiler messages.
+ *
+ *  -  Template code is really hard to look at in a debugger.
+ *
+ *  -  Templates slow down the compiler a lot.
+ *
+ *  In particular, the following bits should be considered deprecated and should
+ *  NOT be used in new code:
+ *
+ *  -  everything in include/iprt/cpputils.h (auto_ref_ptr, exception_trap_base,
+ *     char_auto_ptr and friends)
+ *
+ *  Generally, in many cases, a simple class with a proper destructor can achieve
+ *  the same effect as a 1,000-line template include file, and the code is
+ *  much more accessible that way.
+ *
+ *  Using standard STL templates like std::list, std::vector and std::map is OK.
+ *  Exceptions are:
+ *
+ *  -  Guest Additions because we don't want to link against libstdc++ there.
+ *
+ *  -  std::string should not be used because we have iprt::MiniString and
+ *     com::Utf8Str which can convert efficiently with COM's UTF-16 strings.
+ *
+ *  -  std::auto_ptr<> in general; that part of the C++ standard is just broken.
+ *     Write a destructor that calls delete.
+ *
+ *
  *
  * @section sec_vbox_guideline_optional         Optional
  *
@@ -376,6 +415,7 @@
  * Some of the warnings can seem kind of innocent at first glance. So, let's take the
  * most common ones and explain them.
  *
+ *
  * @subsection sec_vbox_guideline_warnings_signed_unsigned_compare      Signed / Unsigned Compare
  *
  * GCC says: "warning: comparison between signed and unsigned integer expressions"
@@ -399,6 +439,7 @@ int main()
  * unsigned long before doing the compare.
  *
  *
+ *
  * @section sec_vbox_guideline_svn          Subversion Commit Rules
  *
  *
@@ -417,6 +458,9 @@ int main()
  *      - If you make a user visible change, such as fixing a reported bug,
  *        make sure you add an entry to doc/manual/user_ChangeLogImpl.xml.
  *
+ *      - If you are adding files make sure set the right attributes.
+ *        svn-ps.sh/cmd was created for this purpose, please make use of it.
+ *
  *
  * After checking in:
  *
diff --git a/doc/VBox-MakefileGuidelines.cpp b/doc/VBox-MakefileGuidelines.cpp
index a271dadf1..887e2c4f5 100644
--- a/doc/VBox-MakefileGuidelines.cpp
+++ b/doc/VBox-MakefileGuidelines.cpp
@@ -1,4 +1,4 @@
-/* $Id: VBox-MakefileGuidelines.cpp $ */
+/* $Id: VBox-MakefileGuidelines.cpp 19033 2009-04-20 15:39:13Z vboxsync $ */
 /** @file
  * VBox - Makefile Guidelines.
  */
diff --git a/doc/VBox-doc.c b/doc/VBox-doc.c
index 3bb3d9e97..79124c55a 100644
--- a/doc/VBox-doc.c
+++ b/doc/VBox-doc.c
@@ -1,4 +1,4 @@
-/* $Id: VBox-doc.c $ */
+/* $Id: VBox-doc.c 13001 2008-10-06 11:06:14Z vboxsync $ */
 /** @file
  * VirtualBox Top Level Documentation File.
  */