Joey Armstrong | 36592e3 | 2022-11-28 09:00:28 -0500 | [diff] [blame] | 1 | # -*- makefile -*- |
| 2 | # ----------------------------------------------------------------------- |
Joey Armstrong | 9f7c57c | 2024-05-03 18:29:30 -0400 | [diff] [blame^] | 3 | # Copyright 2022-2024 Open Networking Foundation Contributors |
Joey Armstrong | 36592e3 | 2022-11-28 09:00:28 -0500 | [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 | # |
| 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 | # ----------------------------------------------------------------------- |
Joey Armstrong | 9f7c57c | 2024-05-03 18:29:30 -0400 | [diff] [blame^] | 17 | # SPDX-FileCopyrightText: 2022-2024 Open Networking Foundation Contributors |
| 18 | # SPDX-License-Identifier: Apache-2.0 |
| 19 | # ----------------------------------------------------------------------- |
| 20 | # Intent: Makefile for Sphinx documentation |
| 21 | # ----------------------------------------------------------------------- |
Zack Williams | 071eda2 | 2019-05-15 18:19:51 -0700 | [diff] [blame] | 22 | |
Joey Armstrong | 9f7c57c | 2024-05-03 18:29:30 -0400 | [diff] [blame^] | 23 | ifndef .DEFAULT_GOAL |
| 24 | .DEFAULT_GOAL := help # ?= help evaluated late |
| 25 | endif |
| 26 | MAKECMDGOALS ?= help |
Joey Armstrong | 36592e3 | 2022-11-28 09:00:28 -0500 | [diff] [blame] | 27 | |
Joey Armstrong | 9f7c57c | 2024-05-03 18:29:30 -0400 | [diff] [blame^] | 28 | $(if $(findstring disabled-joey,$(USER)),\ |
| 29 | $(eval USE_LF_MK := 1)) # special snowflake |
Joey Armstrong | 36592e3 | 2022-11-28 09:00:28 -0500 | [diff] [blame] | 30 | |
| 31 | ##--------------------## |
| 32 | ##---] INCLUDES [---## |
| 33 | ##--------------------## |
Joey Armstrong | 9f7c57c | 2024-05-03 18:29:30 -0400 | [diff] [blame^] | 34 | ifdef USE_LF_MK |
| 35 | include lf/include.mk |
| 36 | else |
| 37 | include lf/transition.mk |
| 38 | endif # ifdef USE_LF_MK |
Zack Williams | 071eda2 | 2019-05-15 18:19:51 -0700 | [diff] [blame] | 39 | |
| 40 | # You can set these variables from the command line. |
| 41 | SPHINXOPTS ?= |
| 42 | SPHINXBUILD ?= sphinx-build |
| 43 | SOURCEDIR ?= . |
| 44 | BUILDDIR ?= _build |
| 45 | |
Zack Williams | 88df474 | 2019-12-20 08:24:47 -0700 | [diff] [blame] | 46 | # Other repos with documentation to include. |
| 47 | # edit the `git_refs` file with the commit/tag/branch that you want to use |
Andrea Campanella | c18d118 | 2021-09-10 12:01:38 +0200 | [diff] [blame] | 48 | OTHER_REPO_DOCS ?= bbsim cord-tester ofagent-go openolt voltctl voltha-openolt-adapter voltha-openonu-adapter-go voltha-protos voltha-system-tests device-management-interface voltha-helm-charts |
Zack Williams | 88df474 | 2019-12-20 08:24:47 -0700 | [diff] [blame] | 49 | |
Joey Armstrong | 36592e3 | 2022-11-28 09:00:28 -0500 | [diff] [blame] | 50 | ifdef NO_OTHER_REPO_DOCS |
| 51 | # Inhibit pulling in external repos. |
| 52 | # python 3.10+ patching not supported by all repos yet. |
| 53 | OTHER_REPO_DOCS := $(null) |
| 54 | endif |
| 55 | |
Zack Williams | 16042b6 | 2020-03-29 22:03:16 -0700 | [diff] [blame] | 56 | # Static docs, built by other means (usually robot framework) |
| 57 | STATIC_DOCS := _static/voltha-system-tests _static/cord-tester |
| 58 | |
Joey Armstrong | 4de98b7 | 2023-02-09 14:51:38 -0500 | [diff] [blame] | 59 | # Why is existing source Makefile PHONY (?) |
Zack Williams | 88df474 | 2019-12-20 08:24:47 -0700 | [diff] [blame] | 60 | .PHONY: help test lint reload Makefile prep |
Zack Williams | 071eda2 | 2019-05-15 18:19:51 -0700 | [diff] [blame] | 61 | |
Joey Armstrong | 4de98b7 | 2023-02-09 14:51:38 -0500 | [diff] [blame] | 62 | ## ----------------------------------------------------------------------- |
Joey Armstrong | 721519c | 2023-11-13 15:30:54 -0500 | [diff] [blame] | 63 | ## Intent: Display makefile target help |
| 64 | ## ----------------------------------------------------------------------- |
| 65 | help :: help-targets-main |
| 66 | help-verbose :: help-targets-sphinx |
| 67 | |
| 68 | ## ----------------------------------------------------------------------- |
Joey Armstrong | 4de98b7 | 2023-02-09 14:51:38 -0500 | [diff] [blame] | 69 | ## Intent: Real time viewing, dynamically generate and reload document |
| 70 | ## changes for web browser viewing. |
| 71 | ## Usage: |
| 72 | ## make reload |
| 73 | ## ----------------------------------------------------------------------- |
Joey Armstrong | 449ce7a | 2023-07-18 18:32:24 -0400 | [diff] [blame] | 74 | reload: $(venv-activate-patched) |
Joey Armstrong | 4de98b7 | 2023-02-09 14:51:38 -0500 | [diff] [blame] | 75 | $(activate) && sphinx-reload $(SOURCEDIR) |
Zack Williams | 071eda2 | 2019-05-15 18:19:51 -0700 | [diff] [blame] | 76 | |
Joey Armstrong | 8d62cd9 | 2022-12-22 13:53:48 -0500 | [diff] [blame] | 77 | ## ----------------------------------------------------------------------- |
| 78 | ## Intent: lint and link verification. linkcheck is part of sphinx |
Joey Armstrong | 64b8249 | 2023-06-01 17:34:39 -0400 | [diff] [blame] | 79 | ## See Also: make test-errors |
Joey Armstrong | 8d62cd9 | 2022-12-22 13:53:48 -0500 | [diff] [blame] | 80 | ## ----------------------------------------------------------------------- |
Zack Williams | 071eda2 | 2019-05-15 18:19:51 -0700 | [diff] [blame] | 81 | test: lint linkcheck |
Joey Armstrong | a8bc8e1 | 2022-12-04 07:06:59 -0500 | [diff] [blame] | 82 | |
Joey Armstrong | 50895b8 | 2023-09-14 16:44:28 -0400 | [diff] [blame] | 83 | # [TODO] relocate into repo:onf-make/ |
| 84 | lint : $(venv-activate-patched) |
| 85 | linkcheck : $(venv-activate-patched) |
| 86 | |
Joey Armstrong | 8d62cd9 | 2022-12-22 13:53:48 -0500 | [diff] [blame] | 87 | ## ----------------------------------------------------------------------- |
| 88 | ## Intent: Exercise all generation targets |
Joey Armstrong | 4de98b7 | 2023-02-09 14:51:38 -0500 | [diff] [blame] | 89 | ## Bridge: library workaround to support legacy targets |
Joey Armstrong | 8d62cd9 | 2022-12-22 13:53:48 -0500 | [diff] [blame] | 90 | ## ----------------------------------------------------------------------- |
| 91 | test-all-targets += html |
| 92 | test-all-targets += coverage |
| 93 | # test-all-targets += changes |
| 94 | # test-all-targets += info |
| 95 | test-all-targets += man |
| 96 | test-all-targe4ts += text |
| 97 | # test-all-targets += latex |
| 98 | |
Joey Armstrong | 8d62cd9 | 2022-12-22 13:53:48 -0500 | [diff] [blame] | 99 | test-all : test |
| 100 | $(MAKE) $(test-all-targets) |
| 101 | |
Joey Armstrong | 36592e3 | 2022-11-28 09:00:28 -0500 | [diff] [blame] | 102 | # doctest |
| 103 | # coverage |
| 104 | # linkcheck |
Zack Williams | 071eda2 | 2019-05-15 18:19:51 -0700 | [diff] [blame] | 105 | |
Joey Armstrong | 0cbee51 | 2023-10-18 15:39:24 -0400 | [diff] [blame] | 106 | # ----------------------------------------------------------------------- |
Zack Williams | 071eda2 | 2019-05-15 18:19:51 -0700 | [diff] [blame] | 107 | # currently not enabled, should be added to lint target |
Joey Armstrong | 0cbee51 | 2023-10-18 15:39:24 -0400 | [diff] [blame] | 108 | # [TODO] Create repo:onf-make/makefiles/lint/mdl |
| 109 | # ----------------------------------------------------------------------- |
Zack Williams | 071eda2 | 2019-05-15 18:19:51 -0700 | [diff] [blame] | 110 | LINT_STYLE ?= mdl_strict.rb |
| 111 | md-lint: | $(OTHER_REPO_DOCS) |
| 112 | @echo "markdownlint(mdl) version: `mdl --version`" |
| 113 | @echo "style config:" |
| 114 | @echo "---" |
| 115 | @cat $(LINT_STYLE) |
| 116 | @echo "---" |
Joey Armstrong | 4de98b7 | 2023-02-09 14:51:38 -0500 | [diff] [blame] | 117 | mdl -s $(LINT_STYLE) `find -L $(SOURCEDIR) ! -path "./_$(venv-activate-script)/*" ! -path "./_build/*" ! -path "./repos/*" ! -path "*vendor*" -name "*.md"` |
Zack Williams | 071eda2 | 2019-05-15 18:19:51 -0700 | [diff] [blame] | 118 | |
| 119 | # clean up |
Joey Armstrong | 64b8249 | 2023-06-01 17:34:39 -0400 | [diff] [blame] | 120 | clean :: |
Joey Armstrong | 36592e3 | 2022-11-28 09:00:28 -0500 | [diff] [blame] | 121 | $(RM) -r $(BUILDDIR) $(OTHER_REPO_DOCS) $(STATIC_DOCS) |
Zack Williams | 071eda2 | 2019-05-15 18:19:51 -0700 | [diff] [blame] | 122 | |
Joey Armstrong | 4de98b7 | 2023-02-09 14:51:38 -0500 | [diff] [blame] | 123 | clean-all sterile :: clean |
| 124 | $(RM) -r $(venv-activate-script) repos |
Zack Williams | 071eda2 | 2019-05-15 18:19:51 -0700 | [diff] [blame] | 125 | |
Zack Williams | 071eda2 | 2019-05-15 18:19:51 -0700 | [diff] [blame] | 126 | # checkout the repos inside repos/ dir |
| 127 | repos: |
| 128 | mkdir repos |
| 129 | |
| 130 | # build directory paths in repos/* to perform 'git clone <repo>' into |
| 131 | CHECKOUT_REPOS = $(foreach repo,$(OTHER_REPO_DOCS),repos/$(repo)) |
| 132 | |
| 133 | # Host holding the git server |
| 134 | REPO_HOST ?= https://gerrit.opencord.org |
| 135 | |
| 136 | # For QA patchset validation - set SKIP_CHECKOUT to the repo name and |
| 137 | # pre-populate it under repos/ with the specific commit to being validated |
| 138 | SKIP_CHECKOUT ?= |
| 139 | |
Zack Williams | 88df474 | 2019-12-20 08:24:47 -0700 | [diff] [blame] | 140 | # clone (only if doesn't exist) |
Zack Williams | 071eda2 | 2019-05-15 18:19:51 -0700 | [diff] [blame] | 141 | $(CHECKOUT_REPOS): | repos |
Zack Williams | 071eda2 | 2019-05-15 18:19:51 -0700 | [diff] [blame] | 142 | if [ ! -d '$@' ] ;\ |
| 143 | then git clone $(REPO_HOST)/$(@F) $@ ;\ |
Zack Williams | 071eda2 | 2019-05-15 18:19:51 -0700 | [diff] [blame] | 144 | fi |
| 145 | |
Joey Armstrong | 4de98b7 | 2023-02-09 14:51:38 -0500 | [diff] [blame] | 146 | ## ----------------------------------------------------------------------- |
| 147 | ## Intent: checkout correct ref if not under test, then copy |
| 148 | ## subdirectories into main docs dir |
| 149 | ## ----------------------------------------------------------------------- |
Zack Williams | 071eda2 | 2019-05-15 18:19:51 -0700 | [diff] [blame] | 150 | $(OTHER_REPO_DOCS): | $(CHECKOUT_REPOS) |
Zack Williams | 88df474 | 2019-12-20 08:24:47 -0700 | [diff] [blame] | 151 | if [ "$(SKIP_CHECKOUT)" != "$@" ] ;\ |
| 152 | then GIT_REF=`grep '^$@ ' git_refs | awk '{print $$3}'` ;\ |
Zack Williams | 6c1703f | 2019-12-20 15:31:58 -0700 | [diff] [blame] | 153 | cd "repos/$@" && git checkout $$GIT_REF ;\ |
Zack Williams | 88df474 | 2019-12-20 08:24:47 -0700 | [diff] [blame] | 154 | fi |
Zack Williams | 17e3402 | 2019-12-20 13:51:54 -0700 | [diff] [blame] | 155 | GIT_SUBDIR=`grep '^$@ ' git_refs | awk '{print $$2}'` ;\ |
Zack Williams | 3308552 | 2020-02-28 11:41:01 -0700 | [diff] [blame] | 156 | cp -r repos/$(@)$$GIT_SUBDIR $@ ;\ |
Zack Williams | 071eda2 | 2019-05-15 18:19:51 -0700 | [diff] [blame] | 157 | |
Andrea Campanella | 92bd59b | 2020-01-30 17:26:32 +0100 | [diff] [blame] | 158 | # Build Robot documentation in voltha-system-tests and copy it into _static. |
| 159 | _static/voltha-system-tests: | $(OTHER_REPO_DOCS) |
| 160 | make -C voltha-system-tests gendocs |
| 161 | mkdir -p $@ |
| 162 | cp -r voltha-system-tests/gendocs/* $@ |
| 163 | |
Andy Bavier | 39d67b1 | 2020-02-27 16:08:52 -0700 | [diff] [blame] | 164 | # Build Robot documentation in cord-tester and copy it into _static. |
| 165 | _static/cord-tester: | $(OTHER_REPO_DOCS) |
| 166 | make -C cord-tester gendocs |
| 167 | mkdir -p $@ |
| 168 | cp -r cord-tester/gendocs/* $@ |
| 169 | |
Joey Armstrong | 4de98b7 | 2023-02-09 14:51:38 -0500 | [diff] [blame] | 170 | ## ----------------------------------------------------------------------- |
| 171 | ## Intent: generate a list of git checksums suitable for updating git_refs |
| 172 | ## ----------------------------------------------------------------------- |
Zack Williams | 071eda2 | 2019-05-15 18:19:51 -0700 | [diff] [blame] | 173 | freeze: repos |
| 174 | @for repo in $(OTHER_REPO_DOCS) ; do \ |
| 175 | GIT_SUBDIR=`grep "^$$repo " git_refs | awk '{print $$2}'` ;\ |
Zack Williams | 6c1703f | 2019-12-20 15:31:58 -0700 | [diff] [blame] | 176 | cd "repos/$$repo" > /dev/null ;\ |
Zack Williams | 071eda2 | 2019-05-15 18:19:51 -0700 | [diff] [blame] | 177 | HEAD_SHA=`git rev-parse HEAD` ;\ |
| 178 | printf "%-24s %-8s %-40s\n" $$repo $$GIT_SUBDIR $$HEAD_SHA ;\ |
Zack Williams | 6c1703f | 2019-12-20 15:31:58 -0700 | [diff] [blame] | 179 | cd ../.. ;\ |
Zack Williams | 071eda2 | 2019-05-15 18:19:51 -0700 | [diff] [blame] | 180 | done |
| 181 | |
Joey Armstrong | 4de98b7 | 2023-02-09 14:51:38 -0500 | [diff] [blame] | 182 | ## ----------------------------------------------------------------------- |
| 183 | ## Intent: build multiple versions |
| 184 | ## ----------------------------------------------------------------------- |
Joey Armstrong | 7be6581 | 2023-09-29 18:35:31 -0400 | [diff] [blame] | 185 | multiversion: $(venv-activate-patched) Makefile | prep $(OTHER_REPO_DOCS) |
Joey Armstrong | 4de98b7 | 2023-02-09 14:51:38 -0500 | [diff] [blame] | 186 | $(activate)\ |
| 187 | && sphinx-multiversion "$(SOURCEDIR)" "$(BUILDDIR)/multiversion" $(SPHINXOPTS) |
Zack Williams | 16042b6 | 2020-03-29 22:03:16 -0700 | [diff] [blame] | 188 | cp "$(SOURCEDIR)/_templates/meta_refresh.html" "$(BUILDDIR)/multiversion/index.html" |
Zack Williams | 88df474 | 2019-12-20 08:24:47 -0700 | [diff] [blame] | 189 | |
Joey Armstrong | 4de98b7 | 2023-02-09 14:51:38 -0500 | [diff] [blame] | 190 | ## ----------------------------------------------------------------------- |
| 191 | ## Intent: used in sphinx-multiversion to properly link |
| 192 | ## ----------------------------------------------------------------------- |
Zack Williams | 16042b6 | 2020-03-29 22:03:16 -0700 | [diff] [blame] | 193 | prep: | $(OTHER_REPO_DOCS) $(STATIC_DOCS) |
Andy Bavier | 5dee6ae | 2020-01-29 16:03:40 -0700 | [diff] [blame] | 194 | |
Joey Armstrong | 4de98b7 | 2023-02-09 14:51:38 -0500 | [diff] [blame] | 195 | ## ----------------------------------------------------------------------- |
| 196 | ## Intent: Forward sphinx supported targets to sphinxbuild. |
| 197 | ## Bridge: legacy makefile wildcard rule forwarded unknown targets to sphinx. |
| 198 | ## library makefiles do more so transfer control only when needed. |
| 199 | ## ----------------------------------------------------------------------- |
Joey Armstrong | 449ce7a | 2023-07-18 18:32:24 -0400 | [diff] [blame] | 200 | include $(ONF_MAKEDIR)/voltha/docs-catchall-targets.mk |
Joey Armstrong | 7be6581 | 2023-09-29 18:35:31 -0400 | [diff] [blame] | 201 | voltha-docs-catchall : $(voltha-docs-catchall) |
| 202 | $(voltha-docs-catchall): $(venv-activate-patched) Makefile | $(OTHER_REPO_DOCS) $(STATIC_DOCS) |
Joey Armstrong | 36592e3 | 2022-11-28 09:00:28 -0500 | [diff] [blame] | 203 | @echo " ** CATCHALL: $@" |
Joey Armstrong | 4de98b7 | 2023-02-09 14:51:38 -0500 | [diff] [blame] | 204 | $(activate)\ |
| 205 | && $(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) |
Joey Armstrong | 36592e3 | 2022-11-28 09:00:28 -0500 | [diff] [blame] | 206 | |
Joey Armstrong | a8bc8e1 | 2022-12-04 07:06:59 -0500 | [diff] [blame] | 207 | ## ----------------------------------------------------------------------- |
Joey Armstrong | 4de98b7 | 2023-02-09 14:51:38 -0500 | [diff] [blame] | 208 | ## Intent: Display makefile target help |
| 209 | ## ----------------------------------------------------------------------- |
Joey Armstrong | 721519c | 2023-11-13 15:30:54 -0500 | [diff] [blame] | 210 | help-targets-sphinx : $(venv-activate-patched) |
Joey Armstrong | 4de98b7 | 2023-02-09 14:51:38 -0500 | [diff] [blame] | 211 | @ echo |
Joey Armstrong | 721519c | 2023-11-13 15:30:54 -0500 | [diff] [blame] | 212 | @echo '[HELP: Sphinx]' |
Joey Armstrong | 4de98b7 | 2023-02-09 14:51:38 -0500 | [diff] [blame] | 213 | $(HIDE)$(activate) \ |
| 214 | && $(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) |
| 215 | |
| 216 | ## ----------------------------------------------------------------------- |
Joey Armstrong | 924f3cb | 2023-06-05 15:21:51 -0400 | [diff] [blame] | 217 | ## Intent: Display WARNINGS buried in sphinx output |
| 218 | ## ----------------------------------------------------------------------- |
| 219 | warnings-log := warnings.log |
Joey Armstrong | 4f93b76 | 2023-06-06 08:36:02 -0400 | [diff] [blame] | 220 | warnings: sterile |
Joey Armstrong | 924f3cb | 2023-06-05 15:21:51 -0400 | [diff] [blame] | 221 | $(MAKE) html 2>&1 \ |
| 222 | | sed -e 's@\([Ww][Aa][Rr][Nn][Ii][Nn][Gg]\)@\n\1@g' \ |
| 223 | > "$(warnings-log)" |
Joey Armstrong | 4f93b76 | 2023-06-06 08:36:02 -0400 | [diff] [blame] | 224 | grep 'WARNING' $(warnings-log) |
Joey Armstrong | 924f3cb | 2023-06-05 15:21:51 -0400 | [diff] [blame] | 225 | |
Joey Armstrong | 4f93b76 | 2023-06-06 08:36:02 -0400 | [diff] [blame] | 226 | ## ----------------------------------------------------------------------- |
| 227 | ## Intent: Summarize linkcheck failures |
| 228 | ## ----------------------------------------------------------------------- |
| 229 | .PHONY: broken-log |
| 230 | broken-log := broken.log |
| 231 | broken-log : sterile |
| 232 | $(MAKE) linkcheck 2>&1 | tee "$(broken-log)" |
| 233 | ! grep broken "$(broken-log)" |
| 234 | grep -i error _build/linkcheck/output.txt |
| 235 | |
| 236 | ## ----------------------------------------------------------------------- |
Joey Armstrong | e03bc60 | 2024-02-09 17:26:27 -0500 | [diff] [blame] | 237 | ## Intent: Summarize linkcheck failures |
| 238 | ## ----------------------------------------------------------------------- |
| 239 | .PHONY: lint-doc8-debug |
| 240 | lint-doc8-debug : sterile |
| 241 | $(HIDE) @echo "Searching for cryptic failures" |
| 242 | -grep -i 'X <' release_notes/voltha_2.12.rst | grep -v '`__' |
| 243 | |
| 244 | ## ----------------------------------------------------------------------- |
Joey Armstrong | 4f93b76 | 2023-06-06 08:36:02 -0400 | [diff] [blame] | 245 | ## Intent: |
| 246 | ## ----------------------------------------------------------------------- |
Joey Armstrong | 924f3cb | 2023-06-05 15:21:51 -0400 | [diff] [blame] | 247 | clean:: |
Joey Armstrong | 4f93b76 | 2023-06-06 08:36:02 -0400 | [diff] [blame] | 248 | $(RM) $(broken-log) |
Joey Armstrong | 924f3cb | 2023-06-05 15:21:51 -0400 | [diff] [blame] | 249 | $(RM) $(warnings-log) |
| 250 | |
Joey Armstrong | 4f93b76 | 2023-06-06 08:36:02 -0400 | [diff] [blame] | 251 | ## ----------------------------------------------------------------------- |
| 252 | ## Intent: |
| 253 | ## ----------------------------------------------------------------------- |
Joey Armstrong | 721519c | 2023-11-13 15:30:54 -0500 | [diff] [blame] | 254 | help :: help-targets-main |
| 255 | help-targets-main : |
| 256 | |
| 257 | @echo |
| 258 | @echo '[HELP]' |
| 259 | @printf ' %-30.30s %s\n' 'help' \ |
| 260 | 'Summary makefile target help' |
| 261 | @printf ' %-30.30s %s\n' 'help-verbose' \ |
| 262 | 'Extended makefile target help' |
| 263 | |
| 264 | @echo |
Joey Armstrong | 9f7c57c | 2024-05-03 18:29:30 -0400 | [diff] [blame^] | 265 | @echo '[INIT]' |
Joey Armstrong | 721519c | 2023-11-13 15:30:54 -0500 | [diff] [blame] | 266 | @printf ' %-30.30s %s\n' 'init' \ |
| 267 | 'Alias for git-submodules' |
| 268 | @printf ' %-30.30s %s\n' 'git-submodules' \ |
| 269 | 'Checkout external dependent repositories' |
| 270 | |
| 271 | @echo |
| 272 | @echo '[TEST: Failures]' |
| 273 | @printf ' %-30.30s %s\n' 'broken' \ |
| 274 | 'Display broken URLs detected in linkcheck output' |
| 275 | @printf ' %-30.30s %s\n' 'warnings' \ |
| 276 | 'Display WARNING strings buried in sphinx output' |
| 277 | |
| 278 | ## ----------------------------------------------------------------------- |
| 279 | ## Intent: Checkout external repository dependencies |
| 280 | ## ----------------------------------------------------------------------- |
| 281 | init :: git-submodules |
| 282 | |
| 283 | git-submodules: |
| 284 | git submodule update --init --recursive |
Joey Armstrong | 924f3cb | 2023-06-05 15:21:51 -0400 | [diff] [blame] | 285 | |
| 286 | ## ----------------------------------------------------------------------- |
Joey Armstrong | 9f7c57c | 2024-05-03 18:29:30 -0400 | [diff] [blame^] | 287 | ## Intent: Display make help footer |
Joey Armstrong | a8bc8e1 | 2022-12-04 07:06:59 -0500 | [diff] [blame] | 288 | ## ----------------------------------------------------------------------- |
Joey Armstrong | 449ce7a | 2023-07-18 18:32:24 -0400 | [diff] [blame] | 289 | include $(ONF_MAKEDIR)/help/trailer.mk |
Joey Armstrong | 36592e3 | 2022-11-28 09:00:28 -0500 | [diff] [blame] | 290 | |
| 291 | # [EOF] |