Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix README.md example #341

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

fix README.md example #341

wants to merge 1 commit into from

Conversation

Ynewtime
Copy link

The second example in README.md has minor typo which may cause confusion:

mvn jetty:run -Djetty.http.port=9999

notice there is no space between the -D option and the value, shall be updatd with:

mvn jetty:run -D jetty.http.port=9999

@HeinrichAD
Copy link
Collaborator

The missing space was intended.
See: https://books.sonatype.com/mvnref-book/reference/running-sect-options.html#running-sect-define-prop.

But I guess both ways seem to work just fine, as we use both conventions within the workflows:

run: mvn --batch-mode -f pom.jdk8.xml -D java.net.useSystemProxies=true -Dapache-jsp.scope=compile clean package

Since it's more readable with a space, I wouldn't mind changing it.
But I would prefer if we had only one convention within the README.
So, please also change the other 4 occurrences:

mvn jetty:run -D THE_ENV_VARIABLE=THE_ENV_VALUE -Djetty.http.port=9999

* Set PlantUML system properties (like over the Java command line using the `-Dpropertyname=value` syntax).

mvn package -Dapache-jsp.scope=compile

mvn package -f pom.jdk8.xml [-Dapache-jsp.scope=compile]

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants