diff mbox

[API-NEXT,PATCHv4,2/2] doc: update CONTRIBUTING and DEPENDENCIES files for images

Message ID 1452778191-26996-2-git-send-email-bill.fischofer@linaro.org
State Superseded
Headers show

Commit Message

Bill Fischofer Jan. 14, 2016, 1:29 p.m. UTC
Signed-off-by: Bill Fischofer <bill.fischofer@linaro.org>
---
 CONTRIBUTING | 5 ++---
 DEPENDENCIES | 7 ++-----
 2 files changed, 4 insertions(+), 8 deletions(-)

Comments

Mike Holmes Jan. 14, 2016, 7:10 p.m. UTC | #1
The dependencies still talks about pdfs which we dont really support now
for doxygen.

We can opt at this point to completely remove all reference to pdf all
together that to say we dont support it and in that case we need to fix the
configure script to not look for latex and to remove the target doxygen-pdf

On 14 January 2016 at 08:29, Bill Fischofer <bill.fischofer@linaro.org>
wrote:

> Signed-off-by: Bill Fischofer <bill.fischofer@linaro.org>

> ---

>  CONTRIBUTING | 5 ++---

>  DEPENDENCIES | 7 ++-----

>  2 files changed, 4 insertions(+), 8 deletions(-)

>

> diff --git a/CONTRIBUTING b/CONTRIBUTING

> index 4ad964e..f6e3fc6 100644

> --- a/CONTRIBUTING

> +++ b/CONTRIBUTING

> @@ -126,9 +126,8 @@ Code without a proper signoff cannot be merged into

> the mainline.

>          ----

>  - Images are decorated with :-

>          .Optional Title

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

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

> rendered as

> -  png and eps during the build process.

> +        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 asciidoc tool.

>

> diff --git a/DEPENDENCIES b/DEPENDENCIES

> index fec65d2..bc0740f 100644

> --- a/DEPENDENCIES

> +++ b/DEPENDENCIES

> @@ -189,12 +189,9 @@ Prerequisites for building the OpenDataPlane (ODP) API

>

>  5.0 Documentation Images & Doxygen

>

> -  Images are stored as svg files and the png or eps versions generated

> when the docs are built

> -  Image magics convert application is used

> -  # Debian/Ubuntu

> -  # apt-get install imagemagick

> +  Images are stored as svg files. No conversions for these are needed.

>

> -  Message squence diagrams are stored as msc files and the png or eps

> versions generated when the docs are built

> +  Message squence diagrams are stored as msc files and the svg versions

> generated when the docs are built

>    mscgen is used

>    #Debian/Ubuntu

>    # apt-get install mscgen

> --

> 2.5.0

>

> _______________________________________________

> 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
Bill Fischofer Jan. 14, 2016, 8:35 p.m. UTC | #2
Sounds good.  Do you want that as a v5 or should that be a separate patch?

On Thu, Jan 14, 2016 at 1:10 PM, Mike Holmes <mike.holmes@linaro.org> wrote:

> The dependencies still talks about pdfs which we dont really support now

> for doxygen.

>

> We can opt at this point to completely remove all reference to pdf all

> together that to say we dont support it and in that case we need to fix the

> configure script to not look for latex and to remove the target doxygen-pdf

>

> On 14 January 2016 at 08:29, Bill Fischofer <bill.fischofer@linaro.org>

> wrote:

>

>> Signed-off-by: Bill Fischofer <bill.fischofer@linaro.org>

>> ---

>>  CONTRIBUTING | 5 ++---

>>  DEPENDENCIES | 7 ++-----

>>  2 files changed, 4 insertions(+), 8 deletions(-)

>>

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

>> index 4ad964e..f6e3fc6 100644

>> --- a/CONTRIBUTING

>> +++ b/CONTRIBUTING

>> @@ -126,9 +126,8 @@ Code without a proper signoff cannot be merged into

>> the mainline.

>>          ----

>>  - Images are decorated with :-

>>          .Optional Title

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

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

>> rendered as

>> -  png and eps during the build process.

>> +        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 asciidoc tool.

>>

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

>> index fec65d2..bc0740f 100644

>> --- a/DEPENDENCIES

>> +++ b/DEPENDENCIES

>> @@ -189,12 +189,9 @@ Prerequisites for building the OpenDataPlane (ODP)

>> API

>>

>>  5.0 Documentation Images & Doxygen

>>

>> -  Images are stored as svg files and the png or eps versions generated

>> when the docs are built

>> -  Image magics convert application is used

>> -  # Debian/Ubuntu

>> -  # apt-get install imagemagick

>> +  Images are stored as svg files. No conversions for these are needed.

>>

>> -  Message squence diagrams are stored as msc files and the png or eps

>> versions generated when the docs are built

>> +  Message squence diagrams are stored as msc files and the svg versions

>> generated when the docs are built

>>    mscgen is used

>>    #Debian/Ubuntu

