| Message ID | 1405443678-24004-1-git-send-email-mike.holmes@linaro.org |
|---|---|
| State | Rejected |
| Headers | show |
On 2014-07-15 13:01, Mike Holmes wrote: > Signed-off-by: Mike Holmes <mike.holmes@linaro.org> > --- > 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 OpenDataPlane > + > + 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"' Better but s/ARCHi/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 "git am <patch-name>" will high light > +these issues, vi, emacs etc all have tools to clean this up automatically There must be no trailing whitespace, space before tab or trailing newlines. > + > + 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 > + > + when I'm on my anal run... remove one newline here as well. Cheers, Anders > +*/ > -- > 1.9.1 > > > _______________________________________________ > lng-odp mailing list > lng-odp@lists.linaro.org > http://lists.linaro.org/mailman/listinfo/lng-odp
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 <patch-name>" 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 + + +*/
Signed-off-by: Mike Holmes <mike.holmes@linaro.org> --- CONTRIBUTING | 45 +++++++++++++++++++++++++++++++++++++++++++++ Doxyfile.in | 1 + contributing.dox | 13 +++++++++++++ 3 files changed, 59 insertions(+) create mode 100644 CONTRIBUTING create mode 100644 contributing.dox