Gitiles
Code Review Sign In
gerrit.opencord.org / onf-make / a2db6cde51d0fd4f7a65c1ab19013196fbda209f
commita2db6cde51d0fd4f7a65c1ab19013196fbda209f[log] [tgz]
authorJoey Armstrong <joey@opennetworking.org>Thu Nov 30 12:16:18 2023 -0500
committerJoey Armstrong <joey@opennetworking.org>Fri Dec 22 00:48:12 2023 -0500
treed8b46aa3d4f8892d5c862c06d625f8a4027ddd34
parent7298cc40cd5725ed181b2da29a2135e877fdaf08 [diff]
Misc library edits and cleanup

Makefile
--------
  o Simplify initial bootstrap path construction logic used to load
    the top level library makefile repo:onf-lib/makefiles/include.mk.
  o Remove direct includes (consts.mk) that are loaded by include.mk.

bin/setup.sh
------------
  o Update repo:onf-lib installer script.
  o Re-arrange inlined logic into functions.
  o Added a banner message to display installation progress.
  o Added install_config_mk(), relocate sandbox/config.mk into sandbox/makefiles/onf-lib/config.mk.
  o Added detection logic to handle patching python to v3.10+.

makefiles/etc/include.mk
------------------------
  o Remove dup logic, include.mk mirrored features.mk, changed to simply include features.mk.

makefiles/include.mk
--------------------
  o Relocate display of include/display of help target trailer message
    from top level Makefile into the library makefile hierarchy.

makefiles_include_mk.ex
-----------------------
  o Added git-submodule maintenance helper targets & dependencies that
    consuming repository makefiles can use to automate submodule checkout
    from a clean state.

Change-Id: Id8df17cef09a17325137934d04e58d87ea370621
6 files changed
tree: d8b46aa3d4f8892d5c862c06d625f8a4027ddd34
  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