[
https://issues.apache.org/jira/browse/ARTEMIS-476?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Jiri Danek updated ARTEMIS-476:
-------------------------------
Description:
Instructions for running examples are given in three different places
1) File
https://github.com/apache/activemq-artemis/blob/master/docs/user-manual/en/examples.md
says
2) README at
https://github.com/apache/activemq-artemis/blob/master/README.md#examples says
3) Another README at
https://github.com/apache/activemq-artemis/blob/master/examples/README.md
My qualms:
Document 2 is the briefest of them all and quite honestly rather confusing.
(the NB sentence at the end).
Document 2 states, that `mvn verify` will run all examples, while both other
documents say that to run all examples, one has to execute `mvn -Pexamples`
verify. This is an inconsistency.
Document 3 says that I need to set the -Xmx option only when I want to run all
examples in a batch, with -Pexamples profile. I think that since each example
is stopped before another is started, this advice is meaningless. What would
make sense is to set this option before running any example, either single one
or in batch. Document 1 does not mention -Xmx at all.
was:
Instructions for running examples are given in three different places
1) File
https://github.com/apache/activemq-artemis/blob/master/docs/user-manual/en/examples.md
says
2) README at
https://github.com/apache/activemq-artemis/blob/master/README.md#examples says
3) Another README at
https://github.com/apache/activemq-artemis/blob/master/examples/README.md
Document 2 is the briefest of them all and quite honestly rather confusing.
(the NB sentence at the end).
Document 2 states, that `mvn verify` will run all examples, while both other
documents say that to run all examples, one has to execute `mvn -Pexamples`
verify. This is an inconsistency.
> Instructions for running examples are triplicated and confusing in one
> instance
> -------------------------------------------------------------------------------
>
> Key: ARTEMIS-476
> URL: https://issues.apache.org/jira/browse/ARTEMIS-476
> Project: ActiveMQ Artemis
> Issue Type: Bug
> Components: Broker
> Affects Versions: 1.3.0
> Reporter: Jiri Danek
> Original Estimate: 0.5h
> Remaining Estimate: 0.5h
>
> Instructions for running examples are given in three different places
> 1) File
> https://github.com/apache/activemq-artemis/blob/master/docs/user-manual/en/examples.md
> says
> 2) README at
> https://github.com/apache/activemq-artemis/blob/master/README.md#examples says
> 3) Another README at
> https://github.com/apache/activemq-artemis/blob/master/examples/README.md
> My qualms:
> Document 2 is the briefest of them all and quite honestly rather confusing.
> (the NB sentence at the end).
> Document 2 states, that `mvn verify` will run all examples, while both other
> documents say that to run all examples, one has to execute `mvn -Pexamples`
> verify. This is an inconsistency.
> Document 3 says that I need to set the -Xmx option only when I want to run
> all examples in a batch, with -Pexamples profile. I think that since each
> example is stopped before another is started, this advice is meaningless.
> What would make sense is to set this option before running any example,
> either single one or in batch. Document 1 does not mention -Xmx at all.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
