[
https://issues.apache.org/jira/browse/TINKERPOP-2098?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16696206#comment-16696206
]
Robert Dale commented on TINKERPOP-2098:
----------------------------------------
The options are in a somewhat common command-line help format.
{noformat}
{start|stop|restart|status|console|install <group> <artifact> <version>|<conf
file>}{noformat}
reads as:
'start'
or 'stop'
or 'restart'
or 'status'
or 'console'
or 'install' with required, placeholder parameters 'group', 'artifact',
'version'
or placeholder 'conf file'
Using this format, if having 'conf file' were an option for 'start', it would
have displayed
{noformat}
{start [conf file] | stop | ....}
{noformat}
*What would you suggest to make it more clear?*
It would also be great if you could pinpoint places in the docs where it's
confusing. I couldn't find any instances where 'start' and 'conf file' were
intermixed or implied one could be used with the other.
The first mention of starting Gremlin Server shows correct usage.
* [http://tinkerpop.apache.org/docs/current/reference/#starting-gremlin-server]
Configuring describes each parameter and how to configure the env vars.
* [http://tinkerpop.apache.org/docs/current/reference/#_configuring_2]
Just reading through that with your requirements in mind. If I want to run in
the background, then I must use 'start' since it 'Start[s] the server in the
background'. I can't use parameter 'conf file' because it starts in the
foreground. If I want to override the default 'conf/gremlin-server.yaml', then
I must "set GREMLIN_YAML in bin/gemlin-server.conf".
*What would you suggest to make it more clear?*
> gremlin-server.sh start does not seem to work as advertised
> -----------------------------------------------------------
>
> Key: TINKERPOP-2098
> URL: https://issues.apache.org/jira/browse/TINKERPOP-2098
> Project: TinkerPop
> Issue Type: Improvement
> Components: server
> Affects Versions: 3.3.4
> Reporter: Kelvin R. Lawrence
> Priority: Minor
>
> This may be as simple as a documentation issue but the help text for Gremlin
> server implies that I should be able to do:
> {code:java}
> gremlin-server.sh start conf/myyaml.yaml{code}
> However when I do that it does not seem to actually be reading my YAML file
> or if it is it is not reading it fully as I am specifying the WsAndHttp
> channelizer in the YAML and when the server starts the HTTP endpoint is not
> available.
>
> If I start the server in the terminal with
>
> {code:java}
> gremlin-server.sh conf/myyaml.yaml{code}
>
> all is fine but I want to start it in the background.
>
> I spoke to [~pluradj] and he had me try using the environment variable to
> specify the YAML file name and that worked with the *start* keyword.
>
> Is *gremlin-server.sh start conf/myyaml.yam*l supposed to work?
>
> If not it would be good to change the help text for gremlin-server.sh which
> currently reads as follows:
>
>
> {code:java}
> Usage: bin/gremlin-server.sh {start|stop|restart|status|console|install
> <group> <artifact> <version>|<conf file>}{code}
>
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
