Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
Bug 584486 - games-fps/freedoom: post-install instructions are incorrect
Summary: games-fps/freedoom: post-install instructions are incorrect
Status: RESOLVED FIXED
Alias: None
Product: Gentoo Linux
Classification: Unclassified
Component: [OLD] Games (show other bugs)
Hardware: All Linux
: Normal normal (vote)
Assignee: Gentoo Games
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2016-05-29 21:30 UTC by Dave Kennedy
Modified: 2019-05-28 14:34 UTC (History)
0 users

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 Dave Kennedy 2016-05-29 21:30:45 UTC
Instead of:

pkg_postinst() {
	games_pkg_postinst
	elog "A Doom engine is required to play the wad"
	elog "but games-fps/doomsday doesn't count since it doesn't"
	elog "have the necessary features."
	echo
	ewarn "To play freedoom with Doom engines which do not support"
	ewarn "subdirectories, create symlinks by running the following:"
	ewarn "(Be careful of overwriting existing wads.)"
	ewarn
	ewarn "   cd ${GAMES_DATADIR}/doom-data"
	ewarn "   ln -sn freedoom/*.wad ."
	ewarn
}

Should be:

pkg_postinst() {
	games_pkg_postinst
	elog "A Doom engine is required to play the wad"
	elog "but games-fps/doomsday doesn't count since it doesn't"
	elog "have the necessary features."
	echo
	ewarn "To play freedoom with Doom engines which do not support"
	ewarn "subdirectories, create symlinks by running the following:"
	ewarn "(Be careful of overwriting existing wads.)"
	ewarn
	ewarn "   cd ${GAMES_DATADIR}/doom"
	ewarn "   ln -sn ../doom-data/freedoom/*.wad ."
	ewarn
}

According to the documentation this is where most Doom engines look for the wads:

   On Windows, you should place Freedoom's data files (those ending with
   .wad) alongside the engine (eg, odamex.exe). On Unix-like systems, these
   data files should go in either /usr/share/games/doom or your home
   directory. If Freedoom comes packaged as part of your operating system
   distribution, it should already be installed into the proper location.
Comment 1 Stefan Strogin gentoo-dev 2019-05-23 04:30:15 UTC
I don't get it. Tried to play Doomsday/freedoom. It works well. Just need to select the directory with *.wads at first start (/usr/share/doom-data, doomsday includes subdirectories).

What are these symlinks for?

The post-install instructions look incorrect indeed, but the proposed correction does not look correct either.
Comment 2 William Breathitt Gray 2019-05-28 08:57:15 UTC
The documentation has the following instructions:

   On Windows, you should place Freedoom's data files (those ending with
   .wad) alongside the engine (eg, odamex.exe). On Unix-like systems, these
   data files should go in either /usr/share/games/doom or your home
   directory. If Freedoom comes packaged as part of your operating system
   distribution, it should already be installed into the proper location.

The purpose of this is to guarantee that the WAD files are in a directory readable by the user -- it's easier to tell a non-tech user "place files here" rather than explain the nature of computer security permissions.

The ebuild currently installs the WAD files into a place readable by the user, so this pkg_postinst message can be removed -- there's not need to instruct the user to create symlinks and specific game directories.

The only thing that would be useful is to notify the user where the WAD files have been placed by the ebuild, and to tell them to point their engine there.
Comment 3 Larry the Git Cow gentoo-dev 2019-05-28 14:34:11 UTC
The bug has been closed via the following commit(s):

https://gitweb.gentoo.org/repo/gentoo.git/commit/?id=74a1cdbf0fef8611cf0128ec66b2abc272c31247

commit 74a1cdbf0fef8611cf0128ec66b2abc272c31247
Author:     Stefan Strogin <steils@gentoo.org>
AuthorDate: 2019-05-28 14:31:41 +0000
Commit:     Stefan Strogin <steils@gentoo.org>
CommitDate: 2019-05-28 14:32:48 +0000

    games-fps/freedoom: bump version to 0.11.3
    
    Closes: https://bugs.gentoo.org/584486
    Package-Manager: Portage-2.3.67, Repoman-2.3.13
    Signed-off-by: Stefan Strogin <steils@gentoo.org>

 games-fps/freedoom/Manifest               |  2 ++
 games-fps/freedoom/freedoom-0.11.3.ebuild | 30 ++++++++++++++++++++++++++++++
 2 files changed, 32 insertions(+)