summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSona Sarmadi <sona.sarmadi@enea.com>2018-07-04 14:40:51 +0200
committerSona Sarmadi <sona.sarmadi@enea.com>2018-07-04 14:40:51 +0200
commitc8221d41c83631f1fdb67f1568e0cd3a2ef0c633 (patch)
tree58b7c736e5896c20e102b2f885eb727847fea2f4
parent76d920a553dd8fae2a5501913bd02df65de8f402 (diff)
downloadnfv-access-documentation-c8221d41c83631f1fdb67f1568e0cd3a2ef0c633.tar.gz
Fixed some review comments on SDK chapter
- Added path to SDK installers: Enea_NFV_Access_2.0/x86_64/install/esdk Enea_NFV_Access_2.0/x86_64/install/sdk - To avoid confusion, use only [sdkdir] please. Signed-off-by: Sona Sarmadi <sona.sarmadi@enea.com>
-rw-r--r--doc/book-enea-nfv-access-guide-intel/doc/using_nfv_access_sdks.xml61
1 files changed, 34 insertions, 27 deletions
diff --git a/doc/book-enea-nfv-access-guide-intel/doc/using_nfv_access_sdks.xml b/doc/book-enea-nfv-access-guide-intel/doc/using_nfv_access_sdks.xml
index 26e37fb..6280338 100644
--- a/doc/book-enea-nfv-access-guide-intel/doc/using_nfv_access_sdks.xml
+++ b/doc/book-enea-nfv-access-guide-intel/doc/using_nfv_access_sdks.xml
@@ -95,20 +95,24 @@
95 <listitem> 95 <listitem>
96 <para>Download the zip image from <ulink 96 <para>Download the zip image from <ulink
97 url="https://portal.enea.com/access/">portal.enea.com/access</ulink> 97 url="https://portal.enea.com/access/">portal.enea.com/access</ulink>
98 and unzip it on the host machine.</para> 98 and unzip it on the host machine e.g. in the
99 <literal>Enea_NFV_Access_2.0 </literal>directory.</para>
99 </listitem> 100 </listitem>
100 101
101 <listitem> 102 <listitem>
102 <para><programlisting>$ ./install-sdk.sh</programlisting>After 103 <para>Run the install script located at
103 running this script, when prompted, select to install the toolchain 104 <literal>Enea_NFV_Access_2.0/x86_64/install/sdk</literal> directory,
104 in a desired directory, referred to henceforth as 105 when prompted, select to install the toolchain in a desired
105 <literal>sdkdir</literal>.</para> 106 directory, referred to henceforth as
107 <literal>[sdkdir]</literal>.</para>
108
109 <programlisting>$ ./install-sdk.sh</programlisting>
106 110
107 <para>A default path where the toolchain will be installed will be 111 <para>A default path where the toolchain will be installed will be
108 shown in the prompt. The installer will unpack the 112 shown in the prompt. The installer will unpack the
109 <literal>environment-setup</literal> script in 113 <literal>environment-setup</literal> script in
110 <literal>sdkdir</literal> and the toolchain under 114 <literal>[sdkdir]</literal> and the toolchain under
111 <literal>sdkdir/sysroots</literal>.</para> 115 <literal>[sdkdir]/sysroots</literal>.</para>
112 116
113 <note> 117 <note>
114 <para>Choose a unique directory for each toolchain. Installing a 118 <para>Choose a unique directory for each toolchain. Installing a
@@ -176,7 +180,7 @@ hello world</programlisting>
176 180
177 <para>Before cross-compiling kernel modules, inside the kernel source 181 <para>Before cross-compiling kernel modules, inside the kernel source
178 tree in the installed SDK, available at 182 tree in the installed SDK, available at
179 <literal>sdkdir/sysroots/targetarch-enea-linux/usr/src/kernel</literal>, 183 <literal>[sdkdir]/sysroots/targetarch-enea-linux/usr/src/kernel</literal>,
180 run the following command:</para> 184 run the following command:</para>
181 185
182 <programlisting>make scripts prepare</programlisting> 186 <programlisting>make scripts prepare</programlisting>
@@ -310,20 +314,21 @@ $ make</programlisting>
310 <title>Installing the Extensible SDK</title> 314 <title>Installing the Extensible SDK</title>
311 315
312 <para>To install the Extensible SDK on your host development machine, 316 <para>To install the Extensible SDK on your host development machine,
313 run the installation script provided in the <literal>/esdk</literal> 317 run the installation script provided in the
318 <literal>Enea_NFV_Access_2.0/x86_64/install/esdk</literal>
314 folder:</para> 319 folder:</para>
315 320
316 <orderedlist> 321 <orderedlist>
317 <listitem> 322 <listitem>
318 <para><programlisting>$ ./install-sdk.sh</programlisting>When 323 <para><programlisting>$ ./install-sdk.sh</programlisting>When
319 prompted, select to install the toolchain in a desired directory, 324 prompted, select to install the toolchain in a desired directory,
320 referred to henceforth as <literal>sdkdir</literal>.</para> 325 referred to henceforth as <literal>[sdkdir]</literal>.</para>
321 326
322 <para>A default path where the toolchain will be installed will be 327 <para>A default path where the toolchain will be installed will be
323 shown in the prompt. The installer unpacks the 328 shown in the prompt. The installer unpacks the
324 <literal>environment-setup</literal> script in 329 <literal>environment-setup</literal> script in
325 <literal>sdkdir</literal> and the toolchain under 330 <literal>[sdkdir]</literal> and the toolchain under
326 <literal>sdkdir/sysroots</literal>.</para> 331 <literal>[sdkdir]/sysroots</literal>.</para>
327 332
328 <note> 333 <note>
329 <para>Choose a unique directory for each toolchain. Installing a 334 <para>Choose a unique directory for each toolchain. Installing a
@@ -370,9 +375,9 @@ $ make</programlisting>
370 375
371 <para><literal><command>devtool</command></literal> creates a Git 376 <para><literal><command>devtool</command></literal> creates a Git
372 repository locally during extraction at: 377 repository locally during extraction at:
373 <literal>sdkdir/workspace/source/bbexample</literal>, where the 378 <literal>[sdkdir]/workspace/source/bbexample</literal>, where the
374 recipe will be created automatically. E.g: 379 recipe will be created automatically. E.g:
375 <literal>sdkdir/workspace/recipes/bbexample/bbexample.bb</literal>.</para> 380 <literal>[sdkdir]/workspace/recipes/bbexample/bbexample.bb</literal>.</para>
376 </listitem> 381 </listitem>
377 382
378 <listitem> 383 <listitem>
@@ -380,7 +385,7 @@ $ make</programlisting>
380 layer</emphasis></para> 385 layer</emphasis></para>
381 386
382 <para>Use <command>devtool modify [recipe]</command> on any recipe 387 <para>Use <command>devtool modify [recipe]</command> on any recipe
383 from <literal>sdkdir/layers/poky/meta*</literal>, example:</para> 388 from <literal>[sdkdir]/layers/poky/meta*</literal>, example:</para>
384 389
385 <programlisting>$ devtool modify curl</programlisting> 390 <programlisting>$ devtool modify curl</programlisting>
386 </listitem> 391 </listitem>
@@ -395,8 +400,9 @@ $ make</programlisting>
395 <para>Clone a recipe from the upstream Yocto project, e.g. 400 <para>Clone a recipe from the upstream Yocto project, e.g.
396 <literal>meta-security</literal>:</para> 401 <literal>meta-security</literal>:</para>
397 402
398 <programlisting>$ pushd sdkdir/layers/poky 403 <programlisting>$ pushd [sdkdir]/layers/poky
399$ git clone -b rocko git://git.yoctoproject.org/meta-security</programlisting> 404$ git clone -b rocko git://git.yoctoproject.org/meta-security
405$ popd</programlisting>
400 </listitem> 406 </listitem>
401 407
402 <listitem> 408 <listitem>
@@ -411,13 +417,13 @@ enabled in your configuration</programlisting>To rectify the dependency issue
411 exemplified above, clone <literal>meta-perl</literal> from 417 exemplified above, clone <literal>meta-perl</literal> from
412 openembedded and run <command>add-layers</command> 418 openembedded and run <command>add-layers</command>
413 again:<programlisting>$ layers/poky/bitbake/bin/bitbake-layers add-layer layers/poky/meta-security</programlisting>Now 419 again:<programlisting>$ layers/poky/bitbake/bin/bitbake-layers add-layer layers/poky/meta-security</programlisting>Now
414 <literal>sdkdir/layers/poky/meta-security</literal> is created 420 <literal>[sdkdir]/layers/poky/meta-security</literal> is created
415 and the layer has been added to 421 and the layer has been added to
416 <literal>sdkdir/conf/bblayers.conf</literal>:<programlisting>${SDKBASEMETAPATH}/layers/poky/meta-security</programlisting></para> 422 <literal>[sdkdir]/conf/bblayers.conf</literal>:</para>
417 423
418 <note condition="hidden"> 424 <note condition="hidden">
419 <para>The image build result can be seen at: 425 <para>The image build result can be seen at:
420 <literal>sdkdir/tmp/deploy/images/qemux86-64</literal></para> 426 <literal>[sdkdir]/tmp/deploy/images/qemux86-64</literal></para>
421 </note> 427 </note>
422 </listitem> 428 </listitem>
423 429
@@ -429,8 +435,8 @@ enabled in your configuration</programlisting>To rectify the dependency issue
429 <programlisting>$ devtool modify isic</programlisting> 435 <programlisting>$ devtool modify isic</programlisting>
430 436
431 <para>The following directories and files will be created: 437 <para>The following directories and files will be created:
432 <literal>sdkdir/workspace/appends/isic_0.07.bbappend</literal> 438 <literal>[sdkdir]/workspace/appends/isic_0.07.bbappend</literal>
433 and <literal>sdkdir/workspace/sources/isic</literal>.</para> 439 and <literal>[sdkdir]/workspace/sources/isic</literal>.</para>
434 </listitem> 440 </listitem>
435 </orderedlist> 441 </orderedlist>
436 </listitem> 442 </listitem>
@@ -445,9 +451,9 @@ enabled in your configuration</programlisting>To rectify the dependency issue
445 451
446 <para><programlisting>$ devtool build bbexample</programlisting><note> 452 <para><programlisting>$ devtool build bbexample</programlisting><note>
447 <para>The image build result can be seen at 453 <para>The image build result can be seen at
448 <literal>&lt;sdkdir&gt;/tmp/work/&lt;arch&gt;/&lt;recipe&gt;</literal>. 454 <literal>&lt;[sdkdir]&gt;/tmp/work/&lt;arch&gt;/&lt;recipe&gt;</literal>.
449 E.g. 455 E.g.
450 <literal>sdkdir/tmp/work/corei7-64-enea-linux/bbexample</literal>.</para> 456 <literal>[sdkdir]/tmp/work/corei7-64-enea-linux/bbexample</literal>.</para>
451 </note></para> 457 </note></para>
452 </section> 458 </section>
453 </section> 459 </section>
@@ -526,8 +532,9 @@ inherit core-image</programlisting>
526 532
527 <note> 533 <note>
528 <para>The image build result can be seen at: 534 <para>The image build result can be seen at:
529 <literal>sdkdir/tmp/deploy/images/&lt;target&gt;</literal>. E.g.: 535 <literal>[sdkdir]/tmp/deploy/images/&lt;target&gt;</literal>.
530 <literal>sdkdir/tmp/deploy/images/qemux86-64</literal></para> 536 E.g.:
537 <literal>[sdkdir]/tmp/deploy/images/qemux86-64</literal></para>
531 </note> 538 </note>
532 </listitem> 539 </listitem>
533 540
@@ -539,4 +546,4 @@ inherit core-image</programlisting>
539 </orderedlist> 546 </orderedlist>
540 </section> 547 </section>
541 </section> 548 </section>
542</chapter> \ No newline at end of file 549</chapter>