[Esbox-commits] r1607 - www/beta1
eswartz at garage.maemo.org
eswartz at garage.maemo.org
Sat May 16 03:36:24 EEST 2009
Author: eswartz
Date: 2009-05-16 03:36:24 +0300 (Sat, 16 May 2009)
New Revision: 1607
Modified:
www/beta1/documentation.html
www/beta1/release_2_0_0_M4.html
www/beta1/virtual_machines.html
Log:
Use help version of virtual machine doc, add FAQ reference, remove in progress note for ESbox Help
Modified: www/beta1/documentation.html
===================================================================
--- www/beta1/documentation.html 2009-05-16 00:32:35 UTC (rev 1606)
+++ www/beta1/documentation.html 2009-05-16 00:36:24 UTC (rev 1607)
@@ -46,6 +46,10 @@
<div id="container">
<div id="content">
<br /> There are lots of resources to learn how to start Maemo development with ESbox.<br /><br />
+ <h3>ESbox FAQ</h3>
+ <ul>
+ <li><a href="https://garage.maemo.org/svn/esbox/tags/2.0.0-M4/org.maemo.esbox.help/html/reference/FAQ.html" target="_blank">Read on-line</a> </li>
+ </ul>
<!--
<h3><a href="http://esbox.embedded.ufcg.edu.br/help/topic/org.indt.esbox.help/html/toc.html" target="_blank">ESbox User Help (OLD)</a></h3>
-->
@@ -54,9 +58,9 @@
<ul>
<li><a href="virtual_machines.html">Guide to using virtual machines with ESbox</a></li>
</ul>
- <h3>ESbox User Help (in development for 2nd edition)</h3>
+ <h3>ESbox User Help</h3>
<ul>
- <li><a href="https://garage.maemo.org/svn/esbox/trunk/org.maemo.esbox.help/html/toc.html" target="_blank">Read on-line</a> </li>
+ <li><a href="https://garage.maemo.org/svn/esbox/tags/2.0.0-M4/org.maemo.esbox.help/html/toc.html" target="_blank">Read on-line</a> </li>
</ul>
<h3>CDT User Help</h3>
<ul>
Modified: www/beta1/release_2_0_0_M4.html
===================================================================
--- www/beta1/release_2_0_0_M4.html 2009-05-16 00:32:35 UTC (rev 1606)
+++ www/beta1/release_2_0_0_M4.html 2009-05-16 00:36:24 UTC (rev 1607)
@@ -125,6 +125,13 @@
change the user name in a dialog that prompts for a password.
</li>
<li>
+ There is a bug in RSE causing an exception when you attempt to copy
+ default generated RSE connections.
+ If you need to create more connections than those provided, then create
+ a <em>New Connection</em> of system type <em>SSH Only</em>.
+ <a href="https://garage.maemo.org/tracker/index.php?func=detail&aid=4053&group_id=799&atid=2996">[#4053]</a>.
+ </li>
+ <li>
For other issues, see the <a href="https://garage.maemo.org/tracker/index.php?group_id=192&atid=1420">ESbox Bug Tracker</a>
and the <a href="https://garage.maemo.org/tracker/?func=browse&group_id=799&atid=2996">Mica bug tracker</a>
and search for items with <em>Resolution = None</em>.
Modified: www/beta1/virtual_machines.html
===================================================================
--- www/beta1/virtual_machines.html 2009-05-16 00:32:35 UTC (rev 1606)
+++ www/beta1/virtual_machines.html 2009-05-16 00:36:24 UTC (rev 1607)
@@ -46,523 +46,21 @@
<div id="container">
<div id="content">
-<h2>Using ESbox with a Maemo SDK Virtual Machine
-</h2>
-<p>This page describes the way ESbox runs Windows and Mac OS X (or Linux x86/64)
-by hosting the Maemo SDK on a virtual machine.</p>
-
-<ul>
-<li><a href="#overview">Overview</a></li>
-<li><a href="#engines">Virtual Machine Engines</a></li>
-<li><a href="#images">Virtual Machine Images</a></li>
-<li><a href="#config">ESbox Build Machine Configuration</a></li>
-<li><a href="#behavior">ESbox Virtual Machine Behavior</a></li>
-<li><a href="#indexing">Configuring for C/C++ Indexing</a></li>
-<li><a href="#pcconn">PC-Connectivity Interaction</a></li>
-<li><a href="#troubleshoot">Troubleshooting</a></li>
-</ul>
-
-<p id="overview"/>
-<h3 id="heading">Overview</h3>
-<p>The maemo SDK, scratchbox, and rootstraps only run on Linux/x86.
-If you want to use ESbox in Windows -- or even Linux/x86-64 -- then you
-can do this by hooking up ESbox with an appropriately configured virtual
-machine.</p>
-<p>ESbox provides the concept of <em>Build Machines</em>. For
-Linux/x86 hosts, the host serves as a build machine. For other hosts,
-only a virtual machine can be a build machine.</p>
-<p>ESbox will use an SSH connection with the virtual machine to
-perform builds, launch/debug applications, and configure Scratchbox 1 or 2 installations and
-rootstraps.</p>
-<p>In order to use project features in Eclipse, projects must be visible both to the host and
-the VM. We chose to optimize for IDE/editor/debugger-time activity versus build-time activity, so
-in ESbox projects must live on a local host filesystem which is visible to the VM over a shared
-folder.</p>
-<p>Shared folders from the VM to the host may also be used for <a href="#indexing">C/C++ indexing</a>.</p>
-
-
-<p id="engines"/>
-
-<h3 id="heading">Virtual Machine Engines</h3>
-<p>ESbox supports VMware, QEMU, and VirtualBox.
-</p>
-<ul>
-<li>VMware 6.x is supported and recommended for speed. </li>
-<li>VirtualBox 2.1 or 2.2 is supported and recommended for freedom and consistently of behavior across OSes.</li>
-<li>QEMU 0.9.0 and newer is recommended for freedom and
-ease of setup, but is quite slow, even when accelerated.</li>
-</ul>
-
-<p id="images"/>
-
-<h3 id="heading">Virtual Machine Images</h3>
-<p>ESbox needs a specific "server" virtual
-machine image to support development, which has a minimal footprint and is configured
-to provide the best interaction with ESbox.</p>
-<p>
-See <a href="http://maemovmware.garage.maemo.org">Maemo SDK Virtual Machine project page</a>
-for download and installation details.</p>
-<p>
-These images come "bare", without any pre-installed Maemo SDK. ESbox supports installing
-these, however:
-</p>
-<ul>
-<li><em>File > New > Maemo Installers > Scratchbox 1</em></li>
-<li><em>File > New > Maemo Installers > Scratchbox 1 Targets</em></li>
-<li><em>File > New > Maemo Installers > Nokia Closed Binaries</em></li>
-</ul>
-<p/>
-
-<p>Alternately, you can try the "desktop" image if you want the full environment pre-installed.</p>
-
-<p>If you want to use your own VM, ensure it has SSH and Samba
-support. For SSH the <tt>UseDNS</tt> flag should be turned off, and
-to support Samba, you need an often-running cron job to resynchronize
-the clock with the host, to avoid timestamp issues when building.</p>
-
-
-
-
-<div id="warning">
-<h3>Note for Win32 users:</h3>
-<p>
-In any modern version of Linux, there is a known file truncation issue that occurs
-when using <tt>autoconf</tt> 2.62 or older over Samba.</p>
-<p>Due to trying to rename files before closing them, the
-<tt>configure</tt> files will be truncated, preventing Makefiles from
-being generated.
-Current Maemo SDKs ship these old versions of autoconf.
-</p>
-<p><b><i>Never fear!</i></b> ESbox will repair the <tt>autoconf</tt>
-installation in Scratchbox for you. After installing a new Scratchbox installation,
-right-click the Scratchbox node (for example, in
-<em>Window > Preferences > Maemo > Installed Targets</em>)
-and select <em>Patch autoconf...</em>. A wizard will guide you through
-the process of repairing the installation.
-</p>
- </div>
-
-
-<p id="config"/>
-
-<h3 id="heading">ESbox Build Machine Configuration</h3>
-<ul>
- <li>
- Configuration is under <em>ESbox > Build Machines</em>.
- If you
- navigate here before configuring anything, or try to create a project
- and launch first, you will get a message directing you to the page.
- </li>
- <li>
- You need to select a virtual machine engine (or Manual
- configuration) as a virtual machine and
- adjust the configuration accordingly.
- </li>
- <li>
- Any selected build machine has a unique configuration in <em>Machine Access</em> (the user name,
- password, target/host addresses and ports) and <em>Shared Folders</em> (the shares providing
- a mapping between the host and target filesystems) tabs. All machines except for <em>Manually
- Launched</em> have a VM-specific configuration tab as well.
- </li>
-</ul>
-
-<div id="group">
-
-<h3 id="heading">Machine Access</h3>
-
-<p>The <em>Machine Access</em> settings should be optimally configured the image
-as available on the Maemo SDK Virtual Image site, but you need to edit the
-address and port settings depending on your networking configuration.</p>
-
-<ul>
- <li>
- Use the <em>Autoselect Network Settings</em> button
- to try to guess the networking settings from current virtual machine settings
- and the host machine's network interfaces. This assumes the virtual machine
- engine, image, and configuration have all been specified correctly. In any case,
- this is a guess, so read the diagnostic messages.
- <p>Note, when configuring a virtual machine using Bridged networking,
- it's impossible to guess the actual address the machine will have. By default,
- ESbox selects the <em>network address</em> (*.0) and warns you to update it.
- </p>
- </li>
- <li>
- Use the <em>Apply</em> button to accept the changes and immediately
- launch the virtual machine.
- </li>
- <li>
- Use the <em>Apply and Validate</em> button to apply the changes
- and launch the machine, and immediately run through a
- series of tests to validate that the machine is configured properly.
- </li>
-</ul>
-
-<h4>More details</h4>
-
-<p>The Machine Access tab allows you to configure the networking and
-authentication with the VM.</p>
-<p><em>User</em> is the account which acts as the agent for all
-operations with the VM. </p>
-<p><em>Password</em> is the account for the user account. </p>
-
-<p><em>Target address</em> is the address used to access the VM.
-This may be an IP address or a name. You will probably need to discover
-this experimentally, by watching the boot-time messages, unless you use a static address.</p>
-
-<p><em>Target SSH port</em> is the SSH port. This defaults to 2222 for NAT configurations.
-</p><p>
-(The default for normal SSH usage is 22, but if the Target address is
-127.0.0.1, this port must be remapped to avoid conflicts with the host.)
-</p>
-<ul>
-<li>
-For QEMU, this option controls the port used, since it is controlled when the machine is launched.
-</li>
-<li>For VirtualBox, this must match
-the configuration established for a machine via VBoxManage before the machine is launched. (See
-<a href="http://maemovmware.garage.maemo.org/beta1/vbox_installers.html">the maemovmware VirtualBox configuration utility</a>, the
-<a href="http://maemovmware.garage.maemo.org/beta1/create_vbox_machine.html#portforwarding">the maemovmware port forwarding instructions</a>, or
-the Network Address Translation chapter of the VirtualBox manual.)
-</li>
-<li>For VMware, use the Virtual Network Editor > NAT>Edit>Port Forwarding... dialog to
-redirect SSH by adding an <em>Incoming TCP port</em> entry with <em>Host Port</em> 22, <em>Virtual Machine Address</em> matching the Target Address,
-and a <em>Port</em> like 2222 or 2244 matching the Target SSH Port setting.
-
-</li>
-</ul>
-
-<p><em>Host address</em> is the name of the host as seen from the VM
--- this is never 127.0.0.1! The value depends on the kind of networking
-you're using with the VM.</p>
-<ul>
-<li> For QEMU, the default is 10.0.2.2 since the IP
-is shared with the VM and a private subnet is used to reference the
-host.
-</li>
-<li> For VMware, see the
-<em>VM > Removable Devices > Network Adapter</em> menu.
-</li>
-<li>
-For VirtualBox, see the <em>machine > Settings > Network > Adapter</em> dialog.
-Probably
-you'll need to find this by logging into the VM (maemo/maemo) and
-invoking <tt>/sbin/ifconfig</tt>.
-</li>
-</ul>
-
-
-</div>
-
-
-<div id="group">
-
-<h3 id="heading">ESbox Shared Folders</h3>
-
-
-<p>
-On the <em>Shared Folders</em> tab, specify the shared folders that ESbox uses
-to map filesystem paths between the host and VM filesystem.
-<a href="images/shared_folders.png">See a diagram here.</a>
-</p>
-
-<p>We require Eclipse projects to be visible to both the
-host and target, so all projects need to live on a path <i>shared from the host</i> and
-<i>mapped to the VM</i>. (Most Eclipse code assumes that all project files are visible
-on the host. We don't support the notion of a project fully hosted
-on the VM, since this has an unacceptable performance cost
-for the majority of IDE operations.)</p>
-
-<p>The mappings on this tab are essential for allowing ESbox to
-create and access projects, launch builds, perform debugger source lookups, autoconfigure SBRSH,
-etc. so that the host Eclipse and the target Maemo SDK can work on the same files and directories.
-</p>
-<p>The shares allow the virtual machine to see the host filesystem, and optionally, these
-allow ESbox (via CDT and PyDev) to see rootstraps from the virtual machine for the purpose of indexing C/C++ and Python.
-</p>
-<ul>
- <li>The default configuration recommends two shared folders that map a <tt>.../maemo/shared</tt>
- folder from the host to two locations on the target.
- </li>
- <li>These target locations have been selected to point into the user's home on the VM
- to allow ESbox to create projects under the host so that Scratchbox 1 and Scratchbox 2 can see the projects in the same Scratchbox-relative
- directory at build time. (You may edit these if needed but it's up to you to ensure the necessary
- mappings are defined so all targets can see the same path.)
- </li>
- <li>ESbox can automatically mount folders from the host to the virtual machine by running <tt>smbmount</tt>
- or <tt>mount -t cifs</tt> on the Linux VM. It currently cannot mount folders from the VM onto the
- host. To prevent ESbox from trying, set the <em>Mount automatically?</em>
- setting to <em>No</em>.
- </li>
-</ul>
-
-<h4>More details</h4>
-
-<p>ESbox has some support for automatically mounting shares into the
-VM, since this is a commonly needed task when the VM is started and
-stopped. Note, however, ESbox will not configure shares for you or
-validate whether your settings make any sense -- the provided share must
-be manually configured on the host.</p>
-<p>The tooltips in the tree should explain the purpose of the
-fields.</p>
-<p>If <em>Local share?</em> is yes, you need to configure file
-sharing on your host and expose a share which can be mounted by the VM.
-This typically should be <em>yes</em> for normal usage (since the
-Eclipse workspace must be on the local machine).</p>
-<p>Be sure to validate the <em>Share name</em>. In Windows this
-is the base name of the directory by default. On Mac OS X, if you choose
-the defaults, the name is chosen by OS X for the typical user shares.</p>
-
-
-</div>
-
-<p id="behavior"/>
-
-<h3 id="heading">ESbox Virtual Machine Behavior</h3>
-
-<p>
-Once configured, ESbox will automatically connect to or launch the virtual machine when it is needed.
-ESbox will accept any running virtual machine responding to the current Machine Access settings (it
-doesn't have to be the specific one you have selected).
-If no machine responds to the target address and port, then ESbox will launch the configured machine.
-</p>
-<p>
-Usually, only an explicit user action (like starting a wizard or viewing ESbox or Maemo
-preference panels) will require the VM to be running.
-</p>
-<p>
-This may be a problem if you are using other products in your installation, and do not want to
-launch the VM. The easiest solution is to switch the <em>Build Machine</em> to <em>None</em>.
-With this setting, you will not be able to use most ESbox actions, since no installed targets
-(except for Remote Connections) will be recognized.
-</p>
-<p>
-Alternately, a configured build machine can live alongside other products if you avoid allowing
-Eclipse to build ESbox projects:
-</p>
-<ul>
-<li>Close ESbox projects
-</li>
-<li style="list-style-type: none;">or
-</li>
-<li>Disable <em>Project > Build Automatically</em> and
-</li>
-<li>Disable
-<em>Window > Preferences > Run/Debug > Build (if required) Before Launching</em>
-</li>
-</ul>
-
-<p id="indexing"/>
-
-<h3 id="heading">Configuring for C/C++ Indexing</h3>
-
-<p>
-To configure projects for C/C++ indexing, the system includes need to
-be visible in the local filesystem. Since the Maemo SDK is inside a virtual machine,
-you can expose the directories using Samba shares <em>from the VM</em>.
-You need to add entries for those shares; they aren't
-set up by default.
-</p>
-<p>
-Set up two shared folder entries, with <em>Local Share?</em> set to <em>No</em>,
-and <em>Mount automatically?</em> set to <em>No</em>:
-</p>
-<ul>
-<li>One from <tt>/scratchbox</tt> (share name: <tt>scratchbox</tt>) (for Scratchbox 1)
-</li>
-<li>One from <tt>/home/maemo</tt> (share name: <tt>maemo</tt>) (for Scratchbox 2)
-</li>
-</ul>
-<p>
-The Maemo SDK virtual images expose these shares already. In a custom image, add
-entries like this to <tt>/etc/samba/smb.conf</tt>:
-</p>
-<tt class="cmdbox">
-[scratchbox]
-writable = yes
-public = yes
-browseable = yes
-path = /scratchbox
-
-[maemo]
-writable = yes
-public = yes
-browseable = yes
-path = /home/maemo
-</tt>
-<p>
-and then restart Samba with <tt>sudo /etc/init.d/samba restart</tt>.
-</p>
-<p>
-Also, you will need to manually mount these shares on your host.
-</p>
-<p>
-In Windows, you can mount shares like this:
<br/>
-<tt>net use s: \\<em>target.address</em>\scratchbox</tt>
-</p>
-<p>
-When you create a new project, these shares should be automatically integrated
-into the project preferences (<em>C/C++ Indexer</em>) to allow
-indexing. The indexing operation will be slower, though, due to the access over a network.</p>
-
+<br/>
+<br/>
+<br/>
+ <a href="https://garage.maemo.org/svn/esbox/tags/2.0.0-M4/org.maemo.esbox.help/html/tasks/UsingVirtualMachines.html">
+ Visit this topic in the <strong>ESbox User Guide</strong>.</a>
+<br/>
+<br/>
+<br/>
+<br/>
-
-<p id="pcconn"/>
-<h3>PC-Connectivity Interaction</h3>
-<p>
-Here are some tips and tricks for using <a href="http://pc-connectivity.garage.maemo.org">PC Connectivity</a>
-with ESbox and virtual machines.
-</p>
-<ul>
- <li>Using USB, Bluetooth, WLAN ad-hoc networking (static IPs)
- <p>
- USB, WLAN Ad-Hoc, and Bluetooth connections use static addresses (192.168.*.15). The default
- network routing configurations for the host mean that they will only be able to directly communicate
- back and forth with one "machine" at a time.
- </p>
- <p>
- In most cases, you should <b>connect the machine to the host</b>, rather than the virtual machine.
- Eclipse manages most of the SSH traffic with the device, so the host needs to be able to see the device at its static address.
- The host cannot see network traffic inside the VM.
- </p>
- <p>Conversely, from the device point of view, it can only see the machine it is connected to. For
- cases where the device needs to open a socket from the host, the device must be able to see the
- host at the host address (192.168.*.14). This includes Python debugging and SBRSH.
- </p>
- <p>
- Note: if you are using NAT networking with the virtual machine, the VM will <i>also</i> be able to see the
- device at the static address. This is the best of both worlds.
- </p>
- <div id="warning">
- <i>When using SBRSH,</i> you must connect the device to the virtual machine, since
- SBRSH runs on under Scratchbox, and the device needs to mount filesystems from the VM.
- </div>
- <p/>
- <div id="warning">
- <i>When flashing images to device,</i> you must connect the device to the virtual machine, since
- the flasher tool runs on Linux only, unless you have a native Win32 or MacOS X build of the flasher
- and configure an Advanced session which specifies this tool.
- </div>
- <p/>
- </li>
-
-
- <li>Using WLAN networking
- <p>
- WLAN networking is the most flexible option, as long as your virtual machine is configured for Bridged
- networking, where it has its own DHCP-acquired address. In this model, the host, the VM, and the
- device are all peers on the LAN. Thus, the device will be visible to the host and the VM, and the
- device can see the host and the VM.
- </p>
- <p>Unfortunately, of course, WLAN is very slow and prone to packet loss. It is nearly unusable for
- debugging, for example.
- </p>
- </li>
-
-</ul>
-
-
-<p id="troubleshoot"/>
-<h3>Troubleshooting</h3>
-<ul>
- <li>Basic configuration
- <ul>
-
- <li>
- If ESbox can't guess your network properly, look at the boot screen for
- the VM or login to the VM (maemo/maemo) and run <tt>sudo dhclient</tt>
- to validate the assigned IP address for the VM, if you're not getting a
- connection. Only in the case of NAT should you enter 127.0.0.1 as the
- Target address in ESbox. For non-NAT cases, usually the host address is
- xx.xx.xx.2 of the target address.
- </li>
- <li>
- "ping" is your friend. If you have connection problems, cross-check the address displayed, e.g., in a
- launch configuration or in the RSE connection, and verify that you can see if from your host or your VM (depending on context).
- </li>
- <li>
- If you're having trouble accessing port forwarding over SSH, then note that VMware's virtual
- network port mappings apply even when it is not hosting a running VM, so select different
- target ports for other VM engines.
- </li>
- </ul>
- </li>
- <li>Shared folder configuration
- <ul>
- <li>Be careful about the time synchronization configuration in the VM or the timezone
- used in the VM image.
- <p>
- If you see warnings like:
- </p>
- <tt class="cmdbox">
-make: Warning: File `Makefile' has modification time 1.1e+07 s in the future
-rm -f *.o helloworld
-make: warning: Clock skew detected. Your build may be incomplete.
- </tt>
- <p>
- then investigate the Linux configuration inside the virtual machine.
- </p>
- <p>
- VirtualBox, with Guest Additions installed, seems to use a different tactic than QEMU and VMWare. The
- Maemo SDK virtual machines are configured to keep UTC time, so they will not be specific
- to your time zone, but VirtualBox synchronizes against local time, it seems, so the time
- recorded in the filesystem will be off significantly from reality (unless you
- live in Britain).
- </p>
- <p>
- You may need to use
- <tt>sudo dpkg-configure tzdata</tt>, edit/remove
- <tt>/etc/cron.minutely/00resetclock</tt> in Maemo SDK virtual machine images,
- or disable the time synchronization feature in the Guest Additions.
- You usually need to reboot the VM for all such changes to propagate to login and SSH shells.
- </p>
- </li>
- <li>
- You may need to be connected to a LAN for the PC <-> VM communication to
- work properly. Otherwise shared folders will not be mountable and you may get mysterious
- timeouts instead.
- </li>
- <li>
- If you use Windows and your VM uses NAT, it's unlikely you'll be able to mount folders from the VM
- without significant advanced networking setup effort. (You would need to use port forwarding to see ports 139 and 445 from
- the VM without conflicting with the host's own sharing protocol -- but Windows doesn't provide
- an obvious way to use SMB with different ports. From what I know, you'd need to set up some sort
- of virtual host over SSH to forward SMB traffic. Any tips are welcome :) )
- </li>
-
- </ul>
- </li>
- <li>Device access
- <ul>
- <li>
- Watch out for firewall software thwarting you. It may block all access to your device. Allow traffic to
- the 192.168.* IP range.
- </li>
- <li>
- If your LAN uses 192.168.{2,3,4}.* for its own DHCP server, and you want to use the static USB, Bluetooth,
- or WLAN ad-hoc connections, you need to have separate subnets. Reconfigure these static addresses
- in the PC-Connectivity Manager and in your host configuration.
- </li>
- <li>
- Avoid host-only networking configurations in your VM. Otherwise you will not be able to contact
- the device.
- </li>
- <li>
- SBRSH needs to communicate in three ways: between the host (running Eclipse),
- the VM (hosting Scratchbox and running the sbrsh client), and the device (running
- the sbrsh daemon). In most cases, <b>you must use WLAN</b> for this to work,
- unless you know how to manually configure routing tables to do this over
- USB or bluetooth or the ad-hoc WLAN connection.
- </li>
- </ul>
- </li>
-</ul>
-
-
</div>
-
</div>
</div>
+
<div id="footer">
<div class="part">
<table width="100%" cellspacing="5px" style="bgcolor: #000">
More information about the Esbox-commits
mailing list