>>    # apt-get install mscgen

>> --

>> 2.5.0

>>

>> _______________________________________________

>> 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

>

>

>
Mike Holmes Jan. 14, 2016, 9:15 p.m. UTC | #3
I think all at once with new subject like - remove all pdf support

On 14 January 2016 at 15:35, Bill Fischofer <bill.fischofer@linaro.org>
wrote:

> Sounds good.  Do you want that as a v5 or should that be a separate patch?

>

> On Thu, Jan 14, 2016 at 1:10 PM, Mike Holmes <mike.holmes@linaro.org>

> wrote:

>

>> The dependencies still talks about pdfs which we dont really support now

>> for doxygen.

>>

>> We can opt at this point to completely remove all reference to pdf all

>> together that to say we dont support it and in that case we need to fix the

>> configure script to not look for latex and to remove the target doxygen-pdf

>>

>> On 14 January 2016 at 08:29, Bill Fischofer <bill.fischofer@linaro.org>

>> wrote:

>>

>>> Signed-off-by: Bill Fischofer <bill.fischofer@linaro.org>

>>> ---

>>>  CONTRIBUTING | 5 ++---

>>>  DEPENDENCIES | 7 ++-----

>>>  2 files changed, 4 insertions(+), 8 deletions(-)

>>>

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

>>> index 4ad964e..f6e3fc6 100644

>>> --- a/CONTRIBUTING

>>> +++ b/CONTRIBUTING

>>> @@ -126,9 +126,8 @@ Code without a proper signoff cannot be merged into

>>> the mainline.

>>>          ----

>>>  - Images are decorated with :-

>>>          .Optional Title

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

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

>>> rendered as

>>> -  png and eps during the build process.

>>> +        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 asciidoc tool.

>>>

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

>>> index fec65d2..bc0740f 100644

>>> --- a/DEPENDENCIES

>>> +++ b/DEPENDENCIES

>>> @@ -189,12 +189,9 @@ Prerequisites for building the OpenDataPlane (ODP)

>>> API

>>>

>>>  5.0 Documentation Images & Doxygen

>>>

>>> -  Images are stored as svg files and the png or eps versions generated

>>> when the docs are built

>>> -  Image magics convert application is used

>>> -  # Debian/Ubuntu

>>> -  # apt-get install imagemagick

>>> +  Images are stored as svg files. No conversions for these are needed.

>>>

>>> -  Message squence diagrams are stored as msc files and the png or eps

>>> versions generated when the docs are built

>>> +  Message squence diagrams are stored as msc files and the svg versions

>>> generated when the docs are built

>>>    mscgen is used

>>>    #Debian/Ubuntu

>>>    # apt-get install mscgen

>>> --

>>> 2.5.0

>>>

>>> _______________________________________________

>>> 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

>>

>>

>>

>



-- 
Mike Holmes
Technical Manager - Linaro Networking Group
Linaro.org <http://www.linaro.org/> *│ *Open source software for ARM SoCs
Bill Fischofer Jan. 14, 2016, 10:08 p.m. UTC | #4
Taking a look at this, we also have make rules for rtf, chm, xml, ps, and
pdf output so this removal patch is somewhat bigger. I think I'd prefer to
see that as a separate patch.  This one really just cleaning up the image
files and standardizing on svgs. I think a separate one to standardize on
html output for docs would be better than trying to glom everything
together.

On Thu, Jan 14, 2016 at 3:15 PM, Mike Holmes <mike.holmes@linaro.org> wrote:

> I think all at once with new subject like - remove all pdf support

>

> On 14 January 2016 at 15:35, Bill Fischofer <bill.fischofer@linaro.org>

> wrote:

>

>> Sounds good.  Do you want that as a v5 or should that be a separate patch?

>>

>> On Thu, Jan 14, 2016 at 1:10 PM, Mike Holmes <mike.holmes@linaro.org>

>> wrote:

>>

>>> The dependencies still talks about pdfs which we dont really support now

>>> for doxygen.

>>>

>>> We can opt at this point to completely remove all reference to pdf all

>>> together that to say we dont support it and in that case we need to fix the

>>> configure script to not look for latex and to remove the target doxygen-pdf

>>>

>>> On 14 January 2016 at 08:29, Bill Fischofer <bill.fischofer@linaro.org>

>>> wrote:

>>>

>>>> Signed-off-by: Bill Fischofer <bill.fischofer@linaro.org>

>>>> ---

>>>>  CONTRIBUTING | 5 ++---

>>>>  DEPENDENCIES | 7 ++-----

>>>>  2 files changed, 4 insertions(+), 8 deletions(-)

>>>>

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

>>>> index 4ad964e..f6e3fc6 100644

>>>> --- a/CONTRIBUTING

>>>> +++ b/CONTRIBUTING

>>>> @@ -126,9 +126,8 @@ Code without a proper signoff cannot be merged into

>>>> the mainline.

>>>>          ----

>>>>  - Images are decorated with :-

>>>>          .Optional Title

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

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

>>>> rendered as

>>>> -  png and eps during the build process.

>>>> +        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 asciidoc tool.

>>>>

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

>>>> index fec65d2..bc0740f 100644

>>>> --- a/DEPENDENCIES

>>>> +++ b/DEPENDENCIES

>>>> @@ -189,12 +189,9 @@ Prerequisites for building the OpenDataPlane (ODP)

>>>> API

>>>>

>>>>  5.0 Documentation Images & Doxygen

>>>>

>>>> -  Images are stored as svg files and the png or eps versions generated

>>>> when the docs are built

>>>> -  Image magics convert application is used

>>>> -  # Debian/Ubuntu

>>>> -  # apt-get install imagemagick

>>>> +  Images are stored as svg files. No conversions for these are needed.

>>>>

>>>> -  Message squence diagrams are stored as msc files and the png or eps

>>>> versions generated when the docs are built

>>>> +  Message squence diagrams are stored as msc files and the svg

>>>> versions generated when the docs are built

>>>>    mscgen is used

>>>>    #Debian/Ubuntu

>>>>    # apt-get install mscgen

>>>> --

>>>> 2.5.0

>>>>

>>>> _______________________________________________

>>>> 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

>>>

>>>

>>>

>>

>

>

> --

> Mike Holmes

> Technical Manager - Linaro Networking Group

> Linaro.org <http://www.linaro.org/> *│ *Open source software for ARM SoCs

>

>

>
Mike Holmes Jan. 14, 2016, 10:32 p.m. UTC | #5
If it is growing in scope I agree to follow ons, let's focus on what we
broke with this change then.
We only ever supported html and pdf before so this should just clean the
remaining pdf text so people dont read about it.

On 14 January 2016 at 17:08, Bill Fischofer <bill.fischofer@linaro.org>
wrote:

> Taking a look at this, we also have make rules for rtf, chm, xml, ps, and

> pdf output so this removal patch is somewhat bigger. I think I'd prefer to

> see that as a separate patch.  This one really just cleaning up the image

> files and standardizing on svgs. I think a separate one to standardize on

> html output for docs would be better than trying to glom everything

> together.

>

> On Thu, Jan 14, 2016 at 3:15 PM, Mike Holmes <mike.holmes@linaro.org>

> wrote:

>

>> I think all at once with new subject like - remove all pdf support

>>

>> On 14 January 2016 at 15:35, Bill Fischofer <bill.fischofer@linaro.org>

>> wrote:

>>

>>> Sounds good.  Do you want that as a v5 or should that be a separate

>>> patch?

>>>

>>> On Thu, Jan 14, 2016 at 1:10 PM, Mike Holmes <mike.holmes@linaro.org>

>>> wrote:

>>>

>>>> The dependencies still talks about pdfs which we dont really support

>>>> now for doxygen.

>>>>

>>>> We can opt at this point to completely remove all reference to pdf all

>>>> together that to say we dont support it and in that case we need to fix the

>>>> configure script to not look for latex and to remove the target doxygen-pdf

>>>>

>>>> On 14 January 2016 at 08:29, Bill Fischofer <bill.fischofer@linaro.org>

>>>> wrote:

>>>>

>>>>> Signed-off-by: Bill Fischofer <bill.fischofer@linaro.org>

>>>>> ---

>>>>>  CONTRIBUTING | 5 ++---

>>>>>  DEPENDENCIES | 7 ++-----

>>>>>  2 files changed, 4 insertions(+), 8 deletions(-)

>>>>>

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

>>>>> index 4ad964e..f6e3fc6 100644

>>>>> --- a/CONTRIBUTING

>>>>> +++ b/CONTRIBUTING

>>>>> @@ -126,9 +126,8 @@ Code without a proper signoff cannot be merged

>>>>> into the mainline.

>>>>>          ----

>>>>>  - Images are decorated with :-

>>>>>          .Optional Title

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

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

>>>>> rendered as

>>>>> -  png and eps during the build process.

>>>>> +        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 asciidoc tool.

>>>>>

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

>>>>> index fec65d2..bc0740f 100644

>>>>> --- a/DEPENDENCIES

>>>>> +++ b/DEPENDENCIES

>>>>> @@ -189,12 +189,9 @@ Prerequisites for building the OpenDataPlane

>>>>> (ODP) API

>>>>>

>>>>>  5.0 Documentation Images & Doxygen

>>>>>

>>>>> -  Images are stored as svg files and the png or eps versions

>>>>> generated when the docs are built

>>>>> -  Image magics convert application is used

>>>>> -  # Debian/Ubuntu

>>>>> -  # apt-get install imagemagick

>>>>> +  Images are stored as svg files. No conversions for these are needed.

>>>>>

>>>>> -  Message squence diagrams are stored as msc files and the png or eps

