makefiles/lint/robot/help.mk

# -*- makefile -*-
# -----------------------------------------------------------------------
# Copyright 2022-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: 2022-2024 Open Networking Foundation Contributors
# SPDX-License-Identifier: Apache-2.0
# -----------------------------------------------------------------------
# Intent:
# -----------------------------------------------------------------------

$(if $(DEBUG),$(warning ENTER))

## -----------------------------------------------------------------------
## Intent: Display topic help
## -----------------------------------------------------------------------
help-summary ::
	@printf '  %-30s %s\n' 'lint-robot'\
      'Style check ReStructed Text (rst) documents'
	@printf '  %-30s %s\n' 'lint-robot-help'\
	  'Show verbose target help'
  ifdef VERBOSE
	@$(MAKE) --no-print-directory lint-robot-help
  endif

## -----------------------------------------------------------------------
## Intent: Display extended topic help
## -----------------------------------------------------------------------
.PHONY: lint-robot-help
lint-robot-help ::
	@printf '  %-30s %s\n' 'lint-robot-all'\
	  'Robot check available sources'
	@printf '  %-30s %s\n' 'lint-robot-mod'\
	  'Robot check locally modified files (git status)'
	@printf '  %-30s %s\n' 'lint-robot-src'\
      'Robot check a list of files passed in'

	@printf '  %-30s %s\n' 'lint-robot-install'\
	  'Install robot lint command rflint'

	@printf '  %-30s %s\n' 'rflint-cmd-help'\
      'Display rflint command usage'


$(if $(DEBUG),$(warning LEAVE))

# [EOF]