Edits needed for repo:voltha-docs use.
Support a named makefile target for license checking.
makefiles/lint/license/include.mk
makefiles/lint/license/reuse.mk
makefiles/lint/license/help.mk
makefiles/lint/license/install.mk
---------------------------------
o Add reuse/license checking makefile targets.
o repo:voltha-docs jobs perform compliance testing.
Change-Id: Ibb4a30a4b18017a8ff15cdd2bb92d1dc357a5de4
diff --git a/makefiles/lint/license/help.mk b/makefiles/lint/license/help.mk
new file mode 100644
index 0000000..ffd98bd
--- /dev/null
+++ b/makefiles/lint/license/help.mk
@@ -0,0 +1,48 @@
+# -*- makefile -*-
+# -----------------------------------------------------------------------
+# Copyright 2022-2023 Open Networking Foundation (ONF) and the ONF 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.
+# -----------------------------------------------------------------------
+
+$(if $(DEBUG),$(warning ENTER))
+
+## -----------------------------------------------------------------------
+## Intent: Display topic help
+## -----------------------------------------------------------------------
+help-summary ::
+ @printf ' %-30s %s\n' 'lint-reuse'\
+ 'License syntax check'
+ @printf ' %-30s %s\n' 'lint-reuse-help'\
+ 'Show verbose target help'
+ @printf ' %-30s %s\n' 'lint-license'\
+ 'See target lint-reuse'
+ ifdef VERBOSE
+ @$(MAKE) --no-print-directory lint-reuse-help
+ endif
+
+## -----------------------------------------------------------------------
+## Intent: Display extended topic help
+## -----------------------------------------------------------------------
+.PHONY: lint-reuse-help
+lint-reuse-help ::
+ @printf ' %-30s %s\n' 'lint-reuse-all'\
+ 'License check available sources'
+ @printf ' %-30s %s\n' 'lint-reuse-mod'\
+ 'License check locally modified files (git status)'
+ @printf ' %-30s %s\n' 'lint-reuse-src'\
+ 'License check files by path'
+
+$(if $(DEBUG),$(warning LEAVE))
+
+# [EOF]
diff --git a/makefiles/lint/license/include.mk b/makefiles/lint/license/include.mk
index 2b42049..b8f70f4 100644
--- a/makefiles/lint/license/include.mk
+++ b/makefiles/lint/license/include.mk
@@ -15,27 +15,17 @@
# limitations under the License.
# -----------------------------------------------------------------------
-##-------------------##
-##---] GLOBALS [---##
-##-------------------##
+##--------------------##
+##---] INCLUDES [---##
+##--------------------##
+include $(ONF_MAKEDIR)/lint/license/help.mk
+include $(ONF_MAKEDIR)/lint/license/install.mk
+include $(ONF_MAKEDIR)/lint/license/reuse.mk
-##-------------------##
-##---] TARGETS [---##
-##-------------------##
-ifndef NO-LINT-REUSE
- lint : lint-license
-endif
-
-## -----------------------------------------------------------------------
-## Intent: Perform a lint check on makefile sources
-## -----------------------------------------------------------------------
-lint-license:
- reuse --root . lint
-
-## -----------------------------------------------------------------------
-## Intent: Display command help
-## -----------------------------------------------------------------------
-help-summary ::
- @echo ' lint-reuse License syntax checking'
+# Alias targets
+lint-license : lint-reuse
+lint-license-all : lint-reuse-all
+lint-license-mod : lint-reuse-mod
+lint-license-src : lint-reuse-src
# [EOF]
diff --git a/makefiles/lint/license/install.mk b/makefiles/lint/license/install.mk
new file mode 100644
index 0000000..c708482
--- /dev/null
+++ b/makefiles/lint/license/install.mk
@@ -0,0 +1,69 @@
+# -*- makefile -*-
+# -----------------------------------------------------------------------
+# Copyright 2022-2023 Open Networking Foundation (ONF) and the ONF 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: 2022 Open Networking Foundation (ONF) and the ONF Contributors
+# SPDX-License-Identifier: Apache-2.0
+# -----------------------------------------------------------------------
+
+$(if $(DEBUG),$(warning ENTER))
+
+## -----------------------------------------------------------------------
+## Intent: Install the reuse tool
+## -----------------------------------------------------------------------
+
+## Define a macro to standardize and simplify access
+# REUSE ?= $(venv-activate-bin)/reuse
+# REUSE ?= $(activate) && reuse
+
+## -----------------------------------------------------------------------
+## Intent: Display reuse command version string.
+## Note: As a side effect, install reuse by dependency
+## -----------------------------------------------------------------------
+.PHONY: lint-reuse-cmd-version
+lint-reuse-cmd-version : $(venv-activate-bin)/reuse
+
+ $(HIDE) echo
+ $< --version
+
+## -----------------------------------------------------------------------
+## Intent: On-demand instalation of the reuse command
+## -----------------------------------------------------------------------
+.PHONY: lint-reuse-install
+lint-reuse-install : $(venv-activate-bin)/reuse
+$(venv-activate-bin)/reuse : $(venv-activate-script)
+
+ $(call banner-enter,Target $@)
+ $(activate) && pip install reuse
+ $(call banner-leave,Target $@)
+
+## -----------------------------------------------------------------------
+## Intent: Purge reuse tool installation
+## -----------------------------------------------------------------------
+sterile ::
+ $(HIDE)$(RM) "$(venv-abs-bin)/reuse"
+
+## -----------------------------------------------------------------------
+## Intent: Display command usage
+## -----------------------------------------------------------------------
+help::
+ @printf ' %-30s %s\n' 'lint-reuse-install'\
+ 'Install the reuse compliance tool'
+
+# [SEE ALSO]
+# -----------------------------------------------------------------------
+# o https://github.com/fsfe/reuse-tool#install
+
+# [EOF]
diff --git a/makefiles/lint/license/reuse.mk b/makefiles/lint/license/reuse.mk
index 5572bef..408a329 100644
--- a/makefiles/lint/license/reuse.mk
+++ b/makefiles/lint/license/reuse.mk
@@ -23,19 +23,17 @@
##---] TARGETS [---##
##-------------------##
ifndef NO-LINT-REUSE
- lint : lint-license
+ lint : lint-reuse
endif
+lint-reuse-all : lint-reuse
+lint-reuse-mod : lint-reuse
+lint-reuse-src : lint-reuse
+
## -----------------------------------------------------------------------
## Intent: Perform a lint check on makefile sources
## -----------------------------------------------------------------------
-lint-license:
+lint-reuse:
reuse --root . lint
-## -----------------------------------------------------------------------
-## Intent: Display command help
-## -----------------------------------------------------------------------
-help-summary ::
- @echo ' lint-reuse License syntax checking"
-
# [EOF]