GNUBoot
/
coreboot-kgpe-d16
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
coreboot-kgpe-d16/Documentation/Makefile

81 lines
2.2 KiB
Makefile
Raw Normal View History

Docs: Add SPDX headers to Makefiles Signed-off-by: Martin Roth <gaumless@gmail.com> Change-Id: Id229fb22d20c489db3dd7a59f29e7ac10174fd85 Reviewed-on: https://review.coreboot.org/c/coreboot/+/68957 Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Angel Pons <th3fanbus@gmail.com> Reviewed-by: Matt DeVillier <matt.devillier@amd.corp-partner.google.com> Reviewed-by: Elyes Haouas <ehaouas@noos.fr>
2022-10-29 06:25:02 +02:00
## SPDX-License-Identifier: GPL-2.0-only
initial version of LinuxBIOS on AMD64 paper git-svn-id: svn://svn.coreboot.org/coreboot/trunk@1298 2b7e53f0-3cfb-0310-b3e9-8179ed1497e1
2003-11-22 16:15:47 +01:00
#
s/LinuxBIOS/coreboot/. Signed-off-by: Uwe Hermann <uwe@hermann-uwe.de> Acked-by: Uwe Hermann <uwe@hermann-uwe.de> git-svn-id: svn://svn.coreboot.org/coreboot/trunk@4134 2b7e53f0-3cfb-0310-b3e9-8179ed1497e1
2009-04-18 16:18:20 +02:00
# Makefile for coreboot paper.
initial version of LinuxBIOS on AMD64 paper git-svn-id: svn://svn.coreboot.org/coreboot/trunk@1298 2b7e53f0-3cfb-0310-b3e9-8179ed1497e1
2003-11-22 16:15:47 +01:00
# hacked together by Stefan Reinauer <stepan@openbios.org>
#
Docs: Update sphinx targets with the build directory Because Makefile.sphinx looks like a standard makefile from the sphinx project, it probably shouldn't be updated without good reason. This change lets us update the output directory and tell the Makefile.sphinx where we want the output. Also fix the spacing on PDFLATEX to match the new SPHINXDIR variable. Signed-off-by: Martin Roth <gaumless@gmail.com> Change-Id: Iab111e8feea8ec02260f39636e7c17fd1cae7c30 Reviewed-on: https://review.coreboot.org/c/coreboot/+/75499 Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Elyes Haouas <ehaouas@noos.fr> Reviewed-by: Felix Singer <service+coreboot-gerrit@felixsinger.de>
2023-05-30 07:09:54 +02:00
PDFLATEX = pdflatex -t a4
SPHINXDIR = _build
initial version of LinuxBIOS on AMD64 paper git-svn-id: svn://svn.coreboot.org/coreboot/trunk@1298 2b7e53f0-3cfb-0310-b3e9-8179ed1497e1
2003-11-22 16:15:47 +01:00
FIGS=codeflow.pdf hypertransport.pdf
Docs: Add sphinx to the documentation's "all" target The all target really should build the expected output. At this point, that means sphinx as well. Signed-off-by: Martin Roth <gaumless@gmail.com> Change-Id: Ibbceddd013605f5f7e11707480ae2a1e5d012a91 Reviewed-on: https://review.coreboot.org/c/coreboot/+/75498 Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Elyes Haouas <ehaouas@noos.fr> Reviewed-by: Felix Singer <service+coreboot-gerrit@felixsinger.de>
2023-05-30 07:06:52 +02:00
all: sphinx corebootPortingGuide.pdf
initial version of LinuxBIOS on AMD64 paper git-svn-id: svn://svn.coreboot.org/coreboot/trunk@1298 2b7e53f0-3cfb-0310-b3e9-8179ed1497e1
2003-11-22 16:15:47 +01:00
Docs/Makefile: change 'which' to 'command -v' The "which" command is not a posix command. Additionally, if a file is not found, it outputs "command not found", so when checking to see if the response is "", that doesn't work. "command -v" is a posix compliant replacement that doesn't put out any text if the command is not found, so is more suitable in this case anyway. Signed-off-by: Martin Roth <gaumless@gmail.com> Change-Id: I22207e818c847d50998f90c9abd55a3cb4bb2ab3 Reviewed-on: https://review.coreboot.org/c/coreboot/+/72922 Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Felix Singer <felixsinger@posteo.net>
2023-02-10 17:56:40 +01:00
SVG2PDF=$(shell command -v svg2pdf)
INKSCAPE=$(shell command -v inkscape)
CONVERT=$(shell command -v convert)
initial version of LinuxBIOS on AMD64 paper git-svn-id: svn://svn.coreboot.org/coreboot/trunk@1298 2b7e53f0-3cfb-0310-b3e9-8179ed1497e1
2003-11-22 16:15:47 +01:00
Update to this very old document Signed-off-by: Stefan Reinauer <stepan@coresystems.de> Acked-by: Stefan Reinauer <stepan@coresystems.de> git-svn-id: svn://svn.coreboot.org/coreboot/trunk@4155 2b7e53f0-3cfb-0310-b3e9-8179ed1497e1
2009-04-21 23:45:11 +02:00
codeflow.pdf: codeflow.svg
There's no 'svg2pdf' in Debian AFAICT, probably the same problem on other systems too. So, check for svg2pdf, convert, and inkscape and use the first one that is found to convert the SVG files to PDF. Signed-off-by: Uwe Hermann <uwe@hermann-uwe.de> Acked-by: Uwe Hermann <uwe@hermann-uwe.de> git-svn-id: svn://svn.coreboot.org/coreboot/trunk@4275 2b7e53f0-3cfb-0310-b3e9-8179ed1497e1
2009-05-12 16:24:25 +02:00
ifneq ($(strip $(SVG2PDF)),)
Update to this very old document Signed-off-by: Stefan Reinauer <stepan@coresystems.de> Acked-by: Stefan Reinauer <stepan@coresystems.de> git-svn-id: svn://svn.coreboot.org/coreboot/trunk@4155 2b7e53f0-3cfb-0310-b3e9-8179ed1497e1
2009-04-21 23:45:11 +02:00
svg2pdf $< $@
There's no 'svg2pdf' in Debian AFAICT, probably the same problem on other systems too. So, check for svg2pdf, convert, and inkscape and use the first one that is found to convert the SVG files to PDF. Signed-off-by: Uwe Hermann <uwe@hermann-uwe.de> Acked-by: Uwe Hermann <uwe@hermann-uwe.de> git-svn-id: svn://svn.coreboot.org/coreboot/trunk@4275 2b7e53f0-3cfb-0310-b3e9-8179ed1497e1
2009-05-12 16:24:25 +02:00
else ifneq ($(strip $(INKSCAPE)),)
inkscape $< --export-pdf=$@
else ifneq ($(strip $(CONVERT)),)
convert $< $@
endif
initial version of LinuxBIOS on AMD64 paper git-svn-id: svn://svn.coreboot.org/coreboot/trunk@1298 2b7e53f0-3cfb-0310-b3e9-8179ed1497e1
2003-11-22 16:15:47 +01:00
Update to this very old document Signed-off-by: Stefan Reinauer <stepan@coresystems.de> Acked-by: Stefan Reinauer <stepan@coresystems.de> git-svn-id: svn://svn.coreboot.org/coreboot/trunk@4155 2b7e53f0-3cfb-0310-b3e9-8179ed1497e1
2009-04-21 23:45:11 +02:00
hypertransport.pdf: hypertransport.svg
There's no 'svg2pdf' in Debian AFAICT, probably the same problem on other systems too. So, check for svg2pdf, convert, and inkscape and use the first one that is found to convert the SVG files to PDF. Signed-off-by: Uwe Hermann <uwe@hermann-uwe.de> Acked-by: Uwe Hermann <uwe@hermann-uwe.de> git-svn-id: svn://svn.coreboot.org/coreboot/trunk@4275 2b7e53f0-3cfb-0310-b3e9-8179ed1497e1
2009-05-12 16:24:25 +02:00
ifneq ($(strip $(SVG2PDF)),)
Update to this very old document Signed-off-by: Stefan Reinauer <stepan@coresystems.de> Acked-by: Stefan Reinauer <stepan@coresystems.de> git-svn-id: svn://svn.coreboot.org/coreboot/trunk@4155 2b7e53f0-3cfb-0310-b3e9-8179ed1497e1
2009-04-21 23:45:11 +02:00
svg2pdf $< $@
There's no 'svg2pdf' in Debian AFAICT, probably the same problem on other systems too. So, check for svg2pdf, convert, and inkscape and use the first one that is found to convert the SVG files to PDF. Signed-off-by: Uwe Hermann <uwe@hermann-uwe.de> Acked-by: Uwe Hermann <uwe@hermann-uwe.de> git-svn-id: svn://svn.coreboot.org/coreboot/trunk@4275 2b7e53f0-3cfb-0310-b3e9-8179ed1497e1
2009-05-12 16:24:25 +02:00
else ifneq ($(strip $(INKSCAPE)),)
inkscape $< --export-pdf=$@
else ifneq ($(strip $(CONVERT)),)
convert $< $@
endif
initial version of LinuxBIOS on AMD64 paper git-svn-id: svn://svn.coreboot.org/coreboot/trunk@1298 2b7e53f0-3cfb-0310-b3e9-8179ed1497e1
2003-11-22 16:15:47 +01:00
Docs: Update sphinx targets with the build directory Because Makefile.sphinx looks like a standard makefile from the sphinx project, it probably shouldn't be updated without good reason. This change lets us update the output directory and tell the Makefile.sphinx where we want the output. Also fix the spacing on PDFLATEX to match the new SPHINXDIR variable. Signed-off-by: Martin Roth <gaumless@gmail.com> Change-Id: Iab111e8feea8ec02260f39636e7c17fd1cae7c30 Reviewed-on: https://review.coreboot.org/c/coreboot/+/75499 Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Elyes Haouas <ehaouas@noos.fr> Reviewed-by: Felix Singer <service+coreboot-gerrit@felixsinger.de>
2023-05-30 07:09:54 +02:00
$(SPHINXDIR):
mkdir -p $(SPHINXDIR)
Documentation: change coreboot to lowercase The word 'coreboot' should always be written in lowercase, even at the start of a sentence. Unfortunately, some external websites and projects are spelling coreboot with an uppercase C, so references to those pages can't be changed without breaking the link. Change-Id: I79824da8a9ed36a1e4fe23a1711a89535267bf5f Signed-off-by: Martin Roth <martinroth@google.com> Reviewed-on: https://review.coreboot.org/20031 Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Arthur Heymans <arthur@aheymans.xyz>
2017-06-04 04:16:01 +02:00
corebootPortingGuide.toc: $(FIGS) corebootBuildingGuide.tex
initial version of LinuxBIOS on AMD64 paper git-svn-id: svn://svn.coreboot.org/coreboot/trunk@1298 2b7e53f0-3cfb-0310-b3e9-8179ed1497e1
2003-11-22 16:15:47 +01:00
# 2 times to make sure we have a current toc.
Documentation: change coreboot to lowercase The word 'coreboot' should always be written in lowercase, even at the start of a sentence. Unfortunately, some external websites and projects are spelling coreboot with an uppercase C, so references to those pages can't be changed without breaking the link. Change-Id: I79824da8a9ed36a1e4fe23a1711a89535267bf5f Signed-off-by: Martin Roth <martinroth@google.com> Reviewed-on: https://review.coreboot.org/20031 Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Arthur Heymans <arthur@aheymans.xyz>
2017-06-04 04:16:01 +02:00
$(PDFLATEX) corebootBuildingGuide.tex
$(PDFLATEX) corebootBuildingGuide.tex
initial version of LinuxBIOS on AMD64 paper git-svn-id: svn://svn.coreboot.org/coreboot/trunk@1298 2b7e53f0-3cfb-0310-b3e9-8179ed1497e1
2003-11-22 16:15:47 +01:00
Documentation: change coreboot to lowercase The word 'coreboot' should always be written in lowercase, even at the start of a sentence. Unfortunately, some external websites and projects are spelling coreboot with an uppercase C, so references to those pages can't be changed without breaking the link. Change-Id: I79824da8a9ed36a1e4fe23a1711a89535267bf5f Signed-off-by: Martin Roth <martinroth@google.com> Reviewed-on: https://review.coreboot.org/20031 Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Arthur Heymans <arthur@aheymans.xyz>
2017-06-04 04:16:01 +02:00
corebootPortingGuide.pdf: $(FIGS) corebootBuildingGuide.tex corebootPortingGuide.toc
$(PDFLATEX) corebootBuildingGuide.tex
initial version of LinuxBIOS on AMD64 paper git-svn-id: svn://svn.coreboot.org/coreboot/trunk@1298 2b7e53f0-3cfb-0310-b3e9-8179ed1497e1
2003-11-22 16:15:47 +01:00
Docs: Update sphinx targets with the build directory Because Makefile.sphinx looks like a standard makefile from the sphinx project, it probably shouldn't be updated without good reason. This change lets us update the output directory and tell the Makefile.sphinx where we want the output. Also fix the spacing on PDFLATEX to match the new SPHINXDIR variable. Signed-off-by: Martin Roth <gaumless@gmail.com> Change-Id: Iab111e8feea8ec02260f39636e7c17fd1cae7c30 Reviewed-on: https://review.coreboot.org/c/coreboot/+/75499 Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Elyes Haouas <ehaouas@noos.fr> Reviewed-by: Felix Singer <service+coreboot-gerrit@felixsinger.de>
2023-05-30 07:09:54 +02:00
sphinx: $(SPHINXDIR)
doc/Makefile: Remove superfluous quotation marks fixing syntax error Change-Id: I4c269248a3a1e078204882d04964fd5af4b5f51a Signed-off-by: Felix Singer <felixsinger@posteo.net> Reviewed-on: https://review.coreboot.org/c/coreboot/+/75799 Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Nico Huber <nico.h@gmx.de> Reviewed-by: Elyes Haouas <ehaouas@noos.fr> Reviewed-by: Felix Held <felix-coreboot@felixheld.de> Reviewed-by: Daniel Maslowski <info@orangecms.org>
2023-06-08 04:53:13 +02:00
$(MAKE) -f Makefile.sphinx html BUILDDIR="$(SPHINXDIR)"
Documentation: Add support for building with Sphinx This commit adds the necessary infrastructure to convert the Markdown files in the Documentation directory to HTML using Sphinx[1] and recommonmark[2]. I selected "sphinx_rtd_theme" as the theme, because it offers a useful navigation sidebar, and because it's already used for the Linux kernel[3]. Makefile.sphinx was auto-generated by sphinx-quickstart. conf.py was auto-generated and manually adjusted. [1]: http://www.sphinx-doc.org/en/stable/ [2]: https://recommonmark.readthedocs.io/en/latest/ [3]: https://www.kernel.org/doc/html/latest/index.html Change-Id: Ie4de96978e334c598cf5890775807d3e15c29c4d Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net> Reviewed-on: https://review.coreboot.org/25787 Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Patrick Georgi <pgeorgi@google.com>
2018-04-19 16:23:56 +02:00
clean-sphinx:
Docs: Update sphinx targets with the build directory Because Makefile.sphinx looks like a standard makefile from the sphinx project, it probably shouldn't be updated without good reason. This change lets us update the output directory and tell the Makefile.sphinx where we want the output. Also fix the spacing on PDFLATEX to match the new SPHINXDIR variable. Signed-off-by: Martin Roth <gaumless@gmail.com> Change-Id: Iab111e8feea8ec02260f39636e7c17fd1cae7c30 Reviewed-on: https://review.coreboot.org/c/coreboot/+/75499 Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Elyes Haouas <ehaouas@noos.fr> Reviewed-by: Felix Singer <service+coreboot-gerrit@felixsinger.de>
2023-05-30 07:09:54 +02:00
$(MAKE) -f Makefile.sphinx clean BUILDDIR="$(SPHINXDIR)"
Documentation: Add support for building with Sphinx This commit adds the necessary infrastructure to convert the Markdown files in the Documentation directory to HTML using Sphinx[1] and recommonmark[2]. I selected "sphinx_rtd_theme" as the theme, because it offers a useful navigation sidebar, and because it's already used for the Linux kernel[3]. Makefile.sphinx was auto-generated by sphinx-quickstart. conf.py was auto-generated and manually adjusted. [1]: http://www.sphinx-doc.org/en/stable/ [2]: https://recommonmark.readthedocs.io/en/latest/ [3]: https://www.kernel.org/doc/html/latest/index.html Change-Id: Ie4de96978e334c598cf5890775807d3e15c29c4d Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net> Reviewed-on: https://review.coreboot.org/25787 Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Patrick Georgi <pgeorgi@google.com>
2018-04-19 16:23:56 +02:00
clean: clean-sphinx
Documentation: Remove Kconfig.tex and related infrastructure This part of our documentation has bitrotted for a long time. Any remaining information should ideally be moved to Documentation/getting_started/kconfig.md. Change-Id: I3920d002813c2838285446dc0ed8dacfa5364581 Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net> Reviewed-on: https://review.coreboot.org/28665 Reviewed-by: Ronald G. Minnich <rminnich@gmail.com> Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
2018-09-25 23:15:16 +02:00
rm -f *.aux *.idx *.log *.toc *.out $(FIGS)
initial version of LinuxBIOS on AMD64 paper git-svn-id: svn://svn.coreboot.org/coreboot/trunk@1298 2b7e53f0-3cfb-0310-b3e9-8179ed1497e1
2003-11-22 16:15:47 +01:00
distclean: clean
Documentation: Remove Kconfig.tex and related infrastructure This part of our documentation has bitrotted for a long time. Any remaining information should ideally be moved to Documentation/getting_started/kconfig.md. Change-Id: I3920d002813c2838285446dc0ed8dacfa5364581 Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net> Reviewed-on: https://review.coreboot.org/28665 Reviewed-by: Ronald G. Minnich <rminnich@gmail.com> Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
2018-09-25 23:15:16 +02:00
rm -f corebootPortingGuide.pdf
Documentation: Add make rule for sphinx-autobuild Add livesphinx to start sphinx-autobuild Change-Id: I9eb3217e758c2c882c759fa7ae75a39aaf1a0358 Signed-off-by: Tom Hiller <thrilleratplay@gmail.com> Reviewed-on: https://review.coreboot.org/28210 Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Patrick Georgi <pgeorgi@google.com>
2018-08-19 01:20:16 +02:00
Docs: Update sphinx targets with the build directory Because Makefile.sphinx looks like a standard makefile from the sphinx project, it probably shouldn't be updated without good reason. This change lets us update the output directory and tell the Makefile.sphinx where we want the output. Also fix the spacing on PDFLATEX to match the new SPHINXDIR variable. Signed-off-by: Martin Roth <gaumless@gmail.com> Change-Id: Iab111e8feea8ec02260f39636e7c17fd1cae7c30 Reviewed-on: https://review.coreboot.org/c/coreboot/+/75499 Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Elyes Haouas <ehaouas@noos.fr> Reviewed-by: Felix Singer <service+coreboot-gerrit@felixsinger.de>
2023-05-30 07:09:54 +02:00
livesphinx: $(SPHINXDIR)
$(MAKE) -f Makefile.sphinx livehtml SPHINXOPTS="$(SPHINXOPTS)" BUILDDIR="$(SPHINXDIR)"
Docs: Add help target and .phony identifiers This change adds a help target so we can see what the valid targets are and what they do, and also identifies the phony targets. Signed-off-by: Martin Roth <gaumless@gmail.com> Change-Id: Ie61d44d87e8628e12d01f3355360e2a679b5ce85 Reviewed-on: https://review.coreboot.org/c/coreboot/+/75496 Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Felix Singer <service+coreboot-gerrit@felixsinger.de>
2023-05-30 07:02:10 +02:00
Docs: Add a test target for the documentation The test target will run, but won't fail the build if there are issues. This is so it can be added to the jenkins build and run until it passes. At that point, it can be made to fail if there's an error. Signed-off-by: Martin Roth <gaumless@gmail.com> Change-Id: I5810643ee143f9db4f1cd388531161d4398d596c Reviewed-on: https://review.coreboot.org/c/coreboot/+/75497 Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Felix Singer <service+coreboot-gerrit@felixsinger.de>
2023-05-30 07:05:09 +02:00
test:
@echo "Test for logging purposes - Failing tests will not fail the build"
-$(MAKE) -f Makefile.sphinx clean && $(MAKE) -K -f Makefile.sphinx html
-$(MAKE) -f Makefile.sphinx clean && $(MAKE) -K -f Makefile.sphinx doctest
Docs: Add help target and .phony identifiers This change adds a help target so we can see what the valid targets are and what they do, and also identifies the phony targets. Signed-off-by: Martin Roth <gaumless@gmail.com> Change-Id: Ie61d44d87e8628e12d01f3355360e2a679b5ce85 Reviewed-on: https://review.coreboot.org/c/coreboot/+/75496 Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Felix Singer <service+coreboot-gerrit@felixsinger.de>
2023-05-30 07:02:10 +02:00
help:
@echo "all - Builds coreboot porting guide PDF (outdated)"
@echo "sphinx - Builds html documentation in _build directory"
@echo "clean - Cleans intermediate files"
@echo "clean-sphinx - Removes sphinx output files"
@echo "distclean - Removes PDF files as well"
Docs: Add a test target for the documentation The test target will run, but won't fail the build if there are issues. This is so it can be added to the jenkins build and run until it passes. At that point, it can be made to fail if there's an error. Signed-off-by: Martin Roth <gaumless@gmail.com> Change-Id: I5810643ee143f9db4f1cd388531161d4398d596c Reviewed-on: https://review.coreboot.org/c/coreboot/+/75497 Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Felix Singer <service+coreboot-gerrit@felixsinger.de>
2023-05-30 07:05:09 +02:00
@echo "test - Runs documentation tests"
Docs: Add help target and .phony identifiers This change adds a help target so we can see what the valid targets are and what they do, and also identifies the phony targets. Signed-off-by: Martin Roth <gaumless@gmail.com> Change-Id: Ie61d44d87e8628e12d01f3355360e2a679b5ce85 Reviewed-on: https://review.coreboot.org/c/coreboot/+/75496 Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Felix Singer <service+coreboot-gerrit@felixsinger.de>
2023-05-30 07:02:10 +02:00
@echo
@echo " Makefile.sphinx builds - run with $(MAKE) -f Makefile-sphinx [target]"
@echo
@$(MAKE) -s -f Makefile.sphinx help 2>/dev/null
.phony: help livesphinx sphinx test
.phony: distclean clean clean-sphinx