Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
Bug 99371 - app-editors/vim-core - stale doc symlinks, pkg_postrm() needed
Summary: app-editors/vim-core - stale doc symlinks, pkg_postrm() needed
Status: RESOLVED WONTFIX
Alias: None
Product: Gentoo Linux
Classification: Unclassified
Component: New packages (show other bugs)
Hardware: All Linux
: High minor
Assignee: Vim Maintainers
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2005-07-17 16:24 UTC by Carsten Lohrke (RETIRED)
Modified: 2005-07-22 13:02 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 Carsten Lohrke (RETIRED) gentoo-dev 2005-07-17 16:24:12 UTC
$ tree /usr/share/doc/vim-core*
/usr/share/doc/vim-core-6.1-r2
`-- vim-core-6.1 -> ../../vim/vim61/doc
/usr/share/doc/vim-core-6.1-r4
`-- vim-core-6.1 -> ../../vim/vim61/doc
/usr/share/doc/vim-core-6.2
`-- vim-core-6.2 -> ../../vim/vim62/doc
/usr/share/doc/vim-core-6.2-r1
`-- vim-core-6.2 -> ../../vim/vim62/doc
/usr/share/doc/vim-core-6.2-r3
`-- vim-core-6.2 -> ../../vim/vim62/doc
/usr/share/doc/vim-core-6.2-r4
`-- vim-core-6.2 -> ../../vim/vim62/doc

0 directories, 6 files
Comment 1 Carsten Lohrke (RETIRED) gentoo-dev 2005-07-20 05:22:05 UTC
proposed fix:

pkg_postrm(){
    [ -n "${PF}" ] && rm -rf /usr/share/doc/${PF}
}

This doesn't clean up stale directories of previous versions, but is as safe as
possible, imho.
Comment 2 Ryan Phillips (RETIRED) gentoo-dev 2005-07-21 10:42:48 UTC
This is only a problem with pre 6.3 ebuilds.  6.3+ ebuilds use vim-core to
remove /usr/share/vim/* directories and installing into /usr/share/doc/ does not
happen anymore.
Comment 3 Carsten Lohrke (RETIRED) gentoo-dev 2005-07-21 12:43:03 UTC
Sorry, wouldn't have reported, if I'd have seen that it is a known issue. I have
6.3.075 installed and the cruft has not been cleaned, though. Never mind. :)


btw. vim-6.3.084-patches.tar.bz2 can not be found on the mirrors, maybe
temporary, just in case...

Comment 4 Carsten Lohrke (RETIRED) gentoo-dev 2005-07-21 13:47:36 UTC
> and installing into /usr/share/doc/ does not happen anymore.

On a second thought: That's not o.k. According to the FHS docs have to be
installed or symlinked to /usr/share/doc/$appdir which is in our case
/usr/share/doc/$PF
Comment 5 Ryan Phillips (RETIRED) gentoo-dev 2005-07-21 16:00:57 UTC
It isn't FHS compliant, but is better for Gentoo in the long run.
Comment 6 Carsten Lohrke (RETIRED) gentoo-dev 2005-07-21 16:26:47 UTC
> It isn't FHS compliant, but is better for Gentoo in the long run.

Compliance is important and better in the long run. If you start to dismiss it,
everyone goes wild at some point. Think e.g. about writing an application, that
gathers all html documentation, relying on the $PF/html paths for performance
reasons. Feel with users, who don't have to search, because it's always at the
expected place for all installed apps.

Also it's simple to deal with it: Create the symlink and remove it via 

[ -n "${PF}" ] && rm -rf ${ROOT}/usr/share/doc/${PF}

Dead simple.
Comment 7 Ryan Phillips (RETIRED) gentoo-dev 2005-07-21 17:10:58 UTC
Carsten, I agree with you that documentation in one place is important and
should be stored in /usr/share/doc, but vim - unlike many other applications -
has it's own integrated help.  Vim expects the runtime directory in a certain
place and certainly doesn't belong in /usr/share/doc.  If this were like any
other package that didn't have a real :help then I would agree with your argument.

Symlinking the vim-xx/doc directory to /usr/share/doc/ is somewhat silly since
vim integrates a help search feature (would anyone actually just read the vim
markup .txt files???).  Typically README's, CHANGELOGs, etc go into
/usr/share/doc; vim includes these largely within the help system.

Unfortunetly the pre 6.3 ebuilds didn't clean up well, but that is a simple
matter of rm -rf once.

That is my opinion on the matter.  If you would like to discuss it more, lets
have a discussion on the -dev mailing list.
Comment 8 Carsten Lohrke (RETIRED) gentoo-dev 2005-07-22 13:02:41 UTC
Guess it became clear, that I'm not in the vi camp. ;)

> would anyone actually just read the vim markup .txt files?

Well, it's more or less plain text and I for one can't stand the vim
help/command system and rather would grep the files. But since /me doesn't
count, it's time to stop stepping on your toes.