diff options
author | V3n3RiX <venerix@redcorelinux.org> | 2019-03-19 11:37:34 +0000 |
---|---|---|
committer | V3n3RiX <venerix@redcorelinux.org> | 2019-03-19 11:37:34 +0000 |
commit | b7b97785ebbb2f11d24d14dab8b81ed274f4ce6a (patch) | |
tree | 9fd110f9fc996e8a4213eeda994a8c112491b86d /app-doc | |
parent | 066d27181e9a797ad9f8fc43b49fc9a10ff2f707 (diff) |
gentoo resync : 19.03.2019
Diffstat (limited to 'app-doc')
-rw-r--r-- | app-doc/Manifest.gz | bin | 6799 -> 7138 bytes | |||
-rw-r--r-- | app-doc/devmanual/Manifest | 4 | ||||
-rw-r--r-- | app-doc/devmanual/devmanual-0_pre20141116.ebuild | 6 | ||||
-rw-r--r-- | app-doc/devmanual/devmanual-9999.ebuild | 6 | ||||
-rw-r--r-- | app-doc/e16-docs/Manifest | 3 | ||||
-rw-r--r-- | app-doc/e16-docs/e16-docs-0.16.8.0.2.ebuild | 14 | ||||
-rw-r--r-- | app-doc/e16-docs/metadata.xml | 11 | ||||
-rw-r--r-- | app-doc/eclass-manpages/Manifest | 6 | ||||
-rw-r--r-- | app-doc/eclass-manpages/eclass-manpages-20190314.ebuild | 33 | ||||
-rw-r--r-- | app-doc/eclass-manpages/eclass-manpages-99999999.ebuild | 30 | ||||
-rw-r--r-- | app-doc/eclass-manpages/files/eclass-to-manpage.awk | 457 | ||||
-rwxr-xr-x | app-doc/eclass-manpages/files/eclass-to-manpage.sh | 44 | ||||
-rw-r--r-- | app-doc/eclass-manpages/metadata.xml | 12 | ||||
-rw-r--r-- | app-doc/pms/Manifest | 4 | ||||
-rw-r--r-- | app-doc/pms/pms-7_p20180430-r1.ebuild | 4 | ||||
-rw-r--r-- | app-doc/pms/pms-9999.ebuild | 7 |
16 files changed, 624 insertions, 17 deletions
diff --git a/app-doc/Manifest.gz b/app-doc/Manifest.gz Binary files differindex 3bd0ab67654a..0d5c23e8e632 100644 --- a/app-doc/Manifest.gz +++ b/app-doc/Manifest.gz diff --git a/app-doc/devmanual/Manifest b/app-doc/devmanual/Manifest index 2dfc06545484..314727fb8e40 100644 --- a/app-doc/devmanual/Manifest +++ b/app-doc/devmanual/Manifest @@ -1,4 +1,4 @@ DIST devmanual-0_pre20141116.tar.gz 169936 BLAKE2B 9b01004750b9fce226fa6a965292d3ffaff0923f877da611743e39ee19077ea7fe0d21ff138853d3f79e4d4941026c30fcabf63c8903572ed7ba5d50d32c8dd5 SHA512 6af3f9a262bdb2ceb61ab195691dff4a850b22e8d1226e20ae3257c566b6cc913f756c8b90a40e8aa78b1242e78d24c4209a1d9cdb0706ae9b64c653544a028f -EBUILD devmanual-0_pre20141116.ebuild 1773 BLAKE2B ca879efa95086f57a5b648b0e8c093cbef4e3f6aa74c41492ba4559c1f2180157006a1212f911087f4a31cf0159e3bf26a638ec963030a1bee2f04c3eaa46995 SHA512 8ff92699f5e975df3890363334286b023ce3d7d552ab001b47513cbe7615c3d4e0fd54050ca4b405e7e4689fda96782e56eea80a7d5cc0545fff3fcc7c18afd2 -EBUILD devmanual-9999.ebuild 1773 BLAKE2B ca879efa95086f57a5b648b0e8c093cbef4e3f6aa74c41492ba4559c1f2180157006a1212f911087f4a31cf0159e3bf26a638ec963030a1bee2f04c3eaa46995 SHA512 8ff92699f5e975df3890363334286b023ce3d7d552ab001b47513cbe7615c3d4e0fd54050ca4b405e7e4689fda96782e56eea80a7d5cc0545fff3fcc7c18afd2 +EBUILD devmanual-0_pre20141116.ebuild 1762 BLAKE2B 83186e74a1172f7cef733e972bda7c3c88c91d094c9b260e004b16d4e60ca366dc257fc7e108388ef4d6c558e02d669ccdc424737fe03d7e4906c40488695522 SHA512 9420d56918fa471001ab39ffe0e99f8beee07d669e486d1691398c29266898cb5a2426c9d864680529d9a4cb9f13b3829c52827fc6f04f6e3dc4f1c0f26c08a6 +EBUILD devmanual-9999.ebuild 1762 BLAKE2B 83186e74a1172f7cef733e972bda7c3c88c91d094c9b260e004b16d4e60ca366dc257fc7e108388ef4d6c558e02d669ccdc424737fe03d7e4906c40488695522 SHA512 9420d56918fa471001ab39ffe0e99f8beee07d669e486d1691398c29266898cb5a2426c9d864680529d9a4cb9f13b3829c52827fc6f04f6e3dc4f1c0f26c08a6 MISC metadata.xml 444 BLAKE2B e898461555bfab0233e7b0ed865f69366422aba872fbc94f915cbeb21181b7720ea891540bcd11e8e331a968b1bba8ece8b1fb09dd3220749b23c5b8d0c6e071 SHA512 e7902957c885afc8a9652aa172f9e49069b8ee9b963ddc57db762a9bce21b852f6bfb9dbe4ce34219c919a451fd3f82ad6d17bbaf56933a4e96d598d2daf37a8 diff --git a/app-doc/devmanual/devmanual-0_pre20141116.ebuild b/app-doc/devmanual/devmanual-0_pre20141116.ebuild index e891efa24f23..15b7afe991b4 100644 --- a/app-doc/devmanual/devmanual-0_pre20141116.ebuild +++ b/app-doc/devmanual/devmanual-0_pre20141116.ebuild @@ -1,4 +1,4 @@ -# Copyright 1999-2017 Gentoo Foundation +# Copyright 1999-2019 Gentoo Authors # Distributed under the terms of the GNU General Public License v2 EAPI=6 @@ -55,12 +55,12 @@ src_install() { pkg_postinst() { readme.gentoo_print_elog - if ! has_version app-portage/eclass-manpages; then + if ! has_version app-doc/eclass-manpages; then elog "The offline version of the devmanual does not include the" elog "documentation for the eclasses. If you need it, then emerge" elog "the following package:" elog - elog "app-portage/eclass-manpages" + elog "app-doc/eclass-manpages" elog fi } diff --git a/app-doc/devmanual/devmanual-9999.ebuild b/app-doc/devmanual/devmanual-9999.ebuild index e891efa24f23..15b7afe991b4 100644 --- a/app-doc/devmanual/devmanual-9999.ebuild +++ b/app-doc/devmanual/devmanual-9999.ebuild @@ -1,4 +1,4 @@ -# Copyright 1999-2017 Gentoo Foundation +# Copyright 1999-2019 Gentoo Authors # Distributed under the terms of the GNU General Public License v2 EAPI=6 @@ -55,12 +55,12 @@ src_install() { pkg_postinst() { readme.gentoo_print_elog - if ! has_version app-portage/eclass-manpages; then + if ! has_version app-doc/eclass-manpages; then elog "The offline version of the devmanual does not include the" elog "documentation for the eclasses. If you need it, then emerge" elog "the following package:" elog - elog "app-portage/eclass-manpages" + elog "app-doc/eclass-manpages" elog fi } diff --git a/app-doc/e16-docs/Manifest b/app-doc/e16-docs/Manifest new file mode 100644 index 000000000000..fa3445f4c942 --- /dev/null +++ b/app-doc/e16-docs/Manifest @@ -0,0 +1,3 @@ +DIST e16-docs-0.16.8.0.2.tar.gz 1655229 BLAKE2B 7f57fcc90791f27e2186cd266222072c5ab5214f12e0f35fbdf706035e6f7ce68ab632779e77572e3ddb8c0d183aebfacc23dc25f400a941325dced54ae72b92 SHA512 df46cedff63984f5fe3cd4d523406efc3b4334447cbe9e31abae969961142887c5891bad7c65b066bb077f69789de4d38718872554e4a23f3b5b853bda665e31 +EBUILD e16-docs-0.16.8.0.2.ebuild 370 BLAKE2B 1e08021ed008270dd32bf41d31c51ede0723620ad42340ea8d15df9708aeadecb1803b5f5eb171892c36a6aa81aaa5197f070351b4db735cca4959282510d03f SHA512 b485e31a2b8e5379b005d3962f563bd8c9e3ea24204c459d618d4c3c1b4b582c047418d75c31eae0be3de78c7b56a3b194f39e52837ef25e2fb5045fdbcb4d41 +MISC metadata.xml 343 BLAKE2B 295618490636872ce0aff5266028733087db75ec585d604a9908afe1cfa49e4101778badbc3dded2717e733fa76b879a4fbb58070b3e2e1e09268a871eb7bb8c SHA512 200efaf51e5c6746fa854a10d1d63348695db4da86091cd50ef01a9fd4b7d46cda9c79f257fdf337911d276fc2f95ca17dc05070a252f7eaa1fc3bb9eb2c1071 diff --git a/app-doc/e16-docs/e16-docs-0.16.8.0.2.ebuild b/app-doc/e16-docs/e16-docs-0.16.8.0.2.ebuild new file mode 100644 index 000000000000..3de207108ca7 --- /dev/null +++ b/app-doc/e16-docs/e16-docs-0.16.8.0.2.ebuild @@ -0,0 +1,14 @@ +# Copyright 1999-2019 Gentoo Authors +# Distributed under the terms of the GNU General Public License v2 + +EAPI=7 + +DESCRIPTION="The E16 online help" +HOMEPAGE="https://www.enlightenment.org https://sourceforge.net/projects/enlightenment/" +SRC_URI="mirror://sourceforge/enlightenment/${P}.tar.gz" + +LICENSE="BSD" +SLOT="0" +KEYWORDS="~amd64 ~x86" + +RDEPEND="!app-doc/edox-data" diff --git a/app-doc/e16-docs/metadata.xml b/app-doc/e16-docs/metadata.xml new file mode 100644 index 000000000000..2f0f4890caf3 --- /dev/null +++ b/app-doc/e16-docs/metadata.xml @@ -0,0 +1,11 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE pkgmetadata SYSTEM "http://www.gentoo.org/dtd/metadata.dtd"> +<pkgmetadata> + <maintainer type="person"> + <email>bircoph@gentoo.org</email> + <name>Andrew Savchenko</name> + </maintainer> + <upstream> + <remote-id type="sourceforge">enlightenment</remote-id> + </upstream> +</pkgmetadata> diff --git a/app-doc/eclass-manpages/Manifest b/app-doc/eclass-manpages/Manifest new file mode 100644 index 000000000000..d8709e6312c5 --- /dev/null +++ b/app-doc/eclass-manpages/Manifest @@ -0,0 +1,6 @@ +AUX eclass-to-manpage.awk 10909 BLAKE2B e41b792f8316c612609da17c16ba41f01a4fc27c847bc380a26a570abef030d6e11a74673d703da77e17bb3db796ed3207d95cd9d8e7604551a6d0b10c6a3e07 SHA512 c37d502f66c31b2e5be8c27071ade6bfe7617d84bbca57ab3ac9d0f2d3403281d50fd8c6bada2c3dbe29041bcef4c0dafc76506a1ddca82fc26aa83d4785bae2 +AUX eclass-to-manpage.sh 738 BLAKE2B 719f9ac6a4283e6795f0463073a460f35b65b6d5c020eeb3823527cb559774c2273c374ea1fbf196e4528b55de9feedce6d024c4495e76cc7c4b7cd4079da202 SHA512 9d50ca11215fc69cc6b4ed67891039f24a93d9843103ab0bb8b13f0596fbca7541da0feaa31ab236279a7047cd9fcdd4a8f9d8a249de725d69e45e6c276d49d1 +DIST eclass-manpages-20190314.tar.xz 419576 BLAKE2B baad0d5f9c67b7e4b9646e69e90583a8238590a02bb6bcc200b08f17f56b2ae50a56080526d3398623949ffc91857d944a1035d6b44fba07b17024c2c224b802 SHA512 22f4b32654f459afa8e5057f02c92628cc529f236e48a69f9b346e7bdcf60d12a4cdd71debf96e8d4b3e69b0e497feb9143b385a11d835b43d13c32fa1751d51 +EBUILD eclass-manpages-20190314.ebuild 1084 BLAKE2B c5ba9cd688ec3c21f734e36feb32e5651a06f09f42e7886627dd92d122ff99a797f55a734a00d79c7ca3464f61f473cd003ad5961a37d50e23cc2908cf623362 SHA512 93fae7b743267e0c32b1bc3317d1f2cda10e2b64d22d01986730ccc2d648c848be970c57f319dcd58265a450a68b120a58943e18c01201a9b866a76911b56982 +EBUILD eclass-manpages-99999999.ebuild 565 BLAKE2B cf44fffbbb4350569de1d1fceec7a98753625c61876e370a11d3aeeac5d659b32aa182ef62ddebbcb1d2b1eb187722493a66750960820b04fc2d877e50f8692f SHA512 4f21ba6eb7f08778339262db1336b3a9bf5fa9c2323f3f5144ff7e72ea9654f2679c11642e3d1073a10d074603407e3bcf9f4c2581973c9da8e2f9309928f2e4 +MISC metadata.xml 374 BLAKE2B 3f87ce1d875199a067b945d6c9f3b80bde36ec25714d7dd802a55b37895d6c1e9360e003c4e6066ffcf6338a7f04b46a181a8c49f7144866fd9547626a0378bb SHA512 3caedcecef2f388c833b9f7db0af743a71227288bb145ec8a56c2862c7f56571a860f7f961d0ab1565cc98a0d178e87e24a7321cf0b7d4c4d3ab95c120fb0cf9 diff --git a/app-doc/eclass-manpages/eclass-manpages-20190314.ebuild b/app-doc/eclass-manpages/eclass-manpages-20190314.ebuild new file mode 100644 index 000000000000..d0c5185c96f0 --- /dev/null +++ b/app-doc/eclass-manpages/eclass-manpages-20190314.ebuild @@ -0,0 +1,33 @@ +# Copyright 1999-2019 Gentoo Authors +# Distributed under the terms of the GNU General Public License v2 + +EAPI="6" + +DESCRIPTION="Collection of Gentoo eclass manpages" +HOMEPAGE="https://www.gentoo.org/" +SRC_URI="https://dev.gentoo.org/~mgorny/dist/${P}.tar.xz" + +LICENSE="GPL-2" +SLOT="0" +# Keep the keywords stabled. No need to change to ~arch. +KEYWORDS="alpha amd64 arm arm64 hppa ia64 m68k ~mips ppc ppc64 s390 sh sparc x86 ~x86-fbsd ~amd64-linux ~x86-linux ~x64-macos ~x86-solaris" + +DEPEND="app-arch/xz-utils" + +# How to create a snapshot and upload it to your dev-space: +# +# mkdir eclass-manpages-$(date +%Y%m%d) +# cp "$(portageq get_repo_path / gentoo)"/eclass/*.eclass eclass-manpages-$(date +%Y%m%d)/ +# tar -cf eclass-manpages-$(date +%Y%m%d).tar eclass-manpages-$(date +%Y%m%d) +# xz -e eclass-manpages-$(date +%Y%m%d).tar +# scp eclass-manpages-$(date +%Y%m%d).tar.xz dev.gentoo.org:public_html/dist/ +# +# Then copy the ebuild and update your name in SRC_URI ;-). + +src_compile() { + env ECLASSDIR="${S}" bash "${FILESDIR}"/eclass-to-manpage.sh || die +} + +src_install() { + doman *.5 +} diff --git a/app-doc/eclass-manpages/eclass-manpages-99999999.ebuild b/app-doc/eclass-manpages/eclass-manpages-99999999.ebuild new file mode 100644 index 000000000000..7dfb0d7e0d2a --- /dev/null +++ b/app-doc/eclass-manpages/eclass-manpages-99999999.ebuild @@ -0,0 +1,30 @@ +# Copyright 1999-2019 Gentoo Authors +# Distributed under the terms of the GNU General Public License v2 + +EAPI="7" + +inherit git-r3 + +DESCRIPTION="Collection of Gentoo eclass manpages" +HOMEPAGE="https://www.gentoo.org/" +SRC_URI="" +EGIT_REPO_URI="https://anongit.gentoo.org/git/repo/gentoo.git + https://github.com/gentoo/gentoo.git" + +LICENSE="GPL-2" +SLOT="0" +KEYWORDS="" +IUSE="" + +src_unpack() { + git-r3_fetch + git-r3_checkout '' '' '' eclass +} + +src_compile() { + env ECLASSDIR="${S}/eclass" bash "${FILESDIR}"/eclass-to-manpage.sh || die +} + +src_install() { + doman *.5 +} diff --git a/app-doc/eclass-manpages/files/eclass-to-manpage.awk b/app-doc/eclass-manpages/files/eclass-to-manpage.awk new file mode 100644 index 000000000000..b40eaf112091 --- /dev/null +++ b/app-doc/eclass-manpages/files/eclass-to-manpage.awk @@ -0,0 +1,457 @@ +# Copyright 1999-2017 Gentoo Foundation +# Distributed under the terms of the GNU General Public License v2 + +# This awk converts the comment documentation found in eclasses +# into man pages for easier/nicer reading. +# +# If you wish to have multiple paragraphs in a description, then +# create empty comment lines. Paragraph parsing ends when the comment +# block does. + +# The format of the eclass description: +# @ECLASS: foo.eclass +# @MAINTAINER: +# <required; list of contacts, one per line> +# @AUTHOR: +# <optional; list of authors, one per line> +# @BUGREPORTS: +# <optional; description of how to report bugs; +# default: tell people to use bugs.gentoo.org> +# @VCSURL: <optional; url to vcs for this eclass; default: https://gitweb.gentoo.org/repo/gentoo.git/log/eclass/@ECLASS@> +# @SUPPORTED_EAPIS: <optional; space-separated list of EAPIs> +# @BLURB: <required; short description> +# @DESCRIPTION: +# <optional; long description> +# @EXAMPLE: +# <optional; example usage> + +# The format of functions: +# @FUNCTION: foo +# @USAGE: <required arguments to foo> [optional arguments to foo] +# @RETURN: <whatever foo returns> +# @MAINTAINER: +# <optional; list of contacts, one per line> +# [@INTERNAL] +# @DESCRIPTION: +# <required if no @RETURN; blurb about this function> + +# The format of function-specific variables: +# @VARIABLE: foo +# [@USER_VARIABLE] (set in make.conf, not ebuilds) +# [@INTERNAL] (internal eclass use variable) +# [@DEFAULT_UNSET] +# [@REQUIRED] +# @DESCRIPTION: +# <required; blurb about this variable> +# foo="<default value>" + +# The format of eclass variables: +# @ECLASS-VARIABLE: foo +# [@PRE_INHERIT] (the variable must be set before inheriting the eclass) +# [@USER_VARIABLE] (set in make.conf, not ebuilds) +# [@OUTPUT_VARIABLE] (set by eclass, to be read in ebuilds) +# [@INTERNAL] (internal eclass use variable) +# [@DEFAULT_UNSET] +# [@REQUIRED] +# @DESCRIPTION: +# <required; blurb about this variable> +# foo="<default value>" + +# Disable manpage generation: +# @DEAD + +# Common features: +# @CODE +# In multiline paragraphs, you can create chunks of unformatted +# code by using this marker at the start and end. +# @CODE +# +# @ROFF <some roff macros> +# If you want a little more manual control over the formatting, you can +# insert roff macros directly into the output by using the @ROFF escape. + +function _stderr_msg(text, type, file, cnt) { + if (_stderr_header_done != 1) { + cnt = split(FILENAME, file, /\//) + print "\n" file[cnt] ":" > "/dev/stderr" + _stderr_header_done = 1 + } + + print " " type ":" NR ": " text > "/dev/stderr" +} +function warn(text) { + _stderr_msg(text, "warning") +} +function fail(text) { + _stderr_msg(text, "error") + exit(1) +} +function xfail(text) { + _stderr_msg(text, "error (ignoring)") + exit(77) +} + +function eat_line() { + ret = $0 + sub(/^# @[A-Z]*:[[:space:]]*/,"",ret) + getline + return ret +} +function eat_paragraph() { + code = 0 + ret = "" + getline + while ($0 ~ /^#/) { + # Only allow certain tokens in the middle of paragraphs + if ($2 ~ /^@/ && $2 !~ /^@(CODE|ROFF)$/) + break + + sub(/^#[[:space:]]?/, "", $0) + + # Escape . at start of line #420153 + if ($0 ~ /^[.]/) + $0 = "\\&" $0 + + # Translate @CODE into @ROFF + if ($1 == "@CODE" && NF == 1) { + if (code) + $0 = "@ROFF .fi" + else + $0 = "@ROFF .nf" + code = !code + } + + # Allow people to specify *roff commands directly + if ($1 == "@ROFF") + sub(/^@ROFF[[:space:]]*/, "", $0) + + ret = ret "\n" $0 + + # Handle the common case of trailing backslashes in + # code blocks to cross multiple lines #335702 + if (code && $NF == "\\") + ret = ret "\\" + getline + } + sub(/^\n/,"",ret) + return ret +} + +function pre_text(p) { + return ".nf\n" p "\n.fi" +} + +function man_text(p) { + return gensub(/-/, "\\-", "g", p) +} + +# +# Handle an @ECLASS block +# +function handle_eclass() { + eclass = $3 + eclass_maintainer = "" + eclass_author = "" + supported_eapis = "" + blurb = "" + desc = "" + example = "" + + # Sanity check the eclass name. #537392 + if (eclass !~ /[.]eclass$/) + fail(eclass ": @ECLASS name is missing a '.eclass' suffix") + + # first the man page header + print ".\\\" -*- coding: utf-8 -*-" + print ".\\\" ### DO NOT EDIT THIS FILE" + print ".\\\" ### This man page is autogenerated by eclass-to-manpage.awk" + print ".\\\" ### based on comments found in " eclass + print ".\\\"" + print ".\\\" See eclass-to-manpage.awk for documentation on how to get" + print ".\\\" your eclass nicely documented as well." + print ".\\\"" + print ".TH \"" toupper(eclass) "\" 5 \"" strftime("%b %Y") "\" \"Portage\" \"portage\"" + + # now eat the global data + getline + if ($2 == "@MAINTAINER:") + eclass_maintainer = eat_paragraph() + if ($2 == "@AUTHOR:") + eclass_author = eat_paragraph() + if ($2 == "@BUGREPORTS:") + reporting_bugs = eat_paragraph() + if ($2 == "@VCSURL:") + vcs_url = eat_line() + if ($2 == "@SUPPORTED_EAPIS:") + supported_eapis = eat_line() + if ($2 == "@BLURB:") + blurb = eat_line() + if ($2 == "@DESCRIPTION:") + desc = eat_paragraph() + if ($2 == "@EXAMPLE:") + example = eat_paragraph() + # in case they typo-ed the keyword, bail now + if ($2 ~ /^@/) + fail(eclass ": unknown keyword " $2) + + # finally display it + print ".SH \"NAME\"" + print eclass " \\- " man_text(blurb) + if (desc != "") { + print ".SH \"DESCRIPTION\"" + print man_text(desc) + } + if (example != "") { + print ".SH \"EXAMPLE\"" + print man_text(example) + } + + # sanity checks + if (blurb == "") + fail(eclass ": no @BLURB found") + if (eclass_maintainer == "") + warn(eclass ": no @MAINTAINER found") +} + +# +# Handle a @FUNCTION block +# +function show_function_header() { + if (_function_header_done != 1) { + print ".SH \"FUNCTIONS\"" + _function_header_done = 1 + } +} +function handle_function() { + func_name = $3 + usage = "" + funcret = "" + maintainer = "" + internal = 0 + desc = "" + + # make sure people haven't specified this before (copy & paste error) + if (all_funcs[func_name]) + fail(eclass ": duplicate definition found for function: " func_name) + all_funcs[func_name] = func_name + + # grab the docs + getline + if ($2 == "@USAGE:") + usage = eat_line() + if ($2 == "@RETURN:") + funcret = eat_line() + if ($2 == "@MAINTAINER:") + maintainer = eat_paragraph() + if ($2 == "@INTERNAL") { + internal = 1 + getline + } + if ($2 == "@DESCRIPTION:") + desc = eat_paragraph() + + if (internal == 1) + return + + show_function_header() + + # now print out the stuff + print ".TP" + print "\\fB" func_name "\\fR " man_text(usage) + if (desc != "") + print man_text(desc) + if (funcret != "") { + if (desc != "") + print "" + print "Return value: " funcret + } + + if (blurb == "") + fail(func_name ": no @BLURB found") + if (desc == "" && funcret == "") + fail(func_name ": no @DESCRIPTION found") +} + +# +# Handle @VARIABLE and @ECLASS-VARIABLE blocks +# +function _handle_variable() { + var_name = $3 + desc = "" + val = "" + default_unset = 0 + internal = 0 + required = 0 + + # additional variable classes + pre_inherit = 0 + user_variable = 0 + output_variable = 0 + + # make sure people haven't specified this before (copy & paste error) + if (all_vars[var_name]) + fail(eclass ": duplicate definition found for variable: " var_name) + all_vars[var_name] = var_name + + # grab the optional attributes + opts = 1 + while (opts) { + getline + if ($2 == "@DEFAULT_UNSET") + default_unset = 1 + else if ($2 == "@INTERNAL") + internal = 1 + else if ($2 == "@REQUIRED") + required = 1 + else if ($2 == "@PRE_INHERIT") + pre_inherit = 1 + else if ($2 == "@USER_VARIABLE") + user_variable = 1 + else if ($2 == "@OUTPUT_VARIABLE") + output_variable = 1 + else + opts = 0 + } + if ($2 == "@DESCRIPTION:") + desc = eat_paragraph() + + # extract the default variable value + # first try var="val" + op = "=" + regex = "^.*" var_name "=(.*)$" + val = gensub(regex, "\\1", 1, $0) + if (val == $0) { + # next try : ${var:=val} + op = "?=" + regex = "^[[:space:]]*:[[:space:]]*[$]{" var_name ":?=(.*)}" + val = gensub(regex, "\\1", 1, $0) + if (val == $0) { + if (default_unset + required + internal + output_variable == 0) + warn(var_name ": unable to extract default variable content: " $0) + val = "" + } else if (val !~ /^["']/ && val ~ / /) { + if (default_unset == 1) + warn(var_name ": marked as unset, but has value: " val) + val = "\"" val "\"" + } + } + if (length(val)) + val = " " op " \\fI" val "\\fR" + if (required == 1) + val = val " (REQUIRED)" + # TODO: group variables using those classes + if (pre_inherit == 1) + val = val " (SET BEFORE INHERIT)" + if (user_variable == 1) + val = val " (USER VARIABLE)" + if (output_variable == 1) + val = val " (GENERATED BY ECLASS)" + + # check for invalid combos + if (internal + pre_inherit + user_variable + output_variable > 1) + fail(var_name ": multiple variable classes specified") + + if (internal == 1) + return "" + + # now accumulate the stuff + ret = \ + ".TP" "\n" \ + "\\fB" var_name "\\fR" val "\n" \ + man_text(desc) + + if (desc == "") + fail(var_name ": no @DESCRIPTION found") + + return ret +} +function handle_variable() { + show_function_header() + ret = _handle_variable() + if (ret == "") + return + print ret +} +function handle_eclass_variable() { + ret = _handle_variable() + if (ret == "") + return + if (eclass_variables != "") + eclass_variables = eclass_variables "\n" + eclass_variables = eclass_variables ret +} + +# +# Spit out the common footer of manpage +# +function handle_footer() { + if (eclass_variables != "") { + print ".SH \"ECLASS VARIABLES\"" + print man_text(eclass_variables) + } + if (eclass_author != "") { + print ".SH \"AUTHORS\"" + print pre_text(man_text(eclass_author)) + } + if (eclass_maintainer != "") { + print ".SH \"MAINTAINERS\"" + print pre_text(man_text(eclass_maintainer)) + } + print ".SH \"REPORTING BUGS\"" + print reporting_bugs + print ".SH \"FILES\"" + print ".BR " eclass + print ".SH \"SEE ALSO\"" + print ".BR ebuild (5)" + print pre_text(gensub("@ECLASS@", eclass, 1, vcs_url)) +} + +# +# Init parser +# +BEGIN { + state = "header" + reporting_bugs = "Please report bugs via https://bugs.gentoo.org/" + vcs_url = "https://gitweb.gentoo.org/repo/gentoo.git/log/eclass/@ECLASS@" +} + +# +# Main parsing routine +# +{ + if (state == "header") { + if ($0 ~ /^# @ECLASS:/) { + handle_eclass() + state = "funcvar" + } else if ($0 == "# @DEAD") { + eclass = "dead" + exit(77) + } else if ($0 == "# @eclass-begin") { + # White list old eclasses that haven't been updated so we can block + # new ones from being added to the tree. + if (eclass == "") + xfail("java documentation not supported") + fail("java documentation not supported") + } else if ($0 ~ /^# @/) + warn("Unexpected tag in \"" state "\" state: " $0) + } else if (state == "funcvar") { + if ($0 ~ /^# @FUNCTION:/) + handle_function() + else if ($0 ~ /^# @VARIABLE:/) + handle_variable() + else if ($0 ~ /^# @ECLASS-VARIABLE:/) + handle_eclass_variable() + else if ($0 ~ /^# @/) + warn("Unexpected tag in \"" state "\" state: " $0) + } +} + +# +# Tail end +# +END { + if (eclass == "") + xfail("eclass not documented yet (no @ECLASS found)") + else if (eclass != "dead") + handle_footer() +} diff --git a/app-doc/eclass-manpages/files/eclass-to-manpage.sh b/app-doc/eclass-manpages/files/eclass-to-manpage.sh new file mode 100755 index 000000000000..55d25aaaf4d3 --- /dev/null +++ b/app-doc/eclass-manpages/files/eclass-to-manpage.sh @@ -0,0 +1,44 @@ +#!/bin/bash + +: ${ECLASSDIR:=${0%/*}/../../../eclass} +: ${FILESDIR:=${0%/*}} + +AWK="gawk" +while [[ $# -gt 0 ]] ; do + case $1 in + -e) ECLASSDIR=$2; shift;; + -f) FILESDIR=$2; shift;; + -d) AWK="dgawk";; + *) break;; + esac + shift +done + +if [[ ! -d ${ECLASSDIR} ]] ; then + echo "Usage: ${0##*/} [-e eclassdir] [-f eclass-to-manpage.awk FILESDIR] [eclasses]" 1>&2 + exit 1 +fi + +[[ $# -eq 0 ]] && set -- "${ECLASSDIR}"/*.eclass + +ret=0 +for e in "$@" ; do + set -- \ + ${AWK} \ + -f "${FILESDIR}"/eclass-to-manpage.awk \ + ${e} + if [[ ${AWK} == "gawk" ]] ; then + "$@" > ${e##*/}.5 + tret=$? + if [[ ${tret} -ne 0 ]] ; then + rm -f ${e##*/}.5 + if [[ ${tret} -ne 77 ]] ; then + echo "FAIL: ${e}" + ret=1 + fi + fi + else + "$@" + fi +done +exit ${ret} diff --git a/app-doc/eclass-manpages/metadata.xml b/app-doc/eclass-manpages/metadata.xml new file mode 100644 index 000000000000..adfe3aaf03f3 --- /dev/null +++ b/app-doc/eclass-manpages/metadata.xml @@ -0,0 +1,12 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE pkgmetadata SYSTEM "http://www.gentoo.org/dtd/metadata.dtd"> +<pkgmetadata> + <maintainer type="person"> + <email>mgorny@gentoo.org</email> + <name>Michał Górny</name> + </maintainer> + <maintainer type="project"> + <email>tools-portage@gentoo.org</email> + <name>Gentoo Portage tools team</name> + </maintainer> +</pkgmetadata> diff --git a/app-doc/pms/Manifest b/app-doc/pms/Manifest index 5d535391d680..eb36a07787ce 100644 --- a/app-doc/pms/Manifest +++ b/app-doc/pms/Manifest @@ -6,6 +6,6 @@ DIST pms-7_p20180430-prebuilt.tar.xz 593500 BLAKE2B e59882b215492424b351242f31b9 DIST pms-7_p20180430.tar.xz 60072 BLAKE2B 58afb1759c84ae86a1dd69aa04a6e8b799fd0cc1e1877cf1f6224f5b1bdbdfcdeaadcabbd9c37c263d62cb24b4164056a88d3524031d1704b059c376d5572101 SHA512 9bb64de842e0aa8f1a6488d12fffba76bfd190e53523e9261161467b30f001f20cddf593cd32e75ace4af309476eb7eb6966665d7ae9b54a5915237094110a47 EBUILD pms-5_p20120920.ebuild 1409 BLAKE2B dc81ed4b9dadb4b65b9b0bfc8d1d8b1cdfce7e2ca0b940819eb4d496fb6d7c6bbdf9689d33c4c23236c263738c668006fc2ccddc5b0c76649a75c16d1c4330c5 SHA512 a2c63b7c6569d545c2ff589e16438338bcf4ab59322290c44f987922993c17454ed6cc7d406aa00b18c6f54a7413b37419a9abe1a5948962410a4525ee870ddd EBUILD pms-6_p20170429.ebuild 1540 BLAKE2B 6687bd086717f160fe8d93127077103be65e1a848e7fd41b78c913c14d69a89f13c076e42122997dcb61f4f03d62c5f5a5068744b1dd1ae3a9846b0dc661bfe3 SHA512 eab9166b850ce33b48395537d53831659b3b79b9099e83af3d97475dc5ea0929174d8cc0d28002c3b2f2ff72d6e57dd5e9b7f51a244c59d962fcd656c737d8f1 -EBUILD pms-7_p20180430-r1.ebuild 1665 BLAKE2B 4096ed74bfb79901479736fc55f7649c95628f7692f8b5d825a82a38e816e1c103bd7980b41dd0778a3ed9afc13ddf2368b7e4111ecd1d6638fc32a1bd040c3e SHA512 4ae46097bd19328695eb8b51a923723de0c53767e06ea1f6dd194ef59c2aa3a21b5c0f37b3e529c4db4b7bd5164fd33c7d858d54c5b368b36566801f957de569 -EBUILD pms-9999.ebuild 1234 BLAKE2B 46f77394bb3e6c94600e3c37a45f95838cd7dd088eff9c4ded2918a742338d2f221a073f22142488612b53d6ce64de12b903ff4e39f7d8c340801fd5b4d348b3 SHA512 b832a1f3fbbcea3116fa8670fc5e932033bcfa30c7b2c0f7fd209cfb4d519becc79ee3cbf9ea9c6ea6677c13224a9bcb7d67c225bcc24f8b24311695d2c35e60 +EBUILD pms-7_p20180430-r1.ebuild 1653 BLAKE2B 420a4b807d521a890c29b97b4a24c47163cf022196e22b82f61f6d48b4017f5b58a3cdf4ccaf1b5bfcd3f081be5f140f80ee7c18af8c4a80621fde73d0a19604 SHA512 f237a1f35c162e9d091dcccbc931c684781b1e58143620314a112e08d1a265cdce9df7bad0abcb8e2822a9963a89dff90c0d74bb3a1bd4638ba6187ab8bd5b89 +EBUILD pms-9999.ebuild 1210 BLAKE2B eb7a4a5fc3f2d1b4b4eeec8d280a9b18b6be2a82e078b946fc47666edcc56fb755c50e3d854faa6425e269cd49cf530465a08d72ffca2012f4d6d9765e9fa054 SHA512 4e228ad6cc1c436f5ad702c1def0ecec61ea1e73923fefbe0b62c1148bba7cc91aced065710f838f2f1bdde6164a4c4bfbd4d0c6326b2ce246374cd82ce43a51 MISC metadata.xml 518 BLAKE2B 370ddfa79e44e10c0234d0aafb89624181bf64ae7e90b89b678a8dcb518214f310bc9afc261d5069a8f07299b2194c3a831e1d2a9bcba8d97dd6ef0dc1369346 SHA512 e1079583ec59594d9c89dbbf68199aff7edb35112375e96a2f6ca28627f679ee46570f649a0723c296bd41d003dd91226e6b2805bc780baded00dc1ae72d24a2 diff --git a/app-doc/pms/pms-7_p20180430-r1.ebuild b/app-doc/pms/pms-7_p20180430-r1.ebuild index d2ebe0ed3b19..1765e6fd2273 100644 --- a/app-doc/pms/pms-7_p20180430-r1.ebuild +++ b/app-doc/pms/pms-7_p20180430-r1.ebuild @@ -1,4 +1,4 @@ -# Copyright 1999-2018 Gentoo Foundation +# Copyright 1999-2019 Gentoo Authors # Distributed under the terms of the GNU General Public License v2 EAPI=7 @@ -10,7 +10,7 @@ SRC_URI="!binary? ( https://dev.gentoo.org/~ulm/distfiles/${P}.tar.xz ) LICENSE="CC-BY-SA-3.0" SLOT="0" -KEYWORDS="~alpha ~amd64 ~arm ~hppa ~ia64 ~m68k ~mips ~ppc ~ppc64 ~s390 ~sh ~sparc ~x86 ~ppc-aix ~amd64-fbsd ~x86-fbsd ~amd64-linux ~x86-linux ~ppc-macos ~x64-macos ~x86-macos ~m68k-mint ~sparc-solaris ~sparc64-solaris ~x64-solaris ~x86-solaris ~x86-winnt" +KEYWORDS="alpha amd64 arm hppa ia64 ~m68k ~mips ppc ppc64 ~s390 ~sh sparc x86 ~ppc-aix ~amd64-fbsd ~x86-fbsd ~amd64-linux ~x86-linux ~ppc-macos ~x64-macos ~x86-macos ~m68k-mint ~sparc-solaris ~sparc64-solaris ~x64-solaris ~x86-solaris ~x86-winnt" IUSE="binary html twoside" # texlive-bibtexextra: plainurl.bst diff --git a/app-doc/pms/pms-9999.ebuild b/app-doc/pms/pms-9999.ebuild index c3c195c85e60..4a32970eb17e 100644 --- a/app-doc/pms/pms-9999.ebuild +++ b/app-doc/pms/pms-9999.ebuild @@ -1,4 +1,4 @@ -# Copyright 1999-2018 Gentoo Foundation +# Copyright 1999-2019 Gentoo Authors # Distributed under the terms of the GNU General Public License v2 EAPI=7 @@ -25,10 +25,7 @@ BDEPEND="dev-tex/leaflet dev-texlive/texlive-latexextra dev-texlive/texlive-latexrecommended dev-texlive/texlive-mathscience - html? ( - app-text/recode - >=dev-tex/tex4ht-20090611_p1038-r5 - )" + html? ( >=dev-tex/tex4ht-20090611_p1038-r5 )" src_compile() { # just in case; we shouldn't be generating any fonts |