docs: new feature

This one has been brewin' for quite a while but has been completed finally; some tweaks sure can come in later but it's working. Please note that it's rather needed for "proper" distros with specific branding and docs packages prepared for those; one should use l10n feature most likely too.

docs: new feature
9d77c2d4 · Michael Shigorin · 33f79ccf · 9d77c2d4 · 9d77c2d4 · 9d77c2d4
Commit 9d77c2d4 authored Apr 23, 2014 by Michael Shigorin
Showing with 83 additions and 0 deletions

README features.in/docs/README +11 -0

config.mk features.in/docs/config.mk +18 -0

30-docs.mk features.in/docs/lib/30-docs.mk +8 -0

50-docs-indexhtml features.in/docs/scripts.d/50-docs-indexhtml +46 -0

No files found.
--- a/features.in/docs/README
+++ b/features.in/docs/README
+Эта фича добавляет в образ распакованную документацию дистрибутива,
+а именно вводную страничку (входит в пакет branding-*-indexhtml)
+и/или специфичное для данного продукта руководство из пакета docs-*
+(вариант задаётся отдельно выставлением переменной DOCS).
+
+Обратите внимание, что для indexhtml создаётся переброска с учётом
+языка (при наличии index-LL.html), поэтому ожидается задействование
+фичи l10n с соответствующим указанием языка по умолчанию.
+
+NB: предполагается применение при формировании ISO-образов,
+другие случаи наверняка потребуют доработки.
--- a/features.in/docs/config.mk
+++ b/features.in/docs/config.mk
+# copy the packaged docs to image root
+# packaged documentation sources:
+# 1) branding-*-indexhtml
+# 2) docs-* (should be installed elsewhere)
+
+docs: use/docs; @:
+
+use/docs:
+	@$(call add_feature)
+
+use/docs/indexhtml: use/docs use/branding
+	@$(call add,THE_BRANDING,indexhtml)
+
+use/docs/manual: use/docs
+	@$(call xport,DOCS)
+	@$(call add,THE_PACKAGES,docs-$(DOCS))
+
+use/docs/full: use/docs/indexhtml use/docs/manual; @:
--- a/features.in/docs/lib/30-docs.mk
+++ b/features.in/docs/lib/30-docs.mk
+# step 4: build the distribution image
+
+ifneq (,$(DOCS))
+DOT_BASE += docs-$(DOCS)
+CHROOT_PACKAGES += docs-$(DOCS)
+endif
+
+CHROOT_PACKAGES_REGEXP += $(call branding,indexhtml)
--- a/features.in/docs/scripts.d/50-docs-indexhtml
+++ b/features.in/docs/scripts.d/50-docs-indexhtml
+#!/bin/sh -e
+
+# trailing slash is important here
+dest="docs/"
+
+mkdir -p "$WORKDIR/$dest"
+cd $WORKDIR
+
+nonfatal() { echo "** $*" >&2; exit 0; }
+
+indexdir="/usr/share/doc/indexhtml"
+indexfile="$indexdir/index.html"
+
+[ -s "$indexfile" ] || nonfatal "$indexfile not found"
+
+[ -n "$GLOBAL_LOCALE" ] ||
+	echo "** warning: GLOBAL_LOCALE empty, maybe use/l10n" >&2
+
+LANG="$GLOBAL_LOCALE" indexhtml-update
+
+# http://unix.stackexchange.com/questions/94185/convert-soft-to-hardlinks
+cp -aH "$indexdir" "$dest"
+
+mkredir() {
+	cat >"${1}index.html" <<-EOF
+	<html>
+	<head>
+	<meta http-equiv="refresh" content="0;url=${2}indexhtml/index.html">
+	<title>Redirecting...</title>
+	</head>
+	<body>
+	<h1>Redirecting...</h1>
+	</body>
+	</html>
+	EOF
+}
+
+mkredir "" "$dest"	# /index.html -> docs/indexhtml/index.html
+mkredir "$dest" ""	# docs//index.html -> indexhtml/index.html
+
+docdir="/usr/share/doc/documentation"
+[ -d "$docdir" ] || nonfatal "$docdir not found"
+
+cp -aH "$docdir" "$dest"
+
+### no need to replace symlinks with hardlinks by now? (-aH)