From patchwork Wed Dec 9 16:23:35 2015 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: "Van Haaren, Harry" X-Patchwork-Id: 9440 Return-Path: X-Original-To: patchwork@dpdk.org Delivered-To: patchwork@dpdk.org Received: from [92.243.14.124] (localhost [IPv6:::1]) by dpdk.org (Postfix) with ESMTP id 3A8175952; Wed, 9 Dec 2015 17:24:13 +0100 (CET) Received: from mga02.intel.com (mga02.intel.com [134.134.136.20]) by dpdk.org (Postfix) with ESMTP id 23E3D568F for ; Wed, 9 Dec 2015 17:24:10 +0100 (CET) Received: from orsmga001.jf.intel.com ([10.7.209.18]) by orsmga101.jf.intel.com with ESMTP; 09 Dec 2015 08:24:08 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.20,404,1444719600"; d="scan'208";a="837742812" Received: from sie-lab-212-222.ir.intel.com (HELO silpixa00366884.ir.intel.com) ([10.237.212.222]) by orsmga001.jf.intel.com with ESMTP; 09 Dec 2015 08:23:39 -0800 From: Harry van Haaren To: dev@dpdk.org Date: Wed, 9 Dec 2015 16:23:35 +0000 Message-Id: <1449678215-25698-1-git-send-email-harry.van.haaren@intel.com> X-Mailer: git-send-email 1.9.1 Subject: [dpdk-dev] [PATCH] doc: add patch submit cheatsheet 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: , Errors-To: dev-bounces@dpdk.org Sender: "dev" This patch adds the patch submission cheatsheet to the contributers guide. Both HTML and PDF docs show the cheatsheet on its own page. Right clicking the SVG image in the HTML doc allows for viewing the image on its own, useful for printing in high quality. The exact appearance of of the cheatsheet will depend on the default monospace font installed. Signed-off-by: Harry van Haaren --- doc/guides/contributing/img/patch_cheatsheet.svg | 1404 ++++++++++++++++++++++ doc/guides/contributing/index.rst | 1 + 2 files changed, 1405 insertions(+) create mode 100644 doc/guides/contributing/img/patch_cheatsheet.svg diff --git a/doc/guides/contributing/img/patch_cheatsheet.svg b/doc/guides/contributing/img/patch_cheatsheet.svg new file mode 100644 index 0000000..716df89 --- /dev/null +++ b/doc/guides/contributing/img/patch_cheatsheet.svg @@ -0,0 +1,1404 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + image/svg+xml + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + CHEATSHEET + PATCH SUBMIT + + + + + + Patch Pre-Checks + Commit Pre-Checks + Bugfix? + Git send-email + + + Compile Pre-Checks + + + Include warning/error + + Fixes line + + How to reproduce + + + Patch version ( eg: -v2 ) + + Patch version annotations + + Send --to maintainer + + Send --cc dev@dpdk.org + + + + build gcc icc clang + + make test + + make doc + + make examples + + make shared-lib + + library ABI version + + build 32 and 64 bits + + + + Cover letter + git send-email -N --to <maintainer> --cc dev@dpdk.org --annotate [ --cover-letter --cc other@participants.com -v[N] --in-reply-to <message ID> ] + harry.van.haaren@intel.com + + Suggestions / Updates? + + + Send --in-reply-to <message ID> + **** + + v1.0 + + + + + + + + + Signed-off-by: + + Suggested-by: + + Reported-by: + + Tested-by: + + + Previous Acks + * + + + Commit message + + + Mailing List + + Acked-by: + + Reviewed-by: + Nack (refuse patch) + + + + Tested-by: + + Previous Acks only when fixing typos, rebased, or checkpatch issues. + * + + + The version.map function names must be in alphabetical order. + * + * + + + + + Rebase to git + + Checkpatch + + ABI breakage + + Maintainers file + + Release notes + + Documentation + + + ** + + + Update version.map + + + + Doxygen + + *** + + + + + + + + * + * + * + New header files must get a new page in the API docs. + + + Available from patchwork, or email header. Reply to Cover letters. + * + * + * + * + + + + diff --git a/doc/guides/contributing/index.rst b/doc/guides/contributing/index.rst index 561427b..8dadb20 100644 --- a/doc/guides/contributing/index.rst +++ b/doc/guides/contributing/index.rst @@ -9,3 +9,4 @@ Contributor's Guidelines design versioning documentation + cheatsheet