diff options
| author | jmedley <jmedley@chromium.org> | 2014-09-22 13:22:23 -0700 |
|---|---|---|
| committer | Commit bot <commit-bot@chromium.org> | 2014-09-22 20:22:34 +0000 |
| commit | c3e44d6a8d69d8870b5bdc0d71ffe71891c97148 (patch) | |
| tree | 86c4d90a1a9e43f1d4f58ac00c3843ca12b303b5 /native_client_sdk/doc_generated | |
| parent | 75520c990bd82917fce99658ab8383f03e3525ed (diff) | |
| download | chromium_src-c3e44d6a8d69d8870b5bdc0d71ffe71891c97148.zip chromium_src-c3e44d6a8d69d8870b5bdc0d71ffe71891c97148.tar.gz chromium_src-c3e44d6a8d69d8870b5bdc0d71ffe71891c97148.tar.bz2 | |
Copy edit SDK section.
BUG=none
R=
TEST=none
NOTRY=true
(documentation only change)
Review URL: https://codereview.chromium.org/588723002
Cr-Commit-Position: refs/heads/master@{#296033}
Diffstat (limited to 'native_client_sdk/doc_generated')
5 files changed, 178 insertions, 203 deletions
diff --git a/native_client_sdk/doc_generated/devguide/devcycle/running.html b/native_client_sdk/doc_generated/devguide/devcycle/running.html index ee8279a..0cae390 100644 --- a/native_client_sdk/doc_generated/devguide/devcycle/running.html +++ b/native_client_sdk/doc_generated/devguide/devcycle/running.html @@ -209,7 +209,7 @@ to run most applications under the <code>examples</code> directory where you sta server. For example, to run the <code>flock</code> example in the SDK, start the server and point your browser to <code>http://localhost:5103/demo/flock/</code>.</p> <p>Some of the applications need special flags to Chrome, and must be run with the -<code>make run</code> command. See <a class="reference internal" href="/native-client/sdk/examples.html#id1"><em>Run the SDK examples</em></a> for more details.</p> +<code>make run</code> command. See <a class="reference internal" href="/native-client/sdk/examples.html#running-the-sdk-examples"><em>Run the SDK examples</em></a> for more details.</p> <h4 id="chrome-web-store-metadata"><span id="metadata"></span>Chrome Web Store metadata</h4> <p>Applications published in the Chrome Web Store must be accompanied by CWS metadata; specifically, a Chrome Web Store manifest file named diff --git a/native_client_sdk/doc_generated/devguide/tutorial/tutorial-part2.html b/native_client_sdk/doc_generated/devguide/tutorial/tutorial-part2.html index 47dddbd..08a753b 100644 --- a/native_client_sdk/doc_generated/devguide/tutorial/tutorial-part2.html +++ b/native_client_sdk/doc_generated/devguide/tutorial/tutorial-part2.html @@ -37,7 +37,7 @@ application <a class="reference external" href="/apps/contentSecurityPolicy">Con <p>Using the Native Client SDK build system makes it easy to build with all of the SDK toolchains, and switch between the Debug and Release configurations. It also simplifies the makefiles for your project, as we’ll see in the next -section. Finally, it adds some useful commands for <a class="reference internal" href="/native-client/sdk/examples.html#id1"><em>running</em></a> and <a class="reference internal" href="/native-client/sdk/examples.html#debugging-the-sdk-examples"><em>debugging</em></a> +section. Finally, it adds some useful commands for <a class="reference internal" href="/native-client/sdk/examples.html#running-the-sdk-examples"><em>running</em></a> and <a class="reference internal" href="/native-client/sdk/examples.html#debugging-the-sdk-examples"><em>debugging</em></a> your application.</p> <p>The finished code for this example can be found in the <code>pepper_$(VERSION)/getting_started/part2</code> directory in the Native Client SDK diff --git a/native_client_sdk/doc_generated/sdk/download.html b/native_client_sdk/doc_generated/sdk/download.html index 8a57dbc..d5b35ea 100644 --- a/native_client_sdk/doc_generated/sdk/download.html +++ b/native_client_sdk/doc_generated/sdk/download.html @@ -2,18 +2,16 @@ <section id="download-the-native-client-sdk"> <span id="download"></span><h1 id="download-the-native-client-sdk"><span id="download"></span>Download the Native Client SDK</h1> -<p>To build Native Client modules, you must download and install the Native Client -Software Development Kit (SDK). This page provides an overview of the Native -Client SDK, and instructions for how to download and install the SDK.</p> +<p>This page provides an overview of the Native Client SDK, and instructions for +downloading and installing the SDK.</p> <div id="home"> <a class="button-nacl button-download" href="http://storage.googleapis.com/nativeclient-mirror/nacl/nacl_sdk/nacl_sdk.zip">Download SDK Zip File</a> -</div><h2 id="overview">Overview</h2> -<p>The Native Client SDK includes the following:</p> +</div><h2 id="overview"><span id="sdk-overview"></span>Overview</h2> +<p>The Native Client SDK includes:</p> <ul class="small-gap"> <li><strong>Support for multiple Pepper versions</strong> to compile for specific minimum versions of Chrome.</li> -<li><strong>Update utility</strong> to download new bundles that are available, as well as new -versions of existing bundles.</li> +<li><strong>Update utility</strong> to download new bundles and updates to existing bundles.</li> <li><strong>Toolchains</strong> to compile for Portable Native Client (PNaCl), traditional Native Client (NaCl), and for compiling architecture-specific Native Client applications with glibc.</li> @@ -24,45 +22,43 @@ the toolchains.</li> command line.</li> </ul> <p>Follow the steps below to download and install the Native Client SDK.</p> -<h2 id="prerequisites">Prerequisites</h2> +<h2 id="prerequisites"><span id="id1"></span>Prerequisites</h2> +<h3 id="python-2-7"><span id="python26-27"></span>Python 2.7</h3> +<p>Make sure that the Python executable is in your <code>PATH</code> variable. Python 3.x is +not yet supported.</p> <ul class="small-gap"> -<li><p class="first"><strong>Python 2.6 or 2.7:</strong> Make sure that the Python executable is in your path. -Python 2.7 is preferred. Python 3.x is not yet supported.</p> -<ul class="small-gap"> -<li>On Mac and Linux, Python is likely preinstalled. Run the command “<code>python --V</code>” in a terminal window, and make sure that the version you have is 2.6.x -or 2.7.x.</li> -<li>On Windows, you may need to install Python. Go to -<a class="reference external" href="http://www.python.org/download/">http://www.python.org/download/</a> and -select the latest 2.x version. In addition, be sure to add the Python -directory (for example, <code>C:\python27</code>) to the PATH <a class="reference external" href="http://en.wikipedia.org/wiki/Environment_variable">environment -variable</a>. Run -“<code>python -V</code>” from a command line to verify that you properly configured -the PATH variable.</li> +<li>On Mac and Linux, Python is likely preinstalled. Run the command <code>python -V</code> +in a terminal window, and make sure that the version you have is 2.6.x or +2.7.x.</li> +<li>On Windows, you may need to install Python. Go to <a class="reference external" href="http://www.python.org/download/">http://www.python.org/ +download/</a> and select the latest 2.x +version. In addition, be sure to add the Python directory (for example, +<code>C:\python27</code>) to the <code>PATH</code> <a class="reference external" href="http://en.wikipedia.org/wiki/Environment_variable">environment variable</a>. Run <code>python -V</code> from a command line to +verify that you properly configured the PATH variable.</li> </ul> -</li> -<li><strong>Make:</strong> On the Mac, you need to install the <code>make</code> command on your system -before you can build and run the examples in the SDK. One easy way to get -<code>make</code>, along with several other useful tools, is to install -<a class="reference external" href="https://developer.apple.com/technologies/tools/">Xcode Developer Tools</a>. -After installing Xcode, go to the XCode menu, open the Preferences dialog box -then select Downloads and Components. Verify that Command Line Tools are -installed. If you’d rather not install Xcode, you can download and build an -<a class="reference external" href="http://mac.softpedia.com/dyn-postdownload.php?p=44632&t=4&i=1">open source version</a> of <code>make</code>. -To build the command you may also need to download and install -<a class="reference external" href="https://github.com/kennethreitz/osx-gcc-installer">gcc</a>.</li> +<h3 id="make"><span id="id2"></span>Make</h3> +<ul class="small-gap"> +<li>On the Mac, you need to install <code>make</code> on your system before you can build +and run the examples in the SDK. One easy way to get <code>make</code>, along with +several other useful tools, is to install <a class="reference external" href="https://developer.apple.com/technologies/tools/">Xcode Developer Tools</a>. After installing Xcode, +go to the XCode menu, open the Preferences dialog box then select Downloads +and Components. Verify that Command Line Tools are installed. If you’d rather +not install Xcode, you can download and build an <a class="reference external" href="http://mac.softpedia.com/dyn-postdownload.php?p=44632&t=4&i=1">open source version</a> of <code>make</code>. +To build the program you may also need to download and install <a class="reference external" href="https://github.com/kennethreitz/osx-gcc-installer">gcc</a>.</li> +<li>On Windows, the Native Client SDK includes a copy of GNU Make.</li> </ul> -<h2 id="installing-the-sdk">Installing the SDK</h2> +<h2 id="installing-the-sdk"><span id="id3"></span>Installing the SDK</h2> +<h3 id="downloading-and-unzipping"><span id="id4"></span>Downloading and Unzipping</h3> <ol class="arabic"> -<li><p class="first">Download the SDK update zip file: <a class="reference external" href="http://storage.googleapis.com/nativeclient-mirror/nacl/nacl_sdk/nacl_sdk.zip">nacl_sdk.zip</a>.</p> +<li><p class="first">Download the <a class="reference external" href="http://storage.googleapis.com/nativeclient-mirror/nacl/nacl_sdk/nacl_sdk.zip">SDK update zip file</a>.</p> </li> <li><p class="first">Unzip the file:</p> <ul class="small-gap"> -<li><p class="first">On Mac/Linux, run the command “<code>unzip nacl_sdk.zip</code>” in a terminal +<li><p class="first">On Mac/Linux, run the command <code>unzip nacl_sdk.zip</code> in a terminal window.</p> </li> <li><p class="first">On Windows, right-click on the .zip file and select “Extract All...”. A -dialog box will open; enter a location and click “Extract”.</p> +dialog box opens; enter a location and click “Extract”.</p> </li> </ul> <p>A directory is created called <code>nacl_sdk</code> with the following files and @@ -79,11 +75,11 @@ you have already downloaded.</p> </ul> </li> </ol> -<h2 id="installing-bundles">Installing bundles</h2> +<h3 id="installing-the-stable-bundle"><span id="id5"></span>Installing the stable bundle</h3> <ol class="arabic"> <li><p class="first">To see the SDK bundles that are available for download, go to the -<code>nacl_sdk</code> directory and run <code>naclsdk</code> with the “<code>list</code>” command. The -SDK includes a separate bundle for each version of Chrome/Pepper.</p> +<code>nacl_sdk</code> directory and run <code>naclsdk</code> with the <code>list</code> command. The SDK +includes a separate bundle for each version of Chrome/Pepper.</p> <p>On Mac/Linux:</p> <pre class="prettyprint"> $ cd nacl_sdk @@ -114,16 +110,18 @@ Bundles: </pre> <p>The sample output above shows that several bundles are available for download, and that you have already installed the latest revision of the -<code>sdk_tools</code> bundle. (It was included in the zip file you downloaded.) Each -bundle is labeled post-stable, stable, beta, dev, or canary. These labels -usually correspond to the current versions of Chrome.</p> -<p>We recommend that you download and use a “stable” bundle, because -applications developed with “stable” bundles can be used by all current -Chrome users. This is because Native Client is designed to be -backward-compatible (for example, applications developed with the -<code>pepper_31</code> bundle can run in Chrome 31, Chrome 32, etc.).</p> +<code>sdk_tools</code> bundle, which was included in the zip file. You never need to +update the <code>sdk_tools</code> bundle. It is updated automatically (if necessary) +whenever you run <code>naclsdk</code>.</p> +<p>Bundles are labeled post-stable, stable, beta, dev, or canary. These labels +usually correspond to the current versions of Chrome. We recommend that you +develop against a “stable” bundle, because such bundles can be used by all +current Chrome users. Native Client is designed to be backward-compatible.For +example, applications developed with the <code>pepper_31</code> bundle can run in +Chrome 31, Chrome 32, etc..</p> </li> -<li><p class="first">Run <code>naclsdk</code> with the “update” command to download recommended bundles.</p> +<li><p class="first">Run <code>naclsdk</code> with the <code>update</code> command to download recommended bundles, +including the current “stable” bundle.</p> <p>On Mac/Linux:</p> <pre class="prettyprint"> $ ./naclsdk update @@ -132,25 +130,18 @@ $ ./naclsdk update <pre class="prettyprint"> > naclsdk update </pre> -<p>By default, <code>naclsdk</code> only downloads bundles that are recommended— -generally those that are “stable.” Continuing with the earlier example, the -“update” command would only download the <code>pepper_35</code> bundle, since the -bundles <code>pepper_36</code> and greater are not yet stable. If you want the -<code>pepper_36</code> bundle, you must ask for it explicitly:</p> +<p>By default, <code>naclsdk</code> only downloads bundles that are recommended, +generally those that are “stable.” For example, if the current “stable” +bundle is <code>pepper_35</code>, then the <code>update</code> downloads that bundle. To +download the <code>pepper_36</code> bundle you must ask for it explicitly:</p> <pre class="prettyprint"> $ ./naclsdk update pepper_36 </pre> </li> </ol> -<aside class="note"> -<blockquote> -<div>You never need to update the <code>sdk_tools</code> bundle. It is updated -automatically (if necessary) whenever you run <code>naclsdk</code>.</div></blockquote> - -</aside> -<h2 id="updating-bundles">Updating bundles</h2> +<h2 id="updating-bundles"><span id="id6"></span>Updating bundles</h2> <ol class="arabic"> -<li><p class="first">Run <code>naclsdk</code> with the “list” command. This shows you the list of available +<li><p class="first">Run <code>naclsdk</code> with the <code>list</code> command. This shows you the list of available bundles and verifies which bundles you have installed.</p> <p>On Mac/Linux:</p> <pre class="prettyprint"> @@ -160,7 +151,8 @@ $ ./naclsdk list <pre class="prettyprint"> > naclsdk list </pre> -<p>If an update is available, you’ll see something like this.:</p> +<p>An asterisk (*) next to a bundle indicates that there is an update available +it. For example:</p> <pre class="prettyprint"> Bundles: I: installed @@ -178,8 +170,7 @@ Bundles: pepper_canary (canary) bionic_canary (canary) </pre> -<p>An asterisk next to a bundle indicates that there is an update available it. -If you run “<code>naclsdk update</code>” now, it warns you with a message similar to +<p>If you run <code>naclsdk update</code> now, it warns you with a message similar to this:</p> <pre class="prettyprint"> WARNING: pepper_35 already exists, but has an update available. Run update @@ -198,7 +189,7 @@ $ ./naclsdk update --force </pre> </li> </ol> -<h2 id="help-with-the-naclsdk-utility">Help with the <code>naclsdk</code> utility</h2> +<h2 id="help-with-the-naclsdk-utility"><span id="id7"></span>Help with the <code>naclsdk</code> utility</h2> <ol class="arabic"> <li><p class="first">For more information about the <code>naclsdk</code> utility, run:</p> <p>On Mac/Linux:</p> @@ -211,14 +202,14 @@ $ ./naclsdk help </pre> </li> </ol> -<p><strong>Next steps:</strong></p> +<h2 id="next-steps"><span id="id8"></span>Next steps</h2> <ul class="small-gap"> -<li>Browse through the <a class="reference external" href="release-notes">Release Notes</a> for important +<li>Browse the <a class="reference external" href="release-notes">Release Notes</a> for important information about the SDK and new bundles.</li> <li>If you’re just starting with Native Client, we recommend reading the <a class="reference external" href="../overview">Technical Overview</a> and walking through the <a class="reference external" href="devguide/tutorial/tutorial-part1">Getting Started Tutorial</a>.</li> -<li>If you’d rather dive into information about the toolchains, see +<li>If you’d rather dive in, see <a class="reference external" href="devguide/devcycle/building">Building Native Client Modules</a>.</li> </ul> </section> diff --git a/native_client_sdk/doc_generated/sdk/examples.html b/native_client_sdk/doc_generated/sdk/examples.html index aa93928..306031f 100644 --- a/native_client_sdk/doc_generated/sdk/examples.html +++ b/native_client_sdk/doc_generated/sdk/examples.html @@ -1,22 +1,19 @@ {{+bindTo:partials.standard_nacl_article}} -<section id="running-the-sdk-examples"> -<span id="sdk-examples-2"></span><h1 id="running-the-sdk-examples"><span id="sdk-examples-2"></span>Running the SDK Examples</h1> +<span class="target" id="sdk-examples-2"></span><section id="examples"> +<h1 id="examples">Examples</h1> <p>Every Native Client SDK bundle comes with a folder of example applications. Each example demonstrates one or two key Native Client programming concepts. After you’ve <a class="reference internal" href="/native-client/sdk/download.html"><em>downloaded the SDK</em></a>, follow the instructions on this page to build and run the examples.</p> <p>Your version of Chrome must be equal to or greater than the version of your SDK -bundle. For example, if you’re developing with the <code>pepper_31</code> bundle, you -must use Google Chrome version 31 or greater. To find out what version of Chrome +bundle. For example, if you’re developing with the <code>pepper_35</code> bundle, you +must use Google Chrome version 35 or greater. To find out what version of Chrome you’re using, type <code>about:chrome</code> or <code>about:version</code> in the Chrome address bar.</p> -<h2 id="enable-native-client">Enable Native Client</h2> -<aside class="note"> -If you are using Chrome 31 or later, you can skip this section. -</aside> -<p>To run Portable Native Client applications you must specifically enable Native -Client in Chrome:</p> +<h2 id="enable-native-client"><span id="id1"></span>Enable Native Client</h2> +<p>If you are using Chrome 31 or later, you can skip this section. To run Portable +Native Client applications you must specifically enable Native Client in Chrome:</p> <ol class="arabic"> <li><p class="first">Type <code>about:flags</code> in the Chrome address bar and scroll down to “Native Client”.</p> @@ -35,107 +32,85 @@ link.</p> windows will restart when you relaunch Chrome.</p> </li> </ol> -<h2 id="disable-the-chrome-cache">Disable the Chrome cache</h2> -<p>Chrome caches resources aggressively. When you are building a Native Client -application you should disable the cache to make sure that Chrome loads the -latest version.</p> -<ol class="arabic simple"> -<li>Open Chrome’s developer tools by clicking the menu icon <img alt="menu-icon" src="/native-client/images/menu-icon.png" /> and -choosing Tools > Developer tools.</li> -<li>Click the gear icon <img alt="gear-icon" src="/native-client/images/gear-icon.png" /> in the bottom right corner of the Chrome -window.</li> -<li>Under the “General” settings, check the box next to “Disable cache”.</li> -</ol> -<h2 id="build-the-sdk-examples">Build the SDK examples</h2> -<p>The Makefile scripts for the SDK examples build multiple versions of the -examples using all three SDK toolchains (newlib, glibc, and PNaCl) and in both -release and debug configurations. (Note that some examples build only with -particular toolchains).</p> -<h3 id="build-all-examples">Build all examples</h3> -<p>To build all the examples, go to the examples directory in a specific SDK -bundle and run <code>make</code>:</p> +<h2 id="build-the-sdk-examples"><span id="id2"></span>Build the SDK examples</h2> +<p>The Makefile scripts for the SDK examples can build multiple versions of the +examples using any of the three SDK toolchains (newlib, glibc, and PNaCl) and in +both release and debug configurations. Note that some examples, <code>dlopen</code> for +example, build only with particular toolchains.</p> +<p>Find the toolchains for each example by looking at the <code>VALID_TOOLCHAINS</code> +variable in the Makefile for a particular example. The first item listed is the +default. It’s built when you run an example make file without parameters. for +example running make in the <code>core</code> directory of pepper_35 builds the example +using the <code>newlib</code> toolchain.</p> <pre class="prettyprint"> -$ cd pepper_31/examples +$ cd pepper_35/examples/api/core $ make -make -C api all -make[1]: Entering directory `pepper_31/examples/api' -make -C audio all -make[2]: Entering directory `pepper_31/examples/api/audio' - CXX newlib/Debug/audio_x86_32.o - LINK newlib/Debug/audio_x86_32.nexe - CXX newlib/Debug/audio_x86_64.o - LINK newlib/Debug/audio_x86_64.nexe - CXX newlib/Debug/audio_arm.o - LINK newlib/Debug/audio_arm.nexe - CREATE_NMF newlib/Debug/audio.nmf -make[2]: Leaving directory `pepper_31/examples/api/audio' -make -C url_loader all -make[2]: Entering directory `pepper_31/examples/api/url_loader' - CXX newlib/Debug/url_loader_x86_32.o -... + CXX newlib/Release/core_x86_32.o + LINK newlib/Release/core_unstripped_x86_32.nexe + VALIDATE newlib/Release/core_unstripped_x86_32.nexe + CXX newlib/Release/core_x86_64.o + LINK newlib/Release/core_unstripped_x86_64.nexe + VALIDATE newlib/Release/core_unstripped_x86_64.nexe + CXX newlib/Release/core_arm.o + LINK newlib/Release/core_unstripped_arm.nexe + VALIDATE newlib/Release/core_unstripped_arm.nexe + STRIP newlib/Release/core_x86_32.nexe + STRIP newlib/Release/core_x86_64.nexe + STRIP newlib/Release/core_arm.nexe + CREATE_NMF newlib/Release/core.nmf </pre> -<h3 id="build-a-single-example">Build a single example</h3> -<p>Calling <code>make</code> from inside a particular example’s directory will build only -that example:</p> +<p>As you can see, this produces a number of architecture specific nexe files in +the <code>pepper_35/examples/api/core/Release</code> directory. Create debug versions by +using the <code>CONFIG</code> parameter of the make command.</p> <pre class="prettyprint"> -$ cd pepper_31/examples/api/core -$ make - CXX newlib/Debug/core_x86_32.o - LINK newlib/Debug/core_x86_32.nexe - CXX newlib/Debug/core_x86_64.o - LINK newlib/Debug/core_x86_64.nexe - CXX newlib/Debug/core_arm.o - LINK newlib/Debug/core_arm.nexe - CREATE_NMF newlib/Debug/core.nmf +$make CONFIG=Debug </pre> -<h3 id="override-defaults">Override defaults</h3> -<p>You can call <code>make</code> with the <code>TOOLCHAIN</code> and <code>CONFIG</code> parameters to -override the defaults:</p> +<p>This creates similar output, but in <code>pepper_35/examples/api/core/Debug</code>.</p> +<p>Select a different toolchain with the <code>TOOLCHAIN</code> parameter. For example:</p> <pre class="prettyprint"> +$ cd pepper_35/examples/api/core $ make TOOLCHAIN=pnacl CONFIG=Release - CXX pnacl/Release/core_pnacl.o - LINK pnacl/Release/core.bc - FINALIZE pnacl/Release/core.pexe + CXX pnacl/Release/core.o + LINK pnacl/Release/core_unstripped.bc + FINALIZE pnacl/Release/core_unstripped.pexe CREATE_NMF pnacl/Release/core.nmf </pre> -<p>You can also set <code>TOOLCHAIN</code> to “all” to build one or more examples with -all available toolchains:</p> +<p>You can also set <code>TOOLCHAIN</code> to <code>all</code> to build all Release versions with +default toolchains.</p> <pre class="prettyprint"> +$ cd pepper_35/examples/api/core $ make TOOLCHAIN=all make TOOLCHAIN=newlib -make[1]: Entering directory `pepper_31/examples/api/core' - CXX newlib/Debug/core_x86_32.o - LINK newlib/Debug/core_x86_32.nexe - CXX newlib/Debug/core_x86_64.o - LINK newlib/Debug/core_x86_64.nexe - CXX newlib/Debug/core_arm.o - LINK newlib/Debug/core_arm.nexe - CREATE_NMF newlib/Debug/core.nmf -make[1]: Leaving directory `pepper_31/examples/api/core' +make[1]: Entering directory 'pepper_35/examples/api/core' + CXX newlib/Release/core_x86_32.o + LINK newlib/Release/core_unstripped_x86_32.nexe + VALIDATE newlib/Release/core_unstripped_x86_32.nexe + CXX newlib/Release/core_x86_64.o + LINK newlib/Release/core_unstripped_x86_64.nexe + VALIDATE newlib/Release/core_unstripped_x86_64.nexe + CXX newlib/Release/core_arm.o + LINK newlib/Release/core_unstripped_arm.nexe + VALIDATE newlib/Release/core_unstripped_arm.nexe + STRIP newlib/Release/core_x86_32.nexe + STRIP newlib/Release/core_x86_64.nexe + STRIP newlib/Release/core_arm.nexe + CREATE_NMF newlib/Release/core.nmf +make[1]: Leaving directory 'pepper_35/examples/api/core' make TOOLCHAIN=glibc -make[1]: Entering directory `pepper_31/examples/api/core' - CXX glibc/Debug/core_x86_32.o - LINK glibc/Debug/core_x86_32.nexe - CXX glibc/Debug/core_x86_64.o - LINK glibc/Debug/core_x86_64.nexe - CREATE_NMF glibc/Debug/core.nmf -make[1]: Leaving directory `pepper_31/examples/api/core' -make TOOLCHAIN=pnacl -make[1]: Entering directory `pepper_31/examples/api/core' - CXX pnacl/Debug/core.o - LINK pnacl/Debug/core_unstripped.bc - FINALIZE pnacl/Debug/core_unstripped.pexe - CREATE_NMF pnacl/Debug/core.nmf -make[1]: Leaving directory `pepper_31/examples/api/core' -make TOOLCHAIN=linux -make[1]: Entering directory `pepper_31/examples/api/core' - CXX linux/Debug/core.o - LINK linux/Debug/core.so -make[1]: Leaving directory `pepper_31/examples/api/core' +make[1]: Entering directory 'pepper_35/examples/api/core' + CXX glibc/Release/core_x86_32.o + LINK glibc/Release/core_unstripped_x86_32.nexe + VALIDATE glibc/Release/core_unstripped_x86_32.nexe + CXX glibc/Release/core_x86_64.o + LINK glibc/Release/core_unstripped_x86_64.nexe + VALIDATE glibc/Release/core_unstripped_x86_64.nexe + ... + (content excerpted) + ... </pre> -<h2 id="build-results">Build results</h2> -<p>After running <code>make</code>, each example directory will contain one or more of -the following subdirectories:</p> +<h3 id="build-results"><span id="id3"></span>Build results</h3> +<p>After running <code>make</code>, example directories will contain one or more of the +following subdirectories, depending on which Makefile you run:</p> <ul class="small-gap"> <li><code>newlib</code> with subdirectories <code>Debug</code> and <code>Release</code>;</li> <li><code>glibc</code> with subdirectories <code>Debug</code> and <code>Release</code>;</li> @@ -150,23 +125,36 @@ For information about Native Client manifest files, see the <a class="reference Overview</em></a>.</p> <p>For details on how to use <code>make</code>, see the <a class="reference external" href="http://www.gnu.org/software/make/manual/make.html">GNU ‘make’ Manual</a>. For details on how to use the SDK toolchain itself, see <a class="reference internal" href="/native-client/devguide/devcycle/building.html"><em>Building Native Client Modules</em></a>.</p> -<h2 id="run-the-sdk-examples"><span id="id1"></span>Run the SDK examples</h2> -<p>To run the SDK examples, you can use the <code>make run</code> command:</p> +<h2 id="run-the-sdk-examples"><span id="running-the-sdk-examples"></span>Run the SDK examples</h2> +<h3 id="disable-the-chrome-cache"><span id="disable-chrome-cache"></span>Disable the Chrome cache</h3> +<p>Chrome’s intelligent caching caches resources aggressively. When building a +Native Client application you should disable the cache to make sure that Chrome +loads the latest version. Intelligent caching only remains inactive while +Developer Tools are open. Otherwise, agressive caching continues.</p> +<ol class="arabic simple"> +<li>Open Chrome’s developer tools by clicking the menu icon <img alt="menu-icon" src="/native-client/images/menu-icon.png" /> and +choosing Tools > Developer tools.</li> +<li>Click the gear icon <img alt="gear-icon" src="/native-client/images/gear-icon.png" /> in the bottom right corner of the Chrome +window.</li> +<li>Under the “General” settings, check the box next to “Disable cache”.</li> +</ol> +<h3 id="run-the-examples"><span id="id4"></span>Run the examples</h3> +<p>To run the SDK examples, use the <code>make run</code> command:</p> <pre class="prettyprint"> -$ cd pepper_31/examples/api/core +$ cd pepper_35/examples/api/core $ make run </pre> -<p>This will launch a local HTTP server which will serve the data for the -example. It then launches Chrome with the address of this server, usually -<code>http://localhost:5103</code>. After you close Chrome, the local HTTP server is -automatically shutdown.</p> -<p>This command will try to find an executable named <code>google-chrome</code> in your +<p>This launches a local HTTP server that serves the example. It then launches +Chrome with the address of this server, usually <code>http://localhost:5103</code>. +After you close Chrome, the local HTTP server automatically shuts down.</p> +<p>This command tries to find an executable named <code>google-chrome</code> in your <code>PATH</code> environment variable. If it can’t, you’ll get an error message like this:</p> <pre class="prettyprint"> -pepper_31/tools/common.mk:415: No valid Chrome found at CHROME_PATH= -pepper_31/tools/common.mk:415: *** Set CHROME_PATH via an environment variable, or command-line.. Stop. +pepper_35/tools/common.mk:415: No valid Chrome found at CHROME_PATH= +pepper_35/tools/common.mk:415: *** Set CHROME_PATH via an environment variable, or command-line.. Stop. </pre> +<h3 id="add-an-environment-variable-for-chrome"><span id="add-an-env-variable-for-chrome"></span>Add an environment variable for Chrome</h3> <p>Set the CHROME_PATH environment variable to the location of your Chrome executable.</p> <ul class="small-gap"> @@ -175,7 +163,7 @@ executable.</p> <code>C:\Program Files (x86)\Google\Chrome\Application\chrome.exe</code> for Chrome stable and <code>C:\Users\<username>\AppData\Local\Google\Chrome SxS\Application\chrome.exe</code> -for Chrome Canary; try looking in those directories first:</p> +for Chrome Canary. Try looking in those directories first:</p> <pre class="prettyprint"> > set CHROME_PATH=<Path to chrome.exe> </pre> @@ -197,39 +185,36 @@ $ export CHROME_PATH=<Path to Google Chrome> </pre> </li> </ul> -<p>You can run via a different toolchain or configuration by using the -<code>TOOLCHAIN</code> and <code>CONFIG</code> parameters to make:</p> -<pre class="prettyprint"> -$ make run TOOLCHAIN=pnacl CONFIG=Debug -</pre> <h2 id="run-the-sdk-examples-as-packaged-apps"><span id="run-sdk-examples-as-packaged"></span>Run the SDK examples as packaged apps</h2> -<p>Each example can also be launched as a packaged app. For more information about -using Native Client for packaged apps, see <a class="reference internal" href="/native-client/devguide/distributing.html#distributing-packaged"><em>Packaged application</em></a>. For general information about packaged apps, see the -<a class="reference external" href="/apps/about_apps">Chrome apps documentation</a>.</p> +<p>Each example can also be launched as a packaged application. A packaged +application is a special zip file (with a .crx extension) hosted in the Chrome +Web Store. This file contains all of the application parts: A Chrome Web Store +manifest file (manifest.json), an icon, and all of the regular Native Client +application files. Refer to <a class="reference external" href="/apps/about_apps">What are Chrome Apps</a> for more +information about creating a packaged application.</p> <p>Some Pepper features, such as TCP/UDP socket access, are only allowed in -packaged apps. The examples that use these features must be run as packaged -apps, by using the <code>make run_package</code> command:</p> +packaged applications. The examples that use these features must be run as +packaged applications, by using the following command:</p> <pre class="prettyprint"> $ make run_package </pre> -<p>You can use <code>TOOLCHAIN</code> and <code>CONFIG</code> parameters as above to run with a -different toolchain or configuration.</p> -<h2 id="debugging-the-sdk-examples"><span id="id2"></span>Debugging the SDK examples</h2> +<p>You can use <code>TOOLCHAIN</code> and <code>CONFIG</code> parameters as described above to run +with a different toolchain or configuration.</p> +<h2 id="debugging-the-sdk-examples"><span id="id5"></span>Debugging the SDK examples</h2> <p>The NaCl SDK uses <a class="reference external" href="https://www.gnu.org/software/gdb/">GDB</a> to debug Native Client code. The SDK includes a prebuilt version of GDB that is compatible with NaCl code. To use it, run the <code>make debug</code> command from an example directory:</p> <pre class="prettyprint"> $ make debug </pre> -<p>This will launch Chrome with the <code>--enable-nacl-debug</code> flag set. This flag -will cause Chrome to pause when a NaCl module is first loaded, waiting for a -connection from gdb. The <code>make debug</code> command also simultaneously launches -GDB and loads the symbols for that NEXE. To connect GDB to Chrome, in the GDB -console, type:</p> +<p>This launches Chrome with the <code>--enable-nacl-debug</code> flag set. This flag causes +Chrome to pause when a NaCl module is first loaded, waiting for a connection +from gdb. The <code>make debug</code> command also simultaneously launches GDB and loads +the symbols for that NEXE. To connect GDB to Chrome, in the GDB console, type:</p> <pre class="prettyprint"> (gdb) target remote :4014 </pre> -<p>This tells GDB to connect to a TCP port on <code>localhost:4014</code>–the port that +<p>This tells GDB to connect to a TCP port on <code>localhost:4014</code>, the port that Chrome is listening on. GDB will respond:</p> <pre class="prettyprint"> Remote debugging using :4014 @@ -237,8 +222,9 @@ Remote debugging using :4014 </pre> <p>At this point, you can use the standard GDB commands to debug your NaCl module. The most common commands you will use to debug are <code>continue</code>, <code>step</code>, -<code>next</code>, <code>break</code> and <code>backtrace</code>. See <a class="reference internal" href="/native-client/devguide/devcycle/debugging.html"><em>Debugging</em></a> for more information about debugging a Native Client -application.</p> +<code>next</code>, <code>break</code> and <code>backtrace</code>. See +<a class="reference internal" href="/native-client/devguide/devcycle/debugging.html"><em>Debugging</em></a> for more information about +debugging a Native Client application.</p> </section> {{/partials.standard_nacl_article}} diff --git a/native_client_sdk/doc_generated/sitemap.html b/native_client_sdk/doc_generated/sitemap.html index b47fd60..9628579 100644 --- a/native_client_sdk/doc_generated/sitemap.html +++ b/native_client_sdk/doc_generated/sitemap.html @@ -28,16 +28,14 @@ <li class="toctree-l2"><a class="reference internal" href="/native-client/sdk/download.html#overview">Overview</a></li> <li class="toctree-l2"><a class="reference internal" href="/native-client/sdk/download.html#prerequisites">Prerequisites</a></li> <li class="toctree-l2"><a class="reference internal" href="/native-client/sdk/download.html#installing-the-sdk">Installing the SDK</a></li> -<li class="toctree-l2"><a class="reference internal" href="/native-client/sdk/download.html#installing-bundles">Installing bundles</a></li> <li class="toctree-l2"><a class="reference internal" href="/native-client/sdk/download.html#updating-bundles">Updating bundles</a></li> <li class="toctree-l2"><a class="reference internal" href="/native-client/sdk/download.html#help-with-the-naclsdk-utility">Help with the <code>naclsdk</code> utility</a></li> +<li class="toctree-l2"><a class="reference internal" href="/native-client/sdk/download.html#next-steps">Next steps</a></li> </ul> </li> -<li class="toctree-l1"><a class="reference internal" href="/native-client/sdk/examples.html">Running the SDK Examples</a><ul class="small-gap"> +<li class="toctree-l1"><a class="reference internal" href="/native-client/sdk/examples.html">Examples</a><ul class="small-gap"> <li class="toctree-l2"><a class="reference internal" href="/native-client/sdk/examples.html#enable-native-client">Enable Native Client</a></li> -<li class="toctree-l2"><a class="reference internal" href="/native-client/sdk/examples.html#disable-the-chrome-cache">Disable the Chrome cache</a></li> <li class="toctree-l2"><a class="reference internal" href="/native-client/sdk/examples.html#build-the-sdk-examples">Build the SDK examples</a></li> -<li class="toctree-l2"><a class="reference internal" href="/native-client/sdk/examples.html#build-results">Build results</a></li> <li class="toctree-l2"><a class="reference internal" href="/native-client/sdk/examples.html#run-the-sdk-examples">Run the SDK examples</a></li> <li class="toctree-l2"><a class="reference internal" href="/native-client/sdk/examples.html#run-the-sdk-examples-as-packaged-apps">Run the SDK examples as packaged apps</a></li> <li class="toctree-l2"><a class="reference internal" href="/native-client/sdk/examples.html#debugging-the-sdk-examples">Debugging the SDK examples</a></li> |