FAQ addition when to rebuild nominatim.so

[nominatim.git] / CMakeLists.txt

diff --git a/CMakeLists.txt b/CMakeLists.txt
index 66886f63ef735a09ffed7213a0d1002e99a624cb..787baeb23de7e0c9afb7621024d2f448b2c63391 100644 (file)
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -19,7 +19,7 @@ list(APPEND CMAKE_MODULE_PATH "${CMAKE_SOURCE_DIR}/cmake")
 project(nominatim)
 
 set(NOMINATIM_VERSION_MAJOR 3)
-set(NOMINATIM_VERSION_MINOR 3)
+set(NOMINATIM_VERSION_MINOR 5)
 set(NOMINATIM_VERSION_PATCH 0)
 
 set(NOMINATIM_VERSION "${NOMINATIM_VERSION_MAJOR}.${NOMINATIM_VERSION_MINOR}.${NOMINATIM_VERSION_PATCH}")
@@ -28,28 +28,40 @@ add_definitions(-DNOMINATIM_VERSION="${NOMINATIM_VERSION}")
 
 
 #-----------------------------------------------------------------------------
-#
-#  Find external dependencies
-#
+#  Configuration
 #-----------------------------------------------------------------------------
 
-set(BUILD_TESTS off CACHE BOOL "Build test suite" FORCE)
-set(WITH_LUA off CACHE BOOL "Build with lua support" FORCE)
-set(BUILD_DOCS on CACHE BOOL "Build documentation")
-set(BUILD_SERVER on CACHE BOOL "Build API server")
+set(BUILD_IMPORTER on CACHE BOOL "Build everything for importing/updating the database")
+set(BUILD_API on CACHE BOOL "Build everything for the API server")
 set(BUILD_MODULE on CACHE BOOL "Build PostgreSQL module")
-set(BUILD_NOMINATIM on CACHE BOOL "Build Nominatim executable")
-set(BUILD_OSM2PGSQL on CACHE BOOL "Build osm2pgsql")
-
-if (BUILD_SERVER)
-    if (BUILD_OSM2PGSQL)
-       if (NOT EXISTS "${CMAKE_SOURCE_DIR}/osm2pgsql/CMakeLists.txt")
-           message(FATAL_ERROR "The osm2pgsql directory is empty.\
-           Did you forget to check out Nominatim recursively?\
-           \nTry updating submodules with: git submodule update --init")
-       endif()
-       add_subdirectory(osm2pgsql)
+set(BUILD_TESTS on CACHE BOOL "Build test suite")
+set(BUILD_DOCS on CACHE BOOL "Build documentation")
+set(BUILD_OSM2PGSQL on CACHE BOOL "Build osm2pgsql (expert only)")
+
+#-----------------------------------------------------------------------------
+#  osm2pgsql (imports/updates only)
+#-----------------------------------------------------------------------------
+
+if (BUILD_IMPORTER AND BUILD_OSM2PGSQL)
+    if (NOT EXISTS "${CMAKE_SOURCE_DIR}/osm2pgsql/CMakeLists.txt")
+        message(FATAL_ERROR "The osm2pgsql directory is empty.\
+        Did you forget to check out Nominatim recursively?\
+        \nTry updating submodules with: git submodule update --init")
     endif()
+    set(BUILD_TESTS_SAVED "${BUILD_TESTS}")
+    set(BUILD_TESTS off)
+    set(WITH_LUA off CACHE BOOL "")
+    add_subdirectory(osm2pgsql)
+    set(BUILD_TESTS ${BUILD_TESTS_SAVED})
+endif()
+
+
+#-----------------------------------------------------------------------------
+#  python and pyosmium (imports/updates only)
+#-----------------------------------------------------------------------------
+
+if (BUILD_IMPORTER)
+    find_package(PythonInterp 3)
 
     find_program(PYOSMIUM pyosmium-get-changes)
     if (NOT EXISTS "${PYOSMIUM}")
@@ -59,9 +71,15 @@ if (BUILD_SERVER)
         set(PYOSMIUM_PATH "${PYOSMIUM}")
         message(STATUS "Using pyosmium-get-changes at ${PYOSMIUM_PATH}")
     endif()
+endif()
+
+#-----------------------------------------------------------------------------
+# PHP
+#-----------------------------------------------------------------------------
 
+# Setting PHP binary variable as to command line (prevailing) or auto detect
 
