Changes between Initial Version and Version 1 of G8SourceLayout


Ignore:
Timestamp:
06/02/20 01:27:12 (4 years ago)
Author:
marisn
Comment:

Initial version of source code reorganization proposal

Legend:

Unmodified
Added
Removed
Modified
  • G8SourceLayout

    v1 v1  
     1= GRASS 8 new source layout =
     2
     3Rationale: At the moment source directory top level is a mess — distribution / OS specific folders are mixed with source code folders. Moving all source to src would make directory layout cleaner. G8 release is a great opportunity to break everything to make life better.
     4Keep in mind — this is just a proposal to start discussion! Add your input to make it happen.
     5
     6== Folder structure ==
     7
     8How to read: new folder name at the top level, current folders listed below.
     9How to write: add your comments to any item you think should be moved somewhere else etc.
     10
     11=== CI ===
     12
     13Continuous Integration.
     14Do we need this as a separate entry or it should go into packaging?
     15
     16=== doc ===
     17
     18Documentation, that is not individual module help files.
     19 * doc
     20
     21=== src ===
     22
     23All source of GRASS. Should contain everything worth compiling.
     24 * db
     25 * display
     26 * general
     27 * gui
     28 * imagery
     29 * include
     30 * lib
     31 * locale
     32 or should go to the top level?
     33 * misc
     34 * ps
     35 * raster
     36 * raster3d
     37 * scripts
     38 * temporal
     39 * vector
     40
     41=== packaging ===
     42
     43Every distribution or platform specific scripts, build recipes etc.
     44**Question** Are there some packaging systems that require its related files to live on the top level?
     45 * docker
     46 * macosx
     47 * mswindows
     48 * rpm
     49 * singularity
     50 * tools/vagrant => vagrant
     51
     52=== utils ===
     53
     54Helper scripts not intended to be installed as a part of GRASS package.
     55 * tools
     56
     57=== tests ===
     58
     59Testing infrastructure.
     60 * demolocation
     61 * testsuite