better documentation
This commit is contained in:
Marc Wäckerlin
12
ChangeLog
12
ChangeLog
@@ -1,3 +1,15 @@
|
||||
2015-11-09 11:13 marc
|
||||
|
||||
* ChangeLog, ax_init_standard_project.m4, bootstrap.sh,
|
||||
configure.ac, cordova/platforms/android/AndroidManifest.xml,
|
||||
cordova/platforms/android/res/xml/config.xml,
|
||||
html/checknewuser.php, html/get.php, html/login.php,
|
||||
html/messagetable.php, html/messagetable.sql, html/opendb.php,
|
||||
html/pubkey.php, html/safechat.js, html/schema.sql,
|
||||
html/send.php, html/usertable.php, html/usertable.sql, test,
|
||||
test/makefile.am, test/runtests.sh: new way to generate database
|
||||
fromseparate schema.sql
|
||||
|
||||
2015-11-07 10:47 marc
|
||||
|
||||
* bootstrap.sh: there is no qt4-default
|
||||
|
||||
14
bootstrap.sh
14
bootstrap.sh
@@ -110,8 +110,8 @@ 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
|
||||
* test/runtests.sh - template file to run test scripts, i.e. docker based
|
||||
* AUTHORS - replace your name in AUTHORS before first run
|
||||
* NEWS - empty file add your project's news
|
||||
* README - add project description (first line is header, followed by an empty line)
|
||||
@@ -197,7 +197,7 @@ FILES
|
||||
<ou can access the readme by calling
|
||||
${DEFAULT_PROJECT_NAME}::description().
|
||||
* ChangeLog: Your changelog is automatically maintained from
|
||||
subversion history, using svn2cl. You don't need to
|
||||
subversion history, using svn2cl | subversion-tools. You don't need to
|
||||
care about.
|
||||
* configure.ac: This file becomes very short and simple. You provide
|
||||
the project name, the major and minor version. The
|
||||
@@ -425,8 +425,8 @@ 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
|
||||
if testtag AX_BUILD_TEST; then copy test/runtests.sh; fi
|
||||
AUTHOR=$(gpg -K | sed -n 's,uid *,,p' | sort | head -1)
|
||||
if test -z "${AUTHOR}"; then
|
||||
AUTHOR="FIRSTNAME LASTNAME (URL) <EMAIL>"
|
||||
@@ -799,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
|
||||
@@ -837,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
|
||||
@@ -1052,7 +1052,7 @@ if test -f makefile; then
|
||||
fi
|
||||
|
||||
#### Bootstrap Before Configure ####
|
||||
run --no-check svn2cl
|
||||
run --no-check svn2cl | subversion-tools
|
||||
run aclocal
|
||||
if testtag AX_USE_LIBTOOL; then run libtoolize --force; fi
|
||||
run automake -a
|
||||
|
||||
@@ -750,6 +750,8 @@ WARN_LOGFILE = doxygen.errors
|
||||
|
||||
INPUT = @top_srcdir@/src
|
||||
INPUT += @top_srcdir@/html
|
||||
INPUT += @top_srcdir@/scripts
|
||||
INPUT += @top_srcdir@/test
|
||||
|
||||
# This tag can be used to specify the character encoding of the source files
|
||||
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
|
||||
@@ -769,7 +771,7 @@ INPUT_ENCODING = UTF-8
|
||||
# *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf,
|
||||
# *.qsf, *.as and *.js.
|
||||
|
||||
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 *.html *.inc *.m *.markdown *.md *.mm *.dox *.py *.f90 *.f *.for *.tcl *.vhd *.vhdl *.ucf *.qsf *.as *.js *.wt
|
||||
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 *.html *.inc *.m *.markdown *.md *.mm *.dox *.py *.f90 *.f *.for *.tcl *.vhd *.vhdl *.ucf *.qsf *.as *.js *.wt *.sql
|
||||
|
||||
# The RECURSIVE tag can be used to specify whether or not subdirectories should
|
||||
# be searched for input files as well.
|
||||
@@ -863,7 +865,7 @@ INPUT_FILTER =
|
||||
# filters are used. If the FILTER_PATTERNS tag is empty or if none of the
|
||||
# patterns match the file name, INPUT_FILTER is applied.
|
||||
|
||||
FILTER_PATTERNS = *.wt=doxygen-webtester.sed
|
||||
FILTER_PATTERNS = *.wt=doxygen-webtester.sed *.sql=@top_srcdir@/sql-to-dot.sed
|
||||
|
||||
# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
|
||||
# INPUT_FILTER ) will also be used to filter the input files that are used for
|
||||
|
||||
@@ -9,15 +9,14 @@ wwwdir = ${pkgdatadir}/html
|
||||
dist_www_DATA = index.html chat.html newuser.html safechat.js \
|
||||
jquery.js openpgp.js jquery.cssemoticons.js \
|
||||
safechat.css jquery.cssemoticons.css checknewuser.php \
|
||||
get.php login.php messagetable.php pubkey.php \
|
||||
send.php usertable.php abort.svg \
|
||||
get.php login.php pubkey.php send.php abort.svg \
|
||||
A-Tone-His_Self-1266414414.mp3 attachment.svg \
|
||||
audio.svg chat-rodrigo-angleton.svg \
|
||||
Checkout-Scanner-Beep-SoundBible.com-593325210-by-Mike-Koenig.mp3 \
|
||||
envelope.svg functions.php menu.svg pfeil.svg \
|
||||
photo.png photo.svg safechat-rodrigo-angleton.svg \
|
||||
safe-mimooh.svg send.svg update-messages.js video.png \
|
||||
video.svg messagetable.sql usertable.sql
|
||||
video.svg opendb.php schema.sql
|
||||
|
||||
EXTRA_DIST = documentation.dox
|
||||
|
||||
|
||||
@@ -3,20 +3,7 @@
|
||||
|
||||
@id $Id$
|
||||
|
||||
@see @ref usertable for the database schema
|
||||
|
||||
@page database Database
|
||||
|
||||
@tableofcontents
|
||||
|
||||
@section usertable User Table
|
||||
|
||||
<table>
|
||||
<caption>Table: user</caption>
|
||||
<tr><th>Colum Name</th><th>SQL Type</th><th>Description</th></tr>
|
||||
<tr><td>name</td><td>varchar(50)</td><td>The user's name (pseudonym).</td></tr>
|
||||
<tr><td>pubkey</td><td>text</td><td>The user's public key.</td></tr>
|
||||
</table>
|
||||
@see @ref database for the database schema
|
||||
|
||||
*/
|
||||
// 1 2 3 4 5 6 7 8
|
||||
|
||||
@@ -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
|
||||
if ${SUDO} apt-get -y install $*; then
|
||||
return 0
|
||||
fi
|
||||
else
|
||||
if apt-get -y install $*; then
|
||||
return 0
|
||||
fi
|
||||
fi
|
||||
return 1
|
||||
fi
|
||||
}
|
||||
|
||||
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
|
||||
|
||||
41
sql-to-dot.sed
Executable file
41
sql-to-dot.sed
Executable file
@@ -0,0 +1,41 @@
|
||||
#! /bin/sed -f
|
||||
1i\
|
||||
/** @page database Database Schema\
|
||||
\
|
||||
@dot\
|
||||
digraph schema {
|
||||
|
||||
# remove newlines
|
||||
:a;N;$!ba;s/\n/ /g
|
||||
# reduce spaces
|
||||
s, \+, ,g
|
||||
|
||||
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
|
||||
|
||||
:b;s/\([a-z]\+\)\([^;]*\)FOREIGN KEY *( *`\?\([a-z]\+\)`\? *) *REFERENCES *`\?\([a-z]\+\)`\? *( *`\?\([a-z]\+\)`\? *) *\([^,)]*\)[,)]\(.*\)/\1\2\7\n \1:\3 -> \4:\5/ig;tb
|
||||
|
||||
: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| \+</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| *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
|
||||
|
||||
$a\
|
||||
}\
|
||||
@enddot\
|
||||
*/
|
||||
Reference in New Issue
Block a user