From: lafont <francois.lafont@ac-versailles.fr>
Date: Mon, 16 May 2016 15:35:18 +0000 (+0200)
Subject: doc: update the "building doc" part
X-Git-Tag: v11.0.0~451^2
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=54ec7556bca3168803cf9606aaebfb9a1f3df81e;p=ceph.git

doc: update the "building doc" part

* In the doc, the explicit and outdated list of required
  dependencies is removed. Now, launching `./admin/build-doc`
  is suggested because the script gives the missing dependencies.
* Little refactoring of the "Debian checking dependencies" part
  in the script `./admin/build-doc`.
* In the suggested "apt-get" command to install dependencies, the
  option `-o APT::Install-Recommends=true` is added just in case.

Signed-off-by: François Lafont <francois.lafont@ac-versailles.fr>
---

diff --git a/admin/build-doc b/admin/build-doc
index 68e5772b1e97..1286bb9322b6 100755
--- a/admin/build-doc
+++ b/admin/build-doc
@@ -7,16 +7,31 @@ TOPDIR=`pwd`
 install -d -m0755 build-doc
 
 if command -v dpkg >/dev/null; then
-    for package in python-dev python-pip python-virtualenv doxygen ditaa ant libxml2-dev libxslt1-dev zlib1g-dev cython graphviz; do
-	if [ "$(dpkg --status -- $package|sed -n 's/^Status: //p')" != "install ok installed" ]; then
-            # add a space after old values
-	    missing="${missing:+$missing }$package"
-	fi
+    packages='
+      git
+      gcc
+      python-dev
+      python-pip
+      python-virtualenv
+      libxml2-dev
+      libxslt1-dev
+      doxygen
+      ditaa
+      graphviz
+      ant
+      cython
+      librbd-dev
+      zlib1g-dev'
+    for package in $packages; do
+    if [ "$(dpkg --status -- $package 2>&1 | sed -n 's/^Status: //p')" != "install ok installed" ]; then
+        # add a space after old values
+        missing="${missing:+$missing }$package"
+    fi
     done
     if [ -n "$missing" ]; then
-	echo "$0: missing required packages, please install them:" 1>&2
-	echo "sudo apt-get install $missing"
-	exit 1
+        echo "$0: missing required packages, please install them:" 1>&2
+        echo "sudo apt-get install -o APT::Install-Recommends=true $missing" 1>&2
+        exit 1
     fi
 elif command -v yum >/dev/null; then
     for package in python-devel python-pip python-virtualenv doxygen ditaa ant libxml-devel libxslt-devel Cython graphviz; do
diff --git a/doc/dev/generatedocs.rst b/doc/dev/generatedocs.rst
index 7332167590e8..6badef0fb6a3 100644
--- a/doc/dev/generatedocs.rst
+++ b/doc/dev/generatedocs.rst
@@ -28,32 +28,22 @@ You should have a full copy of the Ceph repository.
 Install the Required Tools
 --------------------------
 
-To build the Ceph documentation, the following packages are required on
-Ubuntu 14.04:
+To build the Ceph documentation, some dependencies are required.
+To know what packages are needed, you can launch this command::
 
-- ``python-dev``
-- ``python-pip``
-- ``python-virtualenv``
-- ``libxml2-dev``
-- ``libxslt-dev``
-- ``doxygen``
-- ``ditaa``
-- ``graphviz``
-- ``ant``
-- ``cython``
-- ``librbd-dev``
-
-Execute ``apt-get install`` for each dependency that isn't installed
-on your host.::
-
-	sudo apt-get install python-dev python-pip python-virtualenv libxml2-dev libxslt-dev doxygen ditaa graphviz ant cython librbd-dev
+    cd ceph
+    admin/build-doc
 
+If dependencies are missing, the command above will fail
+with a message that suggests you a command to install all
+missing dependencies.
 
 
 Build the Documents
 -------------------
 
-Once you have installed all the dependencies, execute the build::
+Once you have installed all the dependencies, execute the build (the
+same command as above)::
 
 	cd ceph
 	admin/build-doc