>>>>> versions generated when the docs are built

>>>>> +  Message squence diagrams are stored as msc files and the svg

>>>>> versions generated when the docs are built

>>>>>    mscgen is used

>>>>>    #Debian/Ubuntu

>>>>>    # apt-get install mscgen

>>>>> --

>>>>> 2.5.0

>>>>>

>>>>> _______________________________________________

>>>>> 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

>>>>

>>>>

>>>>

>>>

>>

>>

>> --

>> Mike Holmes

>> Technical Manager - Linaro Networking Group

>> Linaro.org <http://www.linaro.org/> *│ *Open source software for ARM SoCs

>>

>>

>>

>



-- 
Mike Holmes
Technical Manager - Linaro Networking Group
Linaro.org <http://www.linaro.org/> *│ *Open source software for ARM SoCs
Bill Fischofer Jan. 15, 2016, 12:06 a.m. UTC | #6
OK v5 sent.  Only Delta is removing the PDF stuff in DEPENDENCIES.

On Thu, Jan 14, 2016 at 4:32 PM, Mike Holmes <mike.holmes@linaro.org> wrote:

> If it is growing in scope I agree to follow ons, let's focus on what we

> broke with this change then.

> We only ever supported html and pdf before so this should just clean the

> remaining pdf text so people dont read about it.

>

> On 14 January 2016 at 17:08, Bill Fischofer <bill.fischofer@linaro.org>

> wrote:

>

>> Taking a look at this, we also have make rules for rtf, chm, xml, ps, and

>> pdf output so this removal patch is somewhat bigger. I think I'd prefer to

>> see that as a separate patch.  This one really just cleaning up the image

>> files and standardizing on svgs. I think a separate one to standardize on

>> html output for docs would be better than trying to glom everything

>> together.

>>

>> On Thu, Jan 14, 2016 at 3:15 PM, Mike Holmes <mike.holmes@linaro.org>

>> wrote:

>>

>>> I think all at once with new subject like - remove all pdf support

>>>

>>> On 14 January 2016 at 15:35, Bill Fischofer <bill.fischofer@linaro.org>

>>> wrote:

>>>

>>>> Sounds good.  Do you want that as a v5 or should that be a separate

>>>> patch?

>>>>

>>>> On Thu, Jan 14, 2016 at 1:10 PM, Mike Holmes <mike.holmes@linaro.org>

>>>> wrote:

>>>>

>>>>> The dependencies still talks about pdfs which we dont really support

>>>>> now for doxygen.

>>>>>

>>>>> We can opt at this point to completely remove all reference to pdf all

>>>>> together that to say we dont support it and in that case we need to fix the

>>>>> configure script to not look for latex and to remove the target doxygen-pdf

>>>>>

>>>>> On 14 January 2016 at 08:29, Bill Fischofer <bill.fischofer@linaro.org

>>>>> > wrote:

>>>>>

>>>>>> Signed-off-by: Bill Fischofer <bill.fischofer@linaro.org>

>>>>>> ---

>>>>>>  CONTRIBUTING | 5 ++---

>>>>>>  DEPENDENCIES | 7 ++-----

>>>>>>  2 files changed, 4 insertions(+), 8 deletions(-)

>>>>>>

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

>>>>>> index 4ad964e..f6e3fc6 100644

>>>>>> --- a/CONTRIBUTING

>>>>>> +++ b/CONTRIBUTING

>>>>>> @@ -126,9 +126,8 @@ Code without a proper signoff cannot be merged

>>>>>> into the mainline.

>>>>>>          ----

>>>>>>  - Images are decorated with :-

>>>>>>          .Optional Title

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

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

>>>>>> rendered as

>>>>>> -  png and eps during the build process.

>>>>>> +        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 asciidoc tool.

>>>>>>

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

>>>>>> index fec65d2..bc0740f 100644

>>>>>> --- a/DEPENDENCIES

>>>>>> +++ b/DEPENDENCIES

>>>>>> @@ -189,12 +189,9 @@ Prerequisites for building the OpenDataPlane

>>>>>> (ODP) API

>>>>>>

>>>>>>  5.0 Documentation Images & Doxygen

>>>>>>

>>>>>> -  Images are stored as svg files and the png or eps versions

>>>>>> generated when the docs are built

>>>>>> -  Image magics convert application is used

>>>>>> -  # Debian/Ubuntu

>>>>>> -  # apt-get install imagemagick

>>>>>> +  Images are stored as svg files. No conversions for these are

>>>>>> needed.

>>>>>>

>>>>>> -  Message squence diagrams are stored as msc files and the png or

>>>>>> eps versions generated when the docs are built

>>>>>> +  Message squence diagrams are stored as msc files and the svg

>>>>>> versions generated when the docs are built

>>>>>>    mscgen is used

>>>>>>    #Debian/Ubuntu

>>>>>>    # apt-get install mscgen

>>>>>> --

>>>>>> 2.5.0

