aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBill Fischofer <bill.fischofer@linaro.org>2016-01-14 18:06:19 -0600
committerMaxim Uvarov <maxim.uvarov@linaro.org>2016-02-08 20:45:25 +0300
commit6b66457990ba16c7e423cee03368b7431dd9dd22 (patch)
tree07e3bd9829517f9d64e66b9bd38e1d11bdb1b986
parentb6409ad256b7d2b266d0911f0ddad495694e034a (diff)
doc: update CONTRIBUTING and DEPENDENCIES files for images
Signed-off-by: Bill Fischofer <bill.fischofer@linaro.org> Reviewed-by: Mike Holmes <mike.holmes@linaro.org> Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
-rw-r--r--CONTRIBUTING5
-rw-r--r--DEPENDENCIES11
2 files changed, 4 insertions, 12 deletions
diff --git a/CONTRIBUTING b/CONTRIBUTING
index 4ad964e49..f6e3fc643 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 3563b36be..c2711d544 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