[Esbox-commits] r1033 - in branches/work_Jeff/org.maemo.esbox.help/html: gettingstarted tasks
jeffc at garage.maemo.org
jeffc at garage.maemo.org
Thu Dec 4 05:56:16 EET 2008
Author: jeffc
Date: 2008-12-04 05:56:15 +0200 (Thu, 04 Dec 2008)
New Revision: 1033
Modified:
branches/work_Jeff/org.maemo.esbox.help/html/gettingstarted/Introduction.html
branches/work_Jeff/org.maemo.esbox.help/html/gettingstarted/SettingPreferences.html
branches/work_Jeff/org.maemo.esbox.help/html/gettingstarted/virtualmachine.html
branches/work_Jeff/org.maemo.esbox.help/html/tasks/DebianPackage.html
Log:
incorporated comments per Bug 3145
Modified: branches/work_Jeff/org.maemo.esbox.help/html/gettingstarted/Introduction.html
===================================================================
--- branches/work_Jeff/org.maemo.esbox.help/html/gettingstarted/Introduction.html 2008-12-04 03:52:25 UTC (rev 1032)
+++ branches/work_Jeff/org.maemo.esbox.help/html/gettingstarted/Introduction.html 2008-12-04 03:56:15 UTC (rev 1033)
@@ -26,7 +26,7 @@
<h4 align="left" class="style1">Target</h4>
<ul>
<p>
- The active toolchain and configuration currently used. A target uses a selected toolchain and contains a filesystem to use, and a related configuration. You can have multiple targets, even if they all use the same toolchains. This makes it easy to try something different, or start a parallel target to test things from scratch. Examples of targets are DIABLO_ARMEL and DIABLO_X86.</p>
+ The active toolchain and configuration currently used. A target uses a selected toolchain and contains a filesystem to use, and a related configuration. You can have multiple targets for different toolchains in the same project. This makes it easy to try something different, or start a parallel target to test things from scratch. Examples of targets are DIABLO_ARMEL and DIABLO_X86.</p>
</ul>
<h4 align="left" class="style1">Platform</h4>
@@ -34,7 +34,7 @@
<p>
Describes some sort of framework, either in hardware or software,
which allows software to run.
-The maemo platform is built on desktop open source components and provides developers
+The ESbox platform is built on desktop open source components and provides developers
with a powerful and easy-to-use development, build, and test environment. It is aimed
at enabling applications and innovative technology for mobile handheld devices.
</p>
@@ -46,9 +46,10 @@
to create applications for a specific software framework or something similar.
The maemo SDK contains the tools needed to create and port integrated applications,
replicating the Internet Tablet environment in your PC.
+<p>This release officially supports Diablo and Chinook, while older releases are not supported, though they may work.
<p><b>SDK releases for maemo</b></p>
-<p>
-OS2008 for N800 & N810 developers
+<p>OS2008 for Diablo 4.1
+<p>OS2008 for N800 & N810 developers
<ul>
<li>Latest stable: maemo 4.0.1 Chinook</li>
</ul>
Modified: branches/work_Jeff/org.maemo.esbox.help/html/gettingstarted/SettingPreferences.html
===================================================================
--- branches/work_Jeff/org.maemo.esbox.help/html/gettingstarted/SettingPreferences.html 2008-12-04 03:52:25 UTC (rev 1032)
+++ branches/work_Jeff/org.maemo.esbox.help/html/gettingstarted/SettingPreferences.html 2008-12-04 03:56:15 UTC (rev 1033)
@@ -23,8 +23,7 @@
<p>
-The Maemo page allows you to define the syntax used to invoke commands inside Scratchbox (this varies between Scratchbox versions) and the root directory of
-the user's sandbox environment.</p>
+The Maemo page allows you to define the command pattern for the launch shell and whether or not to log commands.</p>
<p></p>
<img src="../images/pref_images/maemo_pref.png" alt="preferences1" width="892" height="477"><br>
@@ -33,7 +32,7 @@
<p> </p>
<h2><a name="env"></a>Environment</h2>
-<p>The <strong>Environment</strong> page allows you to define Scratchbox environment variables. Click the New button to specify the variable Name and Value.</p>
+<p>The <strong>Environment</strong> page allows you to define Scratchbox environment variables. Click the New button to specify the variable Name and Value. This dialog also specifies environment variable *changes* for any program invoked by ESbox. Variables may be replaced/added or undefined.</p>
<p><img src="../images/pref_images/pref_maemo_env.png" alt="environment" width="804" height="495"></p>
<p> </p>
<h2><a name="int"></a>Installed Targets</h2>
Modified: branches/work_Jeff/org.maemo.esbox.help/html/gettingstarted/virtualmachine.html
===================================================================
--- branches/work_Jeff/org.maemo.esbox.help/html/gettingstarted/virtualmachine.html 2008-12-04 03:52:25 UTC (rev 1032)
+++ branches/work_Jeff/org.maemo.esbox.help/html/gettingstarted/virtualmachine.html 2008-12-04 03:56:15 UTC (rev 1033)
@@ -13,7 +13,9 @@
<h2>Running ESbox on other operating systems</h2>
<h3>Overview</h3>
<P>The maemo SDK, scratchbox, and rootstraps only work on Linux/x86. If you want to use ESbox in Windows, or Linux/x86-64, then you can do this by hooking up ESbox with an appropriately configured virtual machine.</P>
-<P>ESbox exposes the concept of "Build Machines". 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 exposes the concept of "Build Machines". For Linux/x86 hosts, the host serves as a build machine. For other hosts, only a virtual machine can be a build machine. You can select the build machine for ESbox by selecting <strong>Window > Preferences > ESbox > Build Machines</strong>.</P>
+<P> </P>
+<P><img src="../images/buildmachines.png" width="843" height="385"></P>
<P>ESbox will use an SSH connection with the virtual machine to perform builds, launch/debug applications, and configure sb1/sb2 rootstraps.</P>
<P>Projects in Eclipse must be visible to both the host and the virtual machine (VM). This requires some folders to be shared between them.</P>
<h3>Virtual machine configuration </h3>
@@ -31,8 +33,9 @@
href="http://www.h6.dion.ne.jp/~kazuw/qemu-win/Kqemu-1.3.0pre11-install.exe">http://www.h6.dion.ne.jp/~kazuw/qemu-win/Kqemu-1.3.0pre11-install.exe</A>). </LI>
</UL>
<UL>
- <LI>An X server is needed to launch the Maemo emulator. The default settings assume you've installed Cygwin/X, with Cygwin at c:\cygwin. Edit ESbox > X Server preferences to configure. </LI>
+ <LI>An X server is needed to launch the Maemo emulator. The default settings assume you've installed Cygwin/X, with Cygwin at c:\cygwin. Edit <strong>Window > Preferences > ESbox > X Server</strong> preferences to configure.</LI>
</UL>
+<p><img src="../images/xserver.png" width="1099" height="448"></p>
<h3>ESbox (virtual) machine configuration </h3>
<UL>
<LI>Configuration is under ESbox > Build Machines. If you navigate here before configuring anything, or try to create a project and launch first, you need to select either VMware or QEMU as a virtual machine and adjust the configuration accordingly.</LI>
@@ -41,25 +44,33 @@
<UL>
<LI>Use the "Apply and Validate" button to run through a series of tests to validate that the machine is configured properly.</LI>
</UL>
+<p><img src="../images/buildmachine_qemu.png" width="1425" height="538"></p>
+
+<p> </p>
+
<h3>ESbox Machine Access </h3>
-<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. This must have passwordless "sudo" access. </P>
-<P><EM>Password</EM> is the account for the user account. <STRONG>NOTE</STRONG>: the password is saved in preferences but in an encrypted form, but, due to current design quirks, this password can still show up in <EM>plaintext</EM> in SSH filesystem URIs. </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 unless you use a static address. </P>
-<P><EM>Target SSH port</EM> is the SSH port. This defaults to 2222. (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>
-<P><EM>Host address</EM> is the name of the host as seen from the VM -- this is <strong>never</strong> 127.0.0.1. The value depends on the kind of networking you're using with the VM. 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. For VMware, it depends on the VMnet you have chosen. Probably you'll need to find this by logging into the VM (maemo/maemo) and invoking "ifconfig". </P>
-<P><EM>Target Samba port</EM> is used to allow sharing of files to and from the host. It's normally 139 or 445. It defaults to 4445, though, to allow two-way Samba access between the host and target when the target address is 127.0.0.1. </P>
-<h3>ESbox Shared Folders </h3>
+<P>The Machine Access tab allows you to configure the networking and authentication with the VM.</P>
+<p><img src="../images/buildmachine_qemu_machine.png" width="962" height="538"></p>
+<P> </P>
+<P><strong>User</strong> is the account which acts as the agent for all operations with the VM. This must have passwordless "sudo" access. </P>
+<P><strong>Password</strong> is the account for the user account. <STRONG>NOTE</STRONG>: the password is saved in preferences but in an encrypted form, but, due to current design quirks, this password can still show up in <EM>plaintext</EM> in SSH filesystem URIs. </P>
+<P><strong>Target address</strong> 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 unless you use a static address. </P>
+<P><strong>Target SSH port </strong>is the SSH port. This defaults to 2222. (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>
+<P><strong>Host address</strong> is the name of the host as seen from the VM -- this is <strong>never</strong> 127.0.0.1. The value depends on the kind of networking you're using with the VM. 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. For VMware, it depends on the VMnet you have chosen. Probably you'll need to find this by logging into the VM (maemo/maemo) and invoking "ifconfig". </P>
+<P><strong>Target Samba port</strong> is used to allow sharing of files to and from the host. It's normally 139 or 445. It defaults to 4445, though, to allow two-way Samba access between the host and target when the target address is 127.0.0.1. </P>
+<h3>ESbox Shared Folders</h3>
<P>Currently we require Eclipse projects to be visible to both the host and target. (Most Eclipse code assumes that all files are visible on the host. We don't yet support the notion of a project fully hosted remotely.) </P>
<P>Additionally, the project must be visible to scratchbox. Sbox 1 has some restrictions here, but sbox 2 is looser. A convenient solution is to make the shared folder visible twice, once in a normal location under the user's home folder, and again in the parallel location visible to sbox 1. (The user's home should be shared identically amongst any sbox 1 target to maximize the benefit, else you need to share yet again for every rootstrap.) </P>
<P>Thus, the Shared Folders portion of the VM configuration page will let ESbox know how to map paths. Each mapping is considered in order, so list sbox 1 mappings at the end. </P>
-<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. </P>
-<P><EM>Host</EM> tells the place where a share will be seen on the Eclipse host. </P>
-<P><EM>Target</EM> tells the place where a share will be seen on the VM. </P>
-<P><EM>Direction</EM> (the arrow in the middle) tells who provides the share. When it points to the target, the host is providing a share to the target, and vice versa. This is used when auto-mounting. </P>
-<P><EM>Name</EM> is the share name, as used in Samba/SMB. (e.g. "c:\users\shared" might be shared as "Public User Share".) If this is unspecified, the last segment of the share directory is used. </P>
-<P><EM>Auto</EM> tells whether ESbox will attempt to mount the share itself. Currently it can only handle mounts into Linux. If the mount is into Windows you need to set this up yourself (set to "No"). </P>
-<P><EM>Type</EM> is the share type. This is fixed to <EM>SMB</EM> for now. </P>
+<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.</P>
+<p><img src="../images/buildmachine_qemu_shfold.png" width="871" height="538"></p>
+<P> </P>
+<P><strong>Host</strong> tells the place where a share will be seen on the Eclipse host. </P>
+<P><strong>Target</strong> tells the place where a share will be seen on the VM. </P>
+<P><strong>Direction</strong> (the arrow in the middle) tells who provides the share. When it points to the target, the host is providing a share to the target, and vice versa. This is used when auto-mounting. </P>
+<P><strong>Name</strong> is the share name, as used in Samba/SMB. (e.g. "c:\users\shared" might be shared as "Public User Share".) If this is unspecified, the last segment of the share directory is used. </P>
+<P><strong>Auto</strong> tells whether ESbox will attempt to mount the share itself. Currently it can only handle mounts into Linux. If the mount is into Windows you need to set this up yourself (set to "No"). </P>
+<P><strong>Type</strong> is the share type. This is fixed to <EM>SMB</EM> for now. </P>
<h3>Networking configuration </h3>
<UL>
<LI>You need to be on a LAN for the PC <-> VM communication to work properly, as far as I know. Otherwise shared folders will not work and you'll get a lot of mysterious timeouts when trying to mount. </LI>
Modified: branches/work_Jeff/org.maemo.esbox.help/html/tasks/DebianPackage.html
===================================================================
--- branches/work_Jeff/org.maemo.esbox.help/html/tasks/DebianPackage.html 2008-12-04 03:52:25 UTC (rev 1032)
+++ branches/work_Jeff/org.maemo.esbox.help/html/tasks/DebianPackage.html 2008-12-04 03:56:15 UTC (rev 1033)
@@ -22,18 +22,9 @@
features to generate, deploy and install .deb packages for your
application (C/C++ or Python) on an Internet Tablet. ESbox uses ssh to
deploy and install your .deb package onto the Internet Tablet, so, it's
-necessary to properly configure ssh in <strong>Window > Preferences > Maemo > SSH</strong> preferences.
-<div style="margin-left: 2em; margin-right: 2em; background-color: #ffff80; border: solid #999 1px; padding: 5px;">
-<span style="font-weight: bold;">NOTE</span>: You have to create a "debian" directory under your project and maintain all
- necessary files in order to create or deploy packages.</p>
- <p>
-The "Hildon GUI Project" template is initialized with such files.</p>
- <p>
- See <a href="http://www.debian.org/doc/FAQ/ch-pkg_basics.en.html">this page</a> for details about Debian packaging.
-</p>
-</div>
-
-
+necessary to properly configure ssh in <strong>Window > Preferences > Maemo > SSH</strong> preferences. See <a href="http://www.debian.org/doc/FAQ/ch-pkg_basics.en.html">this page</a> for details about Debian packaging.
+<h3>Create Debian Structure</h3>
+<p>A selected project's context menu command<strong> Debian Package > Create Debian Structure</strong> creates the "debian" folder and supplies initial contents. Some manual edits to the files may be necessary.
<h3 class="style1">Create Debian Package</h3>
<p>
You can create Debian packages for the Internet Tablet Application
@@ -42,7 +33,7 @@
<ol>
- <li>Select a project, right-click and select Debian Package in the popup menu.</li>
+ <li>Select a project, right-click and select <strong>Debian Package</strong> in the popup menu.</li>
<li>Click on <strong>Create Debian Package</strong>.
More information about the Esbox-commits
mailing list