>>>>>>

>>>>>> _______________________________________________

>>>>>> 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

>>>>>

>>>>>

>>>>>

>>>>

>>>

>>>

>>> --

>>> Mike Holmes

>>> Technical Manager - Linaro Networking Group

>>> Linaro.org <http://www.linaro.org/> *│ *Open source software for ARM

>>> SoCs

>>>

>>>

>>>

>>

>

>

> --

> Mike Holmes

> Technical Manager - Linaro Networking Group

> Linaro.org <http://www.linaro.org/> *│ *Open source software for ARM SoCs

>

>

>
Maxim Uvarov Jan. 15, 2016, 10 a.m. UTC | #7
I might be too late but pdf I think is useful. At least for me. Let's 
discuss that on meeting.

Maxim.

On 01/15/2016 03:06, Bill Fischofer wrote:
> OK v5 sent.  Only Delta is removing the PDF stuff in DEPENDENCIES.
>
> On Thu, Jan 14, 2016 at 4:32 PM, Mike Holmes <mike.holmes@linaro.org 
> <mailto:mike.holmes@linaro.org>> wrote:
>
>     If it is growing in scope I agree to follow ons, let's focus on
>     what we broke with this change then.
>     We only ever supported html and pdf before so this should just
>     clean the remaining pdf text so people dont read about it.
>
>     On 14 January 2016 at 17:08, Bill Fischofer
>     <bill.fischofer@linaro.org <mailto:bill.fischofer@linaro.org>> wrote:
>
>         Taking a look at this, we also have make rules for rtf, chm,
>         xml, ps, and pdf output so this removal patch is somewhat
>         bigger. I think I'd prefer to see that as a separate patch. 
>         This one really just cleaning up the image files and
>         standardizing on svgs. I think a separate one to standardize
>         on html output for docs would be better than trying to glom
>         everything together.
>
>         On Thu, Jan 14, 2016 at 3:15 PM, Mike Holmes
>         <mike.holmes@linaro.org <mailto:mike.holmes@linaro.org>> wrote:
>
>             I think all at once with new subject like - remove all pdf
>             support
>
>             On 14 January 2016 at 15:35, Bill Fischofer
>             <bill.fischofer@linaro.org
>             <mailto:bill.fischofer@linaro.org>> wrote:
>
>                 Sounds good. Do you want that as a v5 or should that
>                 be a separate patch?
>
>                 On Thu, Jan 14, 2016 at 1:10 PM, Mike Holmes
>                 <mike.holmes@linaro.org
>                 <mailto:mike.holmes@linaro.org>> wrote:
>
>                     The dependencies still talks about pdfs which we
>                     dont really support now for doxygen.
>
>                     We can opt at this point to completely remove all
>                     reference to pdf all together that to say we dont
>                     support it and in that case we need to fix the
>                     configure script to not look for latex and to
>                     remove the target doxygen-pdf
>
>                     On 14 January 2016 at 08:29, Bill Fischofer
>                     <bill.fischofer@linaro.org
>                     <mailto:bill.fischofer@linaro.org>> wrote:
>
>                         Signed-off-by: Bill Fischofer
>                         <bill.fischofer@linaro.org
>                         <mailto:bill.fischofer@linaro.org>>
>                         ---
>                          CONTRIBUTING | 5 ++---
>                          DEPENDENCIES | 7 ++-----
>                          2 files changed, 4 insertions(+), 8 deletions(-)
>
>                         diff --git a/CONTRIBUTING b/CONTRIBUTING
>                         index 4ad964e..f6e3fc6 100644
>                         --- a/CONTRIBUTING
>                         +++ b/CONTRIBUTING
>                         @@ -126,9 +126,8 @@ Code without a proper
>                         signoff cannot be merged into the mainline.
>                                  ----
>                          - Images are decorated with :-
>                          .Optional Title
>                         - image::../images/<image
>                         name>.png[align="center"]
>                         -- The images are stored in the doc/images
>                         directory as svg files and rendered as
>                         -  png and eps during the build process.
>                         + 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
>                         asciidoc tool.
>
>                         diff --git a/DEPENDENCIES b/DEPENDENCIES
>                         index fec65d2..bc0740f 100644
>                         --- a/DEPENDENCIES
>                         +++ b/DEPENDENCIES
>                         @@ -189,12 +189,9 @@ Prerequisites for
>                         building the OpenDataPlane (ODP) API
>
>                          5.0 Documentation Images & Doxygen
>
>                         -  Images are stored as svg files and the png
>                         or eps versions generated when the docs are built
>                         -  Image magics convert application is used
>                         -  # Debian/Ubuntu
>                         -  # apt-get install imagemagick
>                         +  Images are stored as svg files. No
>                         conversions for these are needed.
>
>                         -  Message squence diagrams are stored as msc
>                         files and the png or eps versions generated
>                         when the docs are built
>                         +  Message squence diagrams are stored as msc
>                         files and the svg versions generated when the
>                         docs are built
>                            mscgen is used
>                          #Debian/Ubuntu
>                            # apt-get install mscgen
>                         --
>                         2.5.0
>
>                         _______________________________________________
>                         lng-odp mailing list
>                         lng-odp@lists.linaro.org
>                         <mailto: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
>
>
>
>
>
>             -- 
>             Mike Holmes
>             Technical Manager - Linaro Networking Group
>             Linaro.org <http://www.linaro.org/>***│ *Open source
>             software for ARM SoCs
>
>
>
>
>
>     -- 
>     Mike Holmes
>     Technical Manager - Linaro Networking Group
>     Linaro.org <http://www.linaro.org/>***│ *Open source software for
>     ARM SoCs
>
>
>
>
> _______________________________________________
> lng-odp mailing list
> lng-odp@lists.linaro.org
> https://lists.linaro.org/mailman/listinfo/lng-odp
Bill Fischofer Jan. 15, 2016, 1:25 p.m. UTC | #8
I have no objection to keeping PDF capability, however the question is can
PDFs use .svgs?  If yes, then we can still use v4 of the patch.  If not
then given that we'd still need the .eps conversions would this patch
series have utility at all?

