lfs/glfs
1
0
Fork 0
mirror of https://github.com/glfs-book/glfs.git synced 2025-07-22 01:12:59 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
f6e4640ceb74258b5a44f6a845d991a98161fe92
glfs/Makefile
Zeckmathederg f6e4640ceb NVIDIA: Add SysV powerd framework.
2025-06-24 13:34:45 -06:00

267 lines
9.3 KiB
Makefile
Raw Blame History

# vim:ts=3
# Makefile for GLFS Book generation.
# By Tushar Teredesai <tushar@linuxfromscratch.org>
# 2004-01-31
# Edited by Zeckma <zeckma.tech@gmail.com>
# 2025-01-12
# When rendering for the stable release from the stable branch, invoke
# STAB=release to make.
-include local.mk
# Adjust these to suit your installation, or include the variables
# you wish to change in local.mk, which must be created manually.
AUTO_CLEAN ?= 1
GLFS_THEME_PATH ?= stylesheets/lfs-xsl
GLFS_THEME ?= dark
RENDERTMP := $(shell mktemp -d)
HTML_ROOT ?= $(HOME)/public_html
DUMP_ROOT ?= $(HOME)
CHUNK_QUIET ?= 1
ROOT_ID =
SHELL = /bin/bash
ALLXML := $(filter-out $(RENDERTMP)/%, \
$(wildcard *.xml */*.xml */*/*.xml */*/*/*.xml */*/*/*/*.xml))
ALLXSL := $(filter-out $(RENDERTMP)/%, \
$(wildcard *.xsl */*.xsl */*/*.xsl */*/*/*.xsl */*/*/*/*.xsl))
ifdef V
Q =
else
Q = @
endif
ifndef REV
REV = sysv
endif
ifneq ($(REV), sysv)
ifneq ($(REV), systemd)
$(error REV must be 'sysv' (default) or 'systemd')
endif
endif
# Used in the book, does not actually change if the book will render for the
# stable git hash, just changes if text for stable release is rendered or not.
ifndef STAB
STAB = development
endif
ifneq ($(STAB), development)
ifneq ($(STAB), release)
$(error STAB must be 'development' (default) or 'release')
endif
endif
CLEAN = rm -rf $(RENDERTMP)
ifeq ($(AUTO_CLEAN), 0)
CLEAN =
endif
ifeq ($(REV), sysv)
BASEDIR ?= $(HTML_ROOT)/glfs
DUMPDIR ?= $(DUMP_ROOT)/glfs-commands
GLFSHTML ?= glfs-html.xml
GLFSHTML2 ?= glfs-html2.xml
GLFSFULL ?= glfs-full.xml
else
BASEDIR ?= $(HTML_ROOT)/glfs-systemd
DUMPDIR ?= $(DUMP_ROOT)/glfs-sysd-commands
GLFSHTML ?= glfs-systemd-html.xml
GLFSHTML2 ?= glfs-systemd-html2.xml
GLFSFULL ?= glfs-systemd-full.xml
endif
glfs: html wget-list
help:
@echo ""
@echo "make <parameters> <targets>"
@echo ""
@echo "Parameters:"
@echo ""
@echo " REV=<rev> Build variation of book"
@echo " Valid values for REV are:"
@echo " * sysv - Build book for SysV"
@echo " * systemd - Build book for systemd"
@echo " Defaults to 'sysv'"
@echo ""
@echo " BASEDIR=<dir> Put the output in directory <dir>."
@echo " Defaults to"
@echo " '$(HTML_ROOT)/glfs' if REV=sysv (or unset)"
@echo " or to"
@echo " '$(HTML_ROOT)/glfs-systemd' if REV=systemd"
@echo ""
@echo " V=<val> If <val> is a non-empty value, all"
@echo " steps to produce the output is shown."
@echo " Default is unset."
@echo ""
@echo " GLFS_THEME_PATH=<PATH> Sets the path of themes (CSS files)."
@echo " 'stylesheets/lfs-xsl' is the default."
@echo ""
@echo " GLFS_THEME=<theme> Sets the theme of the book, ie. light/dark."
@echo " 'dark' is the default."
@echo ""
@echo "Targets:"
@echo " help Show this help text."
@echo ""
@echo " glfs Builds targets 'html' and 'wget-list'."
@echo ""
@echo " html Builds the HTML pages of the book."
@echo ""
@echo " wget-list Produces a list of all packages to download."
@echo " Output is BASEDIR/wget-list"
@echo ""
@echo " validate Runs validation checks on the XML files."
@echo ""
@echo " test-links Runs validation checks on URLs in the book."
@echo " Produces a file named BASEDIR/bad_urls containing"
@echo " URLS which are invalid and a BASEDIR/good_urls"
@echo " containing all valid URLs."
@echo ""
all: glfs
world: all dump-commands test-links
html: $(BASEDIR)/index.html
$(BASEDIR)/index.html: $(RENDERTMP)/$(GLFSHTML) version wget-list
@echo "Generating chunked XHTML files..."
$(Q)xsltproc --nonet \
--stringparam chunk.quietly $(CHUNK_QUIET) \
--stringparam rootid "$(ROOT_ID)" \
--stringparam base.dir $(BASEDIR)/ \
stylesheets/glfs-chunked.xsl \
$(RENDERTMP)/$(GLFSHTML)
@echo "Copying CSS code, images, and file downloads..."
$(Q)if [ ! -e $(BASEDIR)/stylesheets ]; then \
mkdir -p $(BASEDIR)/stylesheets; \
fi;
$(Q)cp $(GLFS_THEME_PATH)/$(GLFS_THEME).lfs.css $(BASEDIR)/stylesheets/lfs.css
$(Q)cp stylesheets/lfs-xsl/lfs-print.css $(BASEDIR)/stylesheets
$(Q)sed -i 's|../stylesheet|stylesheet|' $(BASEDIR)/index.html
$(Q)if [ ! -e $(BASEDIR)/images ]; then \
mkdir -p $(BASEDIR)/images; \
fi;
$(Q)cp -R images/* $(BASEDIR)/images
$(Q)cd $(BASEDIR)/; sed -e "s@../images@images@g" \
-i *.html
$(Q)if [ ! -e $(BASEDIR)/download ]; then \
mkdir -p $(BASEDIR)/download; \
fi;
$(Q)rm -rf $(BASEDIR)/download/*
$(Q)cp -R download/* $(BASEDIR)/download
$(Q)rm -rf $(BASEDIR)/patches
$(Q)ln -sf download $(BASEDIR)/patches
@echo "Running Tidy and obfuscate.sh on chunked XHTML..."
$(Q)for filename in `find $(BASEDIR) -name "*.html"`; do \
tidy -config tidy.conf $$filename; \
true; \
bash obfuscate.sh $$filename; \
sed -i -e "1,20s@text/html@application/xhtml+xml@g" $$filename; \
done;
@echo "Copying over legacy HTML..."
$(Q)if [ ! -e $(BASEDIR)/archive ]; then \
mkdir -p $(BASEDIR)/archive; \
fi;
$(Q)cp -R archive/*.html $(BASEDIR)/archive
$(Q)$(CLEAN)
validate: $(RENDERTMP)/$(GLFSFULL)
$(RENDERTMP)/$(GLFSFULL): general.ent packages.ent $(ALLXML) $(ALLXSL) version
$(Q)[ -d $(RENDERTMP) ] || mkdir -p $(RENDERTMP)
$(Q)trap '$(CLEAN)' EXIT
@echo "Rendering the book for $(REV)..."
$(Q)xsltproc --nonet \
--xinclude \
--output $(RENDERTMP)/$(GLFSHTML2) \
--stringparam profile.revision $(REV) \
stylesheets/lfs-xsl/profile.xsl \
index.xml
@echo "Validating the book..."
$(Q)xmllint --nonet \
--noent \
--postvalid \
--output $(RENDERTMP)/$(GLFSFULL) \
$(RENDERTMP)/$(GLFSHTML2)
profile-html: $(RENDERTMP)/$(GLFSHTML)
$(RENDERTMP)/$(GLFSHTML): $(RENDERTMP)/$(GLFSFULL) version
@echo "Generating profiled XML for XHTML..."
$(Q)xsltproc --nonet \
--stringparam profile.condition html \
--output $(RENDERTMP)/$(GLFSHTML) \
stylesheets/lfs-xsl/profile.xsl \
$(RENDERTMP)/$(GLFSFULL)
wget-list: $(BASEDIR)/wget-list
$(BASEDIR)/wget-list: $(RENDERTMP)/$(GLFSFULL) version
@echo "Generating wget list for $(REV) at $(BASEDIR)/wget-list ..."
$(Q)mkdir -p $(BASEDIR)
$(Q)xsltproc --nonet \
--output $(BASEDIR)/wget-list \
stylesheets/wget-list.xsl \
$(RENDERTMP)/$(GLFSFULL)
test-links: $(BASEDIR)/test-links
$(BASEDIR)/test-links: $(RENDERTMP)/$(GLFSFULL) version
@echo "Generating test-links file..."
$(Q)mkdir -p $(BASEDIR)
$(Q)xsltproc --nonet \
--stringparam list_mode full \
--output $(BASEDIR)/test-links \
stylesheets/wget-list.xsl \
$(RENDERTMP)/$(GLFSFULL)
@echo "Checking URLs, first pass..."
$(Q)rm -f $(BASEDIR)/{good,bad,true_bad}_urls
$(Q)for URL in `cat $(BASEDIR)/test-links`; do \
wget --spider --tries=2 --timeout=60 $$URL >>/dev/null 2>&1; \
if test $$? -ne 0 ; then \
echo $$URL >> $(BASEDIR)/bad_urls ; \
else \
echo $$URL >> $(BASEDIR)/good_urls 2>&1; \
fi; \
done
@echo "Checking URLs, second pass..."
$(Q)for URL2 in `cat $(BASEDIR)/bad_urls`; do \
wget --spider --tries=2 --timeout=60 $$URL2 >>/dev/null 2>&1; \
if test $$? -ne 0 ; then \
echo $$URL2 >> $(BASEDIR)/true_bad_urls ; \
else \
echo $$URL2 >> $(BASEDIR)/good_urls 2>&1; \
fi; \
done
$(Q)$(CLEAN)
test-options:
$(Q)trap '$(CLEAN)' EXIT
$(Q)xsltproc --xinclude --nonet stylesheets/test-options.xsl index.xml
$(Q)$(CLEAN)
dump-commands: $(DUMPDIR)
$(DUMPDIR): $(RENDERTMP)/$(GLFSFULL) version
@echo "Dumping book commands at $(DUMPDIR)..."
$(Q)xsltproc --output $(DUMPDIR)/ \
stylesheets/dump-commands.xsl \
$(RENDERTMP)/$(GLFSFULL)
$(Q)touch $(DUMPDIR)
$(Q)$(CLEAN)
.PHONY: glfs all world html validate profile-html wget-list test-links \
dump-commands version test-options
version:
$(Q)REV=$(REV) STAB=$(STAB) ./git-version.sh
Reference in New Issue View Git Blame Copy Permalink