Gitiles
Code Review Sign In
gerrit.opencord.org / onf-make / 6f046d073c74f4f74bca1c5d3fe5da9f8d9860b7
commit6f046d073c74f4f74bca1c5d3fe5da9f8d9860b7[log] [tgz]
authorJoey Armstrong <jarmstrong@linuxfoundation.org>Mon Apr 22 13:29:56 2024 -0400
committerJoey Armstrong <jarmstrong@linuxfoundation.org>Fri Apr 26 11:29:51 2024 -0400
tree5aa4a0de34849c98dd4239ae7cc3383f4099d1c7
parenta5d867938f0728523bcb84841ccc5625cd28b76a [diff]
[VOL-5297] Add more pre-commit hooks and git submodule install helpers.

makefiles/consts.mk
-------------------
  o Define macro $(comma) for use in rules (helps avoid delimiter problems).

install/include.mk
install/README.md
------------------
  o Common files installed by bin/setup.sh.
  o Copy into a repositry when repo:onf-make is added as a git submodule.

.pre-commit-config.yaml
-----------------------
  o Include more pre-commit hooks for checking.
  o Added in voltha-lib-go, voltha-docs and others.
  o Include here for central mgmt.

[HOWTO: test]
% make venv
% source .venv/bin/activate
% pre-commit

Change-Id: I15bb814b7d75a450d34af448cb88344d3922c907
Signed-off-by: Joey Armstrong <jarmstrong@linuxfoundation.org>
4 files changed
tree: 5aa4a0de34849c98dd4239ae7cc3383f4099d1c7
  1. .gitignore
  2. .gitreview
  3. .pre-commit-config.yaml
  4. .reuse/
  5. LICENSES/
  6. Makefile
  7. README.md
  8. bin/
  9. config.mk
  10. docs/
  11. install/
  12. makefiles/
  13. makefiles_include_mk.ex
  14. requirements.txt
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

-----------------------------------------------------------------------

Copyright 2023-2024 Open Networking Foundation Contributors

Licensed under the Apache License, Version 2.0 (the "License");

you may not use this file except in compliance with the License.

You may obtain a copy of the License at

http:#www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software

distributed under the License is distributed on an "AS IS" BASIS,

WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

See the License for the specific language governing permissions and

limitations under the License.

-----------------------------------------------------------------------

SPDX-FileCopyrightText: 2023-2024 Open Networking Foundation Contributors

SPDX-License-Identifier: Apache-2.0

-----------------------------------------------------------------------

Intent:

-----------------------------------------------------------------------