On Fri, Jan 15, 2016 at 4:00 AM, Maxim Uvarov <maxim.uvarov@linaro.org>
wrote:

> I might be too late but pdf I think is useful. At least for me. Let's

> discuss that on meeting.

>

> Maxim.

>

> On 01/15/2016 03:06, Bill Fischofer wrote:

>

>> OK v5 sent.  Only Delta is removing the PDF stuff in DEPENDENCIES.

>>

>> On Thu, Jan 14, 2016 at 4:32 PM, Mike Holmes <mike.holmes@linaro.org

>> <mailto:mike.holmes@linaro.org>> wrote:

>>

>>     If it is growing in scope I agree to follow ons, let's focus on

>>     what we broke with this change then.

>>     We only ever supported html and pdf before so this should just

>>     clean the remaining pdf text so people dont read about it.

>>

>>     On 14 January 2016 at 17:08, Bill Fischofer

>>     <bill.fischofer@linaro.org <mailto:bill.fischofer@linaro.org>> wrote:

>>

>>         Taking a look at this, we also have make rules for rtf, chm,

>>         xml, ps, and pdf output so this removal patch is somewhat

>>         bigger. I think I'd prefer to see that as a separate patch.

>>    This one really just cleaning up the image files and

>>         standardizing on svgs. I think a separate one to standardize

>>         on html output for docs would be better than trying to glom

>>         everything together.

>>

>>         On Thu, Jan 14, 2016 at 3:15 PM, Mike Holmes

>>         <mike.holmes@linaro.org <mailto:mike.holmes@linaro.org>> wrote:

>>

>>             I think all at once with new subject like - remove all pdf

>>             support

>>

>>             On 14 January 2016 at 15:35, Bill Fischofer

>>             <bill.fischofer@linaro.org

>>             <mailto:bill.fischofer@linaro.org>> wrote:

>>

>>                 Sounds good. Do you want that as a v5 or should that

>>                 be a separate patch?

>>

>>                 On Thu, Jan 14, 2016 at 1:10 PM, Mike Holmes

>>                 <mike.holmes@linaro.org

>>                 <mailto:mike.holmes@linaro.org>> wrote:

>>

>>                     The dependencies still talks about pdfs which we

>>                     dont really support now for doxygen.

>>

>>                     We can opt at this point to completely remove all

>>                     reference to pdf all together that to say we dont

>>                     support it and in that case we need to fix the

>>                     configure script to not look for latex and to

>>                     remove the target doxygen-pdf

>>

>>                     On 14 January 2016 at 08:29, Bill Fischofer

>>                     <bill.fischofer@linaro.org

>>                     <mailto:bill.fischofer@linaro.org>> wrote:

>>

>>                         Signed-off-by: Bill Fischofer

>>                         <bill.fischofer@linaro.org

>>                         <mailto:bill.fischofer@linaro.org>>

>>

>>                         ---

>>                          CONTRIBUTING | 5 ++---

>>                          DEPENDENCIES | 7 ++-----

>>                          2 files changed, 4 insertions(+), 8 deletions(-)

>>

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

>>                         index 4ad964e..f6e3fc6 100644

>>                         --- a/CONTRIBUTING

>>                         +++ b/CONTRIBUTING

>>                         @@ -126,9 +126,8 @@ Code without a proper

>>                         signoff cannot be merged into the mainline.

>>                                  ----

>>                          - Images are decorated with :-

>>                          .Optional Title

>>                         - image::../images/<image

>>                         name>.png[align="center"]

>>                         -- The images are stored in the doc/images

>>                         directory as svg files and rendered as

>>                         -  png and eps during the build process.

>>                         + 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

