Merge branch 'develop' into MAX-324

Documentation-Contents.md

@@ -1,4 +1,4 @@
-[Search page for MaxScale Documentation]((http://mariadb-corporation.github.io/MaxScale/Search/)
+[Search page for MaxScale Documentation](http://mariadb-corporation.github.io/MaxScale/Search/)
 
 # Contents
 

Getting-Started/Configuration-Guide.md

@@ -518,7 +518,7 @@ Connection based routing is a mechanism by which MaxScale will, for each incomin
 
 ## Statement Based Routing
 
-Statement based routing is somewhat different, the routing modules examine every statement the client sends and determines, on a per statement basis, which of the set of backend servers in the service is best to execute the statement. This gives better dynamic balancing of the load within the cluster but comes at a cost. The query router must understand the statement that is being routing and may have to parse the statement in order to achieve this. 
+Statement based routing is somewhat different, the routing modules examine every statement the client sends and determines, on a per statement basis, which of the set of backend servers in the service is best to execute the statement. This gives better dynamic balancing of the load within the cluster but comes at a cost. The query router must understand the statement that is being routed and may have to parse the statement in order to achieve this. 
 
 Parsing within the router adds overhead to the cost of routing and makes this type of router best suitable for loads in which the gains outweigh this added cost. The added cost from statement parsing also gives the possibility to create and use new type of filters which are based on statement processing. In contrast to the added processing cost, statement-based routing may increase the performance of the cluster by offloading statements away from the master when possible.
 

Getting-Started/Getting-Started-With-MaxScale.md

@@ -45,11 +45,8 @@ Alternatively you may download the MaxScale source and build your own binaries.
 First clone the GitHub project to your machine either via the web interface, your favorite graphical interface or the git command line
 
     $ git clone https://github.com/mariadb-corporation/MaxScale
-
     Cloning into 'MaxScale'...
-
     remote: Counting objects: 16228, done.
-
     ...
 
 Change directory to the MaxScale directory, create a build directory and change directory to that build directory
@@ -111,25 +108,17 @@ $ cmake -DMYSQL\_DIR=/usr/mariadb-5.5.41-linux-x86_64/include/mysql \
 Once the cmake command is complete simply run make to build the MaxScale binaries.
 
     $ make
-
     **Scanning dependencies of target utils**
-
     [  1%] Building CXX object utils/CMakeFiles/utils.dir/skygw_utils.cc.o
-
     **Linking CXX static library libutils.a**
-
     [  1%] Built target utils
-
     **Scanning dependencies of target log_manager**
-
     [  2%] Building CXX object log_manager/CMakeFiles/log_manager.dir/log_manager.cc.o
-
     ...
 
 After the completion of the make process the installation can be achieved by running the make install target.
 
     $ make install
-
     ...
 
 This will result in an installation being created which is identical to that which would be achieved by installing the binary package.
@@ -162,3 +151,4 @@ As well as the four major configuration choices outlined above there are also ot
 
 There are various administration tasks that may be done with MaxScale, a client command, maxadmin, is available that will interact with a running MaxScale and allow the status of MaxScale to be monitored and give some control of the MaxScale functionality. There is a separate reference guide for the maxadmin utility and also a short administration tutorial that covers the common administration tasks that need to be done with MaxScale.
 
+        

Release-Notes/MaxScale-0.5-Release-Notes.md

@@ -48,7 +48,7 @@ MaxScale has added the ability to bind a listener for a service to a network add
 
 The server version reported when connected to a database via MaxScale has now been altered. This now shows the MaxScale name and version together with the backend server name. An example of this can be seen below for the 0.5 release.
 
--bash-4.1$ mysql -h 127.0.0.1 -P 4006 -uxxxx -pxxxx
+-bash-4.1$ mysql -h 127.0.0.1 -P 4006 -uxxxx -pxxxx
 Welcome to the MariaDB monitor.  Commands end with ; or \\g.
 Your MySQL connection id is 22320
 Server version: MaxScale 0.5.0 MariaDB Server

generate-html.cmake

@@ -0,0 +1,18 @@
+# The BUILD_DIR variable is set at runtime
+
+cmake_minimum_required(VERSION 2.8.12)
+
+set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} "${CMAKE_SOURCE_DIR}/")
+find_package(Pandoc)
+
+if(PANDOC_FOUND AND BUILD_DIR)
+  file(MAKE_DIRECTORY ${BUILD_DIR}/html)
+  file(GLOB_RECURSE MARKDOWN *.md)
+  foreach(VAR ${MARKDOWN})
+    string(REPLACE ".md" ".html" OUTPUT ${VAR})
+    get_filename_component(DIR ${VAR} DIRECTORY)
+    string(REPLACE "${CMAKE_CURRENT_BINARY_DIR}" "${BUILD_DIR}/html" FILE ${OUTPUT})
+    execute_process(COMMAND ${CMAKE_COMMAND} -E chdir ${DIR} ${PANDOC_EXECUTABLE} ${VAR} -o ${OUTPUT})
+    execute_process(COMMAND ${CMAKE_COMMAND} -E copy ${OUTPUT} ${FILE})
+  endforeach()
+endif()

generate-pdf.cmake

@@ -0,0 +1,18 @@
+# The BUILD_DIR variable is set at runtime
+
+cmake_minimum_required(VERSION 2.8.12)
+
+set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} "${CMAKE_SOURCE_DIR}/")
+find_package(Pandoc)
+
+if(PANDOC_FOUND AND BUILD_DIR)
+  file(MAKE_DIRECTORY ${BUILD_DIR}/pdf)
+  file(GLOB_RECURSE MARKDOWN *.md)
+  foreach(VAR ${MARKDOWN})
+    string(REPLACE ".md" ".pdf" OUTPUT ${VAR})
+    get_filename_component(DIR ${VAR} DIRECTORY)
+    string(REPLACE "${CMAKE_CURRENT_BINARY_DIR}" "${BUILD_DIR}/pdf" FILE ${OUTPUT})
+    execute_process(COMMAND ${CMAKE_COMMAND} -E chdir ${DIR} ${PANDOC_EXECUTABLE} ${VAR} -o ${OUTPUT})
+    execute_process(COMMAND ${CMAKE_COMMAND} -E copy ${OUTPUT} ${FILE})
+  endforeach()
+endif()