RFR: JDK-8178109: More useful documentation on /help

Robert Field robert.field at oracle.com
Fri Nov 17 22:23:09 UTC 2017


Looks good.

-Robert


Sent from my iPad

> On Nov 17, 2017, at 12:17 PM, Jan Lahoda <jan.lahoda at oracle.com> wrote:
> 
> Updated webrev:
> http://cr.openjdk.java.net/~jlahoda/8178109/webrev.02/
> 
>> On 16.11.2017 20:42, Robert Field wrote:
>> Jan,
>> 
>> Glad you are fixing this bug, it has annoyed me!
>> 
>> /help, after user requests, accepts command names with or without the
>> slash - /
>> So, the patterns need to handle "/help set ..."
> 
> Fixed.
> 
>> 
>> Nit: you allow space or tab in the pattern but only space in the
>> indexOf().  Were we covering all the bases we would use "\h" accepting
>> any horizontal space (not sure of the importance of this for
>> internationalization). But then indexOf() would still be an issue, Maybe
>> the cleanest thing to do would be to do a replaceAll("\\h+", " ") on all
>> of code, first thing; then all of patterns would be much simpler. BTW:
> 
> Done. (I was afraid there could be a problem with changing the offsets/positions inside the code, but after checking, that shouldn't be a problem.)
> 
>> "...[^ \t]..." has the "^" in the wrong place -- but that goes away with
>> the replaceAll.
>> 
>> Can you merge with the latest repo, the changeset doesn't apply -- so, I
>> can't test.
> 
> Done.
> 
> Jan
> 
>> 
>> Thanks,
>> Robert
>> 
>>> On 11/16/17 10:33, Jan Lahoda wrote:
>>> Oops, I missed that, sorry. Updated webrev:
>>> http://cr.openjdk.java.net/~jlahoda/8178109/webrev.01/
>>> 
>>> (I tried to delegate to the command completion, but it turned out
>>> there are small but significant differences in how command completion
>>> and documentation needs to work, so only adding a support for /help
>>> /set <keys>.)
>>> 
>>> Jan
>>> 
>>>> On 16.11.2017 05:59, Robert Field wrote:
>>>> It looks like this code addresses the
>>>> 
>>>>      /help intro <tab>
>>>> 
>>>> case.
>>>> 
>>>> But there is a second case in the bug report of help on subcommands
>>>> 
>>>>       /help /set truncation<Tab>
>>>> 
>>>> For which I don't see code or tests,
>>>> 
>>>> -Robert
>>>> 
>>>> 
>>>>> On 11/15/17 06:52, Jan Lahoda wrote:
>>>>> The proposal here is to change the synopsis/documentation for:
>>>>> /help <anything>
>>>>> 
>>>>> to show the synopsis/documentation for <anything> rather than for
>>>>> /help.
>>>>> 
>>>>> Bug: https://bugs.openjdk.java.net/browse/JDK-8178109
>>>>> Webrev: http://cr.openjdk.java.net/~jlahoda/8178109/webrev.00/
>>>>> 
>>>>> How does it look?
>>>>> 
>>>>> Thanks,
>>>>>    Jan
>>>> 
>> 



More information about the kulla-dev mailing list