From: Thomas Monjalon <thomas.monjalon@6wind.com>
To: John McNamara <john.mcnamara@intel.com>
Cc: dev@dpdk.org
Subject: Re: [dpdk-dev] [PATCH v4] doc: add contributors guide
Date: Sun, 13 Dec 2015 23:35:20 +0100 [thread overview]
Message-ID: <1559545.nMrvn59G5L@xps13> (raw)
In-Reply-To: <1448023573-25103-1-git-send-email-john.mcnamara@intel.com>
Thanks for this very useful doc, John.
2015-11-20 12:46, John McNamara:
> +* Run ``make install``, ``make examples`` and ``make test`` and build the shared and combined libraries
> + to ensure the changes haven't broken existing code:
> +
> + .. code-block:: console
> +
> + export RTE_TARGET=x86_64-native-linuxapp-gcc
> +
> + make T=$RTE_TARGET install
> + make T=$RTE_TARGET install CONFIG_RTE_BUILD_SHARED_LIB=y \
> + CONFIG_RTE_BUILD_COMBINE_LIBS=y
> + make T=$RTE_TARGET examples
> + make T=$RTE_TARGET test
These commands are superseded by a new syntax and may be replaced by the use
of the script test-build.sh.
> +* Use the imperative of the verb (like instructions to the code base).
> + For example::
> +
> + ixgbe: fix compilarion in 32 bit
Typo.
This example is not needed (there is one above).
> +The kernel guidelines tested by ``checkpatch`` don't match the DPDK Coding Style guidelines exactly but
> +they provide a good indication of conformance.
> +Warnings about kernel data types or about split strings can be ignored::
> +
> + /path/checkpatch.pl --ignore PREFER_KERNEL_TYPES,SPLIT_STRING -q files*.patch
The script checkpatches.sh should be used. It includes a list of options to ignore.
> +Ensure that the code compiles with ``gcc`` and ``clang``::
> +
> + make T=x86_64-native-linuxapp-gcc install
> + make T=x86_64-native-linuxapp-clang install
It may be done with
scripts/test-build.sh x86_64-native-linuxapp-gcc x86_64-native-linuxapp-clang
My preferred configs are:
x86_64-native-linuxapp-gcc+shared+next
x86_64-native-linuxapp-clang+shared+combined
i686-native-linuxapp-gcc+combined
And these options are common:
export DPDK_DEP_ZLIB=y
export DPDK_DEP_PCAP=y
export DPDK_DEP_SSL=y
> +Confirm that the changes haven't broken any existing code by running ``make install``, ``make examples`` and
> +``make test`` and building the shared and combined libraries:
> +
> + .. code-block:: console
> +
> + export RTE_TARGET=x86_64-native-linuxapp-gcc
> +
> + make T=$RTE_TARGET install
> + make T=$RTE_TARGET install CONFIG_RTE_BUILD_SHARED_LIB=y \
> + CONFIG_RTE_BUILD_COMBINE_LIBS=y
> + make T=$RTE_TARGET examples
> + make T=$RTE_TARGET test
next prev parent reply other threads:[~2015-12-13 22:36 UTC|newest]
Thread overview: 14+ messages / expand[flat|nested] mbox.gz Atom feed top
2015-10-15 16:51 [dpdk-dev] [PATCH] add a dpdk " John McNamara
2015-10-15 16:51 ` [dpdk-dev] [PATCH] doc: add " John McNamara
2015-10-15 21:36 ` Thomas Monjalon
2015-10-20 10:58 ` Mcnamara, John
2015-10-20 11:03 ` [dpdk-dev] [PATCH v2] " John McNamara
2015-10-23 10:18 ` [dpdk-dev] [PATCH v3] " John McNamara
2015-11-18 13:38 ` Van Haaren, Harry
2015-11-20 12:46 ` [dpdk-dev] [PATCH v4] " John McNamara
2015-12-13 22:35 ` Thomas Monjalon [this message]
2015-12-14 9:31 ` Mcnamara, John
2015-12-14 20:32 ` [dpdk-dev] [PATCH v2] " John McNamara
2015-12-14 20:46 ` Mcnamara, John
2015-12-14 20:45 ` [dpdk-dev] [PATCH v5] " John McNamara
2015-12-14 22:15 ` Thomas Monjalon
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=1559545.nMrvn59G5L@xps13 \
--to=thomas.monjalon@6wind.com \
--cc=dev@dpdk.org \
--cc=john.mcnamara@intel.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).