mvn: add page #1711

jdvr · 2017-11-29T13:06:20Z

The page (if new), does not already exist in the repo.
The page (if new), has been added to the correct platform folder:
common/ if it's common to all platforms, linux/ if it's Linux-specific, and so on.
The page has 8 or fewer examples.
The PR is appropriately titled:
<command name>: add page for new pages, or <command name>: <description of changes> for pages being edited
The page follows the contributing guidelines

CLAassistant · 2017-11-29T13:06:26Z

All committers have signed the CLA.

tldr-bot · 2017-11-29T13:07:22Z

The build for this PR has failed with the following error(s):

pages/common/mvn.md:23: TLDR104 Example descriptions should prefer infinitive tense (e.g. write) over present (e.g. writes) or gerund (e.g. writing)

Please fix the error(s) and push again.

agnivade

Thanks for the PR.

There are some basic changes which needs to be done in this PR. Let's get those out of the way first and we can do the next round of review then.

agnivade · 2017-11-30T09:34:38Z

pages/common/mvn.md

@@ -0,0 +1,25 @@
+# mvn
+
+> Runnign Apache Maven.


Please improve this description to actually say what does apache maven do.

agnivade · 2017-11-30T09:36:10Z

pages/common/mvn.md

+
+> Runnign Apache Maven.
+
+- Most common usage is to invoke a life cicle phase:


We do not use multiple commands for a single example. If this is the most common use case, I would recommend to split this into 3 separate examples. And probably you can remove the other examples which are not so commonly used.

I have remove the two extra lines, it worths less that the next examples.

agnivade

Please use tokens ({{}}) wherever you have user specified variables in the commands.

agnivade · 2017-12-01T12:03:19Z

pages/common/mvn.md

@@ -0,0 +1,23 @@
+# mvn
+
+> Apache Maven. A build automation tool used for JVM environment projects.


Please move the 2nd sentence to a new line.

The maven docs describe mvn as:

"Tool for building and managing Java-based projects."

agnivade · 2017-12-01T12:09:13Z

pages/common/mvn.md

+
+> Apache Maven. A build automation tool used for JVM environment projects.
+
+- Most common usage is to invoke a life cicle phase:


typo at cycle.

This description can be improved. No need to mention "Most common usage". It does not say anything about what mvn package does. Can you expand a bit on what is meant by a life cycle phase ?

It is a little bit difficult to add a phase definition without the maven context, what do you think about this:
"Invoke a Lifecycle phase (a set of steps for the whole project Lifecycle)"?

we can live with it.

agnivade · 2017-12-01T12:09:38Z

pages/common/mvn.md

+
+- Invoke more that one phase with arguments:
+
+`mvn clean -P a_profile package clean`


The phases should be in tokens.

Should the "a_profile" be in token?

agnivade · 2017-12-01T12:10:23Z

pages/common/mvn.md

+
+`mvn -X clean -P a_profile package clean`
+
+- Use an alternative pom o directory:


o directory ? And please expand pom in brackets.

hohonuuli · 2017-12-11T16:44:39Z

Common usages I would recommend to be added:

Delete the target folder, which contains all build outputs:

mvn clean

Compile and build release package, skipping unit tests:

mvn package -Dmaven.test.skip=true

Install the built package in local maven repository:

mvn install

hohonuuli · 2017-12-11T16:59:30Z

pages/common/mvn.md

+
+- Running an spring boot project with remote debug:
+
+`mvn spring-boot:run -Drun.jvmArguments="-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=n,address=5005"`


spring-boot:run is pretty esoteric. A more common maven usage would be to run a main class in your project:

Run a class with a main method:

mvn exec:java -Dexec.mainClass="{{com.example.Main}}" -Dexec.args="{{arg1 arg2}}"

agnivade · 2017-12-11T17:03:04Z

I am really confused about the mvn package command.

@hohonuuli - your description says Compile and build release package
@jdvr - your description says Most common usage is to invoke a life cycle phase

Both seem very different to me. I am not a mvn user so I do not know much. However from a layman's standpoint, I would say @hohonuuli's description sounds much more clear to me.

Combining both PRs, I would recommend to have examples in this order -

mvn compile

mvn -f {{path/to/custom_pom.xml}} compile

mvn package

mvn install

mvn clean

mvn exec:java -Dexec.mainClass="{{com.example.Main}}" -Dexec.args="{{arg1 arg2}}"

jdvr · 2017-12-12T10:27:14Z

This example are missing the fact that pass an argument to a phase like profile on package:
mvn -P {{a_profile}} package

agnivade · 2017-12-12T10:45:12Z

That's right. Please understand that our scope in tldr is really limited and we have to be judicious in the space we use. We have a maximum limit of 8 examples and we usually try to keep it at 6. So we have to think of the most useful and simplest form of the command invocation first and then move on to the complex ones.

Keeping that in mind, I did not mention passing an argument to the mvn package command. However, if you think that it is a really important option that will be needed by beginners, you can add it.

