| 1 | /*! \page main_page Developer and Reference Manual |
|---|
| 2 | |
|---|
| 3 | Somewhat older kernel documentation can be found at |
|---|
| 4 | <ftp://www.mathematik.uni-kl.de/pub/Math/Singular/doc/singular-anatomy.tgz> |
|---|
| 5 | |
|---|
| 6 | Please also read |
|---|
| 7 | - \subpage bs_page and |
|---|
| 8 | - \ref styleguide |
|---|
| 9 | |
|---|
| 10 | Separate top-level packages are as follows (also see the diagram below): |
|---|
| 11 | - \subpage omalloc_page |
|---|
| 12 | - \subpage resources_page |
|---|
| 13 | - \subpage factory_page |
|---|
| 14 | - \subpage libpolys_page |
|---|
| 15 | - \subpage libpolys_misc_page |
|---|
| 16 | - \subpage libpolys_reporter_page |
|---|
| 17 | - \subpage libpolys_coeffs_page |
|---|
| 18 | - \subpage libpolys_polys_page |
|---|
| 19 | - \subpage kernel_page |
|---|
| 20 | - \subpage kernel_numeric_page |
|---|
| 21 | - \subpage kernel_combinatorics_page |
|---|
| 22 | - \subpage kernel_GBEngine_page |
|---|
| 23 | - \subpage kernel_groebner_walk_page |
|---|
| 24 | - \subpage kernel_fglm_page |
|---|
| 25 | - \subpage kernel_maps_page |
|---|
| 26 | - \subpage kernel_spectrum_page |
|---|
| 27 | - \subpage kernel_linear_algebra_page |
|---|
| 28 | - \subpage kernel_oswrapper_page |
|---|
| 29 | - \subpage singular_page |
|---|
| 30 | - \subpage dynmodules_page |
|---|
| 31 | |
|---|
| 32 | Here is a short description of the Singular restructurization: |
|---|
| 33 | <http://www.singular.uni-kl.de/gap-meeting-2012/SW.Aug.12.motsak.2.pdf> |
|---|
| 34 | |
|---|
| 35 | Dependencies between Singular packages are as follows: |
|---|
| 36 | \dotfile Includes.dot Package dependency diagram |
|---|
| 37 | |
|---|
| 38 | */ |
|---|
| 39 | |
|---|
| 40 | |
|---|
| 41 | /*! |
|---|
| 42 | \page bs_page Singular Build System (autotools) |
|---|
| 43 | |
|---|
| 44 | We use autotools. Here is a good autotools (mythbuster) manual: https://www.flameeyes.eu/autotools-mythbuster/ |
|---|
| 45 | Singular consists of several packages (that is, libraries with own |
|---|
| 46 | configure scripts): |
|---|
| 47 | |
|---|
| 48 | - \subpage omalloc_page |
|---|
| 49 | - \subpage resources_page |
|---|
| 50 | - \subpage factory_page |
|---|
| 51 | - \subpage libpolys_page |
|---|
| 52 | - \subpage singular_page |
|---|
| 53 | |
|---|
| 54 | Moreover some of these (top-level) libraries combine smaller ones into |
|---|
| 55 | itself. |
|---|
| 56 | - \subpage libpolys_page |
|---|
| 57 | - \subpage libpolys_misc_page |
|---|
| 58 | - \subpage libpolys_reporter_page |
|---|
| 59 | - \subpage libpolys_coeffs_page |
|---|
| 60 | - \subpage libpolys_polys_page |
|---|
| 61 | - \subpage singular_page |
|---|
| 62 | - \subpage kernel_page |
|---|
| 63 | - \subpage dynmodules_page |
|---|
| 64 | |
|---|
| 65 | |
|---|
| 66 | One can easily exted any existing library by adding new sources to the |
|---|
| 67 | corresponding _SOURCE specification (and headers to _HEADER). |
|---|
| 68 | Sources or headers may be generated by the builds system |
|---|
| 69 | (automatically by cofigure scripts, manually in compile time by |
|---|
| 70 | targets in makefiles) but have to be treated specially. |
|---|
| 71 | |
|---|
| 72 | |
|---|
| 73 | New sub-libraries may be added to the existing directories (to the |
|---|
| 74 | corresponding Makefile.am's) or to their own (new) directory |
|---|
| 75 | with a new Makefile.am, which has to be treated by the corresponding |
|---|
| 76 | configure script. If that new directory has to be treated by |
|---|
| 77 | recursive make - it has to be listed in in a SUBDIRS section |
|---|
| 78 | by some higher-level Makefile.am (which is treated) |
|---|
| 79 | |
|---|
| 80 | |
|---|
| 81 | It is strongly recommended to add separate unit-tests (TESTS) for any |
|---|
| 82 | package or library. |
|---|
| 83 | |
|---|
| 84 | Please test the build system with `make distcheck` before submitting |
|---|
| 85 | in case of a build system chenges. |
|---|
| 86 | |
|---|
| 87 | See also \ref styleguide |
|---|
| 88 | */ |
|---|
