mirror of
https://github.com/ceph/ceph
synced 2024-12-24 12:24:19 +00:00
54ec7556bc
* 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>
148 lines
4.6 KiB
Bash
Executable File
148 lines
4.6 KiB
Bash
Executable File
#!/bin/sh
|
|
|
|
cd "$(dirname "$0")"
|
|
cd ..
|
|
TOPDIR=`pwd`
|
|
|
|
install -d -m0755 build-doc
|
|
|
|
if command -v dpkg >/dev/null; then
|
|
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 -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
|
|
if ! rpm -q $package >/dev/null ; then
|
|
missing="${missing:+$missing }$package"
|
|
fi
|
|
done
|
|
if [ -n "$missing" ]; then
|
|
echo "$0: missing required packages, please install them:" 1>&2
|
|
echo "yum install $missing"
|
|
exit 1
|
|
fi
|
|
else
|
|
for command in virtualenv doxygen ant ditaa cython; do
|
|
command -v "$command" > /dev/null;
|
|
ret_code=$?
|
|
if [ $ret_code -ne 0 ]; then
|
|
# add a space after old values
|
|
missing="${missing:+$missing }$command"
|
|
fi
|
|
done
|
|
if [ -n "$missing" ]; then
|
|
echo "$0: missing required command, please install them:" 1>&2
|
|
echo "$missing"
|
|
exit 1
|
|
fi
|
|
fi
|
|
|
|
# Don't enable -e until after running all the potentially-erroring checks
|
|
# for availability of commands
|
|
set -e
|
|
|
|
cat $TOPDIR/src/osd/PG.h $TOPDIR/src/osd/PG.cc | $TOPDIR/doc/scripts/gen_state_diagram.py > $TOPDIR/doc/dev/peering_graph.generated.dot
|
|
|
|
cd build-doc
|
|
|
|
[ -z "$vdir" ] && vdir="$TOPDIR/build-doc/virtualenv"
|
|
|
|
if [ ! -e $vdir ]; then
|
|
virtualenv --system-site-packages $vdir
|
|
fi
|
|
$vdir/bin/pip install --quiet -r $TOPDIR/admin/doc-requirements.txt
|
|
|
|
install -d -m0755 \
|
|
$TOPDIR/build-doc/output/html \
|
|
$TOPDIR/build-doc/output/man
|
|
|
|
# To avoid having to build librbd to build the Python bindings to build the docs,
|
|
# create a dummy librbd.so that allows the module to be imported by sphinx.
|
|
mkdir -p $vdir/lib
|
|
export LD_LIBRARY_PATH="$vdir/lib"
|
|
export PYTHONPATH=$TOPDIR/src/pybind
|
|
|
|
ln -sf librados.so.2 $vdir/lib/librados.so
|
|
gcc -shared -o $vdir/lib/librados.so.2 -xc /dev/null
|
|
CFLAGS="-iquote $TOPDIR/src/include" \
|
|
CPPFLAGS="-iquote $TOPDIR/src/include" \
|
|
LDFLAGS="-L$vdir/lib -Wl,--no-as-needed" \
|
|
$vdir/bin/pip install $TOPDIR/src/pybind/rados
|
|
nm $vdir/lib/python*/*-packages/rados.so | grep 'U rados_' | \
|
|
awk '{ print "void "$2"(void) {}" }' | \
|
|
gcc -shared -o $vdir/lib/librados.so.2 -xc -
|
|
|
|
# FIXME(sileht): I dunno how to pass the include-dirs correctly with pip
|
|
# for build_ext step, it should be:
|
|
# --global-option=build_ext --global-option="--cython-include-dirs $TOPDIR/src/pybind/rados/"
|
|
# but that doesn't work, so copying the file in the rbd module directly, that's ok for docs
|
|
cp -f $TOPDIR/src/pybind/rados/rados.pxd $TOPDIR/src/pybind/rbd/
|
|
cp -f $TOPDIR/src/pybind/rados/rados.pxd $TOPDIR/src/pybind/cephfs/
|
|
|
|
ln -sf librbd.so.1 $vdir/lib/librbd.so
|
|
gcc -shared -o $vdir/lib/librbd.so.1 -xc /dev/null
|
|
CFLAGS="-iquote $TOPDIR/src/include" \
|
|
CPPFLAGS="-iquote $TOPDIR/src/include" \
|
|
LDFLAGS="-L$vdir/lib -Wl,--no-as-needed" \
|
|
$vdir/bin/pip install $TOPDIR/src/pybind/rbd
|
|
nm $vdir/lib/python*/*-packages/rbd.so | grep 'U rbd_' | \
|
|
awk '{ print "void "$2"(void) {}" }' | \
|
|
gcc -shared -o $vdir/lib/librbd.so.1 -xc -
|
|
|
|
|
|
ln -sf libcephfs.so.1 $vdir/lib/libcephfs.so
|
|
gcc -shared -o $vdir/lib/libcephfs.so.1 -xc /dev/null
|
|
CFLAGS="-iquote $TOPDIR/src/include" \
|
|
CPPFLAGS="-iquote $TOPDIR/src/include" \
|
|
LDFLAGS="-L$vdir/lib -Wl,--no-as-needed" \
|
|
$vdir/bin/pip install $TOPDIR/src/pybind/cephfs
|
|
nm $vdir/lib/python*/*-packages/cephfs.so | grep 'U cephfs_' | \
|
|
awk '{ print "void "$2"(void) {}" }' | \
|
|
gcc -shared -o $vdir/lib/libcephfs.so.1 -xc -
|
|
|
|
rm -f $TOPDIR/src/pybind/rbd/rados.pxd $TOPDIR/src/pybind/cephfs/rados.pxd
|
|
|
|
|
|
$vdir/bin/sphinx-build -a -n -b dirhtml -d doctrees $TOPDIR/doc $TOPDIR/build-doc/output/html
|
|
$vdir/bin/sphinx-build -a -b man -d doctrees $TOPDIR/doc $TOPDIR/build-doc/output/man
|
|
|
|
#
|
|
# Build and install JavaDocs
|
|
#
|
|
JAVADIR=$TOPDIR/src/java
|
|
|
|
# Clean and build JavaDocs
|
|
rm -rf $JAVADIR/doc
|
|
ant -buildfile $JAVADIR/build.xml docs
|
|
|
|
# Create clean target directory
|
|
JAVA_OUTDIR=$TOPDIR/build-doc/output/html/api/libcephfs-java/javadoc
|
|
rm -rf $JAVA_OUTDIR
|
|
mkdir $JAVA_OUTDIR
|
|
|
|
# Copy JavaDocs to target directory
|
|
cp -a $JAVADIR/doc/* $JAVA_OUTDIR/
|