diff --git a/Documentation/arango.template.in b/Documentation/arango.template.in index b4edaa28fb..2fb62e5df0 100644 --- a/Documentation/arango.template.in +++ b/Documentation/arango.template.in @@ -1663,7 +1663,7 @@ DOT_IMAGE_FORMAT = png # The tag DOT_PATH can be used to specify the path where the dot tool can be # found. If left blank, it is assumed the dot tool can be found in the path. -DOT_PATH = +DOT_PATH = @DOT_PATH@ # The DOTFILE_DIRS tag can be used to specify one or more directories that # contain dot files that are included in the documentation (see the diff --git a/Doxygen/arango.template b/Doxygen/arango.template index 5d976951b8..2871de29bb 100644 --- a/Doxygen/arango.template +++ b/Doxygen/arango.template @@ -1663,7 +1663,7 @@ DOT_IMAGE_FORMAT = png # The tag DOT_PATH can be used to specify the path where the dot tool can be # found. If left blank, it is assumed the dot tool can be found in the path. -DOT_PATH = +DOT_PATH = @DOT_PATH@ # The DOTFILE_DIRS tag can be used to specify one or more directories that # contain dot files that are included in the documentation (see the diff --git a/Makefile.am b/Makefile.am index f0bbcccc74..2ca3c9fc28 100644 --- a/Makefile.am +++ b/Makefile.am @@ -356,6 +356,22 @@ endif ## --SECTION-- GENERATED FILES ## ----------------------------------------------------------------------------- +################################################################################ +### @brief generate readme +################################################################################ + +if ENABLE_MARKDOWN +if ENABLE_HTML2TEXT + +BUILT_SOURCES += README + +README: README.md + @MARKDOWN_EXEC@ -o html $< | @HTML2TEXT_EXEC@ -style pretty | fgrep -v _Build_Status_ > $@.tmp + mv $@.tmp $@ + +endif +endif + ################################################################################ ### @brief generate all flex files ################################################################################ diff --git a/Makefile.files b/Makefile.files index b06f9fe35c..2df60f10a8 100644 --- a/Makefile.files +++ b/Makefile.files @@ -1,8 +1,8 @@ # -*- mode: Makefile; -*- -################################################################################ +## ----------------------------------------------------------------------------- ## --SECTION-- JAVASCRIPT -################################################################################ +## ----------------------------------------------------------------------------- ################################################################################ ### @brief JavaScript source code as header @@ -28,9 +28,9 @@ JAVASCRIPT_BROWSER = \ BUILT_SOURCES += $(JAVASCRIPT_BROWSER) -################################################################################ +## ----------------------------------------------------------------------------- ## --SECTION-- MRUBY -################################################################################ +## ----------------------------------------------------------------------------- ################################################################################ ### @brief MRuby source code as header @@ -42,9 +42,9 @@ MRUBY_HEADER = \ BUILT_SOURCES += $(MRUBY_HEADER) -################################################################################ -## --SECTION-- DOXYGEN -################################################################################ +## ----------------------------------------------------------------------------- +## --SECTION-- DOCUMENTATION +## ----------------------------------------------------------------------------- ################################################################################ ### @brief JavaScript files @@ -130,9 +130,9 @@ WIKI = \ AqlExamples \ jsUnity -################################################################################ +## ----------------------------------------------------------------------------- ## --SECTION-- END-OF-FILE -################################################################################ +## ----------------------------------------------------------------------------- ## Local Variables: ## mode: outline-minor diff --git a/Makefile.in b/Makefile.in index 7551b3391c..09b84e5bf9 100644 --- a/Makefile.in +++ b/Makefile.in @@ -23,9 +23,6 @@ # -*- mode: Makefile; -*- -################################################################################ -################################################################################ - ################################################################################ ### @brief JavaScript source code as header ################################################################################ @@ -209,7 +206,7 @@ noinst_PROGRAMS = $(am__EXEEXT_2) $(am__EXEEXT_3) @ENABLE_MRUBY_TRUE@am__append_10 = \ @ENABLE_MRUBY_TRUE@ $(shell find @srcdir@/mr/actions/system -name "*.rb" -print) -DIST_COMMON = $(am__configure_deps) \ +DIST_COMMON = README $(am__configure_deps) \ $(srcdir)/3rdParty/Makefile.all-in-one-libev \ $(srcdir)/3rdParty/Makefile.all-in-one-mruby \ $(srcdir)/3rdParty/Makefile.all-in-one-protobuf \ @@ -261,23 +258,40 @@ DIST_COMMON = $(am__configure_deps) \ ### @brief cleanup ################################################################################ @ENABLE_MRUBY_TRUE@am__append_18 = $(MRUBY_HEADER) .setup-mr-directories -@ENABLE_FLEX_TRUE@am__append_19 = $(FLEX_FILES) $(FLEXXX_FILES) + +################################################################################ +### @brief documentation +################################################################################ + +################################################################################ +### @brief javascript +################################################################################ + +################################################################################ +### @brief mruby +################################################################################ + +################################################################################ +### @brief generate readme +################################################################################ +@ENABLE_HTML2TEXT_TRUE@@ENABLE_MARKDOWN_TRUE@am__append_19 = README +@ENABLE_FLEX_TRUE@am__append_20 = $(FLEX_FILES) $(FLEXXX_FILES) ################################################################################ ### @brief cleanup ################################################################################ -@ENABLE_FLEX_TRUE@am__append_20 = $(FLEX_FILES) $(FLEXXX_FILES) -@ENABLE_BISON_TRUE@am__append_21 = $(BISON_FILES) $(BISONXX_FILES) +@ENABLE_FLEX_TRUE@am__append_21 = $(FLEX_FILES) $(FLEXXX_FILES) +@ENABLE_BISON_TRUE@am__append_22 = $(BISON_FILES) $(BISONXX_FILES) ################################################################################ ### @brief CLEANUP ################################################################################ -@ENABLE_BISON_TRUE@am__append_22 = $(BISON_FILES) $(BISONXX_FILES) -@ENABLE_ALL_IN_ONE_LIBEV_TRUE@am__append_23 = @LIBEV_LIBS@ -@ENABLE_ALL_IN_ONE_PROTOBUF_TRUE@am__append_24 = @PROTOBUF_LIBS@ -@ENABLE_ALL_IN_ONE_V8_TRUE@am__append_25 = @V8_LIBS@ -@ENABLE_MRUBY_TRUE@am__append_26 = @MRUBY_LIBS@ -@ENABLE_ZEROMQ_TRUE@am__append_27 = @ZEROMQ_LIBS@ +@ENABLE_BISON_TRUE@am__append_23 = $(BISON_FILES) $(BISONXX_FILES) +@ENABLE_ALL_IN_ONE_LIBEV_TRUE@am__append_24 = @LIBEV_LIBS@ +@ENABLE_ALL_IN_ONE_PROTOBUF_TRUE@am__append_25 = @PROTOBUF_LIBS@ +@ENABLE_ALL_IN_ONE_V8_TRUE@am__append_26 = @V8_LIBS@ +@ENABLE_MRUBY_TRUE@am__append_27 = @MRUBY_LIBS@ +@ENABLE_ZEROMQ_TRUE@am__append_28 = @ZEROMQ_LIBS@ subdir = . ACLOCAL_M4 = $(top_srcdir)/aclocal.m4 am__aclocal_m4_deps = $(top_srcdir)/m4/acx_pthread.m4 \ @@ -289,7 +303,7 @@ am__aclocal_m4_deps = $(top_srcdir)/m4/acx_pthread.m4 \ $(top_srcdir)/m4/configure.logging \ $(top_srcdir)/m4/configure.largefile \ $(top_srcdir)/m4/configure.threads \ - $(top_srcdir)/m4/configure.dot \ + $(top_srcdir)/m4/configure.documentation \ $(top_srcdir)/m4/configure.coverage \ $(top_srcdir)/m4/configure.flex \ $(top_srcdir)/m4/configure.bison \ @@ -878,6 +892,7 @@ CXXFLAGS = @CXXFLAGS@ CYGPATH_W = @CYGPATH_W@ DEFS = @DEFS@ DEPDIR = @DEPDIR@ +DOT_EXEC = @DOT_EXEC@ DOT_PATH = @DOT_PATH@ ECHO_C = @ECHO_C@ ECHO_N = @ECHO_N@ @@ -890,6 +905,7 @@ GCOV_LDFLAGS = @GCOV_LDFLAGS@ GCOV_LIBS = @GCOV_LIBS@ GREP = @GREP@ HAVE_DOT = @HAVE_DOT@ +HTML2TEXT_EXEC = @HTML2TEXT_EXEC@ INSTALL = @INSTALL@ INSTALL_DATA = @INSTALL_DATA@ INSTALL_PROGRAM = @INSTALL_PROGRAM@ @@ -912,6 +928,7 @@ LIBS = @BOOST_LIBS@ @LIBEV_LIBS@ @MATH_LIBS@ @NCURSES_LIBS@ \ LN_S = @LN_S@ LTLIBOBJS = @LTLIBOBJS@ MAKEINFO = @MAKEINFO@ +MARKDOWN_EXEC = @MARKDOWN_EXEC@ MATH_CPPFLAGS = @MATH_CPPFLAGS@ MATH_LDFLAGS = @MATH_LDFLAGS@ MATH_LIBS = @MATH_LIBS@ @@ -1019,9 +1036,9 @@ BUILT_SOURCES = build.h $(JAVASCRIPT_HEADER) $(JAVASCRIPT_BROWSER) \ etc/arangodb/arangoirb.conf etc/arangodb/arangosh.conf \ $(am__append_16) Documentation/.setup-directories \ @builddir@/.setup-js-directories $(am__append_17) \ - $(am__append_19) $(am__append_21) $(PROTOBUF_FILES) \ - $(am__append_23) $(am__append_24) $(am__append_25) \ - $(am__append_26) $(am__append_27) + $(am__append_19) $(am__append_20) $(am__append_22) \ + $(PROTOBUF_FILES) $(am__append_24) $(am__append_25) \ + $(am__append_26) $(am__append_27) $(am__append_28) ################################################################################ ### @brief files to cleanup @@ -1042,8 +1059,8 @@ CLEANUP = bin/arango-password bin/arango-upgrade bin/arango-dfdb \ $(DOXYGEN) $(addsuffix .md,$(addprefix \ Documentation/xml/,$(WIKI))) $(addsuffix .md,$(addprefix \ Documentation/wiki/,$(WIKI))) $(JAVASCRIPT_HEADER) \ - .setup-js-directories $(am__append_18) $(am__append_20) \ - $(am__append_22) $(PROTOBUF_FILES) + .setup-js-directories $(am__append_18) $(am__append_21) \ + $(am__append_23) $(PROTOBUF_FILES) ################################################################################ ### @brief flex files @@ -1172,9 +1189,6 @@ JAVASCRIPT_BROWSER = \ html/admin/js/modules/simple-query.js -################################################################################ -################################################################################ - ################################################################################ ### @brief MRuby source code as header ################################################################################ @@ -1183,9 +1197,6 @@ MRUBY_HEADER = \ mr/server/mr-server.h -################################################################################ -################################################################################ - ################################################################################ ### @brief JavaScript files ################################################################################ @@ -5274,9 +5285,6 @@ build.h: configure.ac ################################################################################ ################################################################################ -################################################################################ -################################################################################ - ################################################################################ ### @brief config ################################################################################ @@ -5712,6 +5720,10 @@ js/server/js-%.h: @srcdir@/js/server/%.js .setup-js-directories @ENABLE_MRUBY_TRUE@mr/server/mr-%.h: @srcdir@/mr/server/%.rb .setup-mr-directories @ENABLE_MRUBY_TRUE@ @top_srcdir@/config/mr2c.sh $< > $@ +@ENABLE_HTML2TEXT_TRUE@@ENABLE_MARKDOWN_TRUE@README: README.md +@ENABLE_HTML2TEXT_TRUE@@ENABLE_MARKDOWN_TRUE@ @MARKDOWN_EXEC@ -o html $< | @HTML2TEXT_EXEC@ -style pretty | fgrep -v _Build_Status_ > $@.tmp +@ENABLE_HTML2TEXT_TRUE@@ENABLE_MARKDOWN_TRUE@ mv $@.tmp $@ + ################################################################################ ### @brief flex ################################################################################ @@ -5883,18 +5895,6 @@ js/server/js-%.h: @srcdir@/js/server/%.js .setup-js-directories @ENABLE_ZEROMQ_TRUE@ @echo "--------------------------------------------------------------------------------" @ENABLE_ZEROMQ_TRUE@ @echo -################################################################################ -### @brief documentation -################################################################################ - -################################################################################ -### @brief javascript -################################################################################ - -################################################################################ -### @brief mruby -################################################################################ - ################################################################################ ### @brief generate all flex files ################################################################################ diff --git a/README b/README new file mode 100644 index 0000000000..6157251dab --- /dev/null +++ b/README @@ -0,0 +1,99 @@ + + +ArangoDB + +We recently started a new open source project - a nosql database called +AvocadoDB which became ArangoDB in May 2012. The current stable version of +ArangoDB is 1.0. A multi server version is planned for the end of 2012. For +details see the roadmap. +Key features include: + +* Schema-free schemata let you combine the space efficiency of MySQL with the + performance power of NoSQL +* Use ArangoDB as an application server and fuse your application and database + together for maximal throughput +* JavaScript for all: no language zoo, you can use one language from your + browser to your back-end +* ArangoDB is multi-threaded - exploit the power of all your cores +* Flexible data modeling: model your data as combination of key-value pairs, + documents or graphs - perfect for social relations +* Free index choice: use the correct index for your problem, be it a skip list + or a n-gram search +* Configurable durability: let the application decide if it needs more + durability or more performance +* No-nonsense storage: ArangoDB uses all of the power of modern storage + hardware, like SSD and large caches +* Powerful query language (AQL) to retrieve data +* It is open source (Apache Licence 2.0) + +For more in-depth information + +* read more on the design_goals_of_ArangoDB +* watch_the_video - Martin Schoenert, architect of ArangoDB, gives an + introduction of what the ArangoDB project is about. +* or give it a try. + + +Compilation + +Please check the Installation_Manual for installation and compilation +instructions. + +Mac OS X Hints + +On Mac OS X you can install ArangoDB using the packagemanager Homebrew: + +* brew install arangodb (use --HEAD in order to build ArangoDB from current + master) + +This will install ArangoDB and all dependencies. Note that the server will be +installed as + + /usr/local/sbin/arangod + +The ArangoDB shell will be install as + + /usr/local/bin/arangosh + + +First Steps + +Start the server: + + > mkdir /tmp/vocbase + > bin/arangod /tmp/vocbase + 2012-03-30T12:54:19Z [11794] INFO ArangoDB (version 1.x.y) is ready for + business + 2012-03-30T12:54:19Z [11794] INFO Have Fun! + +Start the shell in another windows: + + > bin/arangosh + _ + __ _ _ __ __ _ _ __ __ _ ___ ___| |__ + / _` | '__/ _` | '_ \ / _` |/ _ \/ __| '_ \ + | (_| | | | (_| | | | | (_| | (_) \__ \ | | | + \__,_|_| \__,_|_| |_|\__, |\___/|___/_| |_| + |___/ + + Welcome to arangosh 1.x.y. Copyright (c) 2012 triAGENS GmbH. + Using Google V8 3.9.4.0 JavaScript engine. + Using READLINE 6.1. + + Connected to Arango DB 127.0.0.1:8529 Version 1.x.y + + arangosh> db._create("examples") + [ArangoCollection 106097, "examples] + + arangosh> db.examples.save({ Hallo: "World" }); + {"error":false,"_id":"106097/2333739","_rev":2333739} + + arangosh> db.examples.all(); + [{ _id : "82883/1524675", _rev : 1524675, Hallo : "World" }] + + +Caveat + +Please note that this is a very early version of ArangoDB. There will be bugs +and we'd really appreciate it if you report them: +https://github.com/triAGENS/ArangoDB/issues diff --git a/configure b/configure index ef2242a965..3fe481ebb8 100755 --- a/configure +++ b/configure @@ -663,8 +663,17 @@ GCOV_CFLAGS GCOV_CXXFLAGS ENABLE_GCOV_FALSE ENABLE_GCOV_TRUE -HAVE_DOT +ENABLE_HTML2TEXT_FALSE +ENABLE_HTML2TEXT_TRUE +HTML2TEXT_EXEC +ENABLE_MARKDOWN_FALSE +ENABLE_MARKDOWN_TRUE +MARKDOWN_EXEC +ENABLE_DOT_FALSE +ENABLE_DOT_TRUE DOT_PATH +HAVE_DOT +DOT_EXEC PTHREAD_CFLAGS PTHREAD_LIBS PTHREAD_CC @@ -6537,17 +6546,24 @@ else fi +{ $as_echo "$as_me:${as_lineno-$LINENO}: ................................................................................" >&5 +$as_echo "$as_me: ................................................................................" >&6;} +{ $as_echo "$as_me:${as_lineno-$LINENO}: CHECKING FOR DOCUMENTATION UTILS" >&5 +$as_echo "$as_me: CHECKING FOR DOCUMENTATION UTILS" >&6;} +{ $as_echo "$as_me:${as_lineno-$LINENO}: ................................................................................" >&5 +$as_echo "$as_me: ................................................................................" >&6;} + # Extract the first word of "dot", so it can be a program name with args. set dummy dot; ac_word=$2 { $as_echo "$as_me:${as_lineno-$LINENO}: checking for $ac_word" >&5 $as_echo_n "checking for $ac_word... " >&6; } -if ${ac_cv_path_DOT_PATH+:} false; then : +if ${ac_cv_path_DOT_EXEC+:} false; then : $as_echo_n "(cached) " >&6 else - case $DOT_PATH in + case $DOT_EXEC in [\\/]* | ?:[\\/]*) - ac_cv_path_DOT_PATH="$DOT_PATH" # Let the user override the test with a path. + ac_cv_path_DOT_EXEC="$DOT_EXEC" # Let the user override the test with a path. ;; *) as_save_IFS=$IFS; IFS=$PATH_SEPARATOR @@ -6557,7 +6573,7 @@ do test -z "$as_dir" && as_dir=. for ac_exec_ext in '' $ac_executable_extensions; do if { test -f "$as_dir/$ac_word$ac_exec_ext" && $as_test_x "$as_dir/$ac_word$ac_exec_ext"; }; then - ac_cv_path_DOT_PATH="$as_dir/$ac_word$ac_exec_ext" + ac_cv_path_DOT_EXEC="$as_dir/$ac_word$ac_exec_ext" $as_echo "$as_me:${as_lineno-$LINENO}: found $as_dir/$ac_word$ac_exec_ext" >&5 break 2 fi @@ -6568,10 +6584,10 @@ IFS=$as_save_IFS ;; esac fi -DOT_PATH=$ac_cv_path_DOT_PATH -if test -n "$DOT_PATH"; then - { $as_echo "$as_me:${as_lineno-$LINENO}: result: $DOT_PATH" >&5 -$as_echo "$DOT_PATH" >&6; } +DOT_EXEC=$ac_cv_path_DOT_EXEC +if test -n "$DOT_EXEC"; then + { $as_echo "$as_me:${as_lineno-$LINENO}: result: $DOT_EXEC" >&5 +$as_echo "$DOT_EXEC" >&6; } else { $as_echo "$as_me:${as_lineno-$LINENO}: result: no" >&5 $as_echo "no" >&6; } @@ -6579,9 +6595,9 @@ fi -if test -n "$DOT_PATH"; then +if test -n "$DOT_EXEC"; then HAVE_DOT="YES" - DOT_PATH=`dirname "$DOT_PATH"` + DOT_PATH=`dirname "$DOT_EXEC"` else HAVE_DOT="NO" DOT_PATH="" @@ -6589,13 +6605,152 @@ fi + if test "x$HAVE_DOT" = xYES; then + ENABLE_DOT_TRUE= + ENABLE_DOT_FALSE='#' +else + ENABLE_DOT_TRUE='#' + ENABLE_DOT_FALSE= +fi -if test "x$HAVE_DOT" = xyes; then - BASIC_INFO="$BASIC_INFO|DOT support: enabled ($DOT_PATH)" + + +# Extract the first word of "markdown", so it can be a program name with args. +set dummy markdown; ac_word=$2 +{ $as_echo "$as_me:${as_lineno-$LINENO}: checking for $ac_word" >&5 +$as_echo_n "checking for $ac_word... " >&6; } +if ${ac_cv_path_MARKDOWN_EXEC+:} false; then : + $as_echo_n "(cached) " >&6 +else + case $MARKDOWN_EXEC in + [\\/]* | ?:[\\/]*) + ac_cv_path_MARKDOWN_EXEC="$MARKDOWN_EXEC" # Let the user override the test with a path. + ;; + *) + as_save_IFS=$IFS; IFS=$PATH_SEPARATOR +for as_dir in $PATH +do + IFS=$as_save_IFS + test -z "$as_dir" && as_dir=. + for ac_exec_ext in '' $ac_executable_extensions; do + if { test -f "$as_dir/$ac_word$ac_exec_ext" && $as_test_x "$as_dir/$ac_word$ac_exec_ext"; }; then + ac_cv_path_MARKDOWN_EXEC="$as_dir/$ac_word$ac_exec_ext" + $as_echo "$as_me:${as_lineno-$LINENO}: found $as_dir/$ac_word$ac_exec_ext" >&5 + break 2 + fi +done + done +IFS=$as_save_IFS + + ;; +esac +fi +MARKDOWN_EXEC=$ac_cv_path_MARKDOWN_EXEC +if test -n "$MARKDOWN_EXEC"; then + { $as_echo "$as_me:${as_lineno-$LINENO}: result: $MARKDOWN_EXEC" >&5 +$as_echo "$MARKDOWN_EXEC" >&6; } +else + { $as_echo "$as_me:${as_lineno-$LINENO}: result: no" >&5 +$as_echo "no" >&6; } +fi + + + +if test -n "$MARKDOWN_EXEC"; then + HAVE_MARKDOWN="YES" +else + HAVE_MARKDOWN="NO" +fi + + + + if test "x$HAVE_MARKDOWN" = xYES; then + ENABLE_MARKDOWN_TRUE= + ENABLE_MARKDOWN_FALSE='#' +else + ENABLE_MARKDOWN_TRUE='#' + ENABLE_MARKDOWN_FALSE= +fi + + + +# Extract the first word of "html2text", so it can be a program name with args. +set dummy html2text; ac_word=$2 +{ $as_echo "$as_me:${as_lineno-$LINENO}: checking for $ac_word" >&5 +$as_echo_n "checking for $ac_word... " >&6; } +if ${ac_cv_path_HTML2TEXT_EXEC+:} false; then : + $as_echo_n "(cached) " >&6 +else + case $HTML2TEXT_EXEC in + [\\/]* | ?:[\\/]*) + ac_cv_path_HTML2TEXT_EXEC="$HTML2TEXT_EXEC" # Let the user override the test with a path. + ;; + *) + as_save_IFS=$IFS; IFS=$PATH_SEPARATOR +for as_dir in $PATH +do + IFS=$as_save_IFS + test -z "$as_dir" && as_dir=. + for ac_exec_ext in '' $ac_executable_extensions; do + if { test -f "$as_dir/$ac_word$ac_exec_ext" && $as_test_x "$as_dir/$ac_word$ac_exec_ext"; }; then + ac_cv_path_HTML2TEXT_EXEC="$as_dir/$ac_word$ac_exec_ext" + $as_echo "$as_me:${as_lineno-$LINENO}: found $as_dir/$ac_word$ac_exec_ext" >&5 + break 2 + fi +done + done +IFS=$as_save_IFS + + ;; +esac +fi +HTML2TEXT_EXEC=$ac_cv_path_HTML2TEXT_EXEC +if test -n "$HTML2TEXT_EXEC"; then + { $as_echo "$as_me:${as_lineno-$LINENO}: result: $HTML2TEXT_EXEC" >&5 +$as_echo "$HTML2TEXT_EXEC" >&6; } +else + { $as_echo "$as_me:${as_lineno-$LINENO}: result: no" >&5 +$as_echo "no" >&6; } +fi + + + +if test -n "$HTML2TEXT_EXEC"; then + HAVE_HTML2TEXT="YES" +else + HAVE_HTML2TEXT="NO" +fi + + + + if test "x$HAVE_HTML2TEXT" = xYES; then + ENABLE_HTML2TEXT_TRUE= + ENABLE_HTML2TEXT_FALSE='#' +else + ENABLE_HTML2TEXT_TRUE='#' + ENABLE_HTML2TEXT_FALSE= +fi + + + +if test "x$HAVE_DOT" = xYES; then + BASIC_INFO="$BASIC_INFO|DOT support: enabled ($DOT_EXEC)" else BASIC_INFO="$BASIC_INFO|DOT support: disabled" fi +if test "x$HAVE_MARKDOWN" = xYES; then + BASIC_INFO="$BASIC_INFO|MARKDOWN support: enabled ($MARKDOWN_EXEC)" +else + BASIC_INFO="$BASIC_INFO|MARKDOWN support: disabled" +fi + +if test "x$HAVE_HTML2TEXT" = xYES; then + BASIC_INFO="$BASIC_INFO|HTML2TEXT support: enabled ($HTML2TEXT_EXEC)" +else + BASIC_INFO="$BASIC_INFO|HTML2TEXT support: disabled" +fi + @@ -10036,6 +10191,18 @@ if test -z "${ENABLE_FIGURES_TRUE}" && test -z "${ENABLE_FIGURES_FALSE}"; then as_fn_error $? "conditional \"ENABLE_FIGURES\" was never defined. Usually this means the macro was only invoked conditionally." "$LINENO" 5 fi +if test -z "${ENABLE_DOT_TRUE}" && test -z "${ENABLE_DOT_FALSE}"; then + as_fn_error $? "conditional \"ENABLE_DOT\" was never defined. +Usually this means the macro was only invoked conditionally." "$LINENO" 5 +fi +if test -z "${ENABLE_MARKDOWN_TRUE}" && test -z "${ENABLE_MARKDOWN_FALSE}"; then + as_fn_error $? "conditional \"ENABLE_MARKDOWN\" was never defined. +Usually this means the macro was only invoked conditionally." "$LINENO" 5 +fi +if test -z "${ENABLE_HTML2TEXT_TRUE}" && test -z "${ENABLE_HTML2TEXT_FALSE}"; then + as_fn_error $? "conditional \"ENABLE_HTML2TEXT\" was never defined. +Usually this means the macro was only invoked conditionally." "$LINENO" 5 +fi if test -z "${ENABLE_GCOV_TRUE}" && test -z "${ENABLE_GCOV_FALSE}"; then as_fn_error $? "conditional \"ENABLE_GCOV\" was never defined. Usually this means the macro was only invoked conditionally." "$LINENO" 5 diff --git a/configure.ac b/configure.ac index ed4cf61dc4..5ef14e652e 100644 --- a/configure.ac +++ b/configure.ac @@ -134,7 +134,7 @@ m4_include([m4/configure.memory]) m4_include([m4/configure.logging]) m4_include([m4/configure.largefile]) m4_include([m4/configure.threads]) -m4_include([m4/configure.dot]) +m4_include([m4/configure.documentation]) m4_include([m4/configure.coverage]) m4_include([m4/configure.flex]) m4_include([m4/configure.bison]) diff --git a/m4/configure.documentation b/m4/configure.documentation new file mode 100644 index 0000000000..6c6a86e6a9 --- /dev/null +++ b/m4/configure.documentation @@ -0,0 +1,97 @@ +dnl -*- mode: Autoconf; -*- + +dnl ---------------------------------------------------------------------------- +dnl --SECTION-- DOCUMENTATION +dnl ---------------------------------------------------------------------------- + +AC_ARG_WITH(dot, + AS_HELP_STRING([--with-dot=DIR], [where the dot executable is located]), + tr_DOT_PATH="$withval", + tr_DOT_PATH="$PATH") + +AC_MSG_NOTICE([................................................................................]) +AC_MSG_NOTICE([CHECKING FOR DOCUMENTATION UTILS]) +AC_MSG_NOTICE([................................................................................]) + +dnl ---------------------------------------------------------------------------- +dnl checks for dot +dnl ---------------------------------------------------------------------------- + +AC_PATH_PROG([DOT_EXEC], [dot], [], [$tr_DOT_PATH]) + +if test -n "$DOT_EXEC"; then + HAVE_DOT="YES" + DOT_PATH=`dirname "$DOT_EXEC"` +else + HAVE_DOT="NO" + DOT_PATH="" +fi + +AC_SUBST(HAVE_DOT) dnl for doxygen input file +AC_SUBST(DOT_PATH) dnl for doxygen input file +AC_SUBST(DOT_EXEC) + +AM_CONDITIONAL(ENABLE_DOT, test "x$HAVE_DOT" = xYES) + +dnl ---------------------------------------------------------------------------- +dnl checks for markdown +dnl ---------------------------------------------------------------------------- + +AC_PATH_PROG([MARKDOWN_EXEC], [markdown], [], [$PATH]) + +if test -n "$MARKDOWN_EXEC"; then + HAVE_MARKDOWN="YES" +else + HAVE_MARKDOWN="NO" +fi + +AC_SUBST(MARKDOWN_EXEC) + +AM_CONDITIONAL(ENABLE_MARKDOWN, test "x$HAVE_MARKDOWN" = xYES) + +dnl ---------------------------------------------------------------------------- +dnl checks for html2text +dnl ---------------------------------------------------------------------------- + +AC_PATH_PROG([HTML2TEXT_EXEC], [html2text], [], [$PATH]) + +if test -n "$HTML2TEXT_EXEC"; then + HAVE_HTML2TEXT="YES" +else + HAVE_HTML2TEXT="NO" +fi + +AC_SUBST(HTML2TEXT_EXEC) + +AM_CONDITIONAL(ENABLE_HTML2TEXT, test "x$HAVE_HTML2TEXT" = xYES) + +dnl ---------------------------------------------------------------------------- +dnl informational output +dnl ---------------------------------------------------------------------------- + +if test "x$HAVE_DOT" = xYES; then + BASIC_INFO="$BASIC_INFO|DOT support: enabled ($DOT_EXEC)" +else + BASIC_INFO="$BASIC_INFO|DOT support: disabled" +fi + +if test "x$HAVE_MARKDOWN" = xYES; then + BASIC_INFO="$BASIC_INFO|MARKDOWN support: enabled ($MARKDOWN_EXEC)" +else + BASIC_INFO="$BASIC_INFO|MARKDOWN support: disabled" +fi + +if test "x$HAVE_HTML2TEXT" = xYES; then + BASIC_INFO="$BASIC_INFO|HTML2TEXT support: enabled ($HTML2TEXT_EXEC)" +else + BASIC_INFO="$BASIC_INFO|HTML2TEXT support: disabled" +fi + +dnl ---------------------------------------------------------------------------- +dnl --SECTION-- END-OF-FILE +dnl ---------------------------------------------------------------------------- + +dnl Local Variables: +dnl mode: outline-minor +dnl outline-regexp: "^\\(dnl --SECTION--\\)" +dnl End: diff --git a/m4/configure.dot b/m4/configure.dot deleted file mode 100644 index 51bef4de7e..0000000000 --- a/m4/configure.dot +++ /dev/null @@ -1,45 +0,0 @@ -dnl -*- mode: Autoconf; -*- - -dnl ---------------------------------------------------------------------------- -dnl --SECTION-- DOT -dnl ---------------------------------------------------------------------------- - -AC_ARG_WITH(dot, - AS_HELP_STRING([--with-dot=DIR], [where the dot executable is located]), - tr_DOT_PATH="$withval", - tr_DOT_PATH="$PATH") - -dnl ---------------------------------------------------------------------------- -dnl checks for dot -dnl ---------------------------------------------------------------------------- - -AC_PATH_PROG([DOT_PATH], [dot], [], [$tr_DOT_PATH]) - -if test -n "$DOT_PATH"; then - HAVE_DOT="YES" - DOT_PATH=`dirname "$DOT_PATH"` -else - HAVE_DOT="NO" - DOT_PATH="" -fi - -AC_SUBST(HAVE_DOT) - -dnl ---------------------------------------------------------------------------- -dnl informational output -dnl ---------------------------------------------------------------------------- - -if test "x$HAVE_DOT" = xyes; then - BASIC_INFO="$BASIC_INFO|DOT support: enabled ($DOT_PATH)" -else - BASIC_INFO="$BASIC_INFO|DOT support: disabled" -fi - -dnl ---------------------------------------------------------------------------- -dnl --SECTION-- END-OF-FILE -dnl ---------------------------------------------------------------------------- - -dnl Local Variables: -dnl mode: outline-minor -dnl outline-regexp: "^\\(dnl --SECTION--\\)" -dnl End: