diff mbox

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

Message ID 1452816379-12299-2-git-send-email-bill.fischofer@linaro.org
State Accepted
Commit 6b66457990ba16c7e423cee03368b7431dd9dd22
Headers show

Commit Message

Bill Fischofer Jan. 15, 2016, 12:06 a.m. UTC
Signed-off-by: Bill Fischofer <bill.fischofer@linaro.org>
---
 CONTRIBUTING |  5 ++---
 DEPENDENCIES | 11 ++---------
 2 files changed, 4 insertions(+), 12 deletions(-)

Comments

Maxim Uvarov Jan. 27, 2016, 11:18 a.m. UTC | #1
Merged,
Maxim.

On 01/15/2016 03:06, Bill Fischofer wrote:
> Signed-off-by: Bill Fischofer <bill.fischofer@linaro.org>
> ---
>   CONTRIBUTING |  5 ++---
>   DEPENDENCIES | 11 ++---------
>   2 files changed, 4 insertions(+), 12 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..bddadf3 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
> @@ -208,10 +205,6 @@ The tested version of doxygen is 1.8.8
>      # Debian/Ubuntu
>      $ apt-get install doxygen graphviz
>   
> -5.1.2 PDF
> -   # Debian/Ubuntu
> -   $ apt-get install texlive-latex-recommended texlive-latex-extra texlive-fonts-recommended
> -
>   5.2 User guides
>   
>   5.2.1 HTML
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..bddadf3 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
@@ -208,10 +205,6 @@  The tested version of doxygen is 1.8.8
    # Debian/Ubuntu
    $ apt-get install doxygen graphviz
 
-5.1.2 PDF
-   # Debian/Ubuntu
-   $ apt-get install texlive-latex-recommended texlive-latex-extra texlive-fonts-recommended
-
 5.2 User guides
 
 5.2.1 HTML