/make/edam-mk

To get this branch, use:
bzr branch http://bzr.ed.am/make/edam-mk

« back to all changes in this revision

Viewing changes to edam.mk

  • Committer: edam
  • Date: 2009-03-05 14:01:29 UTC
  • Revision ID: edam@waxworlds.org-20090305140129-ykjca5rvvfggzwjt
Tags: 3.0
- renamed to edam.mk; makefile should now be included rather than duplicated and modified
- added documentation comments and a disclaimer
- removed settings that should now be specified in a separaet Makefile before including edam.mk

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
1
#_______________________________________________________________________________
2
2
#
3
 
#                       edam's general-purpose makefile                     v2.4
4
 
#_______________________________________________________________________________
5
 
#                                                                COMMON SETTINGS
6
 
 
7
 
#
8
 
# overridable options
9
 
# (better to specify in environment/command line)
10
 
#
11
 
#export DEBUGMODE       := 1
12
 
#export PROFILEMODE := 1
13
 
#export LINKSTATIC      := 1
14
 
 
15
 
#
16
 
# target binary/library
17
 
#
18
 
#MKSTATICLIB    := 1
19
 
#MKSHAREDLIB    := 1
20
 
TARGET          := tim
21
 
 
22
 
#
23
 
# all source files
24
 
#
25
 
SOURCES         := tim.cc
26
 
 
27
 
#
28
 
# libraries to link against
29
 
#
30
 
LIBRARIES       := 
31
 
 
32
 
#
33
 
# subdirectories to make first
34
 
#
35
 
SUBDIRS         := 
36
 
 
37
 
#
38
 
# additional build flags
39
 
#
40
 
CPPFLAGS        := 
41
 
CFLAGS          := 
42
 
CXXFLAGS        := 
43
 
DFLAGS          := 
44
 
ASFLAGS         := 
45
 
LDFLAGS         := 
46
 
LDPOSTFLAGS     := 
47
 
 
48
 
#_______________________________________________________________________________
49
 
#                                                                 OTHER SETTINGS
 
3
#                       edam's general-purpose makefile
 
4
#_______________________________________________________________________________
 
5
#                                                                    version 3.0
 
6
# Copyright (c) 2008 Tim Marston <edam@waxworlds.org>.
 
7
#
 
8
# Permission is hereby granted, free of charge, to any person obtaining a copy
 
9
# of this software and associated documentation files (the "Software"), to deal
 
10
# in the Software without restriction, including without limitation the rights
 
11
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 
12
# copies of the Software, and to permit persons to whom the Software is
 
13
# furnished to do so, subject to the following conditions:
 
14
#
 
15
# The above copyright notice and this permission notice shall be included in
 
16
# all copies or substantial portions of the Software.
 
17
#
 
18
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 
19
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 
20
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 
21
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 
22
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 
23
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 
24
# THE SOFTWARE.
 
25
#_______________________________________________________________________________
 
26
#
 
27
#
 
28
# This is a general-purpose makefile for use with GNU make. It can be downloaded
 
29
# from http://www.waxworlds.org/edam/software/general-purpose-makefile where you
 
30
# might also find more information/documentation on it's use. The following text
 
31
# can only really be considered a reference to it's use.
 
32
#
 
33
# To use this makefile, put a file named "Makefile" in your project directory.
 
34
# Add all your project's settings to your Makefile and then include this file
 
35
# from it. For example, your Makefile might look something like this:
 
36
#
 
37
#       TARGET = my_program
 
38
#       SOURCES = main.cc foo.cc
 
39
#       LIBRARIES = bar
 
40
#       include ~/src/edam.mk
 
41
#
 
42
# A complete list of all the settings you can use in your Makefile follows. It
 
43
# should be noted, though, that some settings are better defined in the shell's
 
44
# environment and/or specified on the make command line than hard-coded straight
 
45
# in to the Makefile. For example, the "DEBUGMODE" is an ideal candidate for
 
46
# exporting from your shell:
 
47
#       export DEBUGMODE=1
 
