Maven 1

A big bunch of fixes to maven xdocs

Details

  • Type: Improvement Improvement
  • Status: Closed Closed
  • Resolution: Fixed
  • Affects Version/s: None
  • Fix Version/s: 1.1-beta-1
  • Component/s: None
  • Labels:
    None
  • Number of attachments :
    5

Description

While learning Maven I have read a lot of the documentation. Through this process I have stumbled upon minor errors, like spelling, punctuation and broken links. I will be posting patches that fixes these problems soon.

Attachments

  1. Text File
    maven.xml.patch
    23/Jul/04 1:38 PM
    0.7 kB
    Dennis Lundberg
  2. Text File
    project.xml.patch
    22/Jul/04 6:50 AM
    2 kB
    Dennis Lundberg
  3. Text File
    src.patch
    22/Jul/04 6:52 AM
    3 kB
    Dennis Lundberg
  4. Text File
    xdocs.patch
    23/Jul/04 1:54 PM
    12 kB
    Dennis Lundberg
  5. Text File
    xdocs.patch
    22/Jul/04 7:17 AM
    129 kB
    Dennis Lundberg

Activity

Ascending order - Click to sort in descending order
Hide
Permalink
Dennis Lundberg added a comment -

Fixed some broken URLs in the dependencies section. I found these by adding the linkcheck report to the project.xml file. I have removed that report again before making this patch though.
This patch is for MAVEN-1_0-BRANCH.

Show
Dennis Lundberg added a comment - Fixed some broken URLs in the dependencies section. I found these by adding the linkcheck report to the project.xml file. I have removed that report again before making this patch though. This patch is for MAVEN-1_0-BRANCH.
Hide
Permalink
Dennis Lundberg added a comment -

Fixed some broken URLs in JavaDoc. I found these by adding the linkcheck report to the project.xml file.
This patch is for MAVEN-1_0-BRANCH.

Show
Dennis Lundberg added a comment - Fixed some broken URLs in JavaDoc. I found these by adding the linkcheck report to the project.xml file. This patch is for MAVEN-1_0-BRANCH.
Hide
Permalink
Dennis Lundberg added a comment -

Here's an overview of what's included in this patch:

  • Fixed spelling, punctuation and broken links. Some of the links that were fixed worked when the files were deployed on the Maven site, but not when the generated files were browsed. I found the broken links by adding the linkcheck report to the project.xml file.
  • Updated the POM example in xdocs/start/integrate.xml so that it resembles the current state of Maven's own project.xml file. Perhaps currentVersion should be "1.0" and not "1.0.1-SNAPSHOT" as it is in this patch.
  • Removed links to Misc -> Tasks in the navigation files because the target file is no longer available in CVS.
  • Corrected the order of elements in several POM examples so that they match the order in the XML schema.
  • Alphabetized the entries in xdocs/misc/powered.xml.
  • Added a new subsection called "sourceModification" to xdocs/reference/project-descriptor.xml.
  • Removed the double EOLs from xdocs/reference/developers/sharing-plugins.xml.

Things that I have found but have not been able to fix:

  • In the section "Remote Repository Layout" of xdocs/reference/user-guide.xml the directory tree example is no longer accurate, because "jsse" is not available at ibiblio.
  • There are still a few broken links left that I haven't been able to correct.

This patch is for MAVEN-1_0-BRANCH.

Show
Dennis Lundberg added a comment - Here's an overview of what's included in this patch:
  • Fixed spelling, punctuation and broken links. Some of the links that were fixed worked when the files were deployed on the Maven site, but not when the generated files were browsed. I found the broken links by adding the linkcheck report to the project.xml file.
  • Updated the POM example in xdocs/start/integrate.xml so that it resembles the current state of Maven's own project.xml file. Perhaps currentVersion should be "1.0" and not "1.0.1-SNAPSHOT" as it is in this patch.
  • Removed links to Misc -> Tasks in the navigation files because the target file is no longer available in CVS.
  • Corrected the order of elements in several POM examples so that they match the order in the XML schema.
  • Alphabetized the entries in xdocs/misc/powered.xml.
  • Added a new subsection called "sourceModification" to xdocs/reference/project-descriptor.xml.
  • Removed the double EOLs from xdocs/reference/developers/sharing-plugins.xml.
