Bug 761208 – sys-apps/miller-5.10.0 bump version and add docs building

• Status: UNCONFIRMED
• Product: Gentoo Linux

[Description mehw 2020-12-22 02:20:45 UTC]

Created attachment 679155 [details]
sys-apps/miller-5.10.0.ebuild (bump version and add docs building)

Hello,

As you can see in the diff below, little is done to bump sys-apps/miller to version 5.10.0:
- Update copyright
- Update EAPI
- Update HOMEPAGE
- Set unstable keywords
- 'doc' use flag requires both dev-lang/ruby and dev-python/sphinx
  + mkman.rb is disabled when building the docs, it will only rebuild an already existing mlr.1 (man pages), replacing only some fields, i.e. Generator and Date
  + add missing docs/data/sort-within-records.json file
  + add creach shell script (blame me if it doesn't work ;) ), a replacement to John Kerl's perl script
  + update installation of HTML_DOCS and man pages



diff miller-5.3.0.ebuild miller-5.10.0.ebuild
1c1
< # Copyright 1999-2019 Gentoo Authors
---
> # Copyright 1999-2020 Gentoo Authors
4c4
< EAPI=6
---
> EAPI=7
9c9
< HOMEPAGE="https://johnkerl.org/miller/doc/index.html"
---
> HOMEPAGE="https://miller.readthedocs.io https://github.com/johnkerl/miller"
14c14
< KEYWORDS="amd64 arm x86"
---
> KEYWORDS="~amd64 ~arm ~x86"
19a20,24
> BDEPEND="doc? (
> 		dev-lang/ruby
> 		dev-python/sphinx
> 	)"
> 
26,27c31,45
< 	# disable docs rebuilding as they're shipped prebuilt
< 	sed -e '/SUBDIRS[^=]*=/ s:doc::g' -i -- Makefile.am || die
---
> 	if use doc; then
> 		# disable rebuilding of man pages
> 		sed -ri '/\s+mkman(\.rb)?\s+/d' docs/Makefile || die \
> 			"Cannot disable rebuilding of man pages"
> 
> 		# missing file in v5.10.0
> 		cp "${FILESDIR}/sort-within-records.json" docs/data/ || die \
> 			"Cannot copy file to docs/data"
> 
> 		# shell script replacement for John Kerl's perl script
> 		cp "${FILESDIR}/creach" docs/ || die \
> 			"Cannot copy creach shell script"
> 		chmod +x docs/creach || die \
> 			"Cannot set creach shell script executable bit"
> 	fi
36a55,62
> src_compile() {
> 	emake
> 
> 	if use doc; then
> 		PATH="${S}/c:${S}/docs:${PATH}" emake -C docs html
> 	fi
> }
> 
43c69
< 	local HTML_DOCS=( $(usev doc) )
---
> 	local HTML_DOCS=( $(usex doc docs/_build/html/.) )
47c73
< 	doman 'doc/mlr.1'
---
> 	doman 'docs/mlr.1'

[Comment 1 mehw 2020-12-22 02:22:34 UTC]

Created attachment 679158 [details]
sys-apps/miller/files/sort-within-records.json (needed file to build docs)

Add needed file to build the docs when the use flag 'doc' is enabled.

[Comment 2 mehw 2020-12-22 02:25:22 UTC]

Created attachment 679161 [details]
sys-apps/miller/files/creach (shell script used to build the docs)

Shell script replacement to John Kerl's creach perl script, so there's no need to depend on dev-lang/perl when building the docs (aka 'doc' flag enabled).

[Comment 3 mehw 2020-12-22 02:27:00 UTC]

Created attachment 679164 [details]
sys-apps/miller/Manifest (for miller-5.10.0.tar.gz)

Manifest file for miller version 5.10.0.

[Comment 4 Sam James 2021-03-22 12:47:15 UTC]

Huh. Not sure how I didn't notice this before.

Could you attach this with output from git format-patch or as a GitHub PR? Please also include the GCO sign off if you agree to the terms (Signed-off-by: Real Name <email>).

[Comment 5 mehw 2021-06-27 11:15:49 UTC]

(In reply to Sam James from comment #4)
> Huh. Not sure how I didn't notice this before.
> 
> Could you attach this with output from git format-patch or as a GitHub PR?
> Please also include the GCO sign off if you agree to the terms
> (Signed-off-by: Real Name <email>).

Hi, I just opened a PR.  You may consider the ebuild a proof of concept to build the html docs (ruby is required).