[dpdk-dev] [PATCH v2 2/2] doc: add a guide doc for cross compiling from x86

Kovacevic, Marko marko.kovacevic at intel.com
Mon May 28 18:01:24 CEST 2018


> This is guild for cross compiling for ARM64 from X86 hosts.
> 
> Signed-off-by: Gavin Hu <gavin.hu at arm.com>
> Reviewed-by: Steve Capper <Steve.Capper at arm.com>
> Reviewed-by: Honnappa Nagarahalli <Honnappa.Nagarahalli at arm.com>
> Reviewed-by: Marko Kovacevic <marko.kovacevic at intel.com>
> Reviewed-by: Jerin Jacob <jerin.jacob at caviumnetworks.com>
> Reviewed-by: Thomas Monjalon <thomas at monjalon.net>
> Reviewed-by: Bruce Richardson <bruce.richardson at intel.com>
> ---

Hi Gavin,

After reviewing your file in the .rst format it doesn't look good, the whole formatting is wrong and
unreadable. As you have the wrong headers and sections. You have code block and command line arguments 
added in everywhere making it not look good. Also you have added an index to a file in the howto that doesn't exist.

dpdk/doc/guides/howto/index.rst:7: WARNING: toctree contains reference to nonexisting document u'howto/    cross_compile_sdk_for_arm64'
dpdk/doc/guides/linux_gsg/index.rst:9: WARNING: toctree contains reference to nonexisting document u'linux_gsg/    cross_build_dpdk_for_arm64'
dpdk/doc/guides/linux_gsg/cross_build_dpdk_for_arm64.rst: WARNING: document isn't included in any toctree

Id advise you go to this link and familiarize yourself with the proper way of writing in the rst format.
And also try and view the html version of your file before you send it out to make sure it looks ok.

If you adding command line arguments into text use this ``make -j CROSS=aarch64-linux-gnu- CONFIG_RTE_KNI_KMOD=n CONFIG_RTE_EAL_IGB_UIO=n``

http://dpdk.org/doc/guides/contributing/documentation.html

Marko K



More information about the dev mailing list