Blame - Documentation/Makefile - coreboot

blob: 17aec29450aeff624fe7a47a0a5bb32b606447f7 [file] [log] [blame]

Martin Roth	bfdb489	2022-10-28 22:25:02 -0600	[diff] [blame]	1	## SPDX-License-Identifier: GPL-2.0-only
Stefan Reinauer	37414ca	2003-11-22 15:15:47 +0000	[diff] [blame]	2	#
Uwe Hermann	d2a5a5a	2009-04-18 14:18:20 +0000	[diff] [blame]	3	# Makefile for coreboot paper.
Stefan Reinauer	37414ca	2003-11-22 15:15:47 +0000	[diff] [blame]	4	# hacked together by Stefan Reinauer <stepan@openbios.org>
				5	#
				6
				7	PDFLATEX=pdflatex -t a4
				8
				9	FIGS=codeflow.pdf hypertransport.pdf
				10
Martin Roth	3b89102	2023-05-29 23:06:52 -0600	[diff] [blame]	11	all: sphinx corebootPortingGuide.pdf
Stefan Reinauer	37414ca	2003-11-22 15:15:47 +0000	[diff] [blame]	12
Martin Roth	fd8854e	2023-02-10 09:56:40 -0700	[diff] [blame]	13	SVG2PDF=$(shell command -v svg2pdf)
				14	INKSCAPE=$(shell command -v inkscape)
				15	CONVERT=$(shell command -v convert)
Stefan Reinauer	37414ca	2003-11-22 15:15:47 +0000	[diff] [blame]	16
Stefan Reinauer	ebf2589	2009-04-21 21:45:11 +0000	[diff] [blame]	17	codeflow.pdf: codeflow.svg
Uwe Hermann	67ee8f8	2009-05-12 14:24:25 +0000	[diff] [blame]	18	ifneq ($(strip $(SVG2PDF)),)
Stefan Reinauer	ebf2589	2009-04-21 21:45:11 +0000	[diff] [blame]	19	svg2pdf $< $@
Uwe Hermann	67ee8f8	2009-05-12 14:24:25 +0000	[diff] [blame]	20	else ifneq ($(strip $(INKSCAPE)),)
				21	inkscape $< --export-pdf=$@
				22	else ifneq ($(strip $(CONVERT)),)
				23	convert $< $@
				24	endif
Stefan Reinauer	37414ca	2003-11-22 15:15:47 +0000	[diff] [blame]	25
Stefan Reinauer	ebf2589	2009-04-21 21:45:11 +0000	[diff] [blame]	26	hypertransport.pdf: hypertransport.svg
Uwe Hermann	67ee8f8	2009-05-12 14:24:25 +0000	[diff] [blame]	27	ifneq ($(strip $(SVG2PDF)),)
Stefan Reinauer	ebf2589	2009-04-21 21:45:11 +0000	[diff] [blame]	28	svg2pdf $< $@
Uwe Hermann	67ee8f8	2009-05-12 14:24:25 +0000	[diff] [blame]	29	else ifneq ($(strip $(INKSCAPE)),)
				30	inkscape $< --export-pdf=$@
				31	else ifneq ($(strip $(CONVERT)),)
				32	convert $< $@
				33	endif
Stefan Reinauer	37414ca	2003-11-22 15:15:47 +0000	[diff] [blame]	34
Martin Roth	4b18a92	2017-06-03 20:16:01 -0600	[diff] [blame]	35	corebootPortingGuide.toc: $(FIGS) corebootBuildingGuide.tex
Stefan Reinauer	37414ca	2003-11-22 15:15:47 +0000	[diff] [blame]	36	# 2 times to make sure we have a current toc.
Martin Roth	4b18a92	2017-06-03 20:16:01 -0600	[diff] [blame]	37	$(PDFLATEX) corebootBuildingGuide.tex
				38	$(PDFLATEX) corebootBuildingGuide.tex
Stefan Reinauer	37414ca	2003-11-22 15:15:47 +0000	[diff] [blame]	39
Martin Roth	4b18a92	2017-06-03 20:16:01 -0600	[diff] [blame]	40	corebootPortingGuide.pdf: $(FIGS) corebootBuildingGuide.tex corebootPortingGuide.toc
				41	$(PDFLATEX) corebootBuildingGuide.tex
Stefan Reinauer	37414ca	2003-11-22 15:15:47 +0000	[diff] [blame]	42
Jonathan Neuschäfer	5e48c75	2018-04-19 16:23:56 +0200	[diff] [blame]	43	sphinx:
				44	$(MAKE) -f Makefile.sphinx html
				45
				46	clean-sphinx:
				47	$(MAKE) -f Makefile.sphinx clean
				48
				49	clean: clean-sphinx
Jonathan Neuschäfer	bdebc89	2018-09-25 23:15:16 +0200	[diff] [blame]	50	rm -f .aux .idx .log .toc *.out $(FIGS)
Stefan Reinauer	37414ca	2003-11-22 15:15:47 +0000	[diff] [blame]	51
				52	distclean: clean
Jonathan Neuschäfer	bdebc89	2018-09-25 23:15:16 +0200	[diff] [blame]	53	rm -f corebootPortingGuide.pdf
Tom Hiller	651b11b	2018-08-18 19:20:16 -0400	[diff] [blame]	54
				55	livesphinx:
Patrick Georgi	0cd9366	2019-01-28 19:23:40 +0100	[diff] [blame]	56	$(MAKE) -f Makefile.sphinx livehtml SPHINXOPTS="$(SPHINXOPTS)"
Martin Roth	e441b31	2023-05-29 23:02:10 -0600	[diff] [blame]	57
Martin Roth	34e43f6	2023-05-29 23:05:09 -0600	[diff] [blame^]	58	test:
				59	@echo "Test for logging purposes - Failing tests will not fail the build"
				60	-$(MAKE) -f Makefile.sphinx clean && $(MAKE) -K -f Makefile.sphinx html
				61	-$(MAKE) -f Makefile.sphinx clean && $(MAKE) -K -f Makefile.sphinx doctest
				62
Martin Roth	e441b31	2023-05-29 23:02:10 -0600	[diff] [blame]	63	help:
				64	@echo "all - Builds coreboot porting guide PDF (outdated)"
				65	@echo "sphinx - Builds html documentation in _build directory"
				66	@echo "clean - Cleans intermediate files"
				67	@echo "clean-sphinx - Removes sphinx output files"
				68	@echo "distclean - Removes PDF files as well"
Martin Roth	34e43f6	2023-05-29 23:05:09 -0600	[diff] [blame^]	69	@echo "test - Runs documentation tests"
Martin Roth	e441b31	2023-05-29 23:02:10 -0600	[diff] [blame]	70	@echo
				71	@echo " Makefile.sphinx builds - run with $(MAKE) -f Makefile-sphinx [target]"
				72	@echo
				73	@$(MAKE) -s -f Makefile.sphinx help 2>/dev/null
				74
				75	.phony: help livesphinx sphinx test
				76	.phony: distclean clean clean-sphinx