Skip to main content

Command-line makefile replacement

Project description

Purpose

To replace makefiles with something easier to use. Opinionated and slanted towards C/C++ workflow.

Status: Increasingly Stable

I am closing in on the stable version of the interface and will likely release a v0.1 soon to commemorate that milestone.

Usage

All uses will assume that there is a file called maekfile within the directory being executed. This file consists of a YML dictionary containing a default configuration along with other potential configurations which are variantes on the default. You may specify a different maekfile on the command line using the --file or -f options.

YML files

The YML file is best presented as an example. Below is an example that will compile an generic 'hello-world' type of application that may be found in the examples directory.

Each file must contain a default configuration. All other configurations will inherit from the default configuration.

default:
  clean: false
  compile: true
  link: true

  sources:
    - gcc/src/main.c
    - gcc/src/example.c

  includes:
    - gcc/inc

debug:
  out: exe
  flags:
    - -O0
    - -g

release:
  clean: true
  flags:
    - -O1

Information and Help

The maek command generally expects to find a maekfile in the current directory. If not found, then the file may be specified using the -f or --file options on the command line.

$> maek --version
maek, version 0.0.3
$> maek --help
Usage: maek [OPTIONS] CONFIGURATION

Options:
  --version            Show the version and exit.
  -c, --clean
  -f, --file TEXT      specifies the maekfile
  -v, --verbose        turn on verbose mode
  -q, --quiet          quiet output, only displays warnings and errors
  -l, --list_configs   shows the available configurations
  --version            Show the version and exit.
  --help               Show this message and exit.

Building a Project

Assuming that a configuration called release is available within the yml file, a suitable build command would be

$> maek release

Cleaning a Project

Need to clean up a project directory in order to do a re-build? Simply call up the configuration name with the --clean parameter.

$> maek release --clean

It is also possible to use the clean option shown in configuration options in order to execute a clean on every build.

Configuration Options

Every maekfile file must contain a default configuration. Each configuration is a level 1 within the YAML-based maekfile. Each configuration may contain the following options:

Configuration Options

clean

Boolean true or false. Will trigger a clean as part of every execution of this configuration. Default: false.

compile

Boolean. Will trigger a compile as part of every execution of this configuration. Default: true.

link

Boolean. Will trigger a link as part of every execution of this configuration. Default: true.

out

List of strings. Specifies the extension of the output. Default: out. Other desired extensions might be exe or elf.

default:
  out:
    - hex
    - bin

exports

List of strings. Will trigger a copy operation of the output file into different formats. Valid strings are hex and bin.

scripts

List of pre and post scripts, which are themselves lists of strings. These commands will be executed verbatim before and/or after the build operation. Defaults to null.

default:
  scripts:
    pre:
      - rm -rf /path/to/somefile
    post:
      - /path/to/custom/script --script_param

toolchain_path

String. Specifies the path to the directory containg the toolchain. Defaults to null.

compiler

String. Defaults to gcc.

linker

String. Defaults to gcc.

objcopy

String. Defaults to objcopy.

size

String. Defaults to size.

flags

A list of strings, each containing flags that will be forwarded to, both, the compiler and the linker.

default:
  flags:
    - -O1
    - -fdata-sections
    - -ffunction-sections

cflags

A list of strings, each containing flags that will be forwarded to the compiler only. Very similar to flags above.

lflags

A list of strings, each containing flags that will be forwarded to the linker only. Very similar to flags above.

sources

A list of strings, each of which is a source. This is usually a list of your c files.

default:
  sources:
    - src/main.c
    - src/included_source.c

includes

A list of strings, similar in format to sources, each element of which is an include file that will be passed to, both, the compiler and linker.

lscripts

A list of strings, similar in format to sources, each element of which will be passed as a linker script into the linker.

Special Strings

Some special strings will be automatically replaced wherever encountered in the maekfile.

{{ BUILD_PATH }} will be replaced by the configuration name. This is useful in some places, particularly in pre and post-build scripts which apply to multiple configurations or for options that require a path (such as generating a map file below).

default:
  lflags:
    - -Xlinker -Map={{ BUILD_PATH }}/map

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

maek-0.0.18-py3-none-any.whl (9.0 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page