Gitiles
Code Review Sign In
gerrit.opencord.org / onf-make / 0e0f05a9820cf003aa20f483f8e959af684f9fa8
commit0e0f05a9820cf003aa20f483f8e959af684f9fa8[log] [tgz]
authorJoey Armstrong <joey@opennetworking.org>Mon Oct 02 17:41:31 2023 -0400
committerJoey Armstrong <joey@opennetworking.org>Tue Nov 14 16:39:10 2023 -0500
treeaedec8feeb0a767aa5332acc99646878411cf562
parent216b04b3c6bada846f240fb0eaf838dc30e77cc7 [diff]
Edits needed for repo:voltha-docs use.

Support a named makefile target for license checking.

makefiles/lint/license/include.mk
makefiles/lint/license/reuse.mk
makefiles/lint/license/help.mk
makefiles/lint/license/install.mk
---------------------------------
  o Add reuse/license checking makefile targets.
  o repo:voltha-docs jobs perform compliance testing.

Change-Id: Ibb4a30a4b18017a8ff15cdd2bb92d1dc357a5de4
4 files changed
tree: aedec8feeb0a767aa5332acc99646878411cf562
  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