Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
Bug 563486 - app-emacs/org-mode: add an elog message that lists optional run-time deps
Summary: app-emacs/org-mode: add an elog message that lists optional run-time deps
Status: RESOLVED FIXED
Alias: None
Product: Gentoo Linux
Classification: Unclassified
Component: Current packages (show other bugs)
Hardware: All Linux
: Normal normal (vote)
Assignee: Emacs project
URL: https://github.com/gentoo/gentoo/pull...
Whiteboard:
Keywords: REVIEWED
Depends on:
Blocks:
 
Reported: 2015-10-19 11:47 UTC by Marc Joliet
Modified: 2015-10-25 16:44 UTC (History)
1 user (show)

See Also:
Package list:
Runtime testing required: ---


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Marc Joliet 2015-10-19 11:47:39 UTC
This bug is motivated by the PR I opened at $URL:

    "When installed with USE="contrib", one of the installed contributed packages is ox-bibtex, which, however, requires the bibtex2html command. This is provided by dev-tex/bibtex2html, thus app-emacs/org-mode needs to depend on it when emerged with USE="contrib"."

In the same PR I was told that it probably doesn't make sense to track the run-time contrib dependencies.  I understand, but am not completely sure myself.  I find it hard to weigh between not being surprised of a missing dependency (as a user) and there apparently not being an authoritative list of dependencies for org-mode itself, let alone its contrib packages (I found http://orgmode.org/worg/org-dependencies.html, but it is incomplete and full of TODOs).

The latter would be a problem for both $RDEPENDS and an elog message, that is, it would be difficult to keep either up-to-date.  But again, I certainly didn't like being surprised by the missing bibtex2html dependency ("Oh good, I have to figure out what to install before I can use this.").

Personally, I think at least an elog message would be nice, although it would have to admit incompleteness.  It would also list extra dependencies of org-mode proper (e.g., ob-lilypond requires media-sound/lilypond).  I could do this and update my PR appropriately.

Thoughts?

Reproducible: Always




# emerge --info org-mode
Portage 2.2.20.1 (python 3.4.3-final-0, default/linux/amd64/13.0/desktop/kde/systemd, gcc-4.9.3, glibc-2.20-r2, 4.1.9-gentoo-r1 x86_64)
=================================================================
                         System Settings
=================================================================
System uname: Linux-4.1.9-gentoo-r1-x86_64-AMD_Athlon-tm-_64_X2_Dual_Core_Processor_4200+-with-gentoo-2.2
KiB Mem:     4045488 total,     47148 free
KiB Swap:    4194300 total,   4193832 free
Timestamp of repository gentoo: Sun, 18 Oct 2015 21:00:01 +0000
sh dash 0.5.8.2
ld GNU ld (Gentoo 2.25.1 p1.1) 2.25.1
app-shells/bash:          4.3_p39::gentoo
dev-java/java-config:     2.2.0::gentoo
dev-lang/perl:            5.20.2::gentoo
dev-lang/python:          2.7.10::gentoo, 3.4.3::gentoo
dev-util/cmake:           3.3.1-r1::gentoo
dev-util/pkgconfig:       0.28-r2::gentoo
sys-apps/baselayout:      2.2::gentoo
sys-apps/sandbox:         2.6-r1::gentoo
sys-devel/autoconf:       2.13::gentoo, 2.69::gentoo
sys-devel/automake:       1.11.6-r1::gentoo, 1.13.4::gentoo, 1.14.1::gentoo, 1.15::gentoo
sys-devel/binutils:       2.25.1-r1::gentoo
sys-devel/gcc:            4.9.3::gentoo
sys-devel/gcc-config:     1.7.3::gentoo
sys-devel/libtool:        2.4.6::gentoo
sys-devel/make:           4.1-r1::gentoo
sys-kernel/linux-headers: 3.18::gentoo (virtual/os-headers)
sys-libs/glibc:           2.20-r2::gentoo
Repositories:

gentoo
    location: /usr/portage
    sync-type: rsync
    sync-uri: rsync://rsync.gentoo.org/gentoo-portage
    priority: -1000