-    # Setting PHP binary variable as to command line (prevailing) or auto detect
+if (BUILD_API OR BUILD_IMPORTER)
     if (NOT PHP_BIN)
          find_program (PHP_BIN php)
     endif()
@@ -73,24 +91,12 @@ if (BUILD_SERVER)
 endif()
 
 #-----------------------------------------------------------------------------
-#
-# Setup settings and paths
-#
+# import scripts and utilities (importer only)
 #-----------------------------------------------------------------------------
 
-if (BUILD_SERVER)
-   set(WEBSITESCRIPTS
-       website/deletable.php
-       website/details.php
-       website/hierarchy.php
-       website/lookup.php
-       website/polygons.php
-       website/reverse.php
-       website/search.php
-       website/status.php
-   )
-
+if (BUILD_IMPORTER)
    set(CUSTOMSCRIPTS
+       utils/check_import_finished.php
        utils/country_languages.php
        utils/importWikipedia.php
        utils/export.php
@@ -105,15 +111,29 @@ if (BUILD_SERVER)
        configure_file(${PROJECT_SOURCE_DIR}/cmake/script.tmpl
                       ${PROJECT_BINARY_DIR}/${script_source})
    endforeach()
+endif()
+
+#-----------------------------------------------------------------------------
+# webserver scripts (API only)
+#-----------------------------------------------------------------------------
+
+if (BUILD_API)
+   set(WEBSITESCRIPTS
+       website/deletable.php
+       website/details.php
+       website/hierarchy.php
+       website/lookup.php
+       website/polygons.php
+       website/reverse.php
+       website/search.php
+       website/status.php
+   )
 
    foreach (script_source ${WEBSITESCRIPTS})
        configure_file(${PROJECT_SOURCE_DIR}/cmake/website.tmpl
                       ${PROJECT_BINARY_DIR}/${script_source})
    endforeach()
 
-   configure_file(${PROJECT_SOURCE_DIR}/settings/defaults.php
-                  ${PROJECT_BINARY_DIR}/settings/settings.php)
-
    set(WEBPATHS css images js)
 
    foreach (wp ${WEBPATHS})
@@ -121,12 +141,22 @@ if (BUILD_SERVER)
            COMMAND ln -sf ${PROJECT_SOURCE_DIR}/website/${wp} ${PROJECT_BINARY_DIR}/website/
        )
    endforeach()
+
+   add_custom_target(serve
+           php -S 127.0.0.1:8088
+           WORKING_DIRECTORY ${PROJECT_BINARY_DIR}/website
+   )
 endif()
 
 #-----------------------------------------------------------------------------
-#
+# default settings
+#-----------------------------------------------------------------------------
+
+configure_file(${PROJECT_SOURCE_DIR}/settings/defaults.php
+               ${PROJECT_BINARY_DIR}/settings/settings.php)
+
+#-----------------------------------------------------------------------------
 # Tests
-#
 #-----------------------------------------------------------------------------
 
 if (BUILD_TESTS)
@@ -136,27 +166,33 @@ if (BUILD_TESTS)
 
     foreach (test ${TEST_BDD})
         add_test(NAME bdd_${test}
-                 COMMAND lettuce features/${test}
-                 WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}/tests)
+                 COMMAND behave ${test}
+                 WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}/test/bdd)
         set_tests_properties(bdd_${test}
             PROPERTIES ENVIRONMENT "NOMINATIM_DIR=${PROJECT_BINARY_DIR}")
     endforeach()
 
     add_test(NAME php
              COMMAND phpunit ./
-             WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}/tests-php)
+             WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}/test/php)
+
+    add_test(NAME phpcs
+             COMMAND phpcs --report-width=120 --colors lib website utils
+             WORKING_DIRECTORY ${PROJECT_SOURCE_DIR})
 endif()
 
+#-----------------------------------------------------------------------------
+# Postgres module
 #-----------------------------------------------------------------------------
 
 if (BUILD_MODULE)
     add_subdirectory(module)
 endif()
-if (BUILD_NOMINATIM)
-    add_subdirectory(nominatim)
-endif()
+
+#-----------------------------------------------------------------------------
+# Documentation
+#-----------------------------------------------------------------------------
+
 if (BUILD_DOCS)
    add_subdirectory(docs)
 endif()
-
-#-----------------------------------------------------------------------------