blob: 32499364a0e03eec67b48aedfbeca70c965b1994 [file] [log] [blame]
Joey Armstrong0205d332023-04-11 17:29:23 -04001# -*- makefile -*-
2# -----------------------------------------------------------------------
Joey Armstrong1e07f882023-07-08 19:28:49 -04003# Copyright 2022-2023 Open Networking Foundation (ONF) and the ONF Contributors
Joey Armstrong0205d332023-04-11 17:29:23 -04004#
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#
9# http://www.apache.org/licenses/LICENSE-2.0
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# -----------------------------------------------------------------------
17
Joey Armstrong0205d332023-04-11 17:29:23 -040018.PHONY: help clean help test
19.DEFAULT_GOAL := help
20
Joey Armstronga2db6cd2023-11-30 12:16:18 -050021##---------------------##
22##---] BOOTSTRAP [---##
23##---------------------##
24onf-mk-abs ?= $(abspath $(lastword $(MAKEFILE_LIST)))
25onf-mk-top := $(dir $(onf-mk-abs))
26onf-mk-top := $(patsubst %/,%,$(onf-mk-top))
27
Joey Armstrong0205d332023-04-11 17:29:23 -040028##-------------------##
29##---] GLOBALS [---##
30##-------------------##
Joey Armstrongf128de82023-09-08 17:05:18 -040031TOP ?= .
Joey Armstrong43997db2023-06-04 10:08:58 -040032
Joey Armstrong0205d332023-04-11 17:29:23 -040033##--------------------##
34##---] INCLUDES [---##
35##--------------------##
Joey Armstronga2db6cd2023-11-30 12:16:18 -050036include $(onf-mk-top)/makefiles/include.mk
Joey Armstrong0205d332023-04-11 17:29:23 -040037
Joey Armstrong7f590b92023-10-18 12:07:51 -040038## -----------------------------------------------------------------------
39## Intent: Helper target for interactive README.md viewing
40## Note: This target has limited use for repo:onf-make and this directory
41## Todo: Add makefiles/[lint/]md/include.mk and generalize logic
42## -----------------------------------------------------------------------
43view-docs-src := README.md $(wildcard docs/*.md)
44view-docs-dep := $(addprefix view-dep^,$(view-docs-src))
45
46.PHONY: view $(view-docs-dep)
47view :: $(view-docs-dep)
48
49$(view-docs-dep): # view-dep^README.md => README.md
50 -pandoc $(lastword $(subst ^,$(space),$@)) | lynx -stdin
51
52help ::
53 @echo
54 @printf ' %-25.25s %s\n' 'view'\
55 'Rendering *.md docs for interactive viewing'
56
Joey Armstrong0205d332023-04-11 17:29:23 -040057# [EOF]