48
# and overridding on the command line when necessary:
 
49
#       make DEBUGMODE=
 
50
#
 
51
# It should also be noted that boolean parameters should either be undefined (or
 
52
# defined as an empty string) for "off", and defined as "1" for "on"; as in the
 
53
# above example with setting DEBUGMODE.
 
54
#
 
55
# Here is a list of all configuration parameters:
 
56
#
 
57
# DEBUGMODE    Boolean. Build a debugable version of the target suitable for
 
58
#              debugging with gdb. It's probably better to set this from the
 
59
#              command line or the shell's environment than to hard-code it.
 
60
# PROFILEMODE  Boolean. When set, DEBUGMODE is also implied. Build a profiling
 
61
#              version of the target, for use with gprof. It's probably better
 
62
#              to set this from the command line or the shell's environment
 
63
#              than to hard-code it.
 
64
#
 
65
# LINKSTATIC   Boolean. Set to build a target that staticly links against all
 
66
#              its libraries and doesn't use shared libraries.
 
67
#
 
68
# MKSTATICLIB  Boolean. Target type: Set to build a static library target. If
 
69
#              neither this nor MKSHAREDLIB are set, the target defaults to a
 
70
#              binary executable.
 
71
# MKSHAREDLIB  Boolean. Target type: Set to build a shared library target. If
 
72
#              neither this nor MKSTATICLIB are set, the target defaults to a
 
73
#              binary executable.
 
74
#
 
75
# TARGET       The name of the target file.
 
76
#
 
77
# SOURCES      A list of all source files of whatever language. The language
 
78
#              type is determined by the file extension.
 
79
#
 
80
# LIBRARIES    A list of libraries to link against. Don't include the 'lib'
 
81
#              prefix.
 
82
#
 
83
# SUBDIRS      A list of subdirectories to build before attempting to build the
 
84
#              target. These subdirectories are also included in a clean_all.
 
85
#
 
86
# CPPFLAGS     Flags to give to the C and C++ compilers
 
87
# CFLAGS       Flags to give to the C compiler
 
88
# CXXFLAGS     Flags to give to the C++ compiler
 
89
# DFLAGS       Flags to give to the D compiler
 
90
# ASFLAGS      Flags to give to the assembler
 
91
# LDFLAGS      Flags to give to the linker before librarys
 
92
# LDPOSTFLAGS  Flags to give to the linker after libraries
 
93
#
 
94
# This general-purpose makefile also defines the following goals for use on the
 
95
# command line when you run make:
 
96
#
 
97
# all          This is the default if no goal is specified. It builds subdirs
 
98
#              first and then the target.
 
99
#
 
100
# subdirs      Changes to the subdirectories specified for the project and runs
 
101
#              make in them.
 
102
#
 
103
# target       Builds the target of your Makefile.
 
104
#
 
105
# run          Builds the target of your Makefile and, if successful, runs it.
 
106
#              This is not available if you're building a library of some kind.
 
107
#
 
108
# clean        Deletes temporary files.
 
109
#
 
110
# clean_all    Deletes temporary files and then goes through then project's
 
111
#              subdirectories doing the same.
 
112
#
 
113
# <subdir>     Builds the specified subdirectory from those that are listed for
 
114
#              the project.
 
115
#
 
116
# <file>       Builds the specified file, either an object file or the target,
 
117
#              from those that that would be built for the project.
 
118
#
 
119
# Please report any problems to Tim Marston <edam@waxworlds.org>
 
120
#
 
121
# Known shortcommings:
 
122
# - Using C is probably broken because g++ is currently used for linking. We
 
123
#   should switch to ld and specify the correct crt as required by source files.
 
124
# - Currently can only specify one target. If we could specify several targets
 
125
#   though, we'd need separate sources, libraries and build params for each!
 
126
#
 
127
#_______________________________________________________________________________
 
128
#
50
129
 
51
130
# set debug mode if profiling
52
131
ifdef PROFILEMODE
199
278
endif
200
279
 
201
280
#_______________________________________________________________________________
 
281