Gitiles
Code Review Sign In
gerrit.opencord.org / onf-make / 7ebfb1f38c7461d35bc80ebdb3f8eac6b7e25ac3
commit7ebfb1f38c7461d35bc80ebdb3f8eac6b7e25ac3[log] [tgz]
authorJoey Armstrong <joey@opennetworking.org>Thu Feb 29 12:24:08 2024 -0500
committerJoey Armstrong <joey@opennetworking.org>Thu Feb 29 19:29:48 2024 +0000
tree5816238e09fa8a40462a71bd10489abb4a731b0f
parenta3f9aca5a06297832e399a63e92631b69c853b60 [diff]
Improve target coverage for the reuse license checker.

misc
----
  o Copyright notice update from onf v1 to onf v1.1

makefiles/etc/utils.mk
----------------------
  o Function path-by-makefilepath-by-makefile():
    - Replace $(subst include.mk) with $(dir) so path construction becomes generic.
    - Added wrapper function genpath-makefiles() to improve call usability.

makefiles/lint/license/include.mk
makefiles/lint/license/reuse.mk
makefiles/lint/license/install.mk
---------------------------------
  o Added requirements.txt for reuse tool install (ability to vesion and freeze for release).
  o Define command var REUSE= so local devs can override.
  o Added banner-{enter,leave} for logfile visibility.

makefiles/lint/license/include.mk

makefiles/lint/license/help.mk
------------------------------
  o Document a few missing targets for 'make help' and 'make lint-reuse-help'.

[HOWTO: test]
-------------
% make sterile
% make venv                 # install virtualenv
% make lint-reuse-install

% make sterile
% make lint-reuse-version

% make sterile
% make lint-reuse

Change-Id: I91f4789981f3d3c5bc744d2db99374f9790e3b98
7 files changed
tree: 5816238e09fa8a40462a71bd10489abb4a731b0f
  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