Things that I have found but have not been able to fix:
  • In the section "Remote Repository Layout" of xdocs/reference/user-guide.xml the directory tree example is no longer accurate, because "jsse" is not available at ibiblio.
  • There are still a few broken links left that I haven't been able to correct.
This patch is for MAVEN-1_0-BRANCH.
Hide
Permalink
David Eric Pugh added a comment -

in xdocs/navigation I left the reference to misc/tasks...

didn't apply patches to Attic files in xdocs/ant-guide/qna

also the text has changed in xdocs/adnt-guie/qna/speed.xml

I'm giving the build a test and then if it looks good I'll commit.

Show
David Eric Pugh added a comment - in xdocs/navigation I left the reference to misc/tasks... didn't apply patches to Attic files in xdocs/ant-guide/qna also the text has changed in xdocs/adnt-guie/qna/speed.xml I'm giving the build a test and then if it looks good I'll commit.
Hide
Permalink
David Eric Pugh added a comment -

All done.. Please compare what I did with what your original patch was. A bunch of files wouldn't apply cleanly, so I had to do them by hand. Others seemed to no longer be relavant.. At any rate, I am always happy to help someone doing documentation and tiding up!

Show
David Eric Pugh added a comment - All done.. Please compare what I did with what your original patch was. A bunch of files wouldn't apply cleanly, so I had to do them by hand. Others seemed to no longer be relavant.. At any rate, I am always happy to help someone doing documentation and tiding up!
Hide
Permalink
Dennis Lundberg added a comment -

David, it seems like you have applied my patches to HEAD. Am I correct on that?

I made all my changes on MAVEN-1_0-BRANCH. Before I started making the changes I asked on the users-list where to do my work. There was a reply from Arnaud who said to do it on the 1_0-BRANCH. This is probably why some of the changes didn't work correctly.

So where do you want the changes made? I'll go over the changes - just tell me which branch I should be working on.

Show
Dennis Lundberg added a comment - David, it seems like you have applied my patches to HEAD. Am I correct on that? I made all my changes on MAVEN-1_0-BRANCH. Before I started making the changes I asked on the users-list where to do my work. There was a reply from Arnaud who said to do it on the 1_0-BRANCH. This is probably why some of the changes didn't work correctly. So where do you want the changes made? I'll go over the changes - just tell me which branch I should be working on.
Hide
Permalink
David Eric Pugh added a comment -

I'm asking on the main list for some direction!

Show
David Eric Pugh added a comment - I'm asking on the main list for some direction!
Hide
Permalink
Dennis Lundberg added a comment -

Hello Eric (sorry for using the wrong name the last time)

From the looks of Brett's statement (Maven 1.x CVS and road map) and the answer from Arnaud to MAVEN-1389, it seems like my docs updates should be applied to MAVEN-1_0-BRANCH.

If you, or someone else, could apply my patches to the 1.0-branch, I can then diff the xdocs between HEAD and MAVEN-1_0-BRANCH to make sure everything is OK and up to date.

Show
Dennis Lundberg added a comment - Hello Eric (sorry for using the wrong name the last time) From the looks of Brett's statement (Maven 1.x CVS and road map) and the answer from Arnaud to MAVEN-1389, it seems like my docs updates should be applied to MAVEN-1_0-BRANCH. If you, or someone else, could apply my patches to the 1.0-branch, I can then diff the xdocs between HEAD and MAVEN-1_0-BRANCH to make sure everything is OK and up to date.
Hide
Permalink
David Eric Pugh added a comment -

Reopen so Dennis can apply more patchs to sync up with HEAD. We'll skip applying the patchs to MAVEN-1_0-BRANCH

Show
David Eric Pugh added a comment - Reopen so Dennis can apply more patchs to sync up with HEAD. We'll skip applying the patchs to MAVEN-1_0-BRANCH
Hide
Permalink
Dennis Lundberg added a comment -

When I tried to do:
maven site:generate
from HEAD but it failed with this message:

BUILD FAILED
File...... G:\cvs\maven\maven.xml
Element... ant:copy
Line...... 38
Column.... 117
Warning: Could not find file G:\cvs\maven\src\xsd\maven-project.xsd to copy.
Total time: 4 minutes 30 seconds
Finished at: Fri Jul 23 19:18:56 CEST 2004