>>                         asciidoc tool.

>>

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

>>                         index fec65d2..bc0740f 100644

>>                         --- a/DEPENDENCIES

>>                         +++ b/DEPENDENCIES

>>                         @@ -189,12 +189,9 @@ Prerequisites for

>>                         building the OpenDataPlane (ODP) API

>>

>>                          5.0 Documentation Images & Doxygen

>>

>>                         -  Images are stored as svg files and the png

>>                         or eps versions generated when the docs are built

>>                         -  Image magics convert application is used

>>                         -  # Debian/Ubuntu

>>                         -  # apt-get install imagemagick

>>                         +  Images are stored as svg files. No

>>                         conversions for these are needed.

>>

>>                         -  Message squence diagrams are stored as msc

>>                         files and the png or eps versions generated

>>                         when the docs are built

>>                         +  Message squence diagrams are stored as msc

>>                         files and the svg versions generated when the

>>                         docs are built

>>                            mscgen is used

>>                          #Debian/Ubuntu

>>                            # apt-get install mscgen

>>                         --

>>                         2.5.0

>>

>>                         _______________________________________________

>>                         lng-odp mailing list

>>                         lng-odp@lists.linaro.org

>>                         <mailto: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

>>

>>

>>

>>

>>

>>             --             Mike Holmes

>>             Technical Manager - Linaro Networking Group

>>             Linaro.org <http://www.linaro.org/>***│ *Open source

>>             software for ARM SoCs

>>

>>

>>

>>

>>

>>     --     Mike Holmes

>>     Technical Manager - Linaro Networking Group

>>     Linaro.org <http://www.linaro.org/>***│ *Open source software for

>>     ARM SoCs

>>

>>

>>

>>

>> _______________________________________________

>> lng-odp mailing list

>> lng-odp@lists.linaro.org

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

>>

>

> _______________________________________________

> lng-odp mailing list

> lng-odp@lists.linaro.org

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

>
Mike Holmes Jan. 15, 2016, 5:56 p.m. UTC | #9
On 15 January 2016 at 08:25, Bill Fischofer <bill.fischofer@linaro.org>
wrote:

> I have no objection to keeping PDF capability, however the question is can

> PDFs use .svgs?

>


No, not for doxygen at least it requires they by rendered as .eps to feed
into latex



> If yes, then we can still use v4 of the patch.  If not then given that

> we'd still need the .eps conversions would this patch series have utility

> at all?

>


If we have a use case lets discuss



>

> On Fri, Jan 15, 2016 at 4:00 AM, Maxim Uvarov <maxim.uvarov@linaro.org>

> wrote:

>

>> I might be too late but pdf I think is useful. At least for me. Let's

>> discuss that on meeting.

>>

>> Maxim.

>>

>> On 01/15/2016 03:06, Bill Fischofer wrote:

>>

>>> OK v5 sent.  Only Delta is removing the PDF stuff in DEPENDENCIES.

>>>

>>> On Thu, Jan 14, 2016 at 4:32 PM, Mike Holmes <mike.holmes@linaro.org

>>> <mailto:mike.holmes@linaro.org>> wrote:

>>>

>>>     If it is growing in scope I agree to follow ons, let's focus on

>>>     what we broke with this change then.

>>>     We only ever supported html and pdf before so this should just

>>>     clean the remaining pdf text so people dont read about it.

>>>

>>>     On 14 January 2016 at 17:08, Bill Fischofer

>>>     <bill.fischofer@linaro.org <mailto:bill.fischofer@linaro.org>>

>>> wrote:

>>>

>>>         Taking a look at this, we also have make rules for rtf, chm,

>>>         xml, ps, and pdf output so this removal patch is somewhat

>>>         bigger. I think I'd prefer to see that as a separate patch.

>>>    This one really just cleaning up the image files and

>>>         standardizing on svgs. I think a separate one to standardize

>>>         on html output for docs would be better than trying to glom

>>>         everything together.

>>>

>>>         On Thu, Jan 14, 2016 at 3:15 PM, Mike Holmes

>>>         <mike.holmes@linaro.org <mailto:mike.holmes@linaro.org>> wrote:

>>>

>>>             I think all at once with new subject like - remove all pdf

>>>             support

>>>

>>>             On 14 January 2016 at 15:35, Bill Fischofer

>>>             <bill.fischofer@linaro.org

>>>             <mailto:bill.fischofer@linaro.org>> wrote:

>>>

>>>                 Sounds good. Do you want that as a v5 or should that

>>>                 be a separate patch?

>>>

>>>                 On Thu, Jan 14, 2016 at 1:10 PM, Mike Holmes

>>>                 <mike.holmes@linaro.org

>>>                 <mailto:mike.holmes@linaro.org>> wrote:

>>>

>>>                     The dependencies still talks about pdfs which we

>>>                     dont really support now for doxygen.

>>>

>>>                     We can opt at this point to completely remove all

>>>                     reference to pdf all together that to say we dont

>>>                     support it and in that case we need to fix the

>>>                     configure script to not look for latex and to

>>>                     remove the target doxygen-pdf

>>>

>>>                     On 14 January 2016 at 08:29, Bill Fischofer

>>>                     <bill.fischofer@linaro.org

>>>                     <mailto:bill.fischofer@linaro.org>> wrote:

>>>

>>>                         Signed-off-by: Bill Fischofer

>>>                         <bill.fischofer@linaro.org

>>>                         <mailto:bill.fischofer@linaro.org>>

>>>

>>>                         ---

>>>                          CONTRIBUTING | 5 ++---

>>>                          DEPENDENCIES | 7 ++-----

>>>                          2 files changed, 4 insertions(+), 8 deletions(-)

>>>

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

>>>                         index 4ad964e..f6e3fc6 100644

>>>                         --- a/CONTRIBUTING

>>>                         +++ b/CONTRIBUTING

>>>                         @@ -126,9 +126,8 @@ Code without a proper

>>>                         signoff cannot be merged into the mainline.

>>>                                  ----

>>>                          - Images are decorated with :-

>>>                          .Optional Title

>>>                         - image::../images/<image

>>>                         name>.png[align="center"]

>>>                         -- The images are stored in the doc/images

>>>                         directory as svg files and rendered as

>>>                         -  png and eps during the build process.

>>>                         + 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

>>>                         asciidoc tool.

>>>

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

>>>                         index fec65d2..bc0740f 100644

>>>                         --- a/DEPENDENCIES

>>>                         +++ b/DEPENDENCIES

>>>                         @@ -189,12 +189,9 @@ Prerequisites for

>>>                         building the OpenDataPlane (ODP) API

>>>

>>>                          5.0 Documentation Images & Doxygen

>>>

>>>                         -  Images are stored as svg files and the png

>>>                         or eps versions generated when the docs are built

>>>                         -  Image magics convert application is used

>>>                         -  # Debian/Ubuntu

>>>                         -  # apt-get install imagemagick

>>>                         +  Images are stored as svg files. No

>>>                         conversions for these are needed.

>>>

>>>                         -  Message squence diagrams are stored as msc

>>>                         files and the png or eps versions generated

>>>                         when the docs are built

>>>                         +  Message squence diagrams are stored as msc

>>>                         files and the svg versions generated when the

>>>                         docs are built

>>>                            mscgen is used

>>>                          #Debian/Ubuntu

>>>                            # apt-get install mscgen

>>>                         --

>>>                         2.5.0

>>>

>>>                         _______________________________________________

>>>                         lng-odp mailing list

>>>                         lng-odp@lists.linaro.org

>>>                         <mailto: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

>>>

>>>

>>>

>>>

>>>

>>>             --             Mike Holmes

>>>             Technical Manager - Linaro Networking Group

>>>             Linaro.org <http://www.linaro.org/>***│ *Open source

>>>             software for ARM SoCs

>>>

>>>

>>>

>>>

>>>

>>>     --     Mike Holmes

>>>     Technical Manager - Linaro Networking Group

>>>     Linaro.org <http://www.linaro.org/>***│ *Open source software for

>>>     ARM SoCs

>>>

>>>

>>>

>>>

>>> _______________________________________________

>>> lng-odp mailing list

>>> lng-odp@lists.linaro.org

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

>>>

>>

>> _______________________________________________

>> lng-odp mailing list

>> lng-odp@lists.linaro.org

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

>>

>

>

> _______________________________________________

> 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
diff mbox

Patch

diff --git a/CONTRIBUTING b/CONTRIBUTING
index 4ad964e..f6e3fc6 100644
--- a/CONTRIBUTING
+++ b/CONTRIBUTING
@@ -126,9 +126,8 @@  Code without a proper signoff cannot be merged into the mainline.
         ----
 - Images are decorated with :-
         .Optional Title
-        image::../images/<image name>.png[align="center"]
-- The images are stored in the doc/images directory as svg files and rendered as
-  png and eps during the build process.
+        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 asciidoc tool.
 
diff --git a/DEPENDENCIES b/DEPENDENCIES
index fec65d2..bc0740f 100644
--- a/DEPENDENCIES
+++ b/DEPENDENCIES
@@ -189,12 +189,9 @@  Prerequisites for building the OpenDataPlane (ODP) API
 
 5.0 Documentation Images & Doxygen
 
-  Images are stored as svg files and the png or eps versions generated when the docs are built
-  Image magics convert application is used
-  # Debian/Ubuntu
-  # apt-get install imagemagick
+  Images are stored as svg files. No conversions for these are needed.
 
-  Message squence diagrams are stored as msc files and the png or eps versions generated when the docs are built
+  Message squence diagrams are stored as msc files and the svg versions generated when the docs are built
   mscgen is used
   #Debian/Ubuntu
   # apt-get install mscgen