blob: f73f2b2b2ea3d3bd21f1182fcf55f0130f25c469 [file] [log] [blame]
Joey Armstronga5325392024-04-02 13:22:12 -04001# -*- makefile -*-
2# -----------------------------------------------------------------------
3# Copyright 2017-2024 Open Networking Foundation Contributors
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#
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# SPDX-FileCopyrightText: 2017-2024 Open Networking Foundation Contributors
18# SPDX-License-Identifier: Apache-2.0
19# -----------------------------------------------------------------------
20
21## -----------------------------------------------------------------------
22## Intent: Display target help
23## -----------------------------------------------------------------------
24help ::
25 @printf ' %-33.33s %s\n' 'lf-tempdir(-help)' \
26 'Create a temp directory for internal makefile use'
27
28## -----------------------------------------------------------------------
29## Intent: Display extended target help
30## -----------------------------------------------------------------------
31lf-tempdir-help:
32 @printf 'Usage: make [options] [target] ...\n'
33 @printf ' %-33.33s %s\n' 'lf-mk-tmp-create' \
34 'Create a temporary directory (dependency driven)'
35 @printf ' %-33.33s %s\n' 'lf-mk-meta-create' \
36 'Create a directory for tempdir timestamp tracking'
37 @printf ' %-33.33s %s\n' 'lf-mk-todo' \
38 'Display a list of enhancements for the target'
39
40 @printf '\n[VARS]\n'
41 @printf ' %-33.33s %s\n' ' lf-mk-tmp=' \
42 'Temp directory path'
43 @printf ' %-33.33s %s\n' ' lf-mk-tmp-name=' \
44 'Temp directory basename'
45 @printf ' %-33.33s %s\n' ' lf-mk-user-meta=' \
46 'Per-user timestamp and resource directory (internal)'
47 @printf ' %-33.33s %s\n' ' lf-mk-user-mktemp=' \
48 'Per-user temp directory paths (one per invocation)'
49
50## -----------------------------------------------------------------------
51## -----------------------------------------------------------------------
52# todo-all += lf-mk-todo
53lf-mk-todo ::
54
55 $(call banner-enter,$@)
56
57 @printf '\n[TODO]\n'
58 @printf ' * Replace lf/include.mk macro onf-mk-tmp= with lf-mk-tmp=\n'
59 @printf ' * Create a BATS unit test for tempdir creation\n'
60 @printf ' * Document makefile targets and behavior on docs.voltha.org\n'
61 @printf '\n'
62
63 $(call banner-leave,$@)
64
65# [EOF]