develooper Front page | perl.perl5.porters | Postings from August 2017

Re: perldoc rewrite

Thread Previous
herbert breunung
August 14, 2017 09:38
Re: perldoc rewrite
Message ID:
Yes It will break a little, but only cases, where user added params
that cant be evaluated anyway and this behaviour is also different,
depending what param was in front.

My goal is to make prameter parsing regular (order should not matter).

An simple example that would break would be eg

perldoc reftut -h

becasue you cant really display help and retut at same time.
you have to say

perldoc -h
perldoc reftut

Hope that helps

> On 08/11/2017 11:49 AM, herbert breunung wrote:
>> Dear Porters
>> I posted here some weeks ago  my wish for function and var index page but the
>> issue behind it turned out to be much bigger.
>> Thats why I currently plan a rewrite of perldoc tool. mark and brian are on
>> board and i just had fruitful discussions and input on and off YAPC  including
>> damian and sawyer.
>> Even it will take some time to get even a  functionaly equivalent replacement
>> (first before I can add features),
>> I already want to discuss with you some changes that will be needed.
>> An detailed featurelsit will be posted later on blogs.perl but for now i
>> want to
>> announce the stuff that might be most disturbing from your point.
>> 1. I want make parameter parsing of perldoc stricter, so only input that
>> completely makes sense will be run.
> This suggests the potential for extensive breakage.  Can you provide examples
> of input that currently runs but in the future may not?
>> 2. at some point searchable keywords have to be included in the pod via X<>
>> tags
>> and in the main perl.POD the references to oterh pages has to be converted to
>> L<...> so i can categorize them by the X<in front> to get sensible search
>> categories without guessing too much,
>> plus it would make it more similar what shows.
>> 3. I need the -M key (CLI option) for module related stuff. Since sawyer
>> already
>> told me I can't have the -m
>>     the -M sems a good candidate since its very rarely used (alt formatter
>> Module) and the we have good precedent of changing one very seldom used flag of
>> perldoc by mark in past.(sorry but details to that are at home at my main
>> machine).
>> Thanks
>> Herbert

Thread Previous Perl Programming lists via nntp and http.
Comments to Ask Bjørn Hansen at | Group listing | About