From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mail-wm0-f52.google.com (mail-wm0-f52.google.com [74.125.82.52]) by dpdk.org (Postfix) with ESMTP id 9EBD937A6 for ; Sun, 13 Dec 2015 23:36:37 +0100 (CET) Received: by mail-wm0-f52.google.com with SMTP id n186so95661858wmn.1 for ; Sun, 13 Dec 2015 14:36:37 -0800 (PST) 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:organization:user-agent :in-reply-to:references:mime-version:content-transfer-encoding :content-type; bh=qa1wKNHmvbpl0WwhFKHUjtvvN0JH8ne+Z1SmybE3Jak=; b=mqF8VIeo9Azwest8lzxMEGL9mw1JB4ntPEiKBY/V5IwdRfXFq06sELWneHli8Ux4O2 0CSYH5mfAdUgBDn3sl0IPp8YdkVPdvNGZWnN68tave5dJWQNNmzVnkpc2/yxLdiVHV2W 7ERINOgwcfaGRJPhrBR7B51YKU0Nc3QB/besR2gpfl+LDYDqfmGDgoojzqYtdhBn90zZ 7h04IAMI5BFxeOucUP4ffVrLR5B0zGpgAv7EBJ5MLDFNL2xDlDOlqwkqEaZpA8qW5JLL Di+u2v+ruTC0Sg0zmK+g/Tb/JgIRuXWmJ3SCL+ScDD1y9wK10KteQMtPRfPSd9w9IlFE iP+g== 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:organization :user-agent:in-reply-to:references:mime-version :content-transfer-encoding:content-type; bh=qa1wKNHmvbpl0WwhFKHUjtvvN0JH8ne+Z1SmybE3Jak=; b=hCrcQ6TuSLu3Xc4LyoLqqkt/odhZ8TBwfeoH2Qv6VP6+4Say17zsmGoOdp8O6M7QD2 w7RzITZ/f1Uxt5z77fzEVoO4Y0FgfRWOWuEWvyLftfOyOZKtqxrSm9Ftf9xjCDtaFiHK W8NiWTKNBwyyUCtBDGTxFyTUoX3gjn1C3PAavFV8uOW3H/Jw1/V638n7g6vZsNKBr5C2 28TkrSpcUxKnJykpV2WVQz+g2OQL2choXWlxxbtdPp1hJi5QDK61b3i9S0oJdg3NB7tz /sRHfoWZ6cykIouJcuEBiPeG3yDIGPoeCse7AXsjLbjkFCR3X/gYZG2pEbFzCWgHlFsL cNdg== X-Gm-Message-State: ALoCoQm9Lb4eERp5IzLG2a7Y1QZIbLkpGxdCBpxrarG1gMQDq/VVlmE5uuD4QVyY8ykCUV0h4EatC2m86TqlbtSffczWBUuRNA== X-Received: by 10.28.171.135 with SMTP id u129mr16741405wme.99.1450046197444; Sun, 13 Dec 2015 14:36:37 -0800 (PST) Received: from xps13.localnet (136-92-190-109.dsl.ovh.fr. [109.190.92.136]) by smtp.gmail.com with ESMTPSA id ql10sm27014264wjc.23.2015.12.13.14.36.35 (version=TLSv1/SSLv3 cipher=OTHER); Sun, 13 Dec 2015 14:36:36 -0800 (PST) From: Thomas Monjalon To: John McNamara Date: Sun, 13 Dec 2015 23:35:20 +0100 Message-ID: <1559545.nMrvn59G5L@xps13> Organization: 6WIND User-Agent: KMail/4.14.10 (Linux/4.1.6-1-ARCH; KDE/4.14.11; x86_64; ; ) In-Reply-To: <1448023573-25103-1-git-send-email-john.mcnamara@intel.com> References: <1444927893-19845-1-git-send-email-john.mcnamara@intel.com> <1448023573-25103-1-git-send-email-john.mcnamara@intel.com> MIME-Version: 1.0 Content-Transfer-Encoding: 7Bit Content-Type: text/plain; charset="us-ascii" Cc: dev@dpdk.org Subject: Re: [dpdk-dev] [PATCH v4] doc: add contributors guide 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: , X-List-Received-Date: Sun, 13 Dec 2015 22:36:37 -0000 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