Bug 497992 – app-officeext/ooofbtools-2.25 fails to install DOCS=( ChangeLog* )

• Status: RESOLVED FIXED
• Product: Gentoo Linux

[Description Sergey S. Starikoff 2014-01-13 12:10:08 UTC]

$ grep DOC /usr/portage/gentoo/app-officeext/ooofbtools/ooofbtools-2.25.ebuild 
DOCS=( ChangeLog* )

# ebuild /usr/portage/gentoo/app-officeext/ooofbtools/ooofbtools-2.25.ebuild unpack
 * OOoFBTools-2.25.7z SHA256 SHA512 WHIRLPOOL size ;-) ...                                                                      [ ok ]
 * checking ebuild checksums ;-) ...                                                                                            [ ok ]
 * checking miscfile checksums ;-) ...                                                                                          [ ok ]
>>> Unpacking source...
>>> Unpacking OOoFBTools-2.25.7z to /var/tmp/portage/app-officeext/ooofbtools-2.25/work
>>> Unpacking /var/tmp/portage/app-officeext/ooofbtools-2.25/work/OOoFBTools-2.25/OOoFBTools.oxt to /var/tmp/portage/app-officeext/ooofbtools-2.25/work/OOoFBTools.oxt
>>> Source unpacked in /var/tmp/portage/app-officeext/ooofbtools-2.25/work
# find /var/tmp/portage/app-officeext/ooofbtools-2.25/work -type f | grep -i change
/var/tmp/portage/app-officeext/ooofbtools-2.25/work/OOoFBTools-2.25/ChangeLog_Eng.txt
/var/tmp/portage/app-officeext/ooofbtools-2.25/work/OOoFBTools-2.25/ChangeLog_Rus.txt
/var/tmp/portage/app-officeext/ooofbtools-2.25/work/OOoFBTools.oxt/OOoFBTools/Local_ChangeLang.xba
/var/tmp/portage/app-officeext/ooofbtools-2.25/work/OOoFBTools.oxt/OOoFBTools/ChangeLang.xba
/var/tmp/portage/app-officeext/ooofbtools-2.25/work/OOoFBTools.oxt/images/change_lang.png

But in files of installed package I see no listed DOCS (neither ChangeLog_Eng.txt nor ChangeLog_Rus.txt):
 # qlist app-officeext/ooofbtools | grep -i change
/usr/lib64/libreoffice/share/extensions/OOoFBTools/images/change_lang.png
/usr/lib64/libreoffice/share/extensions/OOoFBTools/OOoFBTools/ChangeLang.xba
/usr/lib64/libreoffice/share/extensions/OOoFBTools/OOoFBTools/Local_ChangeLang.xba

