Mohid Makefile - Revision history

Guillaume: /* How do I add a new module folder? */

2009-07-17T19:31:45Z

‎How do I add a new module folder?

2009-07-17T19:27:21Z

‎Administrator's guide

2009-07-17T16:45:43Z

‎Action extensible

2009-07-17T16:44:38Z

‎Module extensible

2009-07-17T16:44:08Z

‎Module extensible

2009-07-17T16:43:39Z

‎Module extensible

2009-07-17T16:42:51Z

‎Administrator's guide

2009-07-17T16:42:34Z

‎Administrator's guide

2009-07-17T16:40:34Z

‎Makefile project tree

2009-07-16T18:12:56Z

‎Administrator's guide

@@ Line 96: / Line 96: @@
 ## Assign to variables TARGET and SRCDIR appropriate global variables names
 # Edit the ''Nix.mk'' file:
-## Create the global variables to be assigned to TARGET and SRCDIR
+## Create the global variables to be assigned to TARGET and SRCDIR (make sure the variable to be assigned as TARGET ends in $(SUFFPROG) if it's an executable or $(SUFFLIB) if it's a library).
 ## Edit the MODULES variable
 ## Add the module dependency

← Older revision		Revision as of 19:27, 17 July 2009
Line 87:		Line 87:

	*That's it! You can now build the Linux solution!		*That's it! You can now build the Linux solution!
		+
		+	===How do I add a new module folder?===
		+	# Create a new folder (ex: ''MohidLand''),
		+	# Copy a regular folder ''Makefile'' into the new folder,
		+	# Edit the ''Makefile'':
		+	## Edit the FILES variable
		+	## Edit the dependencies
		+	## Assign to variables TARGET and SRCDIR appropriate global variables names
		+	# Edit the ''Nix.mk'' file:
		+	## Create the global variables to be assigned to TARGET and SRCDIR
		+	## Edit the MODULES variable
		+	## Add the module dependency

	== References ==		== References ==

@@ Line 14: / Line 14: @@
 === Action extensible ===
 An ''action'' is one given process to apply to the whole project: it could be to ''build'' the project, to ''clean'' the project, to ''install'' the binaries of the project to a safe place, to ''Get'' the files of the project from [[Sos|SourceOffSite]] etc ... The [[makefile]] code for the ''actions'' of the MOHID project is located in the files contained by the ''makefiles'' folder (at the bottom of the image).
-*To add an action, one needs to edit the ''actions.mk'' file and create in the ''makefiles'' folder a new ''myaction.mk'' file.
+*To add a new action, one needs to edit the ''Makefiles/Makefiles.mk'' file and the ''Makefiles/Makemodules.mk''.
 === Module extensible ===

@@ Line 19: / Line 19: @@
 The MOHID project has a modular nature. In this makefile project, each module is subject to the same overall actions and each module is contained in a light-blue folder in the image (''MohidWater'', ''Mohid_Base_1'', ''Mohid_Base_2'' and ''...'').
 *To add a new file to an existing module: one must edit the ''Makefile'' file within the module's folder.
-*To add a new module: one must create a new folder, name it after the module, copy the module's files, create the corresponding ''Makefile'' file. Finally, one must edit the ''Makefile'' from the ''root'' folder.
+*To add a new module: one must create a new folder, name it after the module, copy the module's files, create the corresponding ''Makefile'' file. Finally, one must edit the ''Nix.mk'' file from the ''root'' folder.
 ==Makefile project tree==

@@ Line 18: / Line 18: @@
 === Module extensible ===
 The MOHID project has a modular nature. In this makefile project, each module is subject to the same overall actions and each module is contained in a light-blue folder in the image (''MohidWater'', ''Mohid_Base_1'', ''Mohid_Base_2'' and ''...'').
-*To add a new file to an existing module: one must edit the ''Files.mk'' and the ''Dependencies.mk'' within the module's folder.
+*To add a new file to an existing module: one must edit the ''Makefile'' file within the module's folder.
 *To add a new module: one must create a new folder, name it after the module, copy the module's files, create the corresponding ''Makefile'' file. Finally, one must edit the ''Makefile'' from the ''root'' folder.

@@ Line 79: / Line 79: @@
 *... look for the Dependencies section at the end:
- > vim Solutions/Linux/MohidWater/Dependencies.mk
+  '''ModuleNew.${O} : ModuleWaterProperties.${O} \'''
                       '''ModuleHydrodynamic.${O}'''
   ModuleGauge.${O} : ModuleToga.${O}

@@ Line 67: / Line 67: @@
 ===How do I add a new module file in MohidWater?===
 Suppose your new module filename is ''MohidWater/ModuleNew.F90'', and it depends only on ''ModuleGlobalData'', ''ModuleWaterproperties.mod'' and ''ModuleHydrodynamic.F90''.
-*Edit the ''Files.mk'' file in the ''Linux/MohidWater'' folder:
+Edit the ''Makefile'' file in the ''Linux/MohidWater'' folder and...
-  > vim Solutions/Linux/MohidWater/Files.mk
+*... look for the FILES variables section:
   FILES = \
         '''ModuleNew.$(S) \'''
@@ Line 77: / Line 78: @@
         ...
-*Edit the ''Dependencies.mk'' file in the ''Linux/MohidWater'' folder:
+*... look for the Dependencies section at the end:
   > vim Solutions/Linux/MohidWater/Dependencies.mk
   '''ModuleNew.${O} : ModuleWaterProperties.${O} \'''

@@ Line 25: / Line 25: @@
   mohid/Solutions/Linux> tree
+  .
   |-- Editme.mk
-  |-- Files.mk
+  |-- Editme_template.mk
   |-- Makefile
   |-- Makefiles
-  |   |-- All.mk
+  |   |-- Makefile
-  |   |-- Alllib.mk
+  |   |-- Makefiles.mk
-  |   |-- Clean.mk
+  |   `-- Makemodules.mk
   |-- MohidWater
   |   `-- Makefile
   |-- Mohid_Base_1
   |   `-- Makefile
   |-- Mohid_Base_2
   |   `-- Makefile
-  `-- Nix.mk
+  |-- Nix.mk
 == User's guide ==

@@ Line 94: / Line 94: @@
   ModuleSand.${O} : ModuleWaves.${O}
         ...
 *That's it! You can now build the Linux solution!