From patchwork Tue Jul 15 18:15:57 2014 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Mike Holmes X-Patchwork-Id: 33696 Return-Path: X-Original-To: linaro@patches.linaro.org Delivered-To: linaro@patches.linaro.org Received: from mail-vc0-f198.google.com (mail-vc0-f198.google.com [209.85.220.198]) by ip-10-151-82-157.ec2.internal (Postfix) with ESMTPS id 5CA8520CAD for ; Tue, 15 Jul 2014 18:16:18 +0000 (UTC) Received: by mail-vc0-f198.google.com with SMTP id hu12sf11356562vcb.9 for ; Tue, 15 Jul 2014 11:16:18 -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=l+v+XOBiG3rOllCa6ZhIDIEs2FLkS0uWB5bllWYAEGg=; b=heV9Fx1ZQsiLBqaP4aisVGwa0YHfMBo8Z9xW7nk9DPHwloi3zqfVfMofkp1OHQicJY KXt3mV7MJIarGPfjtaHFYmUxs4+EGRV31XYkWcs7uy5JA85MIqGVW08p2JUkCOoZ69wa 9xmHcMQQn2JM3e59EhfOc78u5Vrl/c1GOWFCZg5eVtxYDe3n3oM9JtIrSxVIfVhQ+0iz D3aNyQ+sRdQu1iYsy5Yym2dS/3fnkFQ1nBgumXbCP4X0lVL5/KI06GMAeE3Jh1PCXtiu O/W4gT3/D0axQCEblFoTJ7n6tnoVpuY8AbS/C5NCmFzCcj5Y/Ja1yo8Y7HO/R+yu9zsO 74NA== X-Gm-Message-State: ALoCoQlPlbZnAiY6Z+udpO5B+eNe2zEFCoNR+L3NBtWA6qMgKGkAGGY40y3PwbXdPTf00guFknoX X-Received: by 10.236.66.171 with SMTP id h31mr1090884yhd.21.1405448178181; Tue, 15 Jul 2014 11:16:18 -0700 (PDT) X-BeenThere: patchwork-forward@linaro.org Received: by 10.140.44.75 with SMTP id f69ls172586qga.96.gmail; Tue, 15 Jul 2014 11:16:18 -0700 (PDT) X-Received: by 10.221.59.194 with SMTP id wp2mr2489986vcb.59.1405448178103; Tue, 15 Jul 2014 11:16:18 -0700 (PDT) Received: from mail-vc0-f182.google.com (mail-vc0-f182.google.com [209.85.220.182]) by mx.google.com with ESMTPS id ut6si7173983veb.11.2014.07.15.11.16.18 for (version=TLSv1 cipher=ECDHE-RSA-RC4-SHA bits=128/128); Tue, 15 Jul 2014 11:16:18 -0700 (PDT) Received-SPF: pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.220.182 as permitted sender) client-ip=209.85.220.182; Received: by mail-vc0-f182.google.com with SMTP id hy4so1222165vcb.13 for ; Tue, 15 Jul 2014 11:16:18 -0700 (PDT) X-Received: by 10.52.244.81 with SMTP id xe17mr20017396vdc.24.1405448177994; Tue, 15 Jul 2014 11:16:17 -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 tc5csp235274vcb; Tue, 15 Jul 2014 11:16:17 -0700 (PDT) X-Received: by 10.140.86.116 with SMTP id o107mr36117153qgd.14.1405448177530; Tue, 15 Jul 2014 11:16:17 -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 z66si22045954qgd.33.2014.07.15.11.16.16 for (version=TLSv1 cipher=RC4-SHA bits=128/128); Tue, 15 Jul 2014 11:16:17 -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 1X77Ed-0005AJ-78; Tue, 15 Jul 2014 18:13:51 +0000 Received: from mail-qa0-f53.google.com ([209.85.216.53]) by ip-10-141-164-156.ec2.internal with esmtp (Exim 4.76) (envelope-from ) id 1X77EX-0005AE-CV for lng-odp@lists.linaro.org; Tue, 15 Jul 2014 18:13:45 +0000 Received: by mail-qa0-f53.google.com with SMTP id v10so4876894qac.12 for ; Tue, 15 Jul 2014 11:16:05 -0700 (PDT) X-Received: by 10.229.178.202 with SMTP id bn10mr38554038qcb.6.1405448165281; Tue, 15 Jul 2014 11:16:05 -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 98sm14943333qgh.5.2014.07.15.11.16.04 for (version=TLSv1.2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Tue, 15 Jul 2014 11:16:04 -0700 (PDT) From: Mike Holmes To: lng-odp@lists.linaro.org Date: Tue, 15 Jul 2014 14:15:57 -0400 Message-Id: <1405448157-24524-1-git-send-email-mike.holmes@linaro.org> X-Mailer: git-send-email 1.9.1 X-Topics: Architecture patch Subject: [lng-odp] [PATCHv2 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.182 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 | 46 ++++++++++++++++++++++++++++++++++++++++++++++ Doxyfile.in | 1 + contributing.dox | 12 ++++++++++++ 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..3b985d4 --- /dev/null +++ b/CONTRIBUTING @@ -0,0 +1,46 @@ + 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 ARCH"' + + 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, space before tabs or trailing newlines +"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..a6e28fd --- /dev/null +++ b/contributing.dox @@ -0,0 +1,12 @@ +/* Copyright (c) 2013, Linaro Limited + * All rights reserved + * + * SPDX-License-Identifier: BSD-3-Clause + */ + +/** +@page Contributing + +@verbinclude CONTRIBUTING + +*/