DPDK patches and discussions
 help / color / mirror / Atom feed
From: "Kovacevic, Marko" <marko.kovacevic@intel.com>
To: Gavin Hu <gavin.hu@arm.com>, "dev@dpdk.org" <dev@dpdk.org>
Subject: Re: [dpdk-dev] [PATCH v2 2/2] doc: add a guide doc for cross compiling	from x86
Date: Mon, 28 May 2018 16:01:24 +0000	[thread overview]
Message-ID: <6DC05C7C5F25994B81B3F2F214251F6601FE5F26@IRSMSX104.ger.corp.intel.com> (raw)
In-Reply-To: <1527490428-15540-2-git-send-email-gavin.hu@arm.com>

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

  parent reply	other threads:[~2018-05-28 16:01 UTC|newest]

Thread overview: 59+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-05-24  3:38 [dpdk-dev] [PATCH 0/2] *** gcc cross compile dpdk *** Gavin Hu
2018-05-24  3:38 ` [dpdk-dev] [PATCH 1/2] mk: fix cross build errors Gavin Hu
2018-05-24 13:46   ` [dpdk-dev] [dpdk-stable] " Thomas Monjalon
2018-05-25  7:53     ` Gavin Hu
2018-05-24  3:38 ` [dpdk-dev] [PATCH 2/2] doc: add a guide doc for cross compiling from x86 Gavin Hu
2018-05-24 10:45   ` Kovacevic, Marko
2018-05-24 10:47     ` Kovacevic, Marko
2018-05-24 11:17   ` Jerin Jacob
2018-05-24 13:20     ` Bruce Richardson
2018-05-25  7:00       ` Gavin Hu
2018-05-24 13:54     ` Thomas Monjalon
2018-05-24 17:16       ` Jerin Jacob
2018-05-24 20:31         ` Thomas Monjalon
2018-05-28  6:53 ` [dpdk-dev] [PATCH v2 1/2] mk: fix cross build errors Gavin Hu
2018-05-28  6:53   ` [dpdk-dev] [PATCH v2 2/2] doc: add a guide doc for cross compiling from x86 Gavin Hu
2018-05-28 13:25     ` Bruce Richardson
2018-05-29  1:24       ` Gavin Hu
2018-05-28 16:01     ` Kovacevic, Marko [this message]
2018-05-28 13:24   ` [dpdk-dev] [PATCH v2 1/2] mk: fix cross build errors Bruce Richardson
2018-05-29  1:22     ` Gavin Hu
2018-05-29 14:45     ` [dpdk-dev] [dpdk-stable] " Thomas Monjalon
2018-05-29 15:00       ` Bruce Richardson
2018-05-29 16:20         ` Gavin Hu
2018-05-29 19:53           ` Thomas Monjalon
2018-05-29  6:51   ` [dpdk-dev] [PATCH v3 " Gavin Hu
2018-05-29  6:51     ` [dpdk-dev] [PATCH v3 2/2] doc: add a guide doc for cross compiling from x86 Gavin Hu
2018-05-29  7:21     ` [dpdk-dev] [PATCH v4 0/2] *** cross gcc fix and guide doc *** Gavin Hu
2018-05-29  7:21       ` [dpdk-dev] [PATCH v4 1/2] mk: fix cross build errors Gavin Hu
2018-05-29  7:21       ` [dpdk-dev] [PATCH v4 2/2] doc: add a guide doc for cross compiling from x86 Gavin Hu
2018-05-29  8:39         ` Kovacevic, Marko
2018-05-29 10:43       ` [dpdk-dev] [PATCH v5 0/2] *** cross gcc compile fix and add a guide doc *** Gavin Hu
2018-05-29 10:43         ` [dpdk-dev] [PATCH v5 1/2] mk: fix cross build errors Gavin Hu
2018-05-29 15:09           ` [dpdk-dev] [dpdk-stable] " Thomas Monjalon
2018-05-29 10:43         ` [dpdk-dev] [PATCH v5 2/2] doc: add a guide doc for cross compiling from x86 Gavin Hu
2018-05-29 13:33           ` Kovacevic, Marko
2018-05-30 19:16           ` Thomas Monjalon
2018-05-30 19:35           ` Jerin Jacob
2018-06-04  6:03             ` Gavin Hu
2018-06-04 12:50               ` Jerin Jacob
2018-06-12  1:27                 ` Gavin Hu
2018-06-12 12:06                   ` Gavin Hu
2018-06-12 12:11                     ` Thomas Monjalon
2018-06-14  9:51         ` [dpdk-dev] [PATCH v6 0/7] *** fix the cross compile errors *** Gavin Hu
2018-06-14  9:51           ` [dpdk-dev] [PATCH v6 1/7] mk: fix cross build errors Gavin Hu
2018-06-14  9:51           ` [dpdk-dev] [PATCH v6 2/7] doc: add a guide doc for cross compiling from x86 Gavin Hu
2018-06-14  9:51           ` [dpdk-dev] [PATCH v6 3/7] devtools: fix the Exec format error Gavin Hu
2018-06-14 10:34             ` Bruce Richardson
2018-06-15  8:07               ` Gavin Hu
2018-06-14  9:51           ` [dpdk-dev] [PATCH v6 4/7] build: fix the meson build warning Gavin Hu
2018-06-14 10:34             ` Bruce Richardson
2018-06-14  9:51           ` [dpdk-dev] [PATCH v6 5/7] devtools: fix the missing ninja command error on CentOS Gavin Hu
2018-06-14 10:40             ` Bruce Richardson
2018-06-15  8:08               ` Gavin Hu
2018-06-14  9:51           ` [dpdk-dev] [PATCH v6 6/7] build: fix the meson cross compile error Gavin Hu
2018-06-14 10:42             ` Bruce Richardson
2018-06-14  9:51           ` [dpdk-dev] [PATCH v6 7/7] devtools: expand meson cross compiling coverage Gavin Hu
2018-06-14 10:45             ` Bruce Richardson
2018-06-15  8:09               ` Gavin Hu
2018-06-15 10:23               ` Gavin Hu

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=6DC05C7C5F25994B81B3F2F214251F6601FE5F26@IRSMSX104.ger.corp.intel.com \
    --to=marko.kovacevic@intel.com \
    --cc=dev@dpdk.org \
    --cc=gavin.hu@arm.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).