[jira] [Commented] (HBASE-24921) Add help output for shell "magic" commands
[
https://issues.apache.org/jira/browse/HBASE-24921?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=17190840#comment-17190840
]
Nick Dimiduk commented on HBASE-24921:
--
I don't have an answer for you, [~UselessCoder]. I think it'll depend on how
the magic command is implemented. My guess is adding the documentation (new
help section and help docs per command) will be easiest if they're structured
like the other commands. However, I don't know if some of them are implemented
such that they don't work as a
[command|https://github.com/apache/hbase/blob/master/hbase-shell/src/main/ruby/shell/commands.rb#L25].
I think it would be better if they could be converted to implementations of
the {{command}} class, but that might not be possible in all cases. You'll need
to dig in and let us know :)
> Add help output for shell "magic" commands
> --
>
> Key: HBASE-24921
> URL: https://issues.apache.org/jira/browse/HBASE-24921
> Project: HBase
> Issue Type: Improvement
> Components: shell
>Reporter: Nick Dimiduk
>Assignee: Abhey Rana
>Priority: Major
>
> The shell has a handful of "magic" commands, things like {{help}} and
> {{debug}}, that exist as commands in the shell, but are not implementations
> of the command class and have no help documentation of their own.
> Let's promote them to proper commands, add a new command group, call it
> "shell command group", for example. This makes them discoverable. Give each
> of them a help documentation string with examples, as we have for the others,
> i.e., {{help 'help'}}.
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
[jira] [Commented] (HBASE-24921) Add help output for shell "magic" commands
[
https://issues.apache.org/jira/browse/HBASE-24921?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=17190660#comment-17190660
]
Abhey Rana commented on HBASE-24921:
[~ndimiduk] I was exploring the code-base for the making required changes, And
I have a question related to the overall scope of this JIRA.
As part of this JIRA, Do I just need to add help for the _magic commands_, Or I
need to also move the actual implementation of these _magic commands_ to the
newly created classes?
Like _debug_ is a flag currently defined in
[hirb.rb|https://github.com/apache/hbase/blob/master/bin/hirb.rb#L172], So do I
also need to refactor the implementation, So as to define similar behaviour in
the new _debug.rb_ that I will create as part of this work?
Please do not mind, If this is a novice question. I am just starting my journey
of HBase project contribution :)
> Add help output for shell "magic" commands
> --
>
> Key: HBASE-24921
> URL: https://issues.apache.org/jira/browse/HBASE-24921
> Project: HBase
> Issue Type: Improvement
> Components: shell
>Reporter: Nick Dimiduk
>Assignee: Abhey Rana
>Priority: Major
>
> The shell has a handful of "magic" commands, things like {{help}} and
> {{debug}}, that exist as commands in the shell, but are not implementations
> of the command class and have no help documentation of their own.
> Let's promote them to proper commands, add a new command group, call it
> "shell command group", for example. This makes them discoverable. Give each
> of them a help documentation string with examples, as we have for the others,
> i.e., {{help 'help'}}.
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
[jira] [Commented] (HBASE-24921) Add help output for shell "magic" commands
[
https://issues.apache.org/jira/browse/HBASE-24921?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=17190426#comment-17190426
]
Nick Dimiduk commented on HBASE-24921:
--
[~UselessCoder] of course, please help yourself!
> Add help output for shell "magic" commands
> --
>
> Key: HBASE-24921
> URL: https://issues.apache.org/jira/browse/HBASE-24921
> Project: HBase
> Issue Type: Improvement
> Components: shell
>Reporter: Nick Dimiduk
>Priority: Major
>
> The shell has a handful of "magic" commands, things like {{help}} and
> {{debug}}, that exist as commands in the shell, but are not implementations
> of the command class and have no help documentation of their own.
> Let's promote them to proper commands, add a new command group, call it
> "shell command group", for example. This makes them discoverable. Give each
> of them a help documentation string with examples, as we have for the others,
> i.e., {{help 'help'}}.
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
[jira] [Commented] (HBASE-24921) Add help output for shell "magic" commands
[
https://issues.apache.org/jira/browse/HBASE-24921?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=17188982#comment-17188982
]
Abhey Rana commented on HBASE-24921:
[~ndimiduk] I would like to work on this JIRA, May I proceed ahead and assign
this JIRA to myself?
> Add help output for shell "magic" commands
> --
>
> Key: HBASE-24921
> URL: https://issues.apache.org/jira/browse/HBASE-24921
> Project: HBase
> Issue Type: Improvement
> Components: shell
>Reporter: Nick Dimiduk
>Priority: Major
>
> The shell has a handful of "magic" commands, things like {{help}} and
> {{debug}}, that exist as commands in the shell, but are not implementations
> of the command class and have no help documentation of their own.
> Let's promote them to proper commands, add a new command group, call it
> "shell command group", for example. This makes them discoverable. Give each
> of them a help documentation string with examples, as we have for the others,
> i.e., {{help 'help'}}.
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