The file is called maven-project-3.xsd in the HEAD branch.
Apply the attached patch to fix the problem in maven.xml.

Show
Dennis Lundberg added a comment - When I tried to do: maven site:generate from HEAD but it failed with this message: BUILD FAILED File...... G:\cvs\maven\maven.xml Element... ant:copy Line...... 38 Column.... 117 Warning: Could not find file G:\cvs\maven\src\xsd\maven-project.xsd to copy. Total time: 4 minutes 30 seconds Finished at: Fri Jul 23 19:18:56 CEST 2004 The file is called maven-project-3.xsd in the HEAD branch. Apply the attached patch to fix the problem in maven.xml.
Hide
Permalink
Dennis Lundberg added a comment -

Most of the changes made it through in the last commit. Here are the few things that were left behind.

Show
Dennis Lundberg added a comment - Most of the changes made it through in the last commit. Here are the few things that were left behind.
Hide
Permalink
Dennis Lundberg added a comment -

I'm getting a weird error in the pdf-generation when doing:
maven site:generate

Here's the output, I have no idea what it means though. Maybe someone else does.

[java] [INFO] [161]
[java] [ERROR] file:/G:/cvs/maven/target/pdf/project.fo:40859:87 The id "#org.apache.maven.plugin.GoalToJellyScriptHousingMapper
.methodsN271FAB" already exists in this document

BUILD FAILED
File...... C:\Documents and Settings\dlg01\.maven\cache\maven-pdf-plugin-2.1\plugin.jelly
Element... java
Line...... 120
Column.... 98
Java returned: 2
Total time: 4 minutes 53 seconds
Finished at: Fri Jul 23 19:42:48 CEST 2004

Show
Dennis Lundberg added a comment - I'm getting a weird error in the pdf-generation when doing: maven site:generate Here's the output, I have no idea what it means though. Maybe someone else does. [java] [INFO] [161] [java] [ERROR] file:/G:/cvs/maven/target/pdf/project.fo:40859:87 The id "#org.apache.maven.plugin.GoalToJellyScriptHousingMapper .methodsN271FAB" already exists in this document BUILD FAILED File...... C:\Documents and Settings\dlg01\.maven\cache\maven-pdf-plugin-2.1\plugin.jelly Element... java Line...... 120 Column.... 98 Java returned: 2 Total time: 4 minutes 53 seconds Finished at: Fri Jul 23 19:42:48 CEST 2004
Hide
Permalink
Arnaud Heritier added a comment -

For your PDF problem I'll try to find why there's a duplicate id.

Show
Arnaud Heritier added a comment - For your PDF problem I'll try to find why there's a duplicate id.
Hide
Permalink
Arnaud Heritier added a comment -

Can you open a bug on the PDF plug-in please ?

Show
Arnaud Heritier added a comment - Can you open a bug on the PDF plug-in please ?
Hide
Permalink
Dennis Lundberg added a comment -

I will file an issue on the PDF plug-in after someone commits the maxen.xml.patch. Without that patch the PDF-issue is not reproducible, because the build fails prior to the PDF-generation.

Show
Dennis Lundberg added a comment - I will file an issue on the PDF plug-in after someone commits the maxen.xml.patch. Without that patch the PDF-issue is not reproducible, because the build fails prior to the PDF-generation.
Hide
Permalink
David Eric Pugh added a comment -

Okay, all patches applied to CVS HEAD. So, I'm marking this as a 1.1 fix.

Show
David Eric Pugh added a comment - Okay, all patches applied to CVS HEAD. So, I'm marking this as a 1.1 fix.
Hide
Permalink
Dennis Lundberg added a comment -

After doing a clean install I am now unable to reproduce the problem I had earlier with the PDF generation. So consider that a non-issue.

Show
Dennis Lundberg added a comment - After doing a clean install I am now unable to reproduce the problem I had earlier with the PDF generation. So consider that a non-issue.
Hide
Permalink
Arnaud Heritier added a comment -

ok. Thanks for your help.

Show
Arnaud Heritier added a comment - ok. Thanks for your help.

People

Vote (0)
Watch (0)

Dates

  • Created:
    Updated:
    Resolved:
Atlassian JIRA (v4.4.3#663-r165197) | Report a problem
Powered by a free Atlassian JIRA open source license for Codehaus. Try JIRA - bug tracking software for your team.