From patchwork Tue Jul 15 17:01:18 2014 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Mike Holmes X-Patchwork-Id: 33675 Return-Path: X-Original-To: linaro@patches.linaro.org Delivered-To: linaro@patches.linaro.org Received: from mail-qc0-f198.google.com (mail-qc0-f198.google.com [209.85.216.198]) by ip-10-151-82-157.ec2.internal (Postfix) with ESMTPS id 81006201F1 for ; Tue, 15 Jul 2014 17:01:45 +0000 (UTC) Received: by mail-qc0-f198.google.com with SMTP id l6sf21225455qcy.1 for ; Tue, 15 Jul 2014 10:01:45 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:delivered-to:from:to:date:message-id:subject :precedence:list-id:list-unsubscribe:list-archive:list-post :list-help:list-subscribe:mime-version:errors-to:sender :x-original-sender:x-original-authentication-results:mailing-list :content-type:content-transfer-encoding; bh=qOjgw0fLg/ZiqrIa9/dtIfee8WoHhWBgfq+8VtioGME=; b=JKzeoeD2i8YASd3FQ8PivRPk2pfAb9NqnjzhaPgO8dY8ZI6joQ1zQwoIF9aAAg7b6g fjHTgtgyoYJHYwELHSTXBsK55xiyzRe6g6eRnLqCrSDKuHOvhFin3QAt7BMX5WmKk6ex SQpYpFOhyRA1HbfLf/ynrWHYGPRPPuhqvPWrZ7fYfz16IPbYUozDItlwovHPUXxK1hlx L33QRxJxQJu8syIZBNqc4lMzidV7E9M8aer+1UtW1v0W6BgaVcRnoCrVPBGALojZNn+x vqbHpWcAKa5ih8Mjpolu/E1k7YePsr7xdIQ7UpBA7mi8LalvvGaGD5Qv6Q1BCw75R9o4 1Yag== X-Gm-Message-State: ALoCoQks3ZODiBh6kzNIezlZOcbNn6RtBTi5/Jgt/X/XJnUDkv+dEn7Ep9skXzXG16jJ2dJQ9ATF X-Received: by 10.58.94.166 with SMTP id dd6mr11768213veb.12.1405443705264; Tue, 15 Jul 2014 10:01:45 -0700 (PDT) X-BeenThere: patchwork-forward@linaro.org Received: by 10.140.96.6 with SMTP id j6ls157055qge.89.gmail; Tue, 15 Jul 2014 10:01:45 -0700 (PDT) X-Received: by 10.220.99.66 with SMTP id t2mr2219331vcn.40.1405443705178; Tue, 15 Jul 2014 10:01:45 -0700 (PDT) Received: from mail-vc0-f177.google.com (mail-vc0-f177.google.com [209.85.220.177]) by mx.google.com with ESMTPS id dr20si7050086veb.59.2014.07.15.10.01.45 for (version=TLSv1 cipher=ECDHE-RSA-RC4-SHA bits=128/128); Tue, 15 Jul 2014 10:01:45 -0700 (PDT) Received-SPF: pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.220.177 as permitted sender) client-ip=209.85.220.177; Received: by mail-vc0-f177.google.com with SMTP id hy4so4078552vcb.8 for ; Tue, 15 Jul 2014 10:01:45 -0700 (PDT) X-Received: by 10.220.15.8 with SMTP id i8mr2193616vca.45.1405443705098; Tue, 15 Jul 2014 10:01:45 -0700 (PDT) X-Forwarded-To: patchwork-forward@linaro.org X-Forwarded-For: patch@linaro.org patchwork-forward@linaro.org Delivered-To: patch@linaro.org Received: by 10.221.37.5 with SMTP id tc5csp230401vcb; Tue, 15 Jul 2014 10:01:44 -0700 (PDT) X-Received: by 10.140.80.19 with SMTP id b19mr35342126qgd.102.1405443704561; Tue, 15 Jul 2014 10:01:44 -0700 (PDT) Received: from ip-10-141-164-156.ec2.internal (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTPS id w2si21485234qag.33.2014.07.15.10.01.37 for (version=TLSv1 cipher=RC4-SHA bits=128/128); Tue, 15 Jul 2014 10:01:44 -0700 (PDT) Received-SPF: none (google.com: lng-odp-bounces@lists.linaro.org does not designate permitted sender hosts) client-ip=54.225.227.206; Received: from localhost ([127.0.0.1] helo=ip-10-141-164-156.ec2.internal) by ip-10-141-164-156.ec2.internal with esmtp (Exim 4.76) (envelope-from ) id 1X764O-0003Wm-BX; Tue, 15 Jul 2014 16:59:12 +0000 Received: from mail-qg0-f48.google.com ([209.85.192.48]) by ip-10-141-164-156.ec2.internal with esmtp (Exim 4.76) (envelope-from ) id 1X764I-0003We-Eo for lng-odp@lists.linaro.org; Tue, 15 Jul 2014 16:59:06 +0000 Received: by mail-qg0-f48.google.com with SMTP id i50so2307071qgf.7 for ; Tue, 15 Jul 2014 10:01:26 -0700 (PDT) X-Received: by 10.224.130.5 with SMTP id q5mr33839510qas.72.1405443686302; Tue, 15 Jul 2014 10:01:26 -0700 (PDT) Received: from fedora1.holmesfamily.ws (c-98-221-136-245.hsd1.nj.comcast.net. [98.221.136.245]) by mx.google.com with ESMTPSA id m1sm26824607qaz.27.2014.07.15.10.01.25 for (version=TLSv1.2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Tue, 15 Jul 2014 10:01:25 -0700 (PDT) From: Mike Holmes To: lng-odp@lists.linaro.org Date: Tue, 15 Jul 2014 13:01:18 -0400 Message-Id: <1405443678-24004-1-git-send-email-mike.holmes@linaro.org> X-Mailer: git-send-email 1.9.1 X-Topics: Architecture patch Subject: [lng-odp] [PATCH ARCH] Add contributing instructions to the Arch document X-BeenThere: lng-odp@lists.linaro.org X-Mailman-Version: 2.1.14 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: , List-Help: , List-Subscribe: , MIME-Version: 1.0 Errors-To: lng-odp-bounces@lists.linaro.org Sender: lng-odp-bounces@lists.linaro.org X-Removed-Original-Auth: Dkim didn't pass. X-Original-Sender: mike.holmes@linaro.org X-Original-Authentication-Results: mx.google.com; spf=pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.220.177 as permitted sender) smtp.mail=patch+caf_=patchwork-forward=linaro.org@linaro.org Mailing-list: list patchwork-forward@linaro.org; contact patchwork-forward+owners@linaro.org X-Google-Group-Id: 836684582541 Signed-off-by: Mike Holmes --- CONTRIBUTING | 45 +++++++++++++++++++++++++++++++++++++++++++++ Doxyfile.in | 1 + contributing.dox | 13 +++++++++++++ 3 files changed, 59 insertions(+) create mode 100644 CONTRIBUTING create mode 100644 contributing.dox diff --git a/CONTRIBUTING b/CONTRIBUTING new file mode 100644 index 0000000..cdcefc2 --- /dev/null +++ b/CONTRIBUTING @@ -0,0 +1,45 @@ + Contributing to the OpenDataplane (ODP) API Architecture + + Changes or additions should be a patch to this repository and should be +sent to "lng-odp@lists.linaro.org" with the subject containing PATCH and ARCH, +this can be archived with the following if it were the 4th version of the patch + 'git format-patch --subject-prefix="PATCHv4 ARCHi"' + + To certify you wrote the text, or otherwise have the right to pass it +on (presumably from a compatibly licensed project), we use the "Developer's +Certificate of Origin" (see [1]). Using this sign-off process, we are able to +keep track of compliance to our license (see LICENSE file). + + There must be no trailing whitespace "git am " will high light +these issues, vi, emacs etc all have tools to clean this up automatically + + No additional manual flow formatting should be included, for example +adding "\n\n" add spaces, generally indicates that it would be better to use +lists, modules, pages or sections and subsections are really what is required. + + Doxygen will concatenate sentences placed on consecutive lines so that they +flow as a single paragraph, this allows git to see changes on a per sentence +level which much clearer diff results between revisions. + + Thus the text should be structured like this: + + "This is a sentence. + And this is another one." + + and not like this: + + "This is a sentence. And this is another one." + + The "@" symbol should be used to mark Doxygen special commands + + Images are stored in the images directory in png format and must have a png and eps version +so that they render correctly for the html and pdf documents. For example +an image called syncmodels will be found in the images directory +as syncmodels.png & syncmodels.eps. The correct reference to these images is +then provided with: + +@image html syncmodels.png "Figure 1: Synchronization Models" +@image latex syncmodels.eps "Figure 1: Synchronization Models" width=\textwidth + + +[1] https://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/tree/Documentation/SubmittingPatches diff --git a/Doxyfile.in b/Doxyfile.in index d8aec46..728474e 100644 --- a/Doxyfile.in +++ b/Doxyfile.in @@ -13,3 +13,4 @@ PROJECT_LOGO = images/ODP-Logo-HQ.png IMAGE_PATH = images INPUT = . FULL_PATH_NAMES = NO +EXAMPLE_PATH = . diff --git a/contributing.dox b/contributing.dox new file mode 100644 index 0000000..1214ca0 --- /dev/null +++ b/contributing.dox @@ -0,0 +1,13 @@ +/* Copyright (c) 2013, Linaro Limited + * All rights reserved + * + * SPDX-License-Identifier: BSD-3-Clause + */ + +/** +@page Contributing + +@verbinclude CONTRIBUTING + + +*/