Gitiles
Code Review Sign In
gerrit.opencord.org / onf-make / db844cdd8e7e1de6672c5398f7640767182653de / . / makefiles / lint / doc8 / excl.mk
blob: cc68ab0f4bdc45a3b8c00f22b6d57e69db40e2ed [file] [log] [blame]
Joey Armstrongf548adc2023-09-08 15:59:42 -0400[diff] [blame]1# -*- makefile -*-
2# -----------------------------------------------------------------------
Joey Armstrongdc04c932024-04-01 12:14:21 -0400[diff] [blame]3# Copyright 2017-2024 Open Networking Foundation Contributors
Joey Armstrongf548adc2023-09-08 15:59:42 -0400[diff] [blame]4#
5# Licensed under the Apache License, Version 2.0 (the "License");
6# you may not use this file except in compliance with the License.
7# You may obtain a copy of the License at
8#
Joey Armstrongbd667e32024-04-10 16:54:11 -0400[diff] [blame]9# http://www.apache.org/licenses/LICENSE-2.0
Joey Armstrongf548adc2023-09-08 15:59:42 -0400[diff] [blame]10#
11# Unless required by applicable law or agreed to in writing, software
12# distributed under the License is distributed on an "AS IS" BASIS,
13# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14# See the License for the specific language governing permissions and
15# limitations under the License.
16# -----------------------------------------------------------------------
Joey Armstrongdc04c932024-04-01 12:14:21 -0400[diff] [blame]17# SPDX-FileCopyrightText: 2017-2024 Open Networking Foundation Contributors
18# SPDX-License-Identifier: Apache-2.0
19# -----------------------------------------------------------------------
Joey Armstrongbd667e32024-04-10 16:54:11 -0400[diff] [blame]20# Intent: This makefile maintains file and directory exclusion lists
21# for doc8 linting.
Joey Armstrongdc04c932024-04-01 12:14:21 -0400[diff] [blame]22# -----------------------------------------------------------------------
Joey Armstrongf548adc2023-09-08 15:59:42 -0400[diff] [blame]23
24$(if $(DEBUG),$(warning ENTER))
25
26## -----------------------------------------------------------------------
27## -----------------------------------------------------------------------
28
Joey Armstrongad7bd3f2023-10-02 16:55:59 -0400[diff] [blame]29lint-doc8-excl-raw += '*/.git'
Joey Armstrongf548adc2023-09-08 15:59:42 -0400[diff] [blame]30lint-doc8-excl-raw += '$(venv-name)'
31lint-doc8-excl-raw += '*/$(venv-name)'
Joey Armstrongbd667e32024-04-10 16:54:11 -0400[diff] [blame]32lint-doc8-excl-raw += './lf/onf-make'
Joey Armstrongf2f0a3f2024-04-04 15:50:09 -0400[diff] [blame]33lint-doc8-excl-raw += 'LICENSES/'
Joey Armstrongad7bd3f2023-10-02 16:55:59 -0400[diff] [blame]34
35# Should we filter generated content as redundant ?
36# Considering _build will be published and consumed.
Joey Armstrongf548adc2023-09-08 15:59:42 -0400[diff] [blame]37$(if $(BUILDDIR),\
38 $(excl lint-doc8-excl-raw += '$(BUILDDIR)'))
39
Joey Armstrongad7bd3f2023-10-02 16:55:59 -0400[diff] [blame]40# -----------------------------------------------------------------------
Joey Armstrongf548adc2023-09-08 15:59:42 -0400[diff] [blame]41# YUCK! -- overhead
42# o Submodule(s) use individual/variant virtualenv install paths.
43# o Exclude special snowflakes to enable library makefile use.
44# o All can use virtualenv.mk for consistent names and cleanup
45# o [TODO] Ignore submodules, individual repos should check their sources.
Joey Armstrongad7bd3f2023-10-02 16:55:59 -0400[diff] [blame]46# -----------------------------------------------------------------------
47lint-doc8-excl-raw += '*/venv_*'# # '*/venv_cord'
Joey Armstrongbd667e32024-04-10 16:54:11 -0400[diff] [blame]48lint-doc8-excl-raw += '*/*_venv'# # '*/vst_venv'
Joey Armstrongf548adc2023-09-08 15:59:42 -0400[diff] [blame]49
Joey Armstrongad7bd3f2023-10-02 16:55:59 -0400[diff] [blame]50## -----------------------------------------------------------------------
51## repo:voltha-docs exclusions
52## Migrate into one of:
53## makefiles/local/lint/doc8/doc8.ini
54## makefiles/local/lint/doc8/excl.mk
55## -----------------------------------------------------------------------
Joey Armstrongf548adc2023-09-08 15:59:42 -0400[diff] [blame]56lint-doc8-excl-raw += './cord-tester'
57lint-doc8-excl-raw += './repos/cord-tester'
58
59lint-doc8-excl-raw += './bbsim/internal/bbsim/responders/sadis/dp.txt'
60lint-doc8-excl-raw += './repos/bbsim/internal/bbsim/responders/sadis/dp.txt'
61lint-doc8-excl-raw += './repos/voltha-helm-charts/voltha-infra/templates/NOTES.txt'
62lint-doc8-excl-raw += './voltha-helm-charts/voltha-infra/templates/NOTES.txt'
63
64$(if $(DEBUG),$(warning LEAVE))
65
66# [EOF]