giraph-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Nitay Joffe (JIRA)" <>
Subject [jira] [Commented] (GIRAPH-623) Website Documentation: table of parameters
Date Mon, 17 Jun 2013 05:31:21 GMT


Nitay Joffe commented on GIRAPH-623:

I think there might be a better way to do this - I actually built into the *ConfOption classes
a mechanism whereby they register themselves upon construction to a class called AllOptions.
In fact that class has a main() that just prints all the options. I think you can enhance
this to produce the table, and it will potentially work better - (a) you won't need to parse
things and break on changes, and (b) things like MINUTES.toMillis(10) and GIRAPH_YARN_TASK_HEAP_MB_DEFAULT
will get interpreted. The only part that's missing for this to work well is getting the javadoc.
I think the best thing to do there is to add a "description" field to AbstractConfOption and
basically move / copy the javadoc into the construction of the object itself. Just a thought,
up to you.
> Website Documentation: table of parameters
> ------------------------------------------
>                 Key: GIRAPH-623
>                 URL:
>             Project: Giraph
>          Issue Type: Improvement
>            Reporter: Claudio Martella
>         Attachments: GIRAPH-623.patch
> Would be nice to have a table with all the parameters in GiraphConstants, with defaults
and relative javadoc explanation.

This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see:

View raw message