Changeset 169

Timestamp:

12/01/05 16:04:55 (19 years ago)

Author:

boris

Message:

• added sections 'repository structure' and 'building software' to the hacking manual

File:

• docs/HACKING (modified) (2 diffs)

docs/HACKING

@@ -1 @@
-Stuff that are nice to know if you want to hack on MDT.
+THE MDT HACKING MANUAL
 
-I. Making a release
+¤ REPOSITORY STRUCTURE
 
-I.I. Motivational blurb
+¤¤ BACKGROUND BLURB
+
+This section describes the folder structure of the repository, where the things
+are stored and where they should be stored. The discussion starts at the root
+of the MDT subversion repository. Refer to the MDT website for the URL to
+the root of the repository.
+
+¤¤ THE ROOT
+
+ (repository root)
+   + tags     release (and possiby other) tags 
+      + 0.2   source code for 0.2 relese of MDT
+   + trunk    the mainline brunch
+   + docs     general documentation on the project
+
+¤¤ PROJECS
+
+Inside the trunk directory or root directory of any branch there is following
+structure:
+
+  (branch root)
+    + org.modelica.mdt          THE plugin project
+    + org.modelica.mdt.test     the regression tests
+    + org.modelica.mdt.feature  the MDT feature that groups all plugins
+    + org.modelica.mdt.site     the MDT update site
+
+All folders are Eclipse projects and can be checked out into the root of
+the eclipse workspace.
+
+¤ BUILDING SOFTWARE
+
+The only supported way to build mdt plugins, regression tests, feature and 
+update site is through Eclipse. Normaly it is sufficient to import the
+projects into the workspace and let the eclipse autobuilders do the job.
+Building the feature and updatesite is a manul processdure and is documented
+in the 'Making a release' section in this manual.
+
+The only general requirment for all projects is Eclipse 3.* PDE environment. 
+It should be noted that only Eclipse 3.1 and 3.1.1 have been tested and stuff
+may not work as prescribed in earlier versions.
+
+
+¤¤ BUILDING REGRESSION TESTS
+
+To build (and run) the regression tests you need to download 'abbot for eclipse'
+version 1.0rc1 or later plugin. It is available from 
+http://prdownloads.sourceforge.net/abbot/abbot_1.0-rc1-eclipse-3.0.zip?download
+ 
+¤ MAKING A RELEASE
+
+¤¤ MOTIVATIONAL BLURB
 
 The intention of this section is to serve as both a cheat sheet while making a 
@@ -10 +60 @@
 quality of the releases. All in all, doesn't everyone love processes?
 
-I.II. The release procedure
+¤¤ THE RELEASE PROCEDURE
 
  * start with a clean workspace, e.g. use File->Switch Workspace and switch to