digint
    location: /var/lib/layman/digint
    sync-type: git
    sync-uri: git://dev.tty0.ch/portage/digint-overlay.git
    masters: gentoo

mjoliet
    location: /usr/local/portage/marcec
    masters: gentoo proaudio

proaudio
    location: /var/lib/layman/proaudio
    masters: gentoo
    priority: 0

science
    location: /var/lib/layman/science
    masters: gentoo
    priority: 1

sunrise
    location: /var/lib/layman/sunrise
    masters: gentoo
    priority: 2

Installed sets: @audio, @audio-base, @desktop-apps, @desktop-base, @desktop-kde, @desktop-misc, @devel, @devel-audio, @devel-base, @devel-c_cpp, @devel-doc, @devel-python, @games, @latex, @local-marcec, @matlab, @science, @sys-base, @sys-utils, @temp
ACCEPT_KEYWORDS="amd64"
ACCEPT_LICENSE="* -@EULA"
CBUILD="x86_64-pc-linux-gnu"
CFLAGS="-O2 -march=native -pipe"
CHOST="x86_64-pc-linux-gnu"
CONFIG_PROTECT="/etc /usr/lib64/libreoffice/program/sofficerc /usr/share/config /usr/share/gnupg/qualified.txt /usr/share/themes/oxygen-gtk/gtk-2.0 /usr/share/themes/oxygen-gtk/gtk-3.0"
CONFIG_PROTECT_MASK="/etc/ca-certificates.conf /etc/dconf /etc/env.d /etc/fonts/fonts.conf /etc/gconf /etc/gentoo-release /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="-O2 -march=native -pipe"
DISTDIR="/usr/portage/distfiles"
EMERGE_DEFAULT_OPTS="--with-bdeps=y --quiet-build=y --nospinner --keep-going"
FCFLAGS="-O2 -pipe"
FEATURES="assume-digests binpkg-logs buildpkg config-protect-if-modified distlocks 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 xattr"
FFLAGS="-O2 -pipe"
GENTOO_MIRRORS="ftp://de-mirror.org/distro/gentoo/ ftp://ftp-stud.fht-esslingen.de/pub/Mirrors/gentoo/ ftp://mirror.muntinternet.net/pub/gentoo/"
LANG="de_DE.UTF-8"
LDFLAGS="-Wl,-O1 -Wl,--as-needed"
MAKEOPTS="-s -j3"
PKGDIR="/usr/portage/packages"
PORTAGE_COMPRESS=""
PORTAGE_CONFIGROOT="/"
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"
USE="X a52 aac acl acpi alsa amd64 avahi berkdb branding bzip2 cairo caps cdda cdinstall cdr cjk cli cracklib crypt css cups cxx dbus declarative dga djvu dri dssi dts dvd dvdr emboss encode exif fbcon ffmpeg fftw firefox fish-completion flac fortran ftp fuse gdbm gif glamor gmp gnutls iconv idn imlib inotify ipv6 jack jackmidi jpeg jpeg2k kde kipi ladspa lapack lash latex lcms libnotify libsamplerate logrotate lzma mad mmx mmxext mng modplug modules mp3 mp4 mpeg multilib musepack musicbrainz ncurses nls nptl offensive ogg openexr opengl openmp opus osc pam pango pcre pdf phonon plasma plotutils png policykit ppds pulseaudio qt3support qt4 quicktime rar readline rtsp samba sasl seccomp semantic-desktop session sid slang smp sndfile speex spell sse sse2 ssl startup-notification svg systemd taglib tcpd theora threads tiff timidity truetype udev udisks unicode upower usb vaapi vdpau vim-syntax vorbis vpx webkit wma x264 xattr xcb xcomposite xface xml xmp xpm xscreensaver xv xvid zeroconf zlib zsh-completion" ABI_X86="64" ALSA_CARDS="ice1724 hda-intel usb-audio" 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" CPU_FLAGS_X86="mmx mmxext sse sse2 3dnow 3dnowext mmxext sse3" 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" KERNEL="linux" LCD_DEVICES="bayrad cfontz cfontz633 glk hd44780 lb216 lcdm001 mtxorb ncurses text" LIBREOFFICE_EXTENSIONS="presenter-console presenter-minimizer" LINGUAS="en_US en en_GB de" OFFICE_IMPLEMENTATION="libreoffice" PHP_TARGETS="php5-5" PYTHON_SINGLE_TARGET="python2_7" PYTHON_TARGETS="python2_7 python3_4" RUBY_TARGETS="ruby20 ruby21" USERLAND="GNU" VIDEO_CARDS="radeon r600" 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:  CC, CPPFLAGS, CTARGET, CXX, INSTALL_MASK, LC_ALL, PORTAGE_BUNZIP2_COMMAND, PORTAGE_COMPRESS_FLAGS, PORTAGE_RSYNC_EXTRA_OPTS, USE_PYTHON

