X-Git-Url: http://git.droids-corp.org/?a=blobdiff_plain;f=doc%2Fguides%2Flinux_gsg%2Fquick_start.rst;h=1e0f8ff3560d435ea79ec903664e3a54a11e10ed;hb=fe0bd9ee5da3fd52766458a5d0fa9a8728182be1;hp=a1dd3ee4c9beb6ea8ec97d1d786061a870b7988d;hpb=efa2084a840fb83fd9be83adca57e5f23d3fa9fe;p=dpdk.git diff --git a/doc/guides/linux_gsg/quick_start.rst b/doc/guides/linux_gsg/quick_start.rst index a1dd3ee4c9..1e0f8ff356 100644 --- a/doc/guides/linux_gsg/quick_start.rst +++ b/doc/guides/linux_gsg/quick_start.rst @@ -28,6 +28,8 @@ (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +.. _linux_setup_script: + Quick Start Setup Script ======================== @@ -51,7 +53,7 @@ The setup.sh script, found in the tools subdirectory, allows the user to perform * Look at hugepages in the meminfo -* List hugepages in /mnt/huge +* List hugepages in ``/mnt/huge`` * Remove built DPDK libraries @@ -106,7 +108,7 @@ Some options in the script prompt the user for further data before proceeding. .. code-block:: console - user@host:~/rte$ source tools/setup.sh + source tools/setup.sh ------------------------------------------------------------------------ @@ -202,7 +204,7 @@ Some options in the script prompt the user for further data before proceeding. Option: -The following selection demonstrates the creation of the x86_64-native-linuxapp-gcc DPDK library. +The following selection demonstrates the creation of the ``x86_64-native-linuxapp-gcc`` DPDK library. .. code-block:: console @@ -214,7 +216,7 @@ The following selection demonstrates the creation of the x86_64-native-linuxapp- == Build lib ... Build complete - RTE_TARGET exported as x86_64-native -linuxapp-gcc + RTE_TARGET exported as x86_64-native-linuxapp-gcc The following selection demonstrates the starting of the DPDK UIO driver. @@ -226,7 +228,7 @@ The following selection demonstrates the starting of the DPDK UIO driver. Loading DPDK UIO module The following selection demonstrates the creation of hugepages in a NUMA system. -1024 2 Mbyte pages are assigned to each node. +1024 2 MByte pages are assigned to each node. The result is that the application should use -m 4096 for starting the application to access both memory areas (this is done automatically if the -m option is not provided). @@ -239,7 +241,7 @@ The result is that the application should use -m 4096 for starting the applicati Option: 15 Removing currently reserved hugepages - nmounting /mnt/huge and removing directory + mounting /mnt/huge and removing directory Input the number of 2MB pages for each node Example: to have 128MB of hugepages available per node, enter '64' to reserve 64 * 2MB pages on each node @@ -277,15 +279,16 @@ the logical core layout of the platform should be determined when selecting a co .. code-block:: console - rte@rte-desktop:~/rte/examples$ cd helloworld/ - rte@rte-desktop:~/rte/examples/helloworld$ make - CC main.o - LD helloworld - INSTALL-APP helloworld - INSTALL-MAP helloworld.map + cd helloworld/ + make + CC main.o + LD helloworld + INSTALL-APP helloworld + INSTALL-MAP helloworld.map - rte@rte-desktop:~/rte/examples/helloworld$ sudo ./build/app/helloworld -c 0xf -n 3 + sudo ./build/app/helloworld -c 0xf -n 3 [sudo] password for rte: + EAL: coremask set to f EAL: Detected lcore 0 as core 0 on socket 0 EAL: Detected lcore 1 as core 0 on socket 1