Gitiles
Code Review Sign In
gerrit.opencord.org / onf-make / ad7bd3fe665f83d04d695db29fa57b9c443a792d
commitad7bd3fe665f83d04d695db29fa57b9c443a792d[log] [tgz]
authorJoey Armstrong <joey@opennetworking.org>Mon Oct 02 16:55:59 2023 -0400
committerJoey Armstrong <joey@opennetworking.org>Wed Nov 01 16:07:42 2023 +0000
treee0dfd99ec1b3967cfe426beb2cf12cd90be69e2c
parent7f590b9daf005b926ae7e42bae056b166ec2f4d1 [diff]
Integration edits for repo:voltha-docs use.

This patch will add makefile targets and exclusions for doc8 (estructuredText) linting.

makefiles/lint/doc8/excl.mk
makefiles/lint/doc8/doc8.mk
makefiles/lint/doc8/help.mk
makefiles/lint/doc8/include.mk
makefiles/lint/doc8/install.mk
------------------------------
  o Apply exclusion list so checking will not fail on python venv dirs.
  o Split include.mk into named modular makfiles.

makefiles/lint/include.mk
makefiles/lint/shell.mk
-------------------------
  o Remove legacy shell.mk config, lint target loads from lint/shell/*.

Change-Id: I8c214dc499356edf9778ae7ec1deeddf35bd3b65
6 files changed
tree: e0dfd99ec1b3967cfe426beb2cf12cd90be69e2c
  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