ifndef Lib.mak.included
Lib.mak.included := 1
-# These variables should be provided by the includer Makefile:
+# These variables should be provided by the Makefile that include us:
# P should be the project name, mostly used to handle include directories
# T should be the path to the top-level directory.
# S should be sub-directory where the current makefile is, relative to $T.
# Default mode used to install files
IMODE ?= 0644
-# Degault install flags
+# Default install flags
IFLAGS ?= -D
-# Use precompiled headers if non-empty
+# Use pre-compiled headers if non-empty
GCH ?=
# Directories
##############
-# Base directory where to install files (can be overrided, should be absolute)
+# Base directory where to install files (can be overridden, should be absolute)
prefix ?= /usr/local
# Path to a complete alternative environment, usually a jail, or an installed
# Generated files top directory
G ?= $D/$F
-# Objects (and other garbage like precompiled headers and dependency files)
+# Objects (and other garbage like pre-compiled headers and dependency files)
# directory
O ?= $G/obj
# returns empty.
eq = $(if $(subst $1,,$2),,$1)
-# Find sources files and get the corresponding object names
-# The first argument should be the sources extension ("c" or "cpp" typically)
-# It expects the variable $T and $O to be defined as commented previously in
-# this file.
-find_objects = $(patsubst $T/%.$1,$O/%.o,$(shell find $C -name '*.$1'))
+# Find sources files and get the corresponding object names. The first
+# argument should be the sources extension ("c" or "cpp" typically). The
+# second argument is where to search for the sources ($C if omitted). The
+# resulting files will always have the suffix "o" and the directory rewritten
+# to match the directory structure (from $T) but in the $O directory. For
+# example, if $T is "/usr/src", $O is "/tmp/obj", $C is "/usr/src/curr" and it
+# have 2 C sources: "/usr/src/curr/1.c" and "/usr/src/curr/dir/2.c", the call:
+# $(call find_objects,c)
+# Will yield "/tmp/obj/curr/1.o" and "/tmp/obj/curr/dir/2.o".
+find_objects = $(patsubst $T/%.$1,$O/%.o,$(shell \
+ find $(if $2,$2,$C) -name '*.$1'))
# Find sources files and get the corresponding object names
# The first argument should be the sources extension ("c" or "cpp" typically)
# Link object files to build an executable. The objects files are taken from
# the prerequisite files ($O/%.o). If in the prerequisite files are shared
# objects ($L/lib%.so), they are included as libraries to link to (-l%). This
-# function is designed to be used as a command in a rule. The ouput name is
+# function is designed to be used as a command in a rule. The output name is
# taken from the rule automatic variables. If an argument is provided, it's
# included in the link command line. The variable LINKER is used to link the
# executable; for example, if you want to link a C++ executable, you should use
> $(if $4,$4,$@))
# Create a symbolic link to the project under the $(INCLUDE_DIR). The first
-# argument is the name of symlink to create. The link is only created if it
-# doesn't already exist.
+# argument is the name of symbolic link to create. The link is only created if
+# it doesn't already exist.
symlink_include_dir = $(shell \
test -L $(INCLUDE_DIR)/$1 \
|| ln -s $C $(INCLUDE_DIR)/$1 )
echo "$2" > $1 ; fi)
-# Overrided flags
+# Overridden flags
##################
# Warn about everything
# Let the program know where it will be installed
override CPPFLAGS += -DPREFIX=$(prefix)
-# Be standard compilant
+# Be standard compliant
override CFLAGS += -std=c99 -pedantic
override CXXFLAGS += -std=c++98 -pedantic
# sub-makes to add values to the special variables $(all), after this makefile
# was read.
.SECONDEXPANSION:
-
+
# Phony rule to make all the targets (sub-makefiles can append targets to build
# to the $(all) variable).
.PHONY: all
###################################
# Create $O, $B, $L and $(INCLUDE_DIR) directories and replicate the directory
-# structure of the project into $O. Create one symlink "last" to the current
-# build directory.
+# structure of the project into $O. Create one symbolic link "last" to the
+# current build directory.
#
# NOTE: the second mkdir can yield no arguments if the project don't have any
# subdirectories, that's why the current directory "." is included, so it
"embedded" into another tweaking the Config.mak.
lib1 is a standalone C library compiled into a shared object. lib2 is another
-shared library which uses lib1 and subproj, which is a standalone project
-"embedded" into this one. subproj produces another standalone shared object.
-Finally, prog is a program which uses lib1 and lib2.
+shared library which uses lib1 and otherproj, which is a standalone project
+(living in the "subproj" subdirectory) "embedded" into this one. otherproj
+produces another standalone shared object. Finally, prog is a program which
+uses lib1 and lib2.
-Every project have it's copy of Lib.mak and it's own Toplevel.mak, which has
-some global permanent configuration (which doesn't depends on users taste, it
-just have information about the project, like it's name, and does the work to
-include Lib.mak, etc.). Lib.mak shouldn't be modified ever (unless you're
-hacking the build system) and Toplevel.mak should be changes very rarely.
+Every project have it's copy of Lib.mak and it's own Toplevel.mak. Both files
+shouldn't be modified ever (unless you're hacking the build system).
Then each directory containing some library or program to build (or directories
to include) has a Build.mak, which has only the logic to build the
projects / software / makeit.git / commitdiff