Skip Menu |

Preferred bug tracker

Please visit the preferred bug tracker to report your issue.

This queue is for tickets about the Text-Markdown CPAN distribution.

Report information
The Basics
Id: 36537
Status: resolved
Priority: 0/
Queue: Text-Markdown

People
Owner: bobtfish [...] bobtfish.net
Requestors: GWOLF [...] cpan.org
Cc:
AdminCc:

Bug Information
Severity: Normal
Broken in: 1.0.19
Fixed in: 1.0.20



Subject: Missing documentation for Markdown.pl, MultiMarkdown.pl
Hi, The scripts you are shipping as part of your distribution do not have any documentation - one of them even had the --help switch, but did nothing ;-) I wrote the manpage for both (actually, the same manpage with minor modifications) to include it in the Debian package. Of course, if you add the manpages to the official release, we all end up winning :) Please note that, in order to comply with Debian's policy, we are renaming the scripts to plainly markdown and multimarkdown - And the documentation I wrote reflects those names. Oh, and as for installing the manpages: As you are using a probably modified Module::Install, I prefered not to mess with your Makefile.PL - I am doing this in my debian/rules (i.e. the makefile for the Debian package building): install -d $(CURDIR)/debian/$(PACKAGE)/usr/share/man/man1/ pod2man $(CURDIR)/debian/$(PACKAGE)/usr/bin/markdown $(CURDIR)/debian/$(PACKAGE)/usr/share/man/man1/markdown.1 pod2man $(CURDIR)/debian/$(PACKAGE)/usr/bin/multimarkdown $(CURDIR)/debian/$(PACKAGE)/usr/share/man/man1/multimarkdown.1 Of course, it would be way cleaner if the POD were also manified/installed together with the rest of the files.
Subject: add_missing_pod
Download add_missing_pod
application/octet-stream 5.9k

Message body not shown because it is not plain text.

Many thanks for writing this :) I'll include the documentation in the official distribution, it was on my todo list somewhere anyway. I'm afraid, however, that I'm going to keep the Markdown.pl / MultiMarkdown.pl names, as they are the same as supplied with 'original' Markdown / MultiMarkdown, and I'm aiming for 100% compatibility.
On Fri Jun 06 13:48:56 2008, BOBTFISH wrote: Show quoted text
> Many thanks for writing this :) > > I'll include the documentation in the official distribution, it was on > my todo list somewhere anyway. > > I'm afraid, however, that I'm going to keep the Markdown.pl / > MultiMarkdown.pl names, as they are the same as supplied with 'original' > Markdown / MultiMarkdown, and I'm aiming for 100% compatibility.
Great - I'll just keep that as small patches ;-)
From: bobtfish [...] bobtfish.net
Applied as SVN revision r482. Will be in 1.0.20 when I next do a point release, and I'll close this bug then.
New release (1.0.20) is now available, including this documentation. Many thanks!