Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(308)

Side by Side Diff: native_client_sdk/doc_generated/sdk/download.html

Issue 588723002: Copy edit SDK section. (Closed) Base URL: https://chromium.googlesource.com/chromium/src.git@master
Patch Set: Add 'TODO' comment to examples.rst. Created 6 years, 2 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch
OLDNEW
1 {{+bindTo:partials.standard_nacl_article}} 1 {{+bindTo:partials.standard_nacl_article}}
2 2
3 <section id="download-the-native-client-sdk"> 3 <section id="download-the-native-client-sdk">
4 <span id="download"></span><h1 id="download-the-native-client-sdk"><span id="dow nload"></span>Download the Native Client SDK</h1> 4 <span id="download"></span><h1 id="download-the-native-client-sdk"><span id="dow nload"></span>Download the Native Client SDK</h1>
5 <p>To build Native Client modules, you must download and install the Native Clie nt 5 <p>This page provides an overview of the Native Client SDK, and instructions for
6 Software Development Kit (SDK). This page provides an overview of the Native 6 downloading and installing the SDK.</p>
7 Client SDK, and instructions for how to download and install the SDK.</p>
8 <div id="home"> 7 <div id="home">
9 <a class="button-nacl button-download" href="http://storage.googleapis.com/nativ eclient-mirror/nacl/nacl_sdk/nacl_sdk.zip">Download SDK Zip File</a> 8 <a class="button-nacl button-download" href="http://storage.googleapis.com/nativ eclient-mirror/nacl/nacl_sdk/nacl_sdk.zip">Download SDK Zip File</a>
10 </div><h2 id="overview">Overview</h2> 9 </div><h2 id="overview"><span id="sdk-overview"></span>Overview</h2>
11 <p>The Native Client SDK includes the following:</p> 10 <p>The Native Client SDK includes:</p>
12 <ul class="small-gap"> 11 <ul class="small-gap">
13 <li><strong>Support for multiple Pepper versions</strong> to compile for specifi c minimum 12 <li><strong>Support for multiple Pepper versions</strong> to compile for specifi c minimum
14 versions of Chrome.</li> 13 versions of Chrome.</li>
15 <li><strong>Update utility</strong> to download new bundles that are available, as well as new 14 <li><strong>Update utility</strong> to download new bundles and updates to exist ing bundles.</li>
16 versions of existing bundles.</li>
17 <li><strong>Toolchains</strong> to compile for Portable Native Client (PNaCl), t raditional 15 <li><strong>Toolchains</strong> to compile for Portable Native Client (PNaCl), t raditional
18 Native Client (NaCl), and for compiling architecture-specific Native Client 16 Native Client (NaCl), and for compiling architecture-specific Native Client
19 applications with glibc.</li> 17 applications with glibc.</li>
20 <li><strong>Examples</strong> Including C or C++ source files and header files i llustrating 18 <li><strong>Examples</strong> Including C or C++ source files and header files i llustrating
21 how to use NaCl and Pepper, and Makefiles to build the example with each of 19 how to use NaCl and Pepper, and Makefiles to build the example with each of
22 the toolchains.</li> 20 the toolchains.</li>
23 <li><strong>Tools</strong> for validating Native Client modules and running modu les from the 21 <li><strong>Tools</strong> for validating Native Client modules and running modu les from the
24 command line.</li> 22 command line.</li>
25 </ul> 23 </ul>
26 <p>Follow the steps below to download and install the Native Client SDK.</p> 24 <p>Follow the steps below to download and install the Native Client SDK.</p>
27 <h2 id="prerequisites">Prerequisites</h2> 25 <h2 id="prerequisites"><span id="id1"></span>Prerequisites</h2>
26 <h3 id="python-2-7"><span id="python26-27"></span>Python 2.7</h3>
27 <p>Make sure that the Python executable is in your <code>PATH</code> variable. P ython 3.x is
28 not yet supported.</p>
28 <ul class="small-gap"> 29 <ul class="small-gap">
29 <li><p class="first"><strong>Python 2.6 or 2.7:</strong> Make sure that the Pyth on executable is in your path. 30 <li>On Mac and Linux, Python is likely preinstalled. Run the command <code>pytho n -V</code>
30 Python 2.7 is preferred. Python 3.x is not yet supported.</p> 31 in a terminal window, and make sure that the version you have is 2.6.x or
32 2.7.x.</li>
33 <li>On Windows, you may need to install Python. Go to <a class="reference extern al" href="http://www.python.org/download/">http://www.python.org/
34 download/</a> and select the latest 2.x
35 version. In addition, be sure to add the Python directory (for example,
36 <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
37 verify that you properly configured the PATH variable.</li>
38 </ul>
39 <h3 id="make"><span id="id2"></span>Make</h3>
31 <ul class="small-gap"> 40 <ul class="small-gap">
32 <li>On Mac and Linux, Python is likely preinstalled. Run the command &#8220;<cod e>python 41 <li>On the Mac, you need to install <code>make</code> on your system before you can build
33 -V</code>&#8221; in a terminal window, and make sure that the version you have i s 2.6.x 42 and run the examples in the SDK. One easy way to get <code>make</code>, along wi th
34 or 2.7.x.</li> 43 several other useful tools, is to install <a class="reference external" href="ht tps://developer.apple.com/technologies/tools/">Xcode Developer Tools</a>. After installing Xcode,
35 <li>On Windows, you may need to install Python. Go to 44 go to the XCode menu, open the Preferences dialog box then select Downloads
36 <a class="reference external" href="http://www.python.org/download/">http://www. python.org/download/</a> and 45 and Components. Verify that Command Line Tools are installed. If you&#8217;d rat her
37 select the latest 2.x version. In addition, be sure to add the Python 46 not install Xcode, you can download and build an <a class="reference external" h ref="http://mac.softpedia.com/dyn-postdownload.php?p=44632&amp;t=4&amp;i=1">open source version</a> of <code>make</code>.
38 directory (for example, <code>C:\python27</code>) to the PATH <a class="referenc e external" href="http://en.wikipedia.org/wiki/Environment_variable">environment 47 To build the program you may also need to download and install <a class="referen ce external" href="https://github.com/kennethreitz/osx-gcc-installer">gcc</a>.</ li>
39 variable</a>. Run 48 <li>On Windows, the Native Client SDK includes a copy of GNU Make.</li>
40 &#8220;<code>python -V</code>&#8221; from a command line to verify that you prop erly configured
41 the PATH variable.</li>
42 </ul> 49 </ul>
43 </li> 50 <h2 id="installing-the-sdk"><span id="id3"></span>Installing the SDK</h2>
44 <li><strong>Make:</strong> On the Mac, you need to install the <code>make</code> command on your system 51 <h3 id="downloading-and-unzipping"><span id="id4"></span>Downloading and Unzippi ng</h3>
45 before you can build and run the examples in the SDK. One easy way to get
46 <code>make</code>, along with several other useful tools, is to install
47 <a class="reference external" href="https://developer.apple.com/technologies/too ls/">Xcode Developer Tools</a>.
48 After installing Xcode, go to the XCode menu, open the Preferences dialog box
49 then select Downloads and Components. Verify that Command Line Tools are
50 installed. If you&#8217;d rather not install Xcode, you can download and build a n
51 <a class="reference external" href="http://mac.softpedia.com/dyn-postdownload.ph p?p=44632&amp;t=4&amp;i=1">open source version</a> of <code>make</code>.
52 To build the command you may also need to download and install
53 <a class="reference external" href="https://github.com/kennethreitz/osx-gcc-inst aller">gcc</a>.</li>
54 </ul>
55 <h2 id="installing-the-sdk">Installing the SDK</h2>
56 <ol class="arabic"> 52 <ol class="arabic">
57 <li><p class="first">Download the SDK update zip file: <a class="reference exter nal" href="http://storage.googleapis.com/nativeclient-mirror/nacl/nacl_sdk/nacl_ sdk.zip">nacl_sdk.zip</a>.</p> 53 <li><p class="first">Download the <a class="reference external" href="http://sto rage.googleapis.com/nativeclient-mirror/nacl/nacl_sdk/nacl_sdk.zip">SDK update z ip file</a>.</p>
58 </li> 54 </li>
59 <li><p class="first">Unzip the file:</p> 55 <li><p class="first">Unzip the file:</p>
60 <ul class="small-gap"> 56 <ul class="small-gap">
61 <li><p class="first">On Mac/Linux, run the command &#8220;<code>unzip nacl_sdk.z ip</code>&#8221; in a terminal 57 <li><p class="first">On Mac/Linux, run the command <code>unzip nacl_sdk.zip</cod e> in a terminal
62 window.</p> 58 window.</p>
63 </li> 59 </li>
64 <li><p class="first">On Windows, right-click on the .zip file and select &#8220; Extract All...&#8221;. A 60 <li><p class="first">On Windows, right-click on the .zip file and select &#8220; Extract All...&#8221;. A
65 dialog box will open; enter a location and click &#8220;Extract&#8221;.</p> 61 dialog box opens; enter a location and click &#8220;Extract&#8221;.</p>
66 </li> 62 </li>
67 </ul> 63 </ul>
68 <p>A directory is created called <code>nacl_sdk</code> with the following files and 64 <p>A directory is created called <code>nacl_sdk</code> with the following files and
69 directories:</p> 65 directories:</p>
70 <ul class="small-gap"> 66 <ul class="small-gap">
71 <li><p class="first"><code>naclsdk</code> (and <code>naclsdk.bat</code> for Wind ows) &#8212; the update utility, 67 <li><p class="first"><code>naclsdk</code> (and <code>naclsdk.bat</code> for Wind ows) &#8212; the update utility,
72 which is the command you run to download and update bundles.</p> 68 which is the command you run to download and update bundles.</p>
73 </li> 69 </li>
74 <li><p class="first"><code>sdk_cache</code> &#8212; a directory with a manifest file that lists the bundles 70 <li><p class="first"><code>sdk_cache</code> &#8212; a directory with a manifest file that lists the bundles
75 you have already downloaded.</p> 71 you have already downloaded.</p>
76 </li> 72 </li>
77 <li><p class="first"><code>sdk_tools</code> &#8212; the code run by the <code>na clsdk</code> command.</p> 73 <li><p class="first"><code>sdk_tools</code> &#8212; the code run by the <code>na clsdk</code> command.</p>
78 </li> 74 </li>
79 </ul> 75 </ul>
80 </li> 76 </li>
81 </ol> 77 </ol>
82 <h2 id="installing-bundles">Installing bundles</h2> 78 <h3 id="installing-the-stable-bundle"><span id="id5"></span>Installing the stabl e bundle</h3>
83 <ol class="arabic"> 79 <ol class="arabic">
84 <li><p class="first">To see the SDK bundles that are available for download, go to the 80 <li><p class="first">To see the SDK bundles that are available for download, go to the
85 <code>nacl_sdk</code> directory and run <code>naclsdk</code> with the &#8220;<co de>list</code>&#8221; command. The 81 <code>nacl_sdk</code> directory and run <code>naclsdk</code> with the <code>list </code> command. The SDK
86 SDK includes a separate bundle for each version of Chrome/Pepper.</p> 82 includes a separate bundle for each version of Chrome/Pepper.</p>
87 <p>On Mac/Linux:</p> 83 <p>On Mac/Linux:</p>
88 <pre class="prettyprint"> 84 <pre class="prettyprint">
89 $ cd nacl_sdk 85 $ cd nacl_sdk
90 $ ./naclsdk list 86 $ ./naclsdk list
91 </pre> 87 </pre>
92 <p>On Windows:</p> 88 <p>On Windows:</p>
93 <pre class="prettyprint"> 89 <pre class="prettyprint">
94 &gt; cd nacl_sdk 90 &gt; cd nacl_sdk
95 &gt; naclsdk list 91 &gt; naclsdk list
96 </pre> 92 </pre>
(...skipping 10 matching lines...) Expand all
107 pepper_33 (post_stable) 103 pepper_33 (post_stable)
108 pepper_34 (post_stable) 104 pepper_34 (post_stable)
109 pepper_35 (stable) 105 pepper_35 (stable)
110 pepper_36 (beta) 106 pepper_36 (beta)
111 pepper_37 (dev) 107 pepper_37 (dev)
112 pepper_canary (canary) 108 pepper_canary (canary)
113 bionic_canary (canary) 109 bionic_canary (canary)
114 </pre> 110 </pre>
115 <p>The sample output above shows that several bundles are available for 111 <p>The sample output above shows that several bundles are available for
116 download, and that you have already installed the latest revision of the 112 download, and that you have already installed the latest revision of the
117 <code>sdk_tools</code> bundle. (It was included in the zip file you downloaded.) Each 113 <code>sdk_tools</code> bundle, which was included in the zip file. You never nee d to
118 bundle is labeled post-stable, stable, beta, dev, or canary. These labels 114 update the <code>sdk_tools</code> bundle. It is updated automatically (if necess ary)
119 usually correspond to the current versions of Chrome.</p> 115 whenever you run <code>naclsdk</code>.</p>
120 <p>We recommend that you download and use a &#8220;stable&#8221; bundle, because 116 <p>Bundles are labeled post-stable, stable, beta, dev, or canary. These labels
121 applications developed with &#8220;stable&#8221; bundles can be used by all curr ent 117 usually correspond to the current versions of Chrome. We recommend that you
122 Chrome users. This is because Native Client is designed to be 118 develop against a &#8220;stable&#8221; bundle, because such bundles can be used by all
123 backward-compatible (for example, applications developed with the 119 current Chrome users. Native Client is designed to be backward-compatible.For
124 <code>pepper_31</code> bundle can run in Chrome 31, Chrome 32, etc.).</p> 120 example, applications developed with the <code>pepper_31</code> bundle can run i n
121 Chrome 31, Chrome 32, etc..</p>
125 </li> 122 </li>
126 <li><p class="first">Run <code>naclsdk</code> with the &#8220;update&#8221; comm and to download recommended bundles.</p> 123 <li><p class="first">Run <code>naclsdk</code> with the <code>update</code> comma nd to download recommended bundles,
124 including the current &#8220;stable&#8221; bundle.</p>
127 <p>On Mac/Linux:</p> 125 <p>On Mac/Linux:</p>
128 <pre class="prettyprint"> 126 <pre class="prettyprint">
129 $ ./naclsdk update 127 $ ./naclsdk update
130 </pre> 128 </pre>
131 <p>On Windows:</p> 129 <p>On Windows:</p>
132 <pre class="prettyprint"> 130 <pre class="prettyprint">
133 &gt; naclsdk update 131 &gt; naclsdk update
134 </pre> 132 </pre>
135 <p>By default, <code>naclsdk</code> only downloads bundles that are recommended& #8212; 133 <p>By default, <code>naclsdk</code> only downloads bundles that are recommended,
136 generally those that are &#8220;stable.&#8221; Continuing with the earlier examp le, the 134 generally those that are &#8220;stable.&#8221; For example, if the current &#822 0;stable&#8221;
137 &#8220;update&#8221; command would only download the <code>pepper_35</code> bund le, since the 135 bundle is <code>pepper_35</code>, then the <code>update</code> downloads that bu ndle. To
138 bundles <code>pepper_36</code> and greater are not yet stable. If you want the 136 download the <code>pepper_36</code> bundle you must ask for it explicitly:</p>
139 <code>pepper_36</code> bundle, you must ask for it explicitly:</p>
140 <pre class="prettyprint"> 137 <pre class="prettyprint">
141 $ ./naclsdk update pepper_36 138 $ ./naclsdk update pepper_36
142 </pre> 139 </pre>
143 </li> 140 </li>
144 </ol> 141 </ol>
145 <aside class="note"> 142 <h2 id="updating-bundles"><span id="id6"></span>Updating bundles</h2>
146 <blockquote>
147 <div>You never need to update the <code>sdk_tools</code> bundle. It is updated
148 automatically (if necessary) whenever you run <code>naclsdk</code>.</div></block quote>
149
150 </aside>
151 <h2 id="updating-bundles">Updating bundles</h2>
152 <ol class="arabic"> 143 <ol class="arabic">
153 <li><p class="first">Run <code>naclsdk</code> with the &#8220;list&#8221; comman d. This shows you the list of available 144 <li><p class="first">Run <code>naclsdk</code> with the <code>list</code> command . This shows you the list of available
154 bundles and verifies which bundles you have installed.</p> 145 bundles and verifies which bundles you have installed.</p>
155 <p>On Mac/Linux:</p> 146 <p>On Mac/Linux:</p>
156 <pre class="prettyprint"> 147 <pre class="prettyprint">
157 $ ./naclsdk list 148 $ ./naclsdk list
158 </pre> 149 </pre>
159 <p>On Windows:</p> 150 <p>On Windows:</p>
160 <pre class="prettyprint"> 151 <pre class="prettyprint">
161 &gt; naclsdk list 152 &gt; naclsdk list
162 </pre> 153 </pre>
163 <p>If an update is available, you&#8217;ll see something like this.:</p> 154 <p>An asterisk (*) next to a bundle indicates that there is an update available
155 it. For example:</p>
164 <pre class="prettyprint"> 156 <pre class="prettyprint">
165 Bundles: 157 Bundles:
166 I: installed 158 I: installed
167 *: update available 159 *: update available
168 160
169 I sdk_tools (stable) 161 I sdk_tools (stable)
170 vs_addin (dev) 162 vs_addin (dev)
171 pepper_31 (post_stable) 163 pepper_31 (post_stable)
172 pepper_32 (post_stable) 164 pepper_32 (post_stable)
173 pepper_33 (post_stable) 165 pepper_33 (post_stable)
174 pepper_34 (post_stable) 166 pepper_34 (post_stable)
175 I* pepper_35 (stable) 167 I* pepper_35 (stable)
176 pepper_36 (beta) 168 pepper_36 (beta)
177 pepper_37 (dev) 169 pepper_37 (dev)
178 pepper_canary (canary) 170 pepper_canary (canary)
179 bionic_canary (canary) 171 bionic_canary (canary)
180 </pre> 172 </pre>
181 <p>An asterisk next to a bundle indicates that there is an update available it. 173 <p>If you run <code>naclsdk update</code> now, it warns you with a message simil ar to
182 If you run &#8220;<code>naclsdk update</code>&#8221; now, it warns you with a me ssage similar to
183 this:</p> 174 this:</p>
184 <pre class="prettyprint"> 175 <pre class="prettyprint">
185 WARNING: pepper_35 already exists, but has an update available. Run update 176 WARNING: pepper_35 already exists, but has an update available. Run update
186 with the --force option to overwrite the existing directory. Warning: This 177 with the --force option to overwrite the existing directory. Warning: This
187 will overwrite any modifications you have made within this directory. 178 will overwrite any modifications you have made within this directory.
188 </pre> 179 </pre>
189 </li> 180 </li>
190 <li><p class="first">To download and install the new bundle, run:</p> 181 <li><p class="first">To download and install the new bundle, run:</p>
191 <p>On Mac/Linux:</p> 182 <p>On Mac/Linux:</p>
192 <pre class="prettyprint"> 183 <pre class="prettyprint">
193 $ ./naclsdk update --force 184 $ ./naclsdk update --force
194 </pre> 185 </pre>
195 <p>On Windows:</p> 186 <p>On Windows:</p>
196 <pre class="prettyprint"> 187 <pre class="prettyprint">
197 &gt; naclsdk update --force 188 &gt; naclsdk update --force
198 </pre> 189 </pre>
199 </li> 190 </li>
200 </ol> 191 </ol>
201 <h2 id="help-with-the-naclsdk-utility">Help with the <code>naclsdk</code> utilit y</h2> 192 <h2 id="help-with-the-naclsdk-utility"><span id="id7"></span>Help with the <code >naclsdk</code> utility</h2>
202 <ol class="arabic"> 193 <ol class="arabic">
203 <li><p class="first">For more information about the <code>naclsdk</code> utility , run:</p> 194 <li><p class="first">For more information about the <code>naclsdk</code> utility , run:</p>
204 <p>On Mac/Linux:</p> 195 <p>On Mac/Linux:</p>
205 <pre class="prettyprint"> 196 <pre class="prettyprint">
206 $ ./naclsdk help 197 $ ./naclsdk help
207 </pre> 198 </pre>
208 <p>On Windows:</p> 199 <p>On Windows:</p>
209 <pre class="prettyprint"> 200 <pre class="prettyprint">
210 &gt; naclsdk help 201 &gt; naclsdk help
211 </pre> 202 </pre>
212 </li> 203 </li>
213 </ol> 204 </ol>
214 <p><strong>Next steps:</strong></p> 205 <h2 id="next-steps"><span id="id8"></span>Next steps</h2>
215 <ul class="small-gap"> 206 <ul class="small-gap">
216 <li>Browse through the <a class="reference external" href="release-notes">Releas e Notes</a> for important 207 <li>Browse the <a class="reference external" href="release-notes">Release Notes< /a> for important
217 information about the SDK and new bundles.</li> 208 information about the SDK and new bundles.</li>
218 <li>If you&#8217;re just starting with Native Client, we recommend reading the 209 <li>If you&#8217;re just starting with Native Client, we recommend reading the
219 <a class="reference external" href="../overview">Technical Overview</a> and walk ing through the 210 <a class="reference external" href="../overview">Technical Overview</a> and walk ing through the
220 <a class="reference external" href="devguide/tutorial/tutorial-part1">Getting St arted Tutorial</a>.</li> 211 <a class="reference external" href="devguide/tutorial/tutorial-part1">Getting St arted Tutorial</a>.</li>
221 <li>If you&#8217;d rather dive into information about the toolchains, see 212 <li>If you&#8217;d rather dive in, see
222 <a class="reference external" href="devguide/devcycle/building">Building Native Client Modules</a>.</li> 213 <a class="reference external" href="devguide/devcycle/building">Building Native Client Modules</a>.</li>
223 </ul> 214 </ul>
224 </section> 215 </section>
225 216
226 {{/partials.standard_nacl_article}} 217 {{/partials.standard_nacl_article}}
OLDNEW

Powered by Google App Engine
This is Rietveld 408576698