Changeset 7483c72 in git

Timestamp:

Jun 18, 2014, 6:02:24 AM (10 years ago)

Author:

Oleksandr Motsak <http://goo.gl/mcpzY>

Branches:

(u'fieker-DuVal', '117eb8c30fc9e991c4decca4832b1d19036c4c65')(u'spielwiese', 'fc741b6502fd8a97288eaa3eba6e5220f3c3df87')

Children:

7e72f07c1f21abf5aa4e462a747d4a855c28c848

Parents:

b66a066639de40154e2e4bc28a4cfde273259384

Message:

More doxygen docu

Files:

• dox/Doxyfile.in (modified) (1 diff)
• main.dox (modified) (3 diffs)

dox/Doxyfile.in

@@ -761 +761 @@
                          $(abs_top_srcdir)/libpolys/ \
                          $(abs_top_srcdir)/Singular/ \
+                         $(abs_top_srcdir)/templates/ \
                          $(abs_top_srcdir)/main.dox
 

main.dox

@@ -16 +16 @@
 - \subpage factory_page 
 - \subpage libpolys_page 
+  - \subpage libpolys_misc_page
+  - \subpage libpolys_reporter_page
+  - \subpage libpolys_coeffs_page
+  - \subpage libpolys_polys_page
 - \subpage kernel_page 
   - \subpage kernel_numeric_page
@@ -28 +32 @@
 - \subpage singular_page
   - \subpage dynmodules_page
-  
+
+Please also read \subpage bs_page
+
+
 Here is a short description of the Singular restructurization:
 <A HREF="http://www.singular.uni-kl.de/gap-meeting-2012/SW.Aug.12.motsak.2.pdf">Singular Modularization</A>
-
 
 Dependencies between Singular packages are as follows:
@@ -37 +43 @@
 
 */
+
+
+/*!
+\page bs_page Singular Build System (autotools)
+
+We use autotools. Here is a good autotools (mythbuster) manual: https://www.flameeyes.eu/autotools-mythbuster/
+Singular consists of several packages (that is, libraries with own
+configure scripts): 
+
+- \subpage omalloc_page 
+- \subpage resources_page
+- \subpage factory_page 
+- \subpage libpolys_page 
+- \subpage singular_page
+
+Moreover some of these (top-level) libraries combine smaller ones into
+itself. 
+- \subpage libpolys_page 
+  - \subpage libpolys_misc_page
+  - \subpage libpolys_reporter_page
+  - \subpage libpolys_coeffs_page
+  - \subpage libpolys_polys_page
+- \subpage singular_page
+  - \subpage kernel_page 
+  - \subpage dynmodules_page
+
+
+One can easily exted any existing library by adding new sources to the
+corresponding _SOURCE specification (and headers to _HEADER). 
+Sources or headers may be generated by the builds system
+(automatically by cofigure scripts, manually in compile time by
+targets in makefiles) but have to be treated specially.
+
+
+New sub-libraries may be added to the existing directories (to the
+corresponding Makefile.am's) or to their own (new) directory 
+with a new Makefile.am, which has to be treated by the corresponding
+configure script. If that new directory has to be treated by 
+recursive make  - it has to be listed in in a SUBDIRS section
+by some higher-level Makefile.am (which is treated)
+
+
+It is strongly recommended to add separate unit-tests (TESTS) for any
+package or library.
+
+Please test the build system with `make distcheck` before submitting
+in case of a build system chenges.
+
+*/