diff mbox

CONTRIBUTING: add xmllint rule

Message ID 1462304075-2715-1-git-send-email-mike.holmes@linaro.org
State New
Headers show

Commit Message

Mike Holmes May 3, 2016, 7:34 p.m. UTC
Signed-off-by: Mike Holmes <mike.holmes@linaro.org>
---
 CONTRIBUTING | 1 +
 DEPENDENCIES | 3 +++
 2 files changed, 4 insertions(+)

Comments

Bill Fischofer May 3, 2016, 9:10 p.m. UTC | #1
On Tue, May 3, 2016 at 2:34 PM, Mike Holmes <mike.holmes@linaro.org> wrote:

> Signed-off-by: Mike Holmes <mike.holmes@linaro.org>

> ---

>  CONTRIBUTING | 1 +

>  DEPENDENCIES | 3 +++

>  2 files changed, 4 insertions(+)

>

> diff --git a/CONTRIBUTING b/CONTRIBUTING

> index f6e3fc6..791d4bc 100644

> --- a/CONTRIBUTING

> +++ b/CONTRIBUTING

> @@ -128,6 +128,7 @@ Code without a proper signoff cannot be merged into

> the mainline.

>          .Optional Title

>          image::../images/<image name>.svg[align="center"]

>  - The images are stored in the doc/images directory as svg files.

> +- The images are cleaned with xmllint

>


Should give the command that does this:
xmllint --format file.svg --output file.svg


>  - Body text shall wrap at the 80 char point.

>  - No warnings may be generated by the asciidoc tool.

>


asciidoctor


>

> diff --git a/DEPENDENCIES b/DEPENDENCIES

> index d59858c..1f5d700 100644

> --- a/DEPENDENCIES

> +++ b/DEPENDENCIES

> @@ -260,3 +260,6 @@ The tested version of doxygen is 1.8.8

>     To have this tool also check spelling you need codespell.

>     # Debian/Ubuntu

>     #sudo apt install codespell

> +

> +   When submitting .svg graphics xmllint is used

> +   #sudo apt install libxml2-utils

> --

> 2.7.4

>

> _______________________________________________

> lng-odp mailing list

> lng-odp@lists.linaro.org

> https://lists.linaro.org/mailman/listinfo/lng-odp

>
Mike Holmes May 6, 2016, 5:29 p.m. UTC | #2
On 3 May 2016 at 17:10, Bill Fischofer <bill.fischofer@linaro.org> wrote:

>

>

> On Tue, May 3, 2016 at 2:34 PM, Mike Holmes <mike.holmes@linaro.org>

> wrote:

>

>> Signed-off-by: Mike Holmes <mike.holmes@linaro.org>

>> ---

>>  CONTRIBUTING | 1 +

>>  DEPENDENCIES | 3 +++

>>  2 files changed, 4 insertions(+)

>>

>> diff --git a/CONTRIBUTING b/CONTRIBUTING

>> index f6e3fc6..791d4bc 100644

>> --- a/CONTRIBUTING

>> +++ b/CONTRIBUTING

>> @@ -128,6 +128,7 @@ Code without a proper signoff cannot be merged into

>> the mainline.

>>          .Optional Title

>>          image::../images/<image name>.svg[align="center"]

>>  - The images are stored in the doc/images directory as svg files.

>> +- The images are cleaned with xmllint

>>

>

> Should give the command that does this:

> xmllint --format file.svg --output file.svg

>


good idea, v2 sent


>

>

>>  - Body text shall wrap at the 80 char point.

>>  - No warnings may be generated by the asciidoc tool.

>>

>

> asciidoctor

>


already fixed by previous patch


>

>

>>

>> diff --git a/DEPENDENCIES b/DEPENDENCIES

>> index d59858c..1f5d700 100644

>> --- a/DEPENDENCIES

>> +++ b/DEPENDENCIES

>> @@ -260,3 +260,6 @@ The tested version of doxygen is 1.8.8

>>     To have this tool also check spelling you need codespell.

>>     # Debian/Ubuntu

>>     #sudo apt install codespell

>> +

>> +   When submitting .svg graphics xmllint is used

>> +   #sudo apt install libxml2-utils

>> --

>> 2.7.4

>>

>> _______________________________________________

>> lng-odp mailing list

>> lng-odp@lists.linaro.org

>> https://lists.linaro.org/mailman/listinfo/lng-odp

>>

>

>



-- 
Mike Holmes
Technical Manager - Linaro Networking Group
Linaro.org <http://www.linaro.org/> *│ *Open source software for ARM SoCs
"Work should be fun and collaborative, the rest follows"
diff mbox

Patch

diff --git a/CONTRIBUTING b/CONTRIBUTING
index f6e3fc6..791d4bc 100644
--- a/CONTRIBUTING
+++ b/CONTRIBUTING
@@ -128,6 +128,7 @@  Code without a proper signoff cannot be merged into the mainline.
         .Optional Title
         image::../images/<image name>.svg[align="center"]
 - The images are stored in the doc/images directory as svg files.
+- The images are cleaned with xmllint
 - Body text shall wrap at the 80 char point.
 - No warnings may be generated by the asciidoc tool.
 
diff --git a/DEPENDENCIES b/DEPENDENCIES
index d59858c..1f5d700 100644
--- a/DEPENDENCIES
+++ b/DEPENDENCIES
@@ -260,3 +260,6 @@  The tested version of doxygen is 1.8.8
    To have this tool also check spelling you need codespell.
    # Debian/Ubuntu
    #sudo apt install codespell
+
+   When submitting .svg graphics xmllint is used
+   #sudo apt install libxml2-utils