Maven Project Web Site

Misleading documentation on the schema of profiles.xml

Details

  • Type: Improvement Improvement
  • Status: Closed Closed
  • Priority: Major Major
  • Resolution: Fixed
  • Labels:
    None
  • Number of attachments :
    0

Description

The documentation at http://maven.apache.org/guides/introduction/introduction-to-profiles.html seems to indicate that the schema for profiles.xml is 

<profiles>
  <profile>...</profile>
</profiles>

However, it seems that now a root element of <profilesXml>...</profilesXml> is required. A sample working profiles.xml file looks like:

<profilesXml
	xmlns="http://maven.apache.org/PROFILES/1.0.0"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://maven.apache.org/PROFILES/1.0.0 http://maven.apache.org/xsd/profiles-1.0.0.xsd">
	<profiles>
		<profile>
			<id>dev</id>
			<activation>
				<activeByDefault>true</activeByDefault>
			</activation>
			<properties>
			</properties>
		</profile>
	</profiles>
</profilesXml>

Note that the schema for profilesXml is not documented along with settings.xml and the POM.

http://maven.apache.org/general.html

Issue Links

is related to

Bug - A problem which impairs or prevents the functions of the product. MNGSITE-81 Wrong Root Element in profiles.xml examples used

  • Major - Major loss of function.
  • Closed - The issue is considered finished, the resolution is correct. Issues which are not closed can be reopened.
relates to

Wish - General wishlist item MNG-4796 add a warning when profiles.xml is used (Maven 2) or detected (Maven 3)

  • Major - Major loss of function.
  • Closed - The issue is considered finished, the resolution is correct. Issues which are not closed can be reopened.

Activity

Ascending order - Click to sort in descending order
Hide
Permalink
John Cheng added a comment -

I just tested this against Apache Maven 3.0-alpha-5 (r883378; 2009-11-23 07:53:41-0800), and it accepted profiles.xml with both formats without problems.

Show
John Cheng added a comment - I just tested this against Apache Maven 3.0-alpha-5 (r883378; 2009-11-23 07:53:41-0800), and it accepted profiles.xml with both formats without problems.
Hide
Permalink
Benjamin Bentmann added a comment -

Note that Maven 3.0 doesn't support/parse profiles.xml, so you can put anything in there without Maven complaining.

Show
Benjamin Bentmann added a comment - Note that Maven 3.0 doesn't support/parse profiles.xml, so you can put anything in there without Maven complaining.
Hide
Permalink
John Cheng added a comment -

Got it. I was not aware of this. I only started to use Maven 3 after I had trouble with profiles.xml in Maven 2.

Having gone through this myself, my feeling is that if Maven 2 can output a message about profiles.xml going away in 3.0, it can save users quite a bit of headache.

As far as the documentation for Maven 2, it'd still be nice to have it updated, again, to save users a bit of headache if they decided they need to use profiles.xml.

Show
John Cheng added a comment - Got it. I was not aware of this. I only started to use Maven 3 after I had trouble with profiles.xml in Maven 2. Having gone through this myself, my feeling is that if Maven 2 can output a message about profiles.xml going away in 3.0, it can save users quite a bit of headache. As far as the documentation for Maven 2, it'd still be nice to have it updated, again, to save users a bit of headache if they decided they need to use profiles.xml.
Hide
Permalink
Herve Boutemy added a comment -

documentation improved in r992666: added links to descriptors reference (settings.xml and profiles.xml) and a note about profiles.xml being deprecated in Maven 3
I created MNG-4796 to have a warning in Maven 2 and 3 when this profiles.xml file is detected

Show
Herve Boutemy added a comment - documentation improved in r992666 : added links to descriptors reference (settings.xml and profiles.xml) and a note about profiles.xml being deprecated in Maven 3 I created MNG-4796 to have a warning in Maven 2 and 3 when this profiles.xml file is detected

People

  • Assignee:
    Herve Boutemy
    Reporter:
    John Cheng
Vote (0)
Watch (0)

Dates

  • Created:
    Updated:
    Resolved: