better documentation
This commit is contained in:
Marc Wäckerlin
@@ -110,6 +110,7 @@ GENERATED FILES
|
||||
* resolve-rpmbuilddeps.sh - script to install RPM package dependencies
|
||||
* build-in-docker.sh - script to build the project encapsulated in a docker container
|
||||
* build-resource-file.sh - build resource.qrc file from a resource directory
|
||||
* sql-to-dot.sed - script to convert SQL schema files to graphviz dot in doxygen
|
||||
* mac-create-app-bundle.sh - script to create apple mac os-x app-bundle
|
||||
* AUTHORS - replace your name in AUTHORS before first run
|
||||
* NEWS - empty file add your project's news
|
||||
@@ -424,6 +425,7 @@ copy resolve-debbuilddeps.sh
|
||||
copy resolve-rpmbuilddeps.sh
|
||||
copy build-in-docker.sh
|
||||
copy build-resource-file.sh
|
||||
copy sql-to-dot.sed
|
||||
copy mac-create-app-bundle.sh
|
||||
AUTHOR=$(gpg -K | sed -n 's,uid *,,p' | sort | head -1)
|
||||
if test -z "${AUTHOR}"; then
|
||||
@@ -797,14 +799,14 @@ if testtag AX_USE_DOXYGEN; then
|
||||
if testtag AX_BUILD_TEST AX_USE_CPPUNIT; then
|
||||
doxyadd INPUT "@top_srcdir@/test"
|
||||
fi
|
||||
doxyreplace FILE_PATTERNS '*.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.idl *.ddl *.odl *.h *.hh *.hxx *.hpp *.h++ *.cs *.d *.php *.php4 *.php5 *.phtml *.inc *.m *.markdown *.md *.mm *.dox *.py *.f90 *.f *.for *.tcl *.vhd *.vhdl *.ucf *.qsf *.as *.js *.wt'
|
||||
doxyreplace FILE_PATTERNS '*.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.idl *.ddl *.odl *.h *.hh *.hxx *.hpp *.h++ *.cs *.d *.php *.php4 *.php5 *.phtml *.inc *.m *.markdown *.md *.mm *.dox *.py *.f90 *.f *.for *.tcl *.vhd *.vhdl *.ucf *.qsf *.as *.js *.wt *.sql'
|
||||
doxyreplace RECURSIVE YES
|
||||
doxyreplace EXCLUDE_PATTERNS "moc_* uic_* qrc_*"
|
||||
if testtag AX_BUILD_EXAMPLES; then
|
||||
doxyreplace EXAMPLE_PATH @top_srcdir@/examples
|
||||
fi
|
||||
doxyreplace EXAMPLE_RECURSIVE YES
|
||||
doxyreplace FILTER_PATTERNS '*.wt=doxygen-webtester.sed'
|
||||
doxyreplace FILTER_PATTERNS '*.wt=doxygen-webtester.sed *.sql=@top_srcdir@/sql-to-dot.sed'
|
||||
doxyreplace SOURCE_BROWSER YES
|
||||
doxyreplace INLINE_SOURCES YES
|
||||
doxyreplace GENERATE_TESTLIST YES
|
||||
@@ -835,7 +837,7 @@ if testtag AX_USE_DEBIAN_PACKAGING; then
|
||||
|
||||
-- @AUTHOR@ @BUILD_DATE@
|
||||
EOF
|
||||
BUILD_DEPENDS="debhelper, subversion, pkg-config, automake, libtool, autotools-dev, lsb-release $(if testtag AX_USE_DOXYGEN; then echo -n ", doxygen, graphviz, mscgen"; fi; if testtag AX_USE_CPPUNIT; then echo -n ", libcppunit-dev"; fi; if testtag AX_CXX_QT || testtag AX_CHECK_QT AX_REQUIRE_QT; then echo -n ", qt5-default | libqt4-core, qt5-qmake | qt4-qmake, qtbase5-dev | libqt4-dev, qtbase5-dev-tools | qt4-dev-tools, qttools5-dev-tools | qt4-dev-tools, qttools5-dev-tools | qt4-dev-tools"; fi)"
|
||||
BUILD_DEPENDS="debhelper, subversion, pkg-config, automake, libtool, autotools-dev, lsb-release $(if testtag AX_USE_DOXYGEN; then echo -n ", doxygen, graphviz, mscgen"; fi; if testtag AX_USE_CPPUNIT; then echo -n ", libcppunit-dev"; fi; if testtag AX_CXX_QT || testtag AX_CHECK_QT AX_REQUIRE_QT; then echo -n ", qt5-default | libqt4-core | libqtcore4, qt5-qmake | qt4-qmake, qtbase5-dev | libqt4-dev, qtbase5-dev-tools | qt4-dev-tools, qttools5-dev-tools | qt4-dev-tools, qttools5-dev-tools | qt4-dev-tools"; fi)"
|
||||
to debian/control.in <<EOF
|
||||
Source: @PACKAGE_NAME@
|
||||
Priority: extra
|
||||
|
||||
@@ -11,25 +11,27 @@
|
||||
## 45678901234567890123456789012345678901234567890123456789012345678901234567890
|
||||
|
||||
SCHROOTNAME="$1"
|
||||
if test -n "${SCHROOTNAME}"; then
|
||||
DO="schroot -c "${SCHROOTNAME}" --"
|
||||
SUDO="schroot -c "${SCHROOTNAME}" -u root -d / --"
|
||||
else
|
||||
DO=""
|
||||
SUDO="sudo"
|
||||
fi
|
||||
|
||||
function install() {
|
||||
if test -n "${SCHROOTNAME}"; then
|
||||
if schroot -c "${SCHROOTNAME}" -u root -d / -- apt-get -y install $*; then
|
||||
return 0
|
||||
fi
|
||||
if ${SUDO} apt-get -y install $*; then
|
||||
return 0
|
||||
else
|
||||
if apt-get -y install $*; then
|
||||
return 0
|
||||
fi
|
||||
return 1
|
||||
fi
|
||||
return 1
|
||||
}
|
||||
|
||||
TO_INSTALL=
|
||||
|
||||
if test -e debian/control.in -a ! -e debian/control; then
|
||||
for f in $(sed -n 's, *AX_DEB_DEPEND_IFEXISTS(\([^)]*\)).*,\1,p' configure.ac); do
|
||||
if test -n "$(apt-cache policy -q ${f})" && ! dpkg -l "${f}"; then
|
||||
if test -n "$(${DO} apt-cache policy -q ${f})" && ! ${DO} dpkg -l "${f}"; then
|
||||
TO_INSTALL+=" ${f}"
|
||||
fi
|
||||
done
|
||||
@@ -38,13 +40,8 @@ if test -e debian/control.in -a ! -e debian/control; then
|
||||
sed 's,@[^@]*@, dummytext,g' > debian/control
|
||||
fi
|
||||
|
||||
if test -n "${SCHROOTNAME}"; then
|
||||
schroot -c "${SCHROOTNAME}" -u root -d / -- apt-get -y install dpkg-dev
|
||||
DEPS=$(schroot -c "${SCHROOTNAME}" -- dpkg-checkbuilddeps 2>&1 || true)
|
||||
else
|
||||
apt-get -y install dpkg-dev
|
||||
DEPS=$(dpkg-checkbuilddeps 2>&1 || true)
|
||||
fi
|
||||
install dpkg-dev
|
||||
DEPS=$(${DO} dpkg-checkbuilddeps 2>&1 || true)
|
||||
DEPS=$(echo "$DEPS" | sed -n '/Unmet build dependencies/ { s,.*Unmet build dependencies: ,,g; s, ([^)]*),,g; s, *| *,|,g; p}')
|
||||
|
||||
for pa in ${DEPS}; do
|
||||
|
||||
@@ -1,25 +1,41 @@
|
||||
#! /bin/sed -f
|
||||
1idigraph schema {
|
||||
1i\
|
||||
/** @page database Database Schema\
|
||||
\
|
||||
@dot\
|
||||
digraph schema {
|
||||
|
||||
# remove newlines
|
||||
:a;N;$!ba;s/\n/ /g
|
||||
# reduce spaces
|
||||
s, \+, ,g
|
||||
|
||||
s| *CREATE TABLE[^("'`]*[`"']\?\([a-z]\+\)[`"']\? *|\n \1\n [shape=none, margin=0, label=<\n <table>\n <tr><td colspan="3"><b>\1</b></td></tr>\n|ig
|
||||
s| *CREATE *TABLE *\(if *not *exists\)\? *`\?\([a-z]\+\)`\? *|\n \2\n [shape=none, margin=0, label=<\n <table bgcolor="#dddddd">\n <tr><td bgcolor="#ddddff" colspan="4"><b>\2</b></td></tr>\n|ig
|
||||
|
||||
s/varchar *( *\([0-9]\+\) *)/varchar[\1]/ig
|
||||
|
||||
s/ *PRIMARY KEY *( *[`"']\?\([a-z]\+\)[`"']\? *) *[,)]//ig
|
||||
s/ *PRIMARY KEY *( *`\?\([a-z]\+\)`\? *) *[,)]//ig
|
||||
|
||||
:b;s/\([a-z]\+\)\([^;]*\)FOREIGN KEY *( *[`"']\?\([a-z]\+\)[`"']\? *) *REFERENCES *[`"']\?\([a-z]\+\)[`"'] *( *[`"']\?\([a-z]\+\)[`"']\? *) *\([^,)]*\)[,)]\(.*\)/\1\2\7\n \1:\3 -> \4:\5/ig;tb
|
||||
:b;s/\([a-z]\+\)\([^;]*\)FOREIGN KEY *( *`\?\([a-z]\+\)`\? *) *REFERENCES *`\?\([a-z]\+\)`\? *( *`\?\([a-z]\+\)`\? *) *\([^,)]*\)[,)]\(.*\)/\1\2\7\n \1:\3 -> \4:\5/ig;tb
|
||||
|
||||
s| *COMMENT *= *[`"']\?\([^`"']*\)[`"']\?| <tr><td colspan="3">\1</td></tr>|ig
|
||||
:c;s|\n[(,] *`\?\([a-z]\+\)`\? *\([^ ]\+\)*\([^,)]*\) *COMMENT *[`"']\([^`"']*\)[`"'] *[,)]|\n <tr><td align="left" port="\1"><b>\1</b></td><td align="left">\2</td><td align="left">\3</td><td align="left">\4</td></tr>\n,|ig;tc
|
||||
|
||||
s| *[`"']\([a-z]\+\)[`"'] *\([^,)]*\) *COMMENT *[`"']\([^`"']*\)[`"'] *[,)]| <tr><td port="\1">\1</td><td>\2</td><td>\3</td></tr>\n|ig
|
||||
s| \+</td>|</td>|g
|
||||
s|<td> \+|<td>|g
|
||||
s|\(<td[^>]*>[^<]\{30,40\}\) \+\([^<]\{20,\}</td>\)|\1<br/>\2|g
|
||||
:d;s|\(<br/>[^<]\{30,40\}\) \+\([^<]\{20,\}</td>\)|\1<br/>\2|g;td
|
||||
|
||||
s/ *ENGINE *= *\w* *//ig
|
||||
s/ *DEFAULT *CHARSET *= *\w* *//ig
|
||||
s/ *CHARACTER *SET *=\? *\w* *//ig
|
||||
s| *COMMENT *= *["']\?\([^"']*\)["']\?|\n <tr><td bgcolor="#ddddff" colspan="4">\1</td></tr>|ig
|
||||
|
||||
s| \+</td>|</td>|g
|
||||
s|<td> \+|<td>|g
|
||||
s|\(<td[^>]*>[^<]\{60,80\}\) \+\([^<]\{30,\}</td>\)|\1<br/>\2|g
|
||||
:e;s|\(<br/>[^<]\{60,80\}\) \+\([^<]\{30,\}</td>\)|\1<br/>\2|g;te
|
||||
|
||||
s/\n,[^\n]*/\n/g
|
||||
s|;|\n </table>\n >];\n|ig
|
||||
s/(//ig
|
||||
|
||||
$a}
|
||||
$a\
|
||||
}\
|
||||
@enddot\
|
||||
*/
|
||||
|
||||
Reference in New Issue
Block a user