Gitiles
Code Review Sign In
gerrit.opencord.org / onf-make / f548adc757f6ddeec76a1418ccf0dcf56d4bbeb4
commitf548adc757f6ddeec76a1418ccf0dcf56d4bbeb4[log] [tgz]
authorJoey Armstrong <joey@opennetworking.org>Fri Sep 08 15:59:42 2023 -0400
committerJoey Armstrong <joey@opennetworking.org>Fri Sep 08 15:59:42 2023 -0400
tree13d0763edd097f9af32ce776ab1ed7f7d07477c8
parent825114ee76bfe6054fd975b33519e7d94dd83e3d [diff]
Bulk lint target updates.

Import more files and directories from repo:ci-managment so "make lint"
targets can run cleanly.

Change-Id: If45732f6aa3d1548db538bb1aa68cad9035b82ec
31 files changed
tree: 13d0763edd097f9af32ce776ab1ed7f7d07477c8
  1. .gitreview
  2. Makefile
  3. README.md
  4. config.mk
  5. makefiles/
  6. makefiles_include_mk.ex
README.md

Repository: onf-make

This repo holds generic library makefile logic and targets that can be used to build and test arbitrary targets.

Two module directories are maintained, access through variables:

Make MacroDescription
MAKEDIRPath to project specific makefiles/ directory
ONF_MAKEDIRPath to generic library makefiles/ directory

include $(ONF_MAKEDIR)/include.mk

implicit project import:

include $(MAKEDIR)/include.mk

config.mk

Config.mk contains flags that will {en,dis}able conditional makefile logic.

  • Disable unsupported lint targets for checking source or copyrights.
  • Enable makefile features or per-repository special snowflake logic.
  • Define common flags and values: repo-name = foo
  • Define debugging flags, DEBUG=, VERBOSE=, DEBUG*=

Hierarchy

── [mM]akefile ├── config.mk ├── makefiles/

Basic makefile hierarchy contains:

  • At least one {mM}akefile in the repository root directory.
  • Optional config.mk file to define makefile behavior.
  • A makefiles/ directory containing library logic

For each subdir in the makefiles library the file include.mk exists

├── makefiles │ ├── include.mk │ ├── docker │ │ └── include.mk │ ├── etc │ │ └── include.mk │ ├── help │ │ ├── include.mk │ ├── lint │ │ │ ├── include.mk │ │ │ └── reuse.mk

include.mk will capture and normalize access for target logic. One single include to define all permutations for a makefile target.

Special Snowflakes / Custom Target Logic

% onf-make/makefiles ├── lint │ ├── license │ │ ├── include.mk │ │ ├── license-check.sh │ │ ├── license-helper.sh │ │ ├── reuse.mk │ │ ├── voltha-onos.mk <-----** │ │ └── voltha-protos.mk <-----**

Some repositories contain custom logic and scripts attached to a target. To help support variants and create a bridge for refactoring, a custom makefile named for a repository can be supported

  • For example the lint-license target can be customized

    • Target:lint-license is a dependency of target=lint

    • Create makefiles/lint/license/{repo-name}.mk

      • Define repository-name in config.mk

    • Modify lint/license/include.mk to

      • (hyphen-prefix)include $(MAKEDIR)/lint/license/${repo-name}.mk
      • repo-name.mk when included will define a makefile directive.
      • This directive will inhibit definition of library lint-license targets
      • or a better answer to fully suport display of help targets
      • Include lib makefiles but inhibit processing other lint-license targets.