From patchwork Tue Aug 23 12:45:14 2016 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Thomas Monjalon X-Patchwork-Id: 15268 Return-Path: X-Original-To: patchwork@dpdk.org Delivered-To: patchwork@dpdk.org Received: from [92.243.14.124] (localhost [IPv6:::1]) by dpdk.org (Postfix) with ESMTP id A5B9F2931; Tue, 23 Aug 2016 14:45:28 +0200 (CEST) Received: from mail-wm0-f42.google.com (mail-wm0-f42.google.com [74.125.82.42]) by dpdk.org (Postfix) with ESMTP id AD851275D for ; Tue, 23 Aug 2016 14:45:27 +0200 (CEST) Received: by mail-wm0-f42.google.com with SMTP id f65so161212186wmi.0 for ; Tue, 23 Aug 2016 05:45:27 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=6wind-com.20150623.gappssmtp.com; s=20150623; h=from:to:cc:subject:date:message-id; bh=OpNBX3zhAlRKZAWOhTizsoENvH94T+6PMW8ZxGfbyEw=; b=mbUFyJjemdkbi6yrOaTa9DF/zOK+oqV7lywA8+iTcboaJTMrH1wkDnBTTI2+UTG6Sw zfpUpNwRCOKIYPPxKPwCH5Z3xb2m4FyFkpELJVKkTN2vwjBBDAaQ4ZSgjcltxWhELFoF fPyIXb6b9v0Hg0Bgs8GFnKsMvcbBF41JrDz0Vi3DQEpaTXFky+cxk+zDF2XCYRoyDwtl XJP7DCtxYuf16xHH7sv4Yjv6GxHaTdKqFYZGfnH4XTTftw4N0gOI9mdr/V/WJkGJOryj Yd40LELTHasTUNddg1PspZ5NNtllznGYeU09VeZZkdlyyTALUWXzPQd56MCZAe/8go3J Oj4w== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:from:to:cc:subject:date:message-id; bh=OpNBX3zhAlRKZAWOhTizsoENvH94T+6PMW8ZxGfbyEw=; b=QPc0NKKk9Fsb+871aS+r+MOi647oW7Z9KvOd/yMsy87YBt6WC42wMVeEYOqn4OndLo 9Y5NSib6BjP/JadT5qP206QxKuROCP1HKkCVQs4IOYIwkYVbF97VKIZtQC60kyJ2qDV0 VdvWRc7t7hwjQj+uDwd659w8p5ecwjzrMjY2jtQhmOqjgZaNS1tLq9f1RgGQfm7TddMF 77dalwbROJcdqGQnnbHA4xP+UGdlkC1nfK57RMyLY+2mzmhROX9s2OnMP9mZVQ2PKihx GReFhp/AhaAWEwaD4BodOT8pbtqA2ks+YY1wv9TqK+bB4YDaX2cB7/Gk6sZLisSOEVyP M2uw== X-Gm-Message-State: AEkoouuUTk6osC60s4FvVm9zFMSYuOdPGTJMS0mSDksXLvi2/0vWFLQerPV/xTrqBx6efZrE X-Received: by 10.28.196.136 with SMTP id u130mr18988176wmf.83.1471956327345; Tue, 23 Aug 2016 05:45:27 -0700 (PDT) Received: from XPS13.localdomain (124.17.90.79.rev.sfr.net. [79.90.17.124]) by smtp.gmail.com with ESMTPSA id i1sm3655190wjl.9.2016.08.23.05.45.25 (version=TLS1_2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Tue, 23 Aug 2016 05:45:26 -0700 (PDT) From: Thomas Monjalon To: John McNamara Cc: dev@dpdk.org Date: Tue, 23 Aug 2016 14:45:14 +0200 Message-Id: <1471956314-16792-1-git-send-email-thomas.monjalon@6wind.com> X-Mailer: git-send-email 2.7.0 Subject: [dpdk-dev] [PATCH] doc: remove useless file listings X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: patches and discussions about DPDK List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" Lists of DPDK files are hard to maintain up to date and does not bring much information. Signed-off-by: Thomas Monjalon Acked-by: John McNamara Reviewed-by: Yuanhan Liu --- doc/guides/freebsd_gsg/build_dpdk.rst | 13 +----- doc/guides/linux_gsg/build_dpdk.rst | 10 ----- doc/guides/prog_guide/dev_kit_build_system.rst | 57 +------------------------- 3 files changed, 2 insertions(+), 78 deletions(-) diff --git a/doc/guides/freebsd_gsg/build_dpdk.rst b/doc/guides/freebsd_gsg/build_dpdk.rst index 93c4366..27f21de 100644 --- a/doc/guides/freebsd_gsg/build_dpdk.rst +++ b/doc/guides/freebsd_gsg/build_dpdk.rst @@ -111,10 +111,6 @@ First, uncompress the archive and move to the DPDK source directory: unzip DPDK-.zip cd DPDK- - ls - app/ config/ examples/ lib/ LICENSE.GPL LICENSE.LGPL Makefile - mk/ scripts/ tools/ - The DPDK is composed of several directories: * lib: Source code of DPDK libraries @@ -177,14 +173,7 @@ Once a target is created, it contains all the libraries and header files for the DPDK environment that are required to build customer applications. In addition, the test and testpmd applications are built under the build/app directory, which may be used for testing. A kmod directory is also present that -contains the kernel modules to install: - -.. code-block:: console - - ls x86_64-native-bsdapp-gcc - - app build include kmod lib Makefile - +contains the kernel modules to install. .. _loading_contigmem: diff --git a/doc/guides/linux_gsg/build_dpdk.rst b/doc/guides/linux_gsg/build_dpdk.rst index 474598a..527c38d 100644 --- a/doc/guides/linux_gsg/build_dpdk.rst +++ b/doc/guides/linux_gsg/build_dpdk.rst @@ -48,10 +48,6 @@ First, uncompress the archive and move to the uncompressed DPDK source directory unzip DPDK-.zip cd DPDK- - ls - app/ config/ examples/ lib/ LICENSE.GPL LICENSE.LGPL Makefile - mk/ scripts/ tools/ - The DPDK is composed of several directories: * lib: Source code of DPDK libraries @@ -148,12 +144,6 @@ Once a target is created it contains all libraries, including poll-mode drivers, In addition, the test and testpmd applications are built under the build/app directory, which may be used for testing. A kmod directory is also present that contains kernel modules which may be loaded if needed. -.. code-block:: console - - ls x86_64-native-linuxapp-gcc - - app build include kmod lib Makefile - Loading Modules to Enable Userspace IO for DPDK ----------------------------------------------- diff --git a/doc/guides/prog_guide/dev_kit_build_system.rst b/doc/guides/prog_guide/dev_kit_build_system.rst index fa2411f..952146e 100644 --- a/doc/guides/prog_guide/dev_kit_build_system.rst +++ b/doc/guides/prog_guide/dev_kit_build_system.rst @@ -53,62 +53,7 @@ Build Directory Concept ~~~~~~~~~~~~~~~~~~~~~~~ After installation, a build directory structure is created. -Each build directory contains include files, libraries, and applications: - -.. code-block:: console - - ~/DPDK$ ls - app MAINTAINERS - config Makefile - COPYRIGHT mk - doc scripts - examples lib - tools x86_64-native-linuxapp-gcc - x86_64-native-linuxapp-icc i686-native-linuxapp-gcc - i686-native-linuxapp-icc - - ... - ~/DEV/DPDK$ ls i686-native-linuxapp-gcc - - app build buildtools include kmod lib Makefile - - - ~/DEV/DPDK$ ls i686-native-linuxapp-gcc/app/ - cmdline_test dump_cfg test testpmd - cmdline_test.map dump_cfg.map test.map - testpmd.map - - - ~/DEV/DPDK$ ls i686-native-linuxapp-gcc/lib/ - - libethdev.a librte_hash.a librte_mbuf.a librte_pmd_ixgbe.a - - librte_cmdline.a librte_lpm.a librte_mempool.a librte_ring.a - - librte_eal.a librte_pmd_e1000.a librte_timer.a - - - ~/DEV/DPDK$ ls i686-native-linuxapp-gcc/include/ - arch rte_cpuflags.h rte_memcpy.h - cmdline_cirbuf.h rte_cycles.h rte_memory.h - cmdline.h rte_debug.h rte_mempool.h - cmdline_parse_etheraddr.h rte_eal.h rte_memzone.h - cmdline_parse.h rte_errno.h rte_pci_dev_ids.h - cmdline_parse_ipaddr.h rte_ethdev.h rte_pci.h - cmdline_parse_num.h rte_ether.h rte_per_lcore.h - cmdline_parse_portlist.h rte_fbk_hash.h rte_prefetch.h - cmdline_parse_string.h rte_hash_crc.h rte_random.h - cmdline_rdline.h rte_hash.h rte_ring.h - cmdline_socket.h rte_interrupts.h rte_rwlock.h - cmdline_vt100.h rte_ip.h rte_sctp.h - exec-env rte_jhash.h rte_spinlock.h - rte_alarm.h rte_launch.h rte_string_fns.h - rte_atomic.h rte_lcore.h rte_tailq.h - rte_branch_prediction.h rte_log.h rte_tcp.h - rte_byteorder.h rte_lpm.h rte_timer.h - rte_common.h rte_malloc.h rte_udp.h - rte_config.h rte_mbuf.h - +Each build directory contains include files, libraries, and applications. A build directory is specific to a configuration that includes architecture + execution environment + toolchain. It is possible to have several build directories sharing the same sources with different configurations.