My system:
$ einfo 
Portage 2.2.7 (default/linux/amd64/13.0, gcc-4.7.3, glibc-2.17, 3.10.17-aufs x86_64)
=================================================================
System uname: Linux-3.10.17-aufs-x86_64-AMD_Athlon-tm-_II_X2_250_Processor-with-gentoo-2.2
KiB Mem:     1794796 total,     88016 free
KiB Swap:    8000364 total,   7496500 free
Timestamp of tree: Mon, 13 Jan 2014 04:15:01 +0000
ld GNU ld (GNU Binutils) 2.23.2
app-shells/bash:          4.2_p45
dev-java/java-config:     2.1.12-r1
dev-lang/python:          2.7.5-r3, 3.3.2-r2
dev-util/cmake:           2.8.11.2
dev-util/pkgconfig:       0.28
sys-apps/baselayout:      2.2
sys-apps/openrc:          0.12.4
sys-apps/sandbox:         2.6-r1
sys-devel/autoconf:       2.13, 2.69
sys-devel/automake:       1.9.6-r3, 1.11.6, 1.13.4
sys-devel/binutils:       2.23.2
sys-devel/gcc:            4.7.3-r1
sys-devel/gcc-config:     1.7.3
sys-devel/libtool:        2.4.2
sys-devel/make:           3.82-r4
sys-kernel/linux-headers: 3.9 (virtual/os-headers)
sys-libs/glibc:           2.17
Repositories: gentoo local_hdd
ACCEPT_KEYWORDS="amd64"
ACCEPT_LICENSE="* -@EULA"
CBUILD="x86_64-pc-linux-gnu"
CFLAGS="-march=native -O2 -pipe"
CHOST="x86_64-pc-linux-gnu"
CONFIG_PROTECT="/etc /etc/env.d /usr/share/gnupg/qualified.txt /var/bind"
CONFIG_PROTECT_MASK="/etc/ca-certificates.conf /etc/env.d /etc/fonts/fonts.conf /etc/gconf /etc/gentoo-release /etc/php/apache2-php5.4/ext-active/ /etc/php/apache2-php5.5/ext-active/ /etc/php/cgi-php5.4/ext-active/ /etc/php/cgi-php5.5/ext-active/ /etc/php/cli-php5.4/ext-active/ /etc/php/cli-php5.5/ext-active/ /etc/revdep-rebuild /etc/sandbox.d /etc/terminfo /etc/texmf/language.dat.d /etc/texmf/language.def.d /etc/texmf/updmap.d /etc/texmf/web2c"
CXXFLAGS="-march=native -O2 -pipe"
DISTDIR="/usr/portage/distfiles"
EMERGE_DEFAULT_OPTS="--ask --verbose --autounmask=n"
FCFLAGS="-O2 -pipe"
FEATURES="assume-digests binpkg-logs buildsyspkg config-protect-if-modified distlocks downgrade-backup ebuild-locks fixlafiles merge-sync news parallel-fetch preserve-libs protect-owned sandbox sfperms strict unknown-features-warn unmerge-logs unmerge-orphans userfetch userpriv usersandbox usersync"
FFLAGS="-O2 -pipe"
GENTOO_MIRRORS="http://mirror.yandex.ru/gentoo-distfiles/                 ftp://mirror.yandex.ru/gentoo-distfiles/                 http://ftp.corbina.net/pub/Linux/gentoo/                 ftp://ftp.corbina.net/pub/Linux/gentoo/"
LANG="ru_RU.utf8"
LC_ALL=""
LDFLAGS="-Wl,-O1 -Wl,--as-needed"
MAKEOPTS="-j2"
PKGDIR="/usr/portage/packages"
PORTAGE_CONFIGROOT="/"
PORTAGE_RSYNC_EXTRA_OPTS="--exclude-from=/etc/portage/rsync_excludes"
PORTAGE_RSYNC_OPTS="--recursive --links --safe-links --perms --times --omit-dir-times --compress --force --whole-file --delete --stats --human-readable --timeout=180 --exclude=/distfiles --exclude=/local --exclude=/packages"
PORTAGE_TMPDIR="/var/tmp"
PORTDIR="/usr/portage/gentoo"
PORTDIR_OVERLAY="/usr/portage/local"
USE="X a52 ac3 acl alsa amd64 avi berkdb bold bzip2 cdr cli consolekit cracklib crypt cups cxx dbus djvu dri dvd flac fortran gdbm gif gtk iconv inotify jpeg jpeg2k lock mmx modules mp3 mudflap multilib ncurses nls nptl ogg openmp pam pcre pdf png policykit qt3support readline session sse sse2 ssl tcpd thunar tiff udev udisks unicode utf8 vorbis xcb xulrunner zlib" ABI_X86="64" ALSA_CARDS="ali5451 als4000 atiixp atiixp-modem bt87x ca0106 cmipci emu10k1x ens1370 ens1371 es1938 es1968 fm801 hda-intel intel8x0 intel8x0m maestro3 trident usb-audio via82xx via82xx-modem ymfpci" APACHE2_MODULES="authn_core authz_core socache_shmcb unixd actions alias auth_basic authn_alias authn_anon authn_dbm authn_default authn_file authz_dbm authz_default authz_groupfile authz_host authz_owner authz_user autoindex cache cgi cgid dav dav_fs dav_lock deflate dir disk_cache env expires ext_filter file_cache filter headers include info log_config logio mem_cache mime mime_magic negotiation rewrite setenvif speling status unique_id userdir usertrack vhost_alias" CALLIGRA_FEATURES="kexi words flow plan sheets stage tables krita karbon braindump author" CAMERAS="ptp2" COLLECTD_PLUGINS="df interface irq load memory rrdtool swap syslog" ELIBC="glibc" GPSD_PROTOCOLS="ashtech aivdm earthmate evermore fv18 garmin garmintxt gpsclock itrax mtk3301 nmea ntrip navcom oceanserver oldstyle oncore rtcm104v2 rtcm104v3 sirf superstar2 timing tsip tripmate tnt ublox ubx" INPUT_DEVICES="evdev" KERNEL="linux" LCD_DEVICES="bayrad cfontz cfontz633 glk hd44780 lb216 lcdm001 mtxorb ncurses text" LIBREOFFICE_EXTENSIONS="presenter-console presenter-minimizer" LINGUAS="ru ru_RU" OFFICE_IMPLEMENTATION="libreoffice" PHP_TARGETS="php5-4" PYTHON_SINGLE_TARGET="python2_7" PYTHON_TARGETS="python2_7 python3_3" RUBY_TARGETS="ruby19 ruby18" USERLAND="GNU" VIDEO_CARDS="radeon" XTABLES_ADDONS="quota2 psd pknock lscan length2 ipv4options ipset ipp2p iface geoip fuzzy condition tee tarpit sysrq steal rawnat logmark ipmark dhcpmac delude chaos account"
Unset:  CPPFLAGS, CTARGET, INSTALL_MASK, PORTAGE_BUNZIP2_COMMAND, PORTAGE_COMPRESS, PORTAGE_COMPRESS_FLAGS, USE_PYTHON

[Comment 1 Jeroen Roovers (RETIRED) 2014-01-14 13:41:23 UTC]

The ebuild inherits office-ext-r1.eclass but that eclass inherits only eutils and multilib. eutils.eclass only handles DOCS=() if you additionally call einstalldocs, and multilib.eclass doesn't handle DOCS at all.

