diff mbox

DEPENDENCIES: add documentation instructions

Message ID 1418839832-12286-1-git-send-email-mike.holmes@linaro.org
State Accepted
Commit 72b7b11bc160e54666ef0706eb270e898627ba4f
Headers show

Commit Message

Mike Holmes Dec. 17, 2014, 6:10 p.m. UTC
In order to build the documentation doxygen is required, to generate
a pdf further tools are needed.
Add instructions on how to do this.

Signed-off-by: Mike Holmes <mike.holmes@linaro.org>
---
 DEPENDENCIES | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

Comments

Anders Roxell Dec. 18, 2014, 1:12 p.m. UTC | #1
On 2014-12-17 13:10, Mike Holmes wrote:
> In order to build the documentation doxygen is required, to generate
> a pdf further tools are needed.
> Add instructions on how to do this.
> 
> Signed-off-by: Mike Holmes <mike.holmes@linaro.org>

Reviewed-by: Anders Roxell <anders.roxell@linaro.org>

> ---
>  DEPENDENCIES | 14 ++++++++++++++
>  1 file changed, 14 insertions(+)
> 
> diff --git a/DEPENDENCIES b/DEPENDENCIES
> index f70a1d4..62e703d 100644
> --- a/DEPENDENCIES
> +++ b/DEPENDENCIES
> @@ -98,3 +98,17 @@ Prerequisites for building the OpenDataPlane (ODP) API
>     $ Add the configuration option to the regular configuration options
>     ./configure  --enable-cunit  #if cunit is in the PATH
>     ./configure  --with-cunit-path=DIR #only if you need a path to Cunit libs and headers
> +
> +5.0 Documentation & Doxygen
> +
> +See http://www.stack.nl/~dimitri/doxygen/manual/install.html
> +
> +The tested version of doxygen is 1.8.8
> +
> +5.1 HTML
> +   # Debian/Ubuntu
> +   $ apt-get install doxygen graphviz
> +
> +5.2 PDF
> +   # Debian/Ubuntu
> +   $ apt-get install texlive-latex-recommended texlive-latex-extra texlive-fonts-recommended
> -- 
> 2.1.0
> 
> 
> _______________________________________________
> lng-odp mailing list
> lng-odp@lists.linaro.org
> http://lists.linaro.org/mailman/listinfo/lng-odp
Maxim Uvarov Dec. 18, 2014, 1:29 p.m. UTC | #2
Merged,
thanks,
Maxim.

On 12/17/2014 09:10 PM, Mike Holmes wrote:
> In order to build the documentation doxygen is required, to generate
> a pdf further tools are needed.
> Add instructions on how to do this.
>
> Signed-off-by: Mike Holmes <mike.holmes@linaro.org>
> ---
>   DEPENDENCIES | 14 ++++++++++++++
>   1 file changed, 14 insertions(+)
>
> diff --git a/DEPENDENCIES b/DEPENDENCIES
> index f70a1d4..62e703d 100644
> --- a/DEPENDENCIES
> +++ b/DEPENDENCIES
> @@ -98,3 +98,17 @@ Prerequisites for building the OpenDataPlane (ODP) API
>      $ Add the configuration option to the regular configuration options
>      ./configure  --enable-cunit  #if cunit is in the PATH
>      ./configure  --with-cunit-path=DIR #only if you need a path to Cunit libs and headers
> +
> +5.0 Documentation & Doxygen
> +
> +See http://www.stack.nl/~dimitri/doxygen/manual/install.html
> +
> +The tested version of doxygen is 1.8.8
> +
> +5.1 HTML
> +   # Debian/Ubuntu
> +   $ apt-get install doxygen graphviz
> +
> +5.2 PDF
> +   # Debian/Ubuntu
> +   $ apt-get install texlive-latex-recommended texlive-latex-extra texlive-fonts-recommended
diff mbox

Patch

diff --git a/DEPENDENCIES b/DEPENDENCIES
index f70a1d4..62e703d 100644
--- a/DEPENDENCIES
+++ b/DEPENDENCIES
@@ -98,3 +98,17 @@  Prerequisites for building the OpenDataPlane (ODP) API
    $ Add the configuration option to the regular configuration options
    ./configure  --enable-cunit  #if cunit is in the PATH
    ./configure  --with-cunit-path=DIR #only if you need a path to Cunit libs and headers
+
+5.0 Documentation & Doxygen
+
+See http://www.stack.nl/~dimitri/doxygen/manual/install.html
+
+The tested version of doxygen is 1.8.8
+
+5.1 HTML
+   # Debian/Ubuntu
+   $ apt-get install doxygen graphviz
+
+5.2 PDF
+   # Debian/Ubuntu
+   $ apt-get install texlive-latex-recommended texlive-latex-extra texlive-fonts-recommended