From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from lists.gentoo.org (pigeon.gentoo.org [208.92.234.80]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by finch.gentoo.org (Postfix) with ESMTPS id 2AEE2138334 for ; Fri, 22 Mar 2019 13:27:30 +0000 (UTC) Received: from pigeon.gentoo.org (localhost [127.0.0.1]) by pigeon.gentoo.org (Postfix) with SMTP id DD748E0894; Fri, 22 Mar 2019 13:27:28 +0000 (UTC) Received: from smtp.gentoo.org (smtp.gentoo.org [140.211.166.183]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by pigeon.gentoo.org (Postfix) with ESMTPS id 9E0E9E0894 for ; Fri, 22 Mar 2019 13:27:28 +0000 (UTC) Received: from oystercatcher.gentoo.org (unknown [IPv6:2a01:4f8:202:4333:225:90ff:fed9:fc84]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.gentoo.org (Postfix) with ESMTPS id BF8FE335D11 for ; Fri, 22 Mar 2019 13:27:26 +0000 (UTC) Received: from localhost.localdomain (localhost [IPv6:::1]) by oystercatcher.gentoo.org (Postfix) with ESMTP id 20279554 for ; Fri, 22 Mar 2019 13:27:25 +0000 (UTC) From: "Brian Evans" To: gentoo-commits@lists.gentoo.org Content-Transfer-Encoding: 8bit Content-type: text/plain; charset=UTF-8 Reply-To: gentoo-dev@lists.gentoo.org, "Brian Evans" Message-ID: <1553260756.d541c4c23305121c02ed18668b6019e86cfc2404.grknight@gentoo> Subject: [gentoo-commits] proj/devmanual:master commit in: /, bin/ X-VCS-Repository: proj/devmanual X-VCS-Files: .gitignore bin/gen-eclass-html.sh X-VCS-Directories: / bin/ X-VCS-Committer: grknight X-VCS-Committer-Name: Brian Evans X-VCS-Revision: d541c4c23305121c02ed18668b6019e86cfc2404 X-VCS-Branch: master Date: Fri, 22 Mar 2019 13:27:25 +0000 (UTC) Precedence: bulk List-Post: List-Help: List-Unsubscribe: List-Subscribe: List-Id: Gentoo Linux mail X-BeenThere: gentoo-commits@lists.gentoo.org X-Auto-Response-Suppress: DR, RN, NRN, OOF, AutoReply X-Archives-Salt: 38ab2170-5ae1-4890-9de2-5ef890c5e189 X-Archives-Hash: 73bb25fcb2970e33e39fe13a0493419b commit: d541c4c23305121c02ed18668b6019e86cfc2404 Author: Brian Evans gentoo org> AuthorDate: Fri Mar 22 13:19:16 2019 +0000 Commit: Brian Evans gentoo org> CommitDate: Fri Mar 22 13:19:16 2019 +0000 URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=d541c4c2 Create script for eclass-reference This was previously held in infra but contains no identifying information Bug: https://bugs.gentoo.org/536654 Signed-off-by: Brian Evans gentoo.org> .gitignore | 1 + bin/gen-eclass-html.sh | 135 +++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 136 insertions(+) diff --git a/.gitignore b/.gitignore index b364f07..720d4d6 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,3 @@ *.html *.png +eclass-reference/ diff --git a/bin/gen-eclass-html.sh b/bin/gen-eclass-html.sh new file mode 100755 index 0000000..e87f60f --- /dev/null +++ b/bin/gen-eclass-html.sh @@ -0,0 +1,135 @@ +#!/bin/bash + +# pre1) OOB: The host needs to emerge eclass-manpages on a daily basis. +# This script should be run before the make operation is performed + +OUTPUTDIR="eclass-reference" + +IFS='' read -r -d '' FOOTER << 'EOF' + + + + +EOF + +# We also need the ebuild man page +for i in $(/usr/bin/qlist eclass-manpages) /usr/share/man/man5/ebuild.5.bz2; do + BASENAME="$(basename $i .5.bz2)" + DIRNAME="${OUTPUTDIR}/${BASENAME}" + TMP="${DIRNAME}/index.html.tmp" + FINAL="${DIRNAME}/index.html" + [[ -d ${DIRNAME} ]] || mkdir -p ${DIRNAME} + # rebuild the man page each time + cat << EOF > ${FINAL} + + + + Gentoo Development Guide: $BASENAME + + + + + + + + +
+
+ Get Gentoo!
+ +
+
+ +
+
  1. Master Index
  2. Eclass Reference
+
+EOF + # generate html pages and fix hyperlinks for eclass and ebuild man pages + /bin/bunzip2 -c $i | /usr/bin/man2html -r - | \ + sed -e "/:=../\1/index.html>:" \ + -e "/<\/BODY>/d" -e "/<\/HTML>/d" \ + -e "/:=../\1/\index.html>:" >> ${TMP} + # The first 4 lines are cruft for devmanual + tail -n $(($(wc -l ${TMP} | awk '{print $1}') - 4)) ${TMP} >> ${FINAL} + rm -f ${TMP} + echo "${FOOTER}" >> ${FINAL} +done + +# Remove old dirs (eclasses that were dropped from the tree) +find $OUTPUTDIR -mindepth 1 -maxdepth 1 -mtime +1 -exec rm -R {} \; + +# build the index, rebuilding it each time +cat << EOF > $OUTPUTDIR/text.xml + + + +Eclass Reference + + +

+This section provides a reference for some of the more commonly used eclasses. +Note that most eclasses have an accompanying manual page. These man pages can be +installed by emerging app-portage/eclass-manpages. +

+ + +
+Contents + +
    +EOF + +for i in $(find $OUTPUTDIR/ -maxdepth 1 -mindepth 1 -type d | sort); do + echo "
  • $(basename $i) Reference
    • " >> ${OUTPUTDIR}/text.xml +done + +cat << EOF >> ${OUTPUTDIR}/text.xml + +
+
+ + +EOF