| Message ID | 1463080364-1144-1-git-send-email-mike.holmes@linaro.org |
|---|---|
| State | Superseded |
| Headers | show |
Applying this patch shows whitespace errors:
bill@Ubuntu15:~/linaro/mikedoc2$ git am ~/Mail/Incoming/Mike/1
Applying: doc: process-guide: convert CONTRIBUTING to asciidoc
.git/rebase-apply/patch:129: indent with spaces.
`odp_pktio_t`
.git/rebase-apply/patch:164: new blank line at EOF.
+
warning: 2 lines add whitespace errors.
On Thu, May 12, 2016 at 2:12 PM, Mike Holmes <mike.holmes@linaro.org> wrote:
> Converting to asciidoc allows a tidy page to be added to the online
> documentation without cutting and pasting into wordpress.
> Being Asccidoc a tiny amount of clutter is added to show code snippets
> attractively when rendered that make it slightly hard to read as a raw
> document.
>
> Signed-off-by: Mike Holmes <mike.holmes@linaro.org>
> ---
> CONTRIBUTING | 101
> ++++++++++++++++++++++++++----------------
> doc/process-guide/.gitignore | 1 +
> doc/process-guide/Makefile.am | 11 ++++-
> 3 files changed, 72 insertions(+), 41 deletions(-)
>
> diff --git a/CONTRIBUTING b/CONTRIBUTING
> index f2f8947..16175ac 100644
> --- a/CONTRIBUTING
> +++ b/CONTRIBUTING
> @@ -1,28 +1,32 @@
> -Contributing to the OpenDataplane (ODP) API
> --------------------------------------------
> -
> -Table of content:
> ------------------
> -1. New Development
> -2. ODP patch expectations as an open source project
> -3. Common Errors in Patch and Commit Messages
> -4. Documenting the code
> -5. Documenting the user docs
> -6. References
> -
> -1. New Development
> -------------------
> -ODP code shall be written with the kernel coding style [1].
> +:doctitle: OpenDataPlane (ODP) CONTRIBUTING
> +:description: This document is intended to guide a new application
> developer +
> +in understanding the contributing requirements for ODP
> +:imagesdir: ../images
> +:toc:
> +:numbered!:
> +[abstract]
> +
> +== Abstract
> +
> +This document is intended to guide a new application developer in
> understanding
> +the contributing requirements for ODP
> +
> +== New Development
> +
> +ODP code shall be written with the kernel coding style
> https://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/tree/Documentation/CodingStyle[Kernel
> Coding Style]
> +
> ODP code shall be documented using the doxygen style described in the
> "Documenting the code" section.
> Check patch script/checkpatch.pl shall be used before submitting a patch.
>
> -2. ODP patch expectations as an open source project
> -----------------------------------------------------
> +== ODP patch expectations as an open source project
> +
> While specific to the Linux kernel development, the following reference
> could
> -also be considered a general guide for any Open Source development [2]
> and is
> -relevant to ODP. Many of the guidelines in this ODP document are related
> to the
> -items in that information.
> +also be considered a general guide for any Open Source development
> +
> http://ldn.linuxfoundation.org/book/how-participate-linux-community[Participating
> in the Community]
> +and is relevant to ODP. Many of the guidelines in this ODP document are
> related
> +to the items in that information.
> +
> Pay particular attention to section 5.3 that talks about patch
> preparation.
> The key thing to remember is to break up your changes into logical
> sections.
> Otherwise you run the risk of not being able to even explain the purpose
> of a
> @@ -34,11 +38,12 @@ Signed-off-by: tag line a copy of the description
> follows:
> Signed-off-by: this is a developer's certification that he or she has
> the right to submit the patch for inclusion into the [project]. It is
> an agreement to the Developer's Certificate of Origin, the full text of
> -which can be found in [3] Documentation/SubmittingPatches.
> +which can be found in
> https://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/tree/Documentation/SubmittingPatches[Submitting
> Patches]
> +
> Code without a proper signoff cannot be merged into the mainline.
>
> -3. Common Errors in Patch and Commit Messages
> ----------------------------------------------
> +== Common Errors in Patch and Commit Messages
> +
> - Avoid starting the summary line with a capital letter, unless the
> component
> being referred to also begins with a capital letter.
> - Don't have one huge patch, split your change into logical subparts. It's
> @@ -83,8 +88,8 @@ Code without a proper signoff cannot be merged into the
> mainline.
> sources.
> - Avoid punctuation in the short log.
>
> -4. Documenting the code
> ------------------------
> +== Documenting the code
> +
> - Allow doxygen to use all its default behaviors to identify tagged
> information but where a doxygen tag must be specified use @
> - The first line is by default the brief summary.
> @@ -93,49 +98,67 @@ Code without a proper signoff cannot be merged into
> the mainline.
> - Normal comment sections should be before the code block and start with
> /** on its own line and finish with */ on its own line. The exception
> to this rule is a case where the comment is very small, for example
> - /** macro description */
> - #define SOME_MACRO 0
> + [source,doxygen]
> +----
> + /** macro description */
> + #define SOME_MACRO 0
> +----
> - Commenting on the end of a line for macros and struct members is allowed
> - using:
> - /**< <text> */ for example
> - #define SOME_MACRO 0 /**< <text> */
> + using: /**< <text> */ for example
> + [source,doxygen]
> +----
> + #define SOME_MACRO 0 /**< <text> */
> +----
> - Files should start with a files description using @file
> - Functions should specify their parameters with @param[in] and
> @param[out]
> - Functions return values should all be specified using @return or @retval
> - There should be no doxygen warnings or errors generated.
>
> -5. Documenting the user docs
> -----------------------------
> +== Documenting the user docs
> +
> - Users guides are stored in asciidoctor format in the odp/docs directory
> and in
> sub directories of it as appropriate.
> - ODP code references such as types and enums are highlighted using the
> - + syntax. For example text referring to the type odp_pktio_t would
> decorate the
> + ` syntax. For example text referring to the type odp_pktio_t would
> decorate the
> type thus:-
>
thus: is sufficient. The :- syntax isn't standard English punctuation
> - +odp_pktio_t+
> + [source,asciidoc]
>
[source,asciidoc] must start in column 1 (no leading spaces) to be
interpreted correctly.
> +----
> + `odp_pktio_t`
> +----
> - Section heading use the = syntax. For example:-
> + [source,asciidoc]
>
Same comments here
> +----
> == Level 1
> Text.
>
> === Level 2
> Text.
> +----
> - Code and scripting excerpts are decorated with the block syntax:-
> + [source,asciidoc]
>
Same comments here
> +----
> .Optional Title
> [source,perl]
> ----
> <code here>
> ----
> +----
> - Images are decorated with :-
> + [source,asciidoc]
>
Same comments here
> +----
> .Optional Title
> image::../images/<image name>.svg[align="center"]
> +----
> - The images are stored in the doc/images directory as svg files.
>
We use .svg files in the asciidoc tags, however a number of these are
generated from .gv or .msc files in the doc/images directory. Might want to
elaborate this point.
> - Body text shall wrap at the 80 char point.
> - No warnings may be generated by the asciidoctor tool.
>
> -6. References
> --------------
> -[1]
> https://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/tree/Documentation/CodingStyle
> -[2] http://ldn.linuxfoundation.org/book/how-participate-linux-community
> -[3]
> https://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/tree/Documentation/SubmittingPatches
> +
> +
> +
> +
> +
> +
>
>
>
> diff --git a/doc/process-guide/.gitignore b/doc/process-guide/.gitignore
> index 7632500..3370e15 100644
> --- a/doc/process-guide/.gitignore
> +++ b/doc/process-guide/.gitignore
> @@ -1,2 +1,3 @@
> bylaws-guide.html
> release-guide.html
> +CONTRIBUTING.html
> diff --git a/doc/process-guide/Makefile.am b/doc/process-guide/Makefile.am
> index 196ed7f..1aba167 100644
> --- a/doc/process-guide/Makefile.am
> +++ b/doc/process-guide/Makefile.am
> @@ -4,11 +4,13 @@ EXTRA_DIST =
> $(top_srcdir)/doc/process-guide/bylaws-guide.adoc \
> $(top_srcdir)/doc/process-guide/release-guide.adoc
>
> all-local: bylaws-guide.html \
> - release-guide.html
> + release-guide.html \
> + CONTRIBUTING.html
>
> clean-local:
> rm -f $(builddir)/bylaws-guide.html
> rm -f $(builddir)/release-guide.html
> + rm -f $(builddir)/CONTRIBUTING.html
>
> release-guide.html: $(top_srcdir)/doc/process-guide/release-guide.adoc \
> $(top_srcdir)/doc/images/simple_release_git.svg \
> @@ -16,4 +18,9 @@ release-guide.html:
> $(top_srcdir)/doc/process-guide/release-guide.adoc \
>
> bylaws-guide.html: $(top_srcdir)/doc/process-guide/bylaws-guide.adoc
>
> -doc_DATA = bylaws-guide.html release-guide.html
> +#special case is not postfixed .adoc
> +CONTRIBUTING.html: $(top_srcdir)/CONTRIBUTING
> + asciidoctor $(ASCIIDOC_FLAGS) --out-file=$@ $<
> +
> +
> +doc_DATA = bylaws-guide.html release-guide.html CONTRIBUTING.html
> --
> 2.7.4
>
> _______________________________________________
> lng-odp mailing list
> lng-odp@lists.linaro.org
> https://lists.linaro.org/mailman/listinfo/lng-odp
>
diff --git a/CONTRIBUTING b/CONTRIBUTING index f2f8947..16175ac 100644 --- a/CONTRIBUTING +++ b/CONTRIBUTING @@ -1,28 +1,32 @@ -Contributing to the OpenDataplane (ODP) API -------------------------------------------- - -Table of content: ------------------ -1. New Development -2. ODP patch expectations as an open source project -3. Common Errors in Patch and Commit Messages -4. Documenting the code -5. Documenting the user docs -6. References - -1. New Development ------------------- -ODP code shall be written with the kernel coding style [1]. +:doctitle: OpenDataPlane (ODP) CONTRIBUTING +:description: This document is intended to guide a new application developer + +in understanding the contributing requirements for ODP +:imagesdir: ../images +:toc: +:numbered!: +[abstract] + +== Abstract + +This document is intended to guide a new application developer in understanding +the contributing requirements for ODP + +== New Development + +ODP code shall be written with the kernel coding style https://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/tree/Documentation/CodingStyle[Kernel Coding Style] + ODP code shall be documented using the doxygen style described in the "Documenting the code" section. Check patch script/checkpatch.pl shall be used before submitting a patch. -2. ODP patch expectations as an open source project ----------------------------------------------------- +== ODP patch expectations as an open source project + While specific to the Linux kernel development, the following reference could -also be considered a general guide for any Open Source development [2] and is -relevant to ODP. Many of the guidelines in this ODP document are related to the -items in that information. +also be considered a general guide for any Open Source development +http://ldn.linuxfoundation.org/book/how-participate-linux-community[Participating in the Community] +and is relevant to ODP. Many of the guidelines in this ODP document are related +to the items in that information. + Pay particular attention to section 5.3 that talks about patch preparation. The key thing to remember is to break up your changes into logical sections. Otherwise you run the risk of not being able to even explain the purpose of a @@ -34,11 +38,12 @@ Signed-off-by: tag line a copy of the description follows: Signed-off-by: this is a developer's certification that he or she has the right to submit the patch for inclusion into the [project]. It is an agreement to the Developer's Certificate of Origin, the full text of -which can be found in [3] Documentation/SubmittingPatches. +which can be found in https://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/tree/Documentation/SubmittingPatches[Submitting Patches] + Code without a proper signoff cannot be merged into the mainline. -3. Common Errors in Patch and Commit Messages ---------------------------------------------- +== Common Errors in Patch and Commit Messages + - Avoid starting the summary line with a capital letter, unless the component being referred to also begins with a capital letter. - Don't have one huge patch, split your change into logical subparts. It's @@ -83,8 +88,8 @@ Code without a proper signoff cannot be merged into the mainline. sources. - Avoid punctuation in the short log. -4. Documenting the code ------------------------ +== Documenting the code + - Allow doxygen to use all its default behaviors to identify tagged information but where a doxygen tag must be specified use @ - The first line is by default the brief summary. @@ -93,49 +98,67 @@ Code without a proper signoff cannot be merged into the mainline. - Normal comment sections should be before the code block and start with /** on its own line and finish with */ on its own line. The exception to this rule is a case where the comment is very small, for example - /** macro description */ - #define SOME_MACRO 0 + [source,doxygen] +---- + /** macro description */ + #define SOME_MACRO 0 +---- - Commenting on the end of a line for macros and struct members is allowed - using: - /**< <text> */ for example - #define SOME_MACRO 0 /**< <text> */ + using: /**< <text> */ for example + [source,doxygen] +---- + #define SOME_MACRO 0 /**< <text> */ +---- - Files should start with a files description using @file - Functions should specify their parameters with @param[in] and @param[out] - Functions return values should all be specified using @return or @retval - There should be no doxygen warnings or errors generated. -5. Documenting the user docs ----------------------------- +== Documenting the user docs + - Users guides are stored in asciidoctor format in the odp/docs directory and in sub directories of it as appropriate. - ODP code references such as types and enums are highlighted using the - + syntax. For example text referring to the type odp_pktio_t would decorate the + ` syntax. For example text referring to the type odp_pktio_t would decorate the type thus:- - +odp_pktio_t+ + [source,asciidoc] +---- + `odp_pktio_t` +---- - Section heading use the = syntax. For example:- + [source,asciidoc] +---- == Level 1 Text. === Level 2 Text. +---- - Code and scripting excerpts are decorated with the block syntax:- + [source,asciidoc] +---- .Optional Title [source,perl] ---- <code here> ---- +---- - Images are decorated with :- + [source,asciidoc] +---- .Optional Title image::../images/<image name>.svg[align="center"] +---- - The images are stored in the doc/images directory as svg files. - Body text shall wrap at the 80 char point. - No warnings may be generated by the asciidoctor tool. -6. References -------------- -[1] https://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/tree/Documentation/CodingStyle -[2] http://ldn.linuxfoundation.org/book/how-participate-linux-community -[3] https://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/tree/Documentation/SubmittingPatches + + + + + + diff --git a/doc/process-guide/.gitignore b/doc/process-guide/.gitignore index 7632500..3370e15 100644 --- a/doc/process-guide/.gitignore +++ b/doc/process-guide/.gitignore @@ -1,2 +1,3 @@ bylaws-guide.html release-guide.html +CONTRIBUTING.html diff --git a/doc/process-guide/Makefile.am b/doc/process-guide/Makefile.am index 196ed7f..1aba167 100644 --- a/doc/process-guide/Makefile.am +++ b/doc/process-guide/Makefile.am @@ -4,11 +4,13 @@ EXTRA_DIST = $(top_srcdir)/doc/process-guide/bylaws-guide.adoc \ $(top_srcdir)/doc/process-guide/release-guide.adoc all-local: bylaws-guide.html \ - release-guide.html + release-guide.html \ + CONTRIBUTING.html clean-local: rm -f $(builddir)/bylaws-guide.html rm -f $(builddir)/release-guide.html + rm -f $(builddir)/CONTRIBUTING.html release-guide.html: $(top_srcdir)/doc/process-guide/release-guide.adoc \ $(top_srcdir)/doc/images/simple_release_git.svg \ @@ -16,4 +18,9 @@ release-guide.html: $(top_srcdir)/doc/process-guide/release-guide.adoc \ bylaws-guide.html: $(top_srcdir)/doc/process-guide/bylaws-guide.adoc -doc_DATA = bylaws-guide.html release-guide.html +#special case is not postfixed .adoc +CONTRIBUTING.html: $(top_srcdir)/CONTRIBUTING + asciidoctor $(ASCIIDOC_FLAGS) --out-file=$@ $< + + +doc_DATA = bylaws-guide.html release-guide.html CONTRIBUTING.html
Converting to asciidoc allows a tidy page to be added to the online documentation without cutting and pasting into wordpress. Being Asccidoc a tiny amount of clutter is added to show code snippets attractively when rendered that make it slightly hard to read as a raw document. Signed-off-by: Mike Holmes <mike.holmes@linaro.org> --- CONTRIBUTING | 101 ++++++++++++++++++++++++++---------------- doc/process-guide/.gitignore | 1 + doc/process-guide/Makefile.am | 11 ++++- 3 files changed, 72 insertions(+), 41 deletions(-)