Gitiles
Code Review Sign In
gerrit.opencord.org / onf-make / c86d0354d9702dbca6a775bd7a43d255dfe1445b
commitc86d0354d9702dbca6a775bd7a43d255dfe1445b[log] [tgz]
authorJoey Armstrong <joey@opennetworking.org>Thu Nov 09 10:31:10 2023 -0500
committerJoey Armstrong <joey@opennetworking.org>Thu Nov 16 09:35:20 2023 -0500
tree32d7e5492e397f91b4f01d1ab61298ef8fce326b
parent0e0f05a9820cf003aa20f483f8e959af684f9fa8 [diff]
Document makefiles/virtualenv/

makefiles/virtualenv/include.mk
-------------------------------
  o This makefile will install/maintain/invoke a python virtualenv via
    makefile target dependencies.
  o Add more comments to describe macro definitions, targets and usage.

Change-Id: I59e428d3d5e85c8299e9d1e19257e47ed33417e0
1 file changed
tree: 32d7e5492e397f91b4f01d1ab61298ef8fce326b
  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