[Comment 2 Tomáš Chvátal (RETIRED) 2014-02-25 21:05:02 UTC]

Thanks a lot for the report. Fixed in the cvs hopefully.

[Comment 3 Sergey S. Starikoff 2014-03-19 12:50:50 UTC]

(In reply to Tomáš Chvátal from comment #2)
> Fixed in the cvs hopefully.

Not fixed.

It seems to be src_unpack issue (ChangeLog* files are packed into 7z archive, not in .oxt and skipped, src_unpack process only .oxt):

>>> Install ooofbtools-2.26 into /var/tmp/portage/app-officeext/ooofbtools-2.26/image/ category app-officeext
install: cannot stat ‘ChangeLog*’: No such file or directory
!!! dodoc: ChangeLog* does not exist
 * ERROR: app-officeext/ooofbtools-2.26::local_hdd failed (install phase):
 *   dodoc failed
 * 
 * If you need support, post the output of `emerge --info '=app-officeext/ooofbtools-2.26::local_hdd'`,
 * the complete build log and the output of `emerge -pqv '=app-officeext/ooofbtools-2.26::local_hdd'`.
 * The complete build log is located at '/var/tmp/portage/app-officeext/ooofbtools-2.26/temp/build.log'.
 * The ebuild environment file is located at '/var/tmp/portage/app-officeext/ooofbtools-2.26/temp/environment'.
 * Working directory: '/var/tmp/portage/app-officeext/ooofbtools-2.26/work/OOoFBTools-2.26'
 * S: '/var/tmp/portage/app-officeext/ooofbtools-2.26/work/OOoFBTools-2.26'
 * QA Notice: file does not exist:
 * 
 * 	dodoc: ChangeLog* does not exist

So, current version from tree (=app-officeext/ooofbtools-2.25) also is broken.

$ 7z x OOoFBTools-2.26.7z 

7-Zip [64] 9.20  Copyright (c) 1999-2010 Igor Pavlov  2010-11-18
p7zip Version 9.20 (locale=ru_RU.utf8,Utf16=on,HugeFiles=on,2 CPUs)

Processing archive: OOoFBTools-2.26.7z

Extracting  OOoFBTools-2.26/ChangeLog_Eng.txt
Extracting  OOoFBTools-2.26/ChangeLog_Rus.txt
Extracting  OOoFBTools-2.26/OOoFBTools_Help.pdf
Extracting  OOoFBTools-2.26/ExportToFB21_example-1.odt
Extracting  OOoFBTools-2.26/ExportToFB21_example-2.odt
Extracting  OOoFBTools-2.26/OOoFBTools.oxt
Extracting  OOoFBTools-2.26

Everything is Ok

Folders: 1
Files: 6
Size:       5498458
Compressed: 4545655


But:
# ebuild ooofbtools-2.26.ebuild unpack
 * OOoFBTools-2.26.7z SHA256 SHA512 WHIRLPOOL size ;-) ...                                                                      [ ok ]
 * checking ebuild checksums ;-) ...                                                                                            [ ok ]
 * checking miscfile checksums ;-) ...                                                                                          [ ok ]
>>> Unpacking source...
>>> Unpacking OOoFBTools-2.26.7z to /var/tmp/portage/app-officeext/ooofbtools-2.26/work
>>> Unpacking /var/tmp/portage/app-officeext/ooofbtools-2.26/work/OOoFBTools-2.26/OOoFBTools.oxt to /var/tmp/portage/app-officeext/ooofbtools-2.26/work/OOoFBTools.oxt
>>> Source unpacked in /var/tmp/portage/app-officeext/ooofbtools-2.26/work
# find /var/tmp/portage/app-officeext/ooofbtools-2.26 -type f -name ChangeLog*
(finds nothing)

[Comment 4 Sergey S. Starikoff 2014-03-27 11:49:10 UTC]

Created attachment 373632 [details]
ooofbtools-2.26-r1.ebuild  (installing DOCS)

Attach intermediate ebuild version (installing docs together with extension itself).

By default einstalldocs() function search docs file not into ${S} but into "${WORKDIR}/${${MY_PN}.oxt}" (OFFICE_EXTENSIONS?) directory.

Also, by default it installs docs not into standard doc dir (expecting something like (/usr/share/doc/${P}), but into extension directory /usr/lib64/libreoffice/share/extensions/OOoFBTools/ (for example /usr/lib64/libreoffice/share/extensions/OOoFBTools/OOoFBTools_Help.pdf).

One more improvement needed: Russian ChangeLog should be installed depending in LINGUAS="ru" only, I'm not enough familiar with USE_EXPAND handling yet.

[Comment 5 Sergey Popov 2014-04-04 07:34:38 UTC]

+*ooofbtools-2.26-r1 (04 Apr 2014)
+
+  04 Apr 2014; Sergey Popov <[e-mail]> -ooofbtools-2.26.ebuild,
+  +ooofbtools-2.26-r1.ebuild:
+  Revision bump: install documentation properly, wrt bug #497992. Thanks to
+  Sergey Starikoff <Ikonta AT yandex.ru>, who discovered this issue. Drop old
+  revision