Build: Update and move ReadMe.txt
Project: http://git-wip-us.apache.org/repos/asf/incubator-madlib/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-madlib/commit/9362ba80 Tree: http://git-wip-us.apache.org/repos/asf/incubator-madlib/tree/9362ba80 Diff: http://git-wip-us.apache.org/repos/asf/incubator-madlib/diff/9362ba80 Branch: refs/heads/latest_release Commit: 9362ba803c62229a764d946f650c58685f8965d4 Parents: 658ecde Author: Rahul Iyer <ri...@apache.org> Authored: Wed Apr 19 16:09:27 2017 -0700 Committer: Rahul Iyer <ri...@apache.org> Committed: Wed Apr 19 16:09:27 2017 -0700 ---------------------------------------------------------------------- CMakeLists.txt | 1 - ReadMe.txt | 52 ---------------------------------- deploy/PGXN/CMakeLists.txt | 1 + deploy/PGXN/META.json.in | 2 +- deploy/PGXN/ReadMe.txt | 62 +++++++++++++++++++++++++++++++++++++++++ doc/CMakeLists.txt | 2 +- doc/mainpage.dox.in | 10 ++++--- 7 files changed, 71 insertions(+), 59 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-madlib/blob/9362ba80/CMakeLists.txt ---------------------------------------------------------------------- diff --git a/CMakeLists.txt b/CMakeLists.txt index b2e6cf9..b2172ef 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -182,7 +182,6 @@ install(DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}/licenses" ) install( FILES - "${CMAKE_CURRENT_SOURCE_DIR}/ReadMe.txt" "${CMAKE_CURRENT_SOURCE_DIR}/README.md" "${CMAKE_CURRENT_SOURCE_DIR}/RELEASE_NOTES" DESTINATION doc http://git-wip-us.apache.org/repos/asf/incubator-madlib/blob/9362ba80/ReadMe.txt ---------------------------------------------------------------------- diff --git a/ReadMe.txt b/ReadMe.txt deleted file mode 100644 index 2116d7f..0000000 --- a/ReadMe.txt +++ /dev/null @@ -1,52 +0,0 @@ -MADlib Read Me --------------- - -MADlib is an open-source library for scalable in-database analytics. -It provides data-parallel implementations of mathematical, statistical -and machine learning methods for structured and unstructured data. - -See the project web site located at http://madlib.incubator.apache.org/ for links to the latest -binary and source packages. - -For installation and contribution guides, please see the MADlib wiki at -https://github.com/madlib/madlib/wiki. - -The latest documentation of MADlib modules can be found at http://madlib.incubator.apache.org/docs -or can be accessed directly from the MADlib installation directory by opening -doc/user/html/index.html. - -Changes between MADlib versions are described in the ReleaseNotes.txt file. - -MADlib incorporates material from the following third-party components: -- argparse 1.2.1 "provides an easy, declarative interface for creating command - line tools" - http://code.google.com/p/argparse/ -- Boost 1.47.0 (or newer) "provides peer-reviewed portable C++ source - libraries" - http://www.boost.org/ -- doxypy 0.4.2 "is an input filter for Doxygen" - http://code.foosel.org/doxypy -- Eigen 3.2.2 "is a C++ template library for linear algebra" - http://eigen.tuxfamily.org/index.php?title=Main_Page -- PyYAML 3.10 "is a YAML parser and emitter for Python" - http://pyyaml.org/wiki/PyYAML - -License information regarding MADlib and included third-party libraries can be -found inside the 'licenses' directory. - -------------------------------------------------------------------------- - -The following list of functions have been deprecated and will be removed on -upgrading to the next major version: - - All overloaded functions 'cox_prop_hazards' and 'cox_prop_hazards_regr'. - - All overloaded functions 'mlogregr'. - - Overloaded forms of function 'robust_variance_mlogregr' that accept - individual optimizer parameters (max_iter, optimizer, tolerance). These - parameters have been replaced with a single optimizer parameter. - - Overloaded forms of function 'clusterd_variance_mlogregr' that accept - individual optimizer parameters (max_iter, optimizer, tolerance). These - parameters have been replaced with a single optimizer parameter. - - Overloaded forms of function 'margins_mlogregr' that accept - individual optimizer parameters (max_iter, optimizer, tolerance). These - parameters have been replaced with a single optimizer parameter. - - All overloaded functions 'margins_logregr'. http://git-wip-us.apache.org/repos/asf/incubator-madlib/blob/9362ba80/deploy/PGXN/CMakeLists.txt ---------------------------------------------------------------------- diff --git a/deploy/PGXN/CMakeLists.txt b/deploy/PGXN/CMakeLists.txt index 39c4c82..22195b9 100644 --- a/deploy/PGXN/CMakeLists.txt +++ b/deploy/PGXN/CMakeLists.txt @@ -12,6 +12,7 @@ set(MADLIB_PGXN_NAME "madlib-pgxn-${MADLIB_PGXN_VERSION_STR}") configure_file(META.json.in META.json) configure_file(generate_package.sh.in generate_package.sh @ONLY) configure_file(zipignore.in zipignore) +configure_file(ReadMe.txt ReadMe.txt COPYONLY) add_custom_command( OUTPUT madlib.zip COMMAND "${CMAKE_COMMAND}" -E create_symlink http://git-wip-us.apache.org/repos/asf/incubator-madlib/blob/9362ba80/deploy/PGXN/META.json.in ---------------------------------------------------------------------- diff --git a/deploy/PGXN/META.json.in b/deploy/PGXN/META.json.in index 914454d..e1196c0 100644 --- a/deploy/PGXN/META.json.in +++ b/deploy/PGXN/META.json.in @@ -8,7 +8,7 @@ "provides": { "madlib": { "file": "madlib--@MADLIB_VERSION_MAJOR@.@MADLIB_VERSION_MINOR@.@MADLIB_VERSION_PATCH@.sql", - "docfile": "ReadMe.txt", + "docfile": "deploy/PGXN/ReadMe.txt", "version": "@MADLIB_VERSION_MAJOR@.@MADLIB_VERSION_MINOR@.@MADLIB_VERSION_PATCH@" } }, http://git-wip-us.apache.org/repos/asf/incubator-madlib/blob/9362ba80/deploy/PGXN/ReadMe.txt ---------------------------------------------------------------------- diff --git a/deploy/PGXN/ReadMe.txt b/deploy/PGXN/ReadMe.txt new file mode 100644 index 0000000..2982477 --- /dev/null +++ b/deploy/PGXN/ReadMe.txt @@ -0,0 +1,62 @@ +MADlib Read Me +-------------- + +MADlib is an open-source library for scalable in-database analytics. +It provides data-parallel implementations of mathematical, statistical +and machine learning methods for structured and unstructured data. + +See the project web site located at http://madlib.incubator.apache.org/ for +links to the latest binary and source packages. + +For installation and contribution guides, please see the MADlib wiki at +https://cwiki.apache.org/confluence/display/MADLIB. + +The latest documentation of MADlib modules can be found at http://madlib.incubator.apache.org/docs +or can be accessed directly from the MADlib installation directory by opening +doc/user/html/index.html. + +Changes between MADlib versions are described in the ReleaseNotes.txt file. + +MADlib incorporates material from the following third-party components: + +Bundled with source code: +- libstemmer "small string processing language" + http://snowballstem.org/ +- m_widen_init "allows compilation with recent versions of gcc with runtime + dependencies from earlier versions of libstdc++" + https://github.com/apache/incubator-madlib/blob/master/licenses/third_party/_M_widen_init.txt +- PyYAML 3.10 "is a YAML parser and emitter for Python" + http://pyyaml.org/wiki/PyYAML +- argparse 1.2.1 "provides an easy, declarative interface for creating command + line tools" + http://code.google.com/p/argparse/ +- UseLATEX.cmake "CMAKE commands to use the LaTeX compiler" + https://github.com/kmorel/UseLATEX/blob/master/UseLATEX.cmake + +Downloaded at build time: +- Boost 1.61.0 (or newer) "provides peer-reviewed portable C++ source + libraries" + http://www.boost.org/ +- Eigen 3.2 "is a C++ template library for linear algebra" + http://eigen.tuxfamily.org/index.php?title=Main_Page +- PyXB 1.2.4 "Python library for XML Schema Bindings" + +License information regarding MADlib and included third-party libraries can be +found inside the 'licenses' directory. + +------------------------------------------------------------------------- + +The following list of functions have been deprecated and will be removed on +upgrading to the next major version: + - All overloaded functions 'cox_prop_hazards' and 'cox_prop_hazards_regr'. + - All overloaded functions 'mlogregr'. + - Overloaded forms of function 'robust_variance_mlogregr' that accept + individual optimizer parameters (max_iter, optimizer, tolerance). These + parameters have been replaced with a single optimizer parameter. + - Overloaded forms of function 'clusterd_variance_mlogregr' that accept + individual optimizer parameters (max_iter, optimizer, tolerance). These + parameters have been replaced with a single optimizer parameter. + - Overloaded forms of function 'margins_mlogregr' that accept + individual optimizer parameters (max_iter, optimizer, tolerance). These + parameters have been replaced with a single optimizer parameter. + - All overloaded functions 'margins_logregr'. http://git-wip-us.apache.org/repos/asf/incubator-madlib/blob/9362ba80/doc/CMakeLists.txt ---------------------------------------------------------------------- diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt index aa969dc..d85272e 100644 --- a/doc/CMakeLists.txt +++ b/doc/CMakeLists.txt @@ -2,7 +2,7 @@ # MADlib Documentation # ------------------------------------------------------------------------------ -set(DOXYGEN_README_FILE "../ReadMe.txt" CACHE STRING +set(DOXYGEN_README_FILE "../README.md" CACHE STRING "Path to ReadMe file relative to the doc directory after installation") set(DOXYGEN_LICENSE_DIR "../../licenses" CACHE STRING "Path to license directory relative to the doc directory after installation") http://git-wip-us.apache.org/repos/asf/incubator-madlib/blob/9362ba80/doc/mainpage.dox.in ---------------------------------------------------------------------- diff --git a/doc/mainpage.dox.in b/doc/mainpage.dox.in index 94950e7..510ab1b 100644 --- a/doc/mainpage.dox.in +++ b/doc/mainpage.dox.in @@ -30,10 +30,12 @@ Useful links: </li> </ul> -Please refer to the <a href="https://github.com/apache/incubator-madlib/blob/master/ReadMe.txt";>Read-Me</a> file for information -about incorporated third-party material. License information regarding MADlib -and included third-party libraries can be found inside the -<a href="https://github.com/apache/incubator-madlib/blob/master/LICENSE";>License</a> directory. +Please refer to the +<a href="https://github.com/apache/incubator-madlib/blob/master/README.md";>ReadMe</a> +file for information about incorporated third-party material. License information +regarding MADlib and included third-party libraries can be found inside the +<a href="https://github.com/apache/incubator-madlib/blob/master/LICENSE";> +License</a> directory. @defgroup grp_datatrans Data Types and Transformations @{Data types and transformation operations @}
