Gitiles
Code Review Sign In
gerrit.opencord.org / onf-make / cacdaa0b72f421fa1250c83fb67a537d064f27fd
commitcacdaa0b72f421fa1250c83fb67a537d064f27fd[log] [tgz]
authorJoey Armstrong <joey@opennetworking.org>Thu Feb 08 16:40:55 2024 -0500
committerJoey Armstrong <joey@opennetworking.org>Fri Feb 09 11:14:26 2024 -0500
tree1ab059872354472173c6bc7db011843207d0ccb2
parent88fca7236a5df41192c5305dcb51964e32fbfda6 [diff]
Add golang makefile library targets for 'go mod'

makefiles/include.mk
makefiles/golang/include.mk
makefiles/golang/mod-update.mk
------------------------------
  o Added target mod-tidy   to invoke 'go mod tidy'   w/output banner.
  o Added target mod-vendor to invoke 'go mod vendor' w/output banner.
  o Added helper target mod-update to invoke mod-tidy and mod-vendor.
  o Targets help-summary (~help) and mod-update-help document use.
  o Dev mode flag LOCAL_FIX_PERMS=1 can be added to correct problems
    when docker mount is unaware of user uid/gid.

makefiles/targets/sterile.mk
----------------------------
  o Corrected a comment typo.
    + Amusing when this checkin message also requires a "correction".

Change-Id: Ia50c43a7b7bab4340a5390956cccd857a938c8c9
4 files changed
tree: 1ab059872354472173c6bc7db011843207d0ccb2
  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