Skip to content

Latest commit

 

History

History
153 lines (100 loc) · 5.08 KB

README.md

File metadata and controls

153 lines (100 loc) · 5.08 KB
Raw

MakeBS

MakeBS is a flexible build system for UNIX development environments.

Requirements

Getting MakeBS

Version control for MakeBS is handled with Git. The following command clones its repository:

git clone https://github.com/Boobies/makebs.git

For projects that are versioned with Git, it is recommended that MakeBS be imported as a submodule, as such:

git submodule add https://github.com/Boobies/makebs

and to include the following lines in the project's .gitignore file:

/lib
/man
/obj

Alternatively, GitHub provides an archive of the master branch.

Usage

In order to build a project with MakeBS, the build system must reside in a subdirectory called makebs. The project's root directory should contain a wrapper makefile that may define macros, may contain rules, and must include makebs/makebs.mk. The wrapper makefile is project-specific and should be used as make's input.

The documentation's source should be a set of DocBook documents which will be transformed to man pages by default. While automatic dependency tracking works for XInclude tags, external entities are not supported.

Project Directory Structure

  • bin: Executable files
  • include: Header files
  • lib: Library files
  • makebs: Build system
    • dep: Source code dependencies
      • docbook: Source documentation dependencies
  • man: Man pages
    • manN: Section N
  • obj: Object files
  • src: Source code
    • docbook: Source documentation

Targets

The following targets are supported:

  • all: Builds everything
  • makebs_obj: Compiles source code
  • makebs_lib: Builds libraries
  • makebs_bin: Builds programs
  • makebs_doc: Generates documentation
  • clean: Removes dependency and output directories
  • install: Installs headers, libraries, programs, and/or documentation

By default, the install target will attempt to install everything in /usr/local/ but the wrapper makefile may change this (see the examples below).

Examples

The following example snippets are intended to document the build system's features. Note the order in which things are written:

  1. File macro definitions
  2. MakeBS makefile inclusion
  3. Install macro definition and target rules

Building a Library

makefile
FOOBAR_SRC_FILES = foo.c bar.c
FOOBAR_OBJ_FILES = $(FOOBAR_SRC_FILES:.c=.o)
FOOBAR_LIB_FILE = libfoobar.a

SRC_FILES += $(FOOBAR_SRC_FILES)
LIB_FILES += $(FOOBAR_LIB_FILE)

include makebs/makebs.mk

INSTALL = $(INC_DIR) $(LIB_DIR)

$(LIB_DIR)/$(FOOBAR_LIB_FILE): $(FOOBAR_OBJ_FILES:%=$(OBJ_DIR)/%) | $(LIB_DIR)
	$(AR) $(ARFLAGS) $@ $?

Building a Program

makefile
FOOBAR_SRC_FILES = foo.c bar.c
FOOBAR_OBJ_FILES = $(FOOBAR_SRC_FILES:.c=.o)
FOOBAR_LIB_FILES = libbaz.a
FOOBAR_BIN_FILE = foobar.out

SRC_FILES += $(FOOBAR_SRC_FILES)
BIN_FILES += $(FOOBAR_BIN_FILE)

include makebs/makebs.mk

INSTALL = $(BIN_DIR)

$(BIN_DIR)/$(FOOBAR_BIN_FILE): $(FOOBAR_OBJ_FILES:%=$(OBJ_DIR)/%) $(FOOBAR_LIB_FILES:%=$(LIB_DIR)/%) | $(BIN_DIR)
	$(CC) $(CFLAGS) $(LDFLAGS) -o $@ $(FOOBAR_OBJ_FILES:%=$(OBJ_DIR)/%) -L $(LIB_DIR) $(FOOBAR_LIB_FILES:lib%.a=-l %)

Generating Documenation

makefile
MAN_VOL = 1
FOOBAR_DBK_FILES = foo.xml

DBK_FILES += $(FOOBAR_DBK_FILES)

include makebs/makebs.mk

INSTALL = $(MAN_DIR)
doc2web.sh
DOC_DIR=var/www DOC_EXT=html STYLESHEET=/usr/share/xml/docbook/stylesheet/docbook-xsl-ns/html/docbook.xsl make makebs_doc

Troubleshooting

  • If Saxon cannot be found, its expected location can be changed by using a different definition of the conditionally-defined SAXON macro. It is recommended that it be passed as a variable, as shown in doc2web.sh above.

  • If Saxon complains about dep.xml, it is probably because it is an older version, which implements an XSLT 1.0 processor, instead of an XSLT 2.0 one.

  • If xsltproc complains about the namespaces used in the DocBook XSLT Stylesheets, it may be because the wrong version is used. For instance, the package included with most Linux distributions is docbook-xsl, instead of docbook-xsl-ns.

  • If xsltproc complains when using a custom stylesheet, it may be because it is not XSLT 1.0.

License

MakeBS is free software licensed under the terms and conditions of the GNU Lesser General Public License. For more details, see the COPYING and COPYING.LESSER files.