blob: 7feeb6bdb5042271d5d2aaea467c9fb535685773 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
|
#!/bin/sh
help()
{
echo "Generate and add eclipse help from yocto's documentation"
echo "Usage: [DOC_GIT=url_of_repo] $0 BRANCH_NAME PLUGIN_FOLDER"
echo " [DOC_GIT=url_of_repo] $0 -t TAG_NAME PLUGIN_FOLDER"
echo ""
echo "Options:"
echo "-h - display this help and exit"
echo "-t TAG_NAME - tag to build the documentation upon"
echo "BRANCH_NAME - branch to build the documentation upon"
echo "PLUGIN_FOLDER - root folder of the eclipse-poky project"
echo "DOC_GIT - use this repo for documentation. Defaults to git://git.pokylinux.org/yocto-docs.git if not set"
exit 1
}
fail ()
{
local retval=$1
shift $1
echo "[Fail $retval]: $*"
echo "BUILD_TOP=${BUILD_TOP}"
cd ${TOP}
exit ${retval}
}
CHECKOUT_TAG=0
while getopts ":ht" opt; do
case $opt in
h)
help
;;
t)
CHECKOUT_TAG=1
;;
esac
done
shift $(($OPTIND - 1))
if [ $# -ne 2 ]; then
help
fi
if [ $CHECKOUT_TAG -eq 0 ]; then
REFERENCE=origin/$1
else
REFERENCE=$1
fi
PLUGIN_FOLDER=`readlink -f $2`
TOP=`pwd`
DOC_DIR=${PLUGIN_FOLDER}/docs
rm -rf ${DOC_DIR}
DOC_PLUGIN_DIR=${PLUGIN_FOLDER}/plugins/org.yocto.doc.user
DOC_HTML_DIR=${DOC_PLUGIN_DIR}/html/
# git clone
DOC_GIT=${DOC_GIT:-git://git.yoctoproject.org/yocto-docs.git}
git clone ${DOC_GIT} ${DOC_DIR} || fail $? "git clone ${DOC_GIT}"
cd ${DOC_DIR}
git checkout ${REFERENCE} || fail $? "git checkout ${REFERENCE}"
COMMIT_ID=`git rev-parse HEAD`
# build and copy
DOCS="yocto-project-qs adt-manual kernel-dev \
bsp-guide ref-manual dev-manual profile-manual"
cd documentation
ECLIPSE_TARGET_AVAILABLE=`make -q eclipse &> /dev/null; echo $?`
if [ ${ECLIPSE_TARGET_AVAILABLE} -ne 1 ]; then
echo "WARNING:"
echo "This version does not support generating eclipse help"
echo "Documentation will not be available in eclipse"
exit 1
fi
for DOC in ${DOCS}; do
make DOC=${DOC} eclipse
cp -rf ${DOC}/eclipse/html/* ${DOC_HTML_DIR}
cp -f ${DOC}/eclipse/${DOC}-toc.xml ${DOC_HTML_DIR}
done
sed -e "s/@.*@/${COMMIT_ID}/" < ${DOC_PLUGIN_DIR}/about.html.in > ${DOC_PLUGIN_DIR}/about.html
cd ${TOP}
|
