Dancer2 pod hidden by dancer2 on case-insensitive filesystems (eg. OS X)

[y]

On case-insensitive filesystems, like OS X's default- HFS+, perldoc Dancer2 results in the pod for dancer2 being displayed. Using Test::Portability::Files would help find other occurrences.

[xsawyerx]

I'm not sure how to fix it. The problem is that these two exist, no matter what.

There is the command line application and the top class name.

[hvoers]

Can you rename dancer2 to e.g. dancemaster, dancertwo, dancerctl, ...?

[xsawyerx]

Maybe dancer2ctl. I would prefer to get more input before doing this. Also, Dancer2 is just a conduit to the rest of the documentation and we can put that documentation in dancer2 as well.

[ambs]

Solving this to Dancer2 doesn't solve it for a lot of other tools that might have the same problem. Shouldn't perldoc be patched in a way to include some -a option, like the unix man page?

Also, perldoc might be intelligent to find first modules if the name starts with uppercase.

I know, we do not control perldoc, but I think it is more important to try to "solve" or "diminish" the problem in a global way than to run from the problem.

This said, nothing against changing the command line tool name.

[y]

@ambs is right that renaming is probably not enough, since that will work only for people that first manually uninstall the old version then install the new version. cpanm does not delete cruft from older versions of a distribution when they are updated, though it does have an option to uninstall a distribution.

Reference: https://github.com/miyagawa/cpanminus/issues/344

[bigpresh]

As I see it, renaming the dancer2 script isn't a fix, it's a bodgy workaround for a broken system. Fixing the broken system would be far better, or if a workaround for such a broken system is required, it should be in perldoc so it'd work for everyone, not in Dancer2.

[xsawyerx]

Maybe for now, until this is fixed in a global level, we could provide add the links from Dancer2.pm to dancer2.pm. That's all Dancer2.pm really has that's interesting.

We could alternatively move everything into Dancer2::Manual and link both simply there.

[xsawyerx]

It's funny we didn't get such a ticket opened on Dancer 1 or even in Carton.

If no one suggests anything, I will simply make sure that dancer2 has explanation at the top giving the details that Dancer2 has pointing to Dancer2::Manual.

Dancer2.pm really does not have anything interesting or important. It currently only lists the import and one single short example. That can and should be removed.