[VOL-5285] - JJB Upgrade toward v5

makefiles/include.mk
--------------------
  o Define new lib var sandbox-root= pointing at the build directory.
  o Added a comment section at the bottom to document declared vars.

makefiles/virtualenv/requirements-txt.mk
----------------------------------------
  o Rework pip -r requirements.txt logic to be dependency driven.
  o pip install will be run when requirements.txt is modified.

makefiles/virtualenv/include.mk
-------------------------------
  o Populate venv-abs-path= with sandbox-root= to insulate against
    $(PWD) path changes.
  o Split logic into separate makefiles so include.mk remains small.
  o Rework dependencies to leverage the new requirements-txt.mk logic.

Misc
----
  o Rework help help-* targets to not display everything, all the time.
  o make help      : display venv (primary target).
  o make venv-help : display exteneded help, venv targets and flags.

[HOWTO: test]
  % git clone onf-make
  % cd onf-make
  % touch requirements.txt

  % make help | grep venv
  % make venv-help

  % make venv
  % make venv-requirements

  % touch requirements.txt
  % make venv-requirements

Change-Id: I9e12bc45c73a0e2bc90b1fd11c87ccffc7ebe57a
6 files changed
tree: 89959821d75e3754a4e9f0a0614eb3fa01c1541c
  1. .gitignore
  2. .gitreview
  3. Makefile
  4. README.md
  5. bin/
  6. config.mk
  7. docs/
  8. makefiles/
  9. makefiles_include_mk.ex
README.md

onf-make library makefiles

This repository contains common makefile logic and targets that can be used to build arbitrary repositories. Makefile logic is currently being consumed by the VOLTHA project

makefiles/ subdirectories

Two distinct sets of makefiles are needed to support builds:

  • The first is a subdir of makefiles/ named 'onf-make'

    • This directory exists and is maintained as a git-submodule of repo:onf-make.
    • Library makefiles contain independent logic to install common tools such as (virtualenv), perform linting tasks, define constants and perform path/string manipulation, etc.
  • The second makefile directory contains repository/project specific logic:

    • makefiles/local/ exists as a repository subdirectory under SCM.
    • Contains custom targets, variant parameters and custom logic specific to the repository it exists within.
  • Most makefile logic can be parameterized and implemented to support reuse. Consider adding enhancements or refactoring local/ makefile logic into repo:onf-make so all makefiles can leverage it.

Hierarchy

% tree --charset=ascii -n

Makefile
config.mk
makefiles/
|-- include.mk
|-- local
|   |-- include.mk
|   |   |   |-- doc8
|   |   |   |    |-- doc8.ini   (alas only one --config switch allowed)
|-- [onf-make: git-submodule](https://github.com/opencord/onf-make)
|   |-- makefiles
|   |   |-- consts.mk
|   |   |-- include.mk
|   |   |-- lint
|   |   |   |-- doc8            Syntax check ReStructuredText (rst) files
|   |   |   |-- groovy
|   |   |   |-- python
|   |   |   |-- robot.mk        Syntax check robot testing framework
|   |   |   |-- shell.mk        Invoke shellcheck command on scripts
|   |   |   |-- yaml            Syntax check yaml configs

NOTES

  • Ascii art was rendered using

    • tree --charset=ascii -n
  • README.md can be rendered locally using

    • pandoc README.md | lynx -stdin
    • make view

SEE ALSO