This is an automated email from the ASF dual-hosted git repository.
abukor pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/kudu.git
The following commit(s) were added to refs/heads/master by this push:
new 3cdc56d [docs] Update doxygen requirements in docs
3cdc56d is described below
commit 3cdc56dce7e548ddf08c2ebe15036491ce3cfb98
Author: Attila Bukor <[email protected]>
AuthorDate: Thu Nov 12 17:22:57 2020 +0100
[docs] Update doxygen requirements in docs
Before the release of 1.13 we bumped the required version of Doxygen to
1.8.19. README.adoc has been updated along with the version bump, but
the installation doc also mentions installing doxygen as an optional
dependency using the OS package manager, which is not enough now as
CentOS and Ubuntu distribute an older version of Doxygen. This commit
fixes the installation instructions.
Change-Id: Ie0f92f185490ad15d8f4f71d9c7fc5f6a6073fdc
Reviewed-on: http://gerrit.cloudera.org:8080/16715
Tested-by: Kudu Jenkins
Reviewed-by: Alexey Serbin <[email protected]>
---
docs/installation.adoc | 12 ++++++++++--
1 file changed, 10 insertions(+), 2 deletions(-)
diff --git a/docs/installation.adoc b/docs/installation.adoc
index ec313bb..5f6c48e 100644
--- a/docs/installation.adoc
+++ b/docs/installation.adoc
@@ -132,9 +132,14 @@ $ sudo ldconfig
. Optional: Install some additional packages, including ruby, if you plan to
build documentation.
+
----
-$ sudo yum install doxygen gem graphviz ruby-devel zlib-devel
+$ sudo yum install gem graphviz ruby-devel zlib-devel
----
NOTE: If building on RHEL or CentOS older than 7.0, the gem package may need
to be replaced with rubygems
++
+NOTE: Doxygen 1.8.19 or later is required to build the documentation, which
has to be
+https://www.doxygen.nl/manual/install.html#install_src_unix[built from source
manually]. Building
+this version of Doxygen on CentOS or RHEL older than 8.0 also requires
+https://www.softwarecollections.org/en/scls/rhscl/devtoolset-8/[devtoolset].
. Clone the Git repository and change to the new `kudu` directory.
+
@@ -281,8 +286,11 @@ $ sudo ldconfig
. Optional: Install some additional packages, including ruby, if you plan to
build documentation.
+
----
-$ sudo apt-get install doxygen gem graphviz ruby-dev xsltproc zlib1g-dev
+$ sudo apt-get install gem graphviz ruby-dev xsltproc zlib1g-dev
----
++
+NOTE: Doxygen 1.8.19 or later is required to build the documentation, which
has to be
+https://www.doxygen.nl/manual/install.html#install_src_unix[built from source
manually].
. Clone the Git repository and change to the new `kudu` directory.
+