jdvr · 2017-12-12T14:24:05Z

I have tried to join the two PR with the best information, I've tried to add a generic examples of the commands that new members of my teams used to need.

agnivade · 2017-12-12T15:23:53Z

Hey @jdvr - We always introduce the simplest invocation of the commands first and then move on to more complex ones. You have used mvn compile with an argument without mentioning mvn compile first. Same with mvn clean. The general convention is to mention mvn compile and mvn clean and explain what it does before moving on to more complex examples. It seems your requirements are a bit specific than the general command invocations.

Also the language of the command descriptions can be improved slightly. If you don't mind, may I edit the PR ?

jdvr · 2017-12-12T15:53:27Z

Sure, feel free to edit the PR. compile and clean reference can be removed or replace by package

hohonuuli · 2017-12-12T17:15:46Z

@jdvr Just a note that I've been using Maven for about 20 years, but I've never once used: mvn -f {{path/to/custom_pom.xml}} compile. Is that something that you find yourself using day to day? I do however, commonly skip unit tests when building a final package as they can often take a long time to run. perhaps trim the examples to:

mvn compile

mvn package

mvn package -Dmaven.test.skip=true

mvn install

mvn clean

mvn exec:java -Dexec.mainClass="{{com.example.Main}}" -Dexec.args="{{arg1 arg2}}"

agnivade · 2017-12-13T06:16:17Z

Thanks @hohonuuli - I agree with you. I have asked around a couple of people who use maven. And collating all of their feedback, I have made the final changes. It matches almost perfectly with your suggestions. Also, I have added a few more commands which other people have found useful. I had to stretch the page to 8, but I think given the regular usage of the command, it's worth it.

EDIT - @jdvr please take a look and let me know if this looks good to you. I have deliberately avoided using the words build life cycle and phases as I think they are beyond the scope of the page. Instead, using simple words to explain what the commands do make more sense to me.

jdvr · 2017-12-13T09:18:23Z

Yes, it looks great. Sorry for including that options, maybe my scope it is to limited :).

agnivade · 2017-12-13T12:16:44Z

Over to you @sbrl

sbrl

Looks ok as far as I can tell! I'm not well versed in maven itself, so I'll trust that you've got all that sorted out, @agnivade / @jdvr / @hohonuuli :P

jdvr added 2 commits November 29, 2017 09:35

Create mvn.md

99d1093

Update mvn.md

cb9dd06

Update mvn.md

4e4c632

agnivade added the new command Issues requesting creation of a new page or PRs adding a new page for a command. label Nov 30, 2017

agnivade requested changes Nov 30, 2017

View reviewed changes

Update mvn.md

ea10d74

agnivade requested changes Dec 1, 2017

View reviewed changes

agnivade mentioned this pull request Dec 10, 2017

mvn:add page #1781

Closed

5 tasks

hohonuuli reviewed Dec 11, 2017

View reviewed changes

change example, change order and inprove descriptions

9daf498

Restructuring the entire page

524b308

agnivade approved these changes Dec 13, 2017

View reviewed changes

sbrl approved these changes Dec 13, 2017

View reviewed changes

sbrl merged commit 1094158 into tldr-pages:master Dec 13, 2017

Managor mentioned this pull request Mar 8, 2025

Let's document: mvn #15570

Open

11 tasks


		> Runnign Apache Maven.

		- Most common usage is to invoke a life cicle phase:

		@@ -0,0 +1,23 @@
		# mvn

		> Apache Maven. A build automation tool used for JVM environment projects.


		- Invoke more that one phase with arguments:

		`mvn clean -P a_profile package clean`


		`mvn -X clean -P a_profile package clean`

		- Use an alternative pom o directory:


		- Running an spring boot project with remote debug:

		`mvn spring-boot:run -Drun.jvmArguments="-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=n,address=5005"`

Uh oh!

mvn: add page #1711

mvn: add page #1711

Uh oh!

Conversation

jdvr commented Nov 29, 2017

Uh oh!

CLAassistant commented Nov 29, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

tldr-bot commented Nov 29, 2017

Uh oh!

agnivade left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

agnivade left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

hohonuuli commented Dec 11, 2017

Common usages I would recommend to be added:

Uh oh!

Choose a reason for hiding this comment

Uh oh!

agnivade commented Dec 11, 2017

Uh oh!

jdvr commented Dec 12, 2017

Uh oh!

agnivade commented Dec 12, 2017

Uh oh!

jdvr commented Dec 12, 2017

Uh oh!

agnivade commented Dec 12, 2017

Uh oh!

jdvr commented Dec 12, 2017

Uh oh!

hohonuuli commented Dec 12, 2017

Uh oh!

agnivade commented Dec 13, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jdvr commented Dec 13, 2017

Uh oh!

agnivade commented Dec 13, 2017

Uh oh!

sbrl left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

CLAassistant commented Nov 29, 2017 •

edited

Loading

agnivade commented Dec 13, 2017 •

edited

Loading