=================================================================
                        Package Settings
=================================================================

app-emacs/org-mode-8.2.6::gentoo was built with the following:
USE="contrib -doc -odt-schema" ABI_X86="64"
Comment 1 Ulrich Müller gentoo-dev 2015-10-23 16:23:57 UTC
The Emacs team's policy for such runtime dependencies is outlined in bug 72850 comment #1.

Org-mode (like Emacs itself) supports many backends, and it neither makes sense to add things like lilypond as an unconditional dependency, nor to add a USE flag (plus a USE-conditional dependency) for each of them. This argument is even more valid for dependencies that are not needed by the package proper, but only by some file in contrib.

(See also bug 327701 "recommended/suggested dependencies"; however, there is no such type of dependency yet.)


(In reply to Marc Joliet from comment #0)
> Personally, I think at least an elog message would be nice, although it
> would have to admit incompleteness.  It would also list extra dependencies
> of org-mode proper (e.g., ob-lilypond requires media-sound/lilypond).  I
> could do this and update my PR appropriately.

I'd rather use readme.gentoo.eclass than an elog message. We could just mention that certain parts of org-mode require extra dependencies and point users to the list in http://orgmode.org/worg/org-dependencies.html for specifics, even if that list is not entirely accurate. Generally, I believe that tracking the extra dependencies upstream makes much more sense than tracking them in the Gentoo package.
Comment 2 Marc Joliet 2015-10-23 21:09:38 UTC
I agree with everything you said, and I like the idea of using a README.gentoo file for this.  Should I have a go at that?
Comment 3 Ulrich Müller gentoo-dev 2015-10-23 21:37:03 UTC
(In reply to Marc Joliet from comment #2)
> I agree with everything you said, and I like the idea of using a
> README.gentoo file for this.  Should I have a go at that?

Yes, go ahead.
Comment 4 Marc Joliet 2015-10-24 18:22:04 UTC
FYI, I opened https://github.com/gentoo/gentoo/pull/285.
Comment 5 Ulrich Müller gentoo-dev 2015-10-24 19:10:41 UTC
(In reply to Marc Joliet from comment #4)
> FYI, I opened https://github.com/gentoo/gentoo/pull/285.

Thank you.

There are some issues:
1. In DOC_CONTENTS, you may want to put angle brackets <> around the URL,
   to make clear that the full stop doesn't belong to it. Alternatively,
   rearrange the sentence so that the URL isn't at the end.
2. elisp.eclass should be inherited last, because we want elisp_pkg_postinst()
   to take effect (which will call readme.gentoo_pkg_postinst too).
3. For the same reason as in 2., the ebuild shouldn't define pkg_postinst.
Comment 6 Marc Joliet 2015-10-24 19:40:17 UTC
(In reply to Ulrich Müller from comment #5)
[...]
> There are some issues:
> 1. In DOC_CONTENTS, you may want to put angle brackets <> around the URL,
>    to make clear that the full stop doesn't belong to it. Alternatively,
>    rearrange the sentence so that the URL isn't at the end.
> 2. elisp.eclass should be inherited last, because we want
> elisp_pkg_postinst()
>    to take effect (which will call readme.gentoo_pkg_postinst too).
> 3. For the same reason as in 2., the ebuild shouldn't define pkg_postinst.

Thanks for the prompt feedback.  I updated the PR accordingly.
Comment 7 Michał Górny archtester Gentoo Infrastructure gentoo-dev Security 2015-10-25 10:34:41 UTC
Merged now, thanks!