Gitiles
Code Review Sign In
gerrit.opencord.org / onf-make / 024492a619949ba9ccca670ef1e523a064457798
commit024492a619949ba9ccca670ef1e523a064457798[log] [tgz]
authorJoey Armstrong <jarmstrong@linuxfoundation.org>Mon Apr 01 12:30:35 2024 -0400
committerJoey Armstrong <jarmstrong@linuxfoundation.org>Mon Apr 01 12:30:35 2024 -0400
tree8a666d005b06c73dc6aca5cfe8720f30b893eb57
parentdc04c935b41ad2bef1302c78e2f07430c30f3bd6 [diff]
make lint-reuse: fix SPDX copyright notice.

makefiles/lint/groovy/.groovylintrc.json
----------------------------------------
  o Inline notice strings as json record data.

.gitignore
----------
  o Special case for source patches.
  o reuse tool does not support exceptions.
  o Cannot inline copyright strings in patch data due to patched files being altered.
  o Workaround: gitignore patch sources post checkin.

Signed-off-by: Joey Armstrong <jarmstrong@linuxfoundation.org>
Change-Id: Ifd96df363dbdd234992383d3f971cb1c06e3b599
2 files changed
tree: 8a666d005b06c73dc6aca5cfe8720f30b893eb57
  1. .gitignore
  2. .gitreview
  3. Makefile
  4. README.md
  5. bin/
  6. config.mk
  7. docs/
  8. makefiles/
  9. makefiles_include_mk.ex
  10. 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:

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