Changeset: cc2af2615835 for MonetDB
URL: https://dev.monetdb.org/hg/MonetDB?cmd=changeset;node=cc2af2615835
Added Files:
documentation/source/intro.rst
documentation/source/windowsbuild.rst
Removed Files:
documentation/old/README.rst
Modified Files:
cmake/monetdb-packages.cmake
ctest/cmake/CMakeLists.txt
documentation/index.rst
documentation/source/release.rst
Branch: default
Log Message:
move some old documentation
diffs (truncated from 311 to 300 lines):
diff --git a/cmake/monetdb-packages.cmake b/cmake/monetdb-packages.cmake
--- a/cmake/monetdb-packages.cmake
+++ b/cmake/monetdb-packages.cmake
@@ -27,5 +27,4 @@ if(${CMAKE_SYSTEM_NAME} STREQUAL "Linux"
endif()
endif()
-
include(CPack)
diff --git a/ctest/cmake/CMakeLists.txt b/ctest/cmake/CMakeLists.txt
--- a/ctest/cmake/CMakeLists.txt
+++ b/ctest/cmake/CMakeLists.txt
@@ -8,8 +8,6 @@
# For now these tests only work on special docker containers.
-#project(MonetDB-unittest LANGUAGES C)
-
include(os_release_info)
if(${CMAKE_SYSTEM_NAME} STREQUAL "Linux")
diff --git a/documentation/index.rst b/documentation/index.rst
--- a/documentation/index.rst
+++ b/documentation/index.rst
@@ -16,7 +16,9 @@ Welcome to MonetDB's documentation!
monetdbe/examples
monetdbe/installation
monetdbe/monetdbe_api
+ source/intro
source/build
+ source/windowsbuild
source/build-fedora
source/build-debian
source/clients
diff --git a/documentation/old/README.rst b/documentation/old/README.rst
deleted file mode 100644
--- a/documentation/old/README.rst
+++ /dev/null
@@ -1,34 +0,0 @@
-The MonetDB Database System
-===========================
-
-The MonetDB database is developed by the CWI database research group
-(see https://www.monetdb.org/).
-
-Via the MonetDB project we have brought the MonetDB system in open source,
-where it is accessible at https://www.monetdb.org/Downloads/
-
-The MonetDB database system is a high-performance database kernel for
-query-intensive applications. The MonetDB source can be found at our `Mercurial
-server`__. There is also a `github mirror`__ that is updated once a day.
-
-.. _MonetDB: https://dev.monetdb.org/hg/MonetDB/
-__ MonetDB_
-
-.. _github: https://github.com/MonetDB/MonetDB
-__ github_
-
-If you got a source distribution, please compile and install MonetDB first,
-following the instructions in the file `HowToStart.rst`__ (for Unix)
-or `buildtools/doc/windowsbuild.rst`__ (for Windows).
-
-__ HowToStart.rst
-__ buildtools/doc/windowsbuild.rst
-
-Copyright Notice
-================
-
-This Source Code Form is subject to the terms of the Mozilla Public
-License, v. 2.0. If a copy of the MPL was not distributed with this
-file, You can obtain one at http://mozilla.org/MPL/2.0/.
-
-Copyright 1997 - July 2008 CWI, August 2008 - 2020 MonetDB B.V.
diff --git a/documentation/source/intro.rst b/documentation/source/intro.rst
new file mode 100644
--- /dev/null
+++ b/documentation/source/intro.rst
@@ -0,0 +1,40 @@
+.. This Source Code Form is subject to the terms of the Mozilla Public
+.. License, v. 2.0. If a copy of the MPL was not distributed with this
+.. file, You can obtain one at http://mozilla.org/MPL/2.0/.
+..
+.. Copyright 1997 - July 2008 CWI, August 2008 - 2020 MonetDB B.V.
+
+The MonetDB Database System
+===========================
+
+The MonetDB database is developed by the CWI database research group
+(see https://www.monetdb.org/).
+
+Via the MonetDB project we have brought the MonetDB system in open source,
+where it is accessible at https://www.monetdb.org/Downloads/
+
+The MonetDB database system is a high-performance database kernel for
+query-intensive applications. The MonetDB source can be found at our `Mercurial
+server`__. There is also a `github mirror`__ that is updated once a day.
+
+.. _MonetDB: https://dev.monetdb.org/hg/MonetDB/
+__ MonetDB_
+
+.. _github: https://github.com/MonetDB/MonetDB
+__ github_
+
+If you got a source distribution, please compile and install MonetDB first,
+following the instructions in the file `HowToStart.rst`__ (for Unix)
+or `buildtools/doc/windowsbuild.rst`__ (for Windows).
+
+__ HowToStart.rst
+__ buildtools/doc/windowsbuild.rst
+
+Copyright Notice
+================
+
+This Source Code Form is subject to the terms of the Mozilla Public
+License, v. 2.0. If a copy of the MPL was not distributed with this
+file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+Copyright 1997 - July 2008 CWI, August 2008 - 2020 MonetDB B.V.
diff --git a/documentation/source/release.rst b/documentation/source/release.rst
--- a/documentation/source/release.rst
+++ b/documentation/source/release.rst
@@ -1,7 +1,63 @@
+.. This Source Code Form is subject to the terms of the Mozilla Public
+.. License, v. 2.0. If a copy of the MPL was not distributed with this
+.. file, You can obtain one at http://mozilla.org/MPL/2.0/.
+..
+.. Copyright 1997 - July 2008 CWI, August 2008 - 2020 MonetDB B.V.
+
***************
MonetDB Release
***************
+How to Prepare a Release
+========================
+
+.. This document is written in reStructuredText (see
+ https://docutils.sourceforge.io/ for more information).
+ Use ``rst2html.py`` to convert this file to HTML.
+
+This document gives step-by-step instructions on how to prepare a
+release for the MonetDB suite of programs.
+
+Release Etiquette
+-----------------
+
+- A release is a major time investment of several people. Cooperation
+ of all developers is essential to live up to our charter: to deliver
+ state-of-the-art database technology to the community.
+- In particular, a new release should not be worse than any previous one,
+ i.e., all features and tests that did work before (and are still
+ supported) must still work flawlessly with the new release.
+- Strictly adhere to bug fixes and feature updates. Nothing
+ is a bug fix unless it is covered by a bug report.
+- Remember that after every release there will be uncountable
+ opportunities to get your favorite feature in.
+- Refrain from any act that may complicate the process.
+
+Well before the release
+-----------------------
+
+- Identify a release manager who has the authority to decide on the
+ precise release content and date, rollback updates, block updates,
+ etc. i.e. anything that could put the release in danger.
+- Prepare a draft release note to finalize the scope of the release
+ and inform those affected/responsible for parts to fix errors and
+ prepare/update documentation.
+- Decide on and fix the desired version numbers for all packages involved in
+ the release.
+- All other developers leave the stable branch.
+- Get all the bug fixes (and new features for a major release) in long
+ before continuing with the rest of the steps.
+- Announce freeze dates and planned release dates on the developers
+ list.
+- Regularly try building the release on Windows during this stage.
+ This includes trying to create installers and trying out the
+ installers.
+- A major (and very time consuming) task of the release manager is to
+ continuously remind the developers to indeed care about and fix their
+ bugs. This task consists mainly of reading aloud both the nightly testing
+ result emails and the daily TestWeb status to each involved developer
+ personally.
+
``Procedure``
=============
diff --git a/documentation/source/windowsbuild.rst
b/documentation/source/windowsbuild.rst
new file mode 100644
--- /dev/null
+++ b/documentation/source/windowsbuild.rst
@@ -0,0 +1,121 @@
+.. This Source Code Form is subject to the terms of the Mozilla Public
+.. License, v. 2.0. If a copy of the MPL was not distributed with this
+.. file, You can obtain one at http://mozilla.org/MPL/2.0/.
+..
+.. Copyright 1997 - July 2008 CWI, August 2008 - 2020 MonetDB B.V.
+
+.. This document is written in reStructuredText (see
+ http://docutils.sourceforge.net/ for more information).
+ Use ``rst2html.py`` to convert this file to HTML.
+
+Building MonetDB On Windows
++++++++++++++++++++++++++++
+
+In this document we describe how to build the MonetDB suite of
+programs on Windows using the sources from `our source repository`__.
+This document is mainly targeted at building on Windows on a 32-bit
+architecture, but there are notes throughout about building on Windows
+on a 64-bit architecture which is indicated with Windows64. We have
+successfully built on Windows XP, Windows Server, and Windows 7.
+
+.. _MonetDB: https://dev.monetdb.org/hg/MonetDB/
+
+__ MonetDB_
+
+Introduction
+============
+
+The MonetDB suite of programs consists of a number of components which
+we will describe briefly here. The section names are the names of the
+top-level folders in the Mercurial clone.
+
+Note that in branches up to and including Oct2010 the build process
+was different. This document describes the build process for the
+branch this document is part of. Use the command ``hg branch`` to
+find out the name of the branch.
+
+buildtools
+----------
+
+The buildtools component contains tools that are used to build the
+other components. This component is required, but not all parts of
+this component are required for all configurations.
+
+common
+------
+
+Also known as the MonetDB Common component contains some generally
+useful libraries. This component is required.
+
+gdk
+---
+
+Also known as the Goblin Database Kernel contains the database kernel,
+i.e. the heart of MonetDB. This component is required.
+
+clients
+-------
+
+Also known as the MonetDB Client component contains a library which
+forms the basis for communicating with the MonetDB server components,
+and some interface programs that use this library to communicate with
+the server. This component is required.
+
+monetdb5
+--------
+
+The MonetDB5 Server component is the database server. It uses MAL
+(the MonetDB Algebra Language) as programming interface. This
+component is required.
+
+sql
+---
+
+Also known as MonetDB SQL, this component provides an SQL frontend to
+MonetDB5. This component is required if you need SQL support.
+
+tools
+-----
+
+The tools component contains two parts. The mserver part is the
+actual database server binary and is required. The merovingian part
+is not used on Windows.
+
+geom
+----
+
+The geom component provides a module for the MonetDB SQL frontend.
+This component is optional.
+
+testing
+-------
+
+The testing component contains some files and programs we use for
+testing the MonetDB suite. This component is optional.
+
+Prerequisites
+=============
+
+In order to compile the MonetDB suite of programs, several other
+programs and libraries need to be installed. Some further programs
+and libraries can be optionally installed to enable optional features.
+The required programs and libraries are listed in this section, the
+following section lists the optional programs and libraries.
+
+Chocolatey
+----------
+
+Although Chocolatey_ is not a prerequisite per se, it makes
+installing and maintaining some of the other prerequisites a lot
+easier. Therefore we recommend installing chocolatey. Instructions
_______________________________________________
checkin-list mailing list
checkin-list@monetdb.org
https://www.monetdb.org/mailman/listinfo/checkin-list
