diff mbox series

[v2,37/37] doc: update quick build doc to remove make references

Message ID 20200820124140.13451-38-ciara.power@intel.com (mailing list archive)
State Superseded, archived
Delegated to: Thomas Monjalon
Headers
Series remove make support in DPDK |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation fail Compilation issues

Commit Message

Power, Ciara Aug. 20, 2020, 12:41 p.m. UTC 
  Make is no longer supported for compiling DPDK, references are now
removed in the documentation.

Signed-off-by: Ciara Power <ciara.power@intel.com>
---
 doc/build-sdk-quick.txt | 55 ++++++++++++++++-------------------------
 1 file changed, 21 insertions(+), 34 deletions(-)

Comments

Kevin Laatz Sept. 2, 2020, 11:08 a.m. UTC | #1 
On 20/08/2020 13:41, Ciara Power wrote:
> Make is no longer supported for compiling DPDK, references are now
> removed in the documentation.
>
> Signed-off-by: Ciara Power <ciara.power@intel.com>
> ---
>   doc/build-sdk-quick.txt | 55 ++++++++++++++++-------------------------
>   1 file changed, 21 insertions(+), 34 deletions(-)
>
Reviewed-by: Kevin Laatz <kevin.laatz@intel.com>
diff mbox series

Patch

diff --git a/doc/build-sdk-quick.txt b/doc/build-sdk-quick.txt
index bcfa7d6fe1..423104094e 100644
--- a/doc/build-sdk-quick.txt
+++ b/doc/build-sdk-quick.txt
@@ -1,34 +1,21 @@ 
-Basic build
-	make defconfig && make
-	or
-	make config T=x86_64-native-linux-gcc && make
-Build commands
-	config           get configuration from target template (T=)
-	defconfig        auto-select target template based on arch, OS, etc.
-	all              same as build (default rule)
-	build            build in a configured directory
-	clean            remove files but keep configuration
-	install T=       configure, build and install a target in DESTDIR
-	install          install optionally staged in DESTDIR
-	examples         build examples for given targets (T=)
-	examples_clean   clean examples for given targets (T=)
-	test             compile tests and run basic unit tests
-	test-*           run specific subset of unit tests
-	tags|etags|gtags generate tags database for given targets (T=)
-	cscope           generate cscope database for given targets (T=)
-Build variables
-	EXTRA_CPPFLAGS   preprocessor options
-	EXTRA_CFLAGS     compiler options
-	EXTRA_LDFLAGS    linker options
-	EXTRA_LDLIBS     linker library options
-	RTE_KERNELDIR    linux headers path
-	RTE_DEVEL_BUILD  stricter options (default: y in git tree)
-	CROSS     toolchain prefix
-	V         verbose
-	D         debug dependencies
-	O         build directory (default: build/ - install T= default: ./)
-	DESTDIR   staging install directory (default: empty)
-	prefix    root install directory (default: /usr/local)
-	T         target template - used with config or install
-			format: <arch-machine-execenv-toolchain>
-			templates in config/defconfig_*
+For many platforms, compiling and installing DPDK should work using the
+following set of commands::
+
+	meson build
+	cd build
+	ninja
+	ninja install
+
+This will compile DPDK in the ``build`` subdirectory, and then install the
+resulting libraries, drivers and header files onto the system - generally
+in /usr/local. A package-config file, ``libdpdk.pc``,  for DPDK will also
+be installed to allow ease of compiling and linking with applications.
+
+After installation, to use DPDK, the necessary CFLAG and LDFLAG variables
+can be got from pkg-config::
+
+	pkg-config --cflags libdpdk
+	pkg-config --libs libdpdk
+
+More detail on each of these steps can be got from the
+"Installing DPDK Using the meson build system" section of the programming guides.