Home | About | Sematext search-lucene.com search-hadoop.com
 Search Hadoop and all its subprojects:

Switch to Threaded View
Hive >> mail # user >> DISCUSS: Hive language manual to be source control managed


Copy link to this message
-
Re: DISCUSS: Hive language manual to be source control managed
I am not sure about BNF. Hive uses antlr so the language itself is never
described as BNF. Maybe antlr has a tool or clever way to turn the .g file
into BNF. If it is possible that should be something we do during a
document generating step. Also if a new feature does change the language
the theory would be the feature would not be committed unless it had
associated documentation.
On Sun, Sep 1, 2013 at 5:44 PM, Stephen Boesch <[EMAIL PROTECTED]> wrote:

> Will this allow BNF's for the DDL / DML to be  provided and made up to
> date  more readily ?
>
>
> 2013/9/1 Edward Capriolo <[EMAIL PROTECTED]>
>
>> Over the past few weeks I have taken several looks over documents in our
>> wiki.
>> The page that strikes me as alarmingly poor is the:
>> https://cwiki.apache.org/Hive/languagemanual.html
>>
>> This page has several critical broken links such as
>> https://cwiki.apache.org/Hive/languagemanual-groupby.html
>> https://cwiki.apache.org/Hive/languagemanual-transform.html
>>
>> The language manual used to be in decent shape. At times it had omissions
>> or was not clear about what version something appeared it, but it was very
>> usable.
>>
>> A long time ago I had began and completed moving the wiki documentation
>> inside the project as xdoc. After completion, several had a problem with
>> the xdocs approach. The main complaint was the xdoc approach was too
>> cumbersome. (However we have basically had a 'turn over' and since that
>> time I am one of the few active committers)
>>
>> The language manual is in very poor shape at the moment with broken
>> links, incorrect content, incomplete content, and poor coverage of the
>> actual languages. IMHO the attempts to crowd-source this documentation has
>> failed. Having a good concise language manual is critical to the success
>> and adoption of hive.
>>
>> I do not believe all of our documentation needs to be in xdoc (as in
>> every udf, or every input format) but I believe the language manual surely
>> does.
>>
>> Please review the current wiki and discuss the concept of moving the
>> language manual to source control, or suggest other options.
>>
>> Thank you,
>> Edward
>>
>>
>>
>