Gitiles
Code Review Sign In
gerrit.opencord.org / onf-make / 6fdded6e4468b30be44f38bd90e306a3f1c5645e
commit6fdded6e4468b30be44f38bd90e306a3f1c5645e[log] [tgz]
authorJoey Armstrong <joey@opennetworking.org>Thu Nov 30 12:47:50 2023 -0500
committerJoey Armstrong <joey@opennetworking.org>Thu Nov 30 12:47:50 2023 -0500
tree1f0f77e8e9420101a230c3a78b996f5395ba65e7
parentc2094fce7853aa27d34d0d6fc1691da30f1fa7e3 [diff]
lint-doc8 exclusion string fixes

makefiles/lint/doc8/doc8.mk
---------------------------
  o Added debug flag LINT_DOC8_DEBUG=1 for the module.
  o Unwind iteration loop constructing exclusion command line arguments.
  o Display each pattern digested when DEBUG is enabled.
  o Remove double-quotes from --ignore-path "$(dir)", re-quoting single
    quoted exclusion strings added by excl.mk will corrupt them.

Change-Id: I324a9d4885be53c038170890e6a82aadfd9cd89a
1 file changed
tree: 1f0f77e8e9420101a230c3a78b996f5395ba65e7
  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