Author: sisbell Date: Sun Aug 19 16:10:20 2007 New Revision: 567501 URL: http://svn.apache.org/viewvc?rev=567501&view=rev Log: Updated Visual Studio docs.
Added: incubator/nmaven/trunk/site/src/site/images/IdeMavenEmbedderInteraction.jpg (with props) Modified: incubator/nmaven/trunk/site/src/site/apt/features.apt incubator/nmaven/trunk/site/src/site/apt/getting-started.apt incubator/nmaven/trunk/site/src/site/apt/ide/visual-studio.apt incubator/nmaven/trunk/site/src/site/apt/plugins/index.apt Modified: incubator/nmaven/trunk/site/src/site/apt/features.apt URL: http://svn.apache.org/viewvc/incubator/nmaven/trunk/site/src/site/apt/features.apt?rev=567501&r1=567500&r2=567501&view=diff ============================================================================== --- incubator/nmaven/trunk/site/src/site/apt/features.apt (original) +++ incubator/nmaven/trunk/site/src/site/apt/features.apt Sun Aug 19 16:10:20 2007 @@ -25,13 +25,13 @@ * XSD and WSDL Generation * Assembly Signing + + * FxCop Support + + * Writing Plugins in .NET * Cool New Features - * Writing Maven Plugins in .NET (Microsoft Only) - * Experimental IDE Support (VS2005, #develop) - * Deploying and Retrieving of .NET Artifacts from a Remote Repository - - * FxCop Maven Plugin \ No newline at end of file + * New artifact resolver that uses RDF \ No newline at end of file Modified: incubator/nmaven/trunk/site/src/site/apt/getting-started.apt URL: http://svn.apache.org/viewvc/incubator/nmaven/trunk/site/src/site/apt/getting-started.apt?rev=567501&r1=567500&r2=567501&view=diff ============================================================================== --- incubator/nmaven/trunk/site/src/site/apt/getting-started.apt (original) +++ incubator/nmaven/trunk/site/src/site/apt/getting-started.apt Sun Aug 19 16:10:20 2007 @@ -183,6 +183,8 @@ * {Using NMaven Without Building} + NOTE: Remote downloading is not currently working with snapshots. You will need to build NMaven. + ** Prerequisites [[1]] {{{ http://java.sun.com/javase/downloads/index_jdk5.jsp} JDK 5.0 Update x}} @@ -269,7 +271,7 @@ -DartifactId=<<myArtifactId>> \ -DarchetypeArtifactId=maven-archetype-dotnet-simple \ -DarchetypeGroupId=org.apache.maven.dotnet \ - -DarchetypeVersion=0.14 + -DarchetypeVersion=0.14-SNAPSHOT +----+ You will see the following project generated: @@ -503,12 +505,12 @@ (directly or through a script) using the maven-install-plugin: +----+ - mvn org.apache.maven.plugins:maven-install-plugin:install-file + mvn org.apache.maven.dotnet.plugins:maven-install-plugin:install-file -Dfile=../imports/nunit-2.0/nunit.framework.dll - -DgroupId=org.nunit - -DartifactId=nunit.framework - -Dpackaging=dll - -Dversion=2.2.8.0 + -DgroupId=NUnit + -DartifactId=NUnit.Framework + -Dpackaging=library + -DartifactVersion=2.2.8.0 +----+ After that, include the dependency in your pom.xml file and you are ready to go. @@ -523,9 +525,6 @@ </dependency> </dependencies> +----+ - - Note that there is no current support for the use of classifiers within NMaven: - {{{http://jira.codehaus.org/browse/NMAVEN-2} NMAVEN-2}} * {Generating Resources} Modified: incubator/nmaven/trunk/site/src/site/apt/ide/visual-studio.apt URL: http://svn.apache.org/viewvc/incubator/nmaven/trunk/site/src/site/apt/ide/visual-studio.apt?rev=567501&r1=567500&r2=567501&view=diff ============================================================================== --- incubator/nmaven/trunk/site/src/site/apt/ide/visual-studio.apt (original) +++ incubator/nmaven/trunk/site/src/site/apt/ide/visual-studio.apt Sun Aug 19 16:10:20 2007 @@ -55,7 +55,7 @@ -DartifactId=<<myArtifactId>> \ -DarchetypeArtifactId=maven-archetype-dotnet-simple \ -DarchetypeGroupId=org.apache.maven.dotnet \ - -DarchetypeVersion=0.14 + -DarchetypeVersion=0.14-SNAPSHOT +----+ You will see the following project generated: @@ -129,3 +129,81 @@ Go back through the steps that caused the error. Now look at your log file. The most common error is: "Unable to connect to the remote server" This means that the embedded server did not properly start up. + If the plugin loads, but you still encounter errors, check under the .m2/embedder-error-logs directory. You will see + two log files: jetty-log.xml and the nmaven-embedder-log.xml. The jetty-log will tell you what port the jetty server + starts on and the location of the war file. If the war file does not load correctly, jetty will output information to + this log. This log will also tell you if the server started successfully. + ++----+ + <record> + <date>2007-07-30T17:35:37</date> + <millis>1185842137390</millis> + <sequence>0</sequence> + <level>INFO</level> + <class>org.apache.maven.dotnet.jetty.JettyStarter</class> + <method>main</method> + <thread>10</thread> + <message>NMAVEN: Port = 8080, + warFile = C:\Documents and Settings\shane\.m2\repository\org\apache\maven\dotnet\dotnet-service-embedder\0.14\dotnet-service-embedder-0.14.war</message> +</record> +<record> + <date>2007-07-30T17:35:40</date> + <millis>1185842140500</millis> + <sequence>7</sequence> + <level>INFO</level> + <class>org.apache.maven.dotnet.jetty.JettyStarter</class> + <method>main</method> + <thread>10</thread> + <message>NMAVEN: Successfully started server</message> +</record> ++----+ + + The nmaven-embedder-log.xml is useful for given information about why jetty itself does not start. It gives the location + of the local repository that the embedder uses as well as the full classpath that jetty is using when it starts. + ++----+ +<record> + <date>2007-07-30T17:35:37</date> + <millis>1185842137078</millis> + <sequence>0</sequence> + <level>INFO</level> + <class>org.apache.maven.dotnet.plugin.embedder.EmbedderStarterMojo</class> + <method>execute</method> + <thread>10</thread> + <message>NMAVEN: Found local repository: Path = C:\Documents and Settings\shane\.m2\repository</message> +</record> +<record> + <date>2007-07-30T17:35:37</date> + <millis>1185842137109</millis> + <sequence>2</sequence> + <level>INFO</level> + <class>org.apache.maven.dotnet.plugin.embedder.EmbedderStarterMojo</class> + <method>execute</method> + <thread>10</thread> + <message>[-Dport=8080, + -DwarFile=C:\Documents and Settings\shane\.m2\repository\org\apache\maven\dotnet\dotnet-service-embedder\0.14\dotnet-service-embedder-0.14.war, + -classpath, "C:\Documents and Settings\shane\.m2\repository\javax\servlet\jsp\jsp-api\2.1\jsp-api-2.1.jar"; + "C:\Documents and Settings\shane\.m2\repository\org\mortbay\jetty\jetty\6.1.5\jetty-6.1.5.jar"; + "C:\Documents and Settings\shane\.m2\repository\org\mortbay\jetty\jetty-util\6.1.5\jetty-util-6.1.5.jar"; + "C:\Documents and Settings\shane\.m2\repository\org\mortbay\jetty\jetty-embedded\6.1.5\jetty-embedded-6.1.5.jar"; + "C:\Documents and Settings\shane\.m2\repository\org\mortbay\jetty\servlet-api-2.5\6.1.5\servlet-api-2.5-6.1.5.jar"; + "C:\Documents and Settings\shane\.m2\repository\org\apache\maven\dotnet\dotnet-jetty\0.14\dotnet-jetty-0.14.jar", + org.apache.maven.dotnet.jetty.JettyStarter]</message> +</record> ++----+ + +* IDE And MavenEmbedder Interaction + +[../images/IdeMavenEmbedderInteraction.jpg] + + The interaction starts when the <<developer>> loads the NMaven build addin (1). <<Visual Studio>> then starts up + the MavenEmbedder as an external process running within a Jetty Server(2). <<Visual Studio>> starts up a logger port + (3) that the <<MavenEmbedder>> can use to write log messages to. + + The <<developer>> now issues a build command (4): compile, test, clean or install. <<Visual Studio>> does a SOAP + call to the <<MavenEmbedder>> (5). The SOAP message contains the build command, the logger port and the file location + of the pom.xml file to use during the build. The <<MavenEmbedder>> configures its logger to use a socket and + connects to the <<Visual Studio>> logger port (6, 7). The <<MavenEmbedder>> issues the build command for each + project contained within the pom.xml file (8) and starts building the project and writing the log messages to + <<Visual Studio>> (9). <<Visual Studio>> takes the log messages and writes it out to the IDE output console (10) + where the developer can see the build results (11). \ No newline at end of file Modified: incubator/nmaven/trunk/site/src/site/apt/plugins/index.apt URL: http://svn.apache.org/viewvc/incubator/nmaven/trunk/site/src/site/apt/plugins/index.apt?rev=567501&r1=567500&r2=567501&view=diff ============================================================================== --- incubator/nmaven/trunk/site/src/site/apt/plugins/index.apt (original) +++ incubator/nmaven/trunk/site/src/site/apt/plugins/index.apt Sun Aug 19 16:10:20 2007 @@ -1,17 +1,27 @@ Available Plugins *-----------------------------------------------------------------------------------+----------------------------------+ -| <<Plugin>> | <<Description>> +| <<Java Plugin>> | <<Description>> *-----------------------------------------------------------------------------------+----------------------------------+ | {{{maven-compile-plugin/index.html} <<<compile>>>}} | Compiles .NET Applications *-----------------------------------------------------------------------------------+----------------------------------+ +| {{{maven-deploy-plugin/index.html} <<<deploy>>>}} | Deploys .NET assemblies to a remote repository +*-----------------------------------------------------------------------------------+----------------------------------+ +| {{{maven-embedder-plugin/index.html} <<<embedder>>>}} | Starts the Maven Embedder SOAP Service +*-----------------------------------------------------------------------------------+----------------------------------+ +| {{{maven-fxcop-plugin/index.html} <<<fxcop>>>}} | Runs the FxCop Code Analysis Tool +*-----------------------------------------------------------------------------------+----------------------------------+ | {{{maven-install-plugin/index.html} <<<install>>>}} | Installs Artifacts *-----------------------------------------------------------------------------------+----------------------------------+ -| {{{maven-resgen-plugin/index.html} <<<resgen>>>}} | Generates .NET Resources +| {{{maven-link-plugin/index.html} <<<link>>>}} | Links Modules into Assemblies *-----------------------------------------------------------------------------------+----------------------------------+ -| {{{maven-resolver-plugin/index.html} <<<resolver>>>}} | Resolves Artifacts +| {{{maven-mojo-generator-plugin/index.html} <<<mojo-generator>>>}} | Generates Java Bindings for .NET Mojos *-----------------------------------------------------------------------------------+----------------------------------+ -| {{{maven-settings-plugin/index.html} <<<settings>>>}} | Generates an nmaven-settings file +| {{{maven-repository-plugin/index.html} <<<repository>>>}} | Tools for exporting RDF XML Metadata and converting repository formats +*-----------------------------------------------------------------------------------+----------------------------------+ +| {{{maven-resgen-plugin/index.html} <<<resgen>>>}} | Generates .NET Resources +*-----------------------------------------------------------------------------------+---------------------------------- +| {{{maven-resolver-plugin/index.html} <<<resolver>>>}} | Resolves Artifacts *-----------------------------------------------------------------------------------+----------------------------------+ | {{{maven-test-plugin/index.html} <<<test>>>}} | Tests class files with NUnit *-----------------------------------------------------------------------------------+----------------------------------+ @@ -23,5 +33,21 @@ *-----------------------------------------------------------------------------------+----------------------------------+ | {{{maven-xsd-plugin/index.html} <<<xsd>>>}} | Generates schema bindings *-----------------------------------------------------------------------------------+----------------------------------+ -| {{{maven-xsp-plugin/index.html} <<<xsp>>>}} | +| {{{maven-xsp-plugin/index.html} <<<xsp>>>}} | Manages the Mono XSP Server +*-----------------------------------------------------------------------------------+----------------------------------+ + +* .NET Plugins + +*-----------------------------------------------------------------------------------+----------------------------------+ +| <<.NET Plugin>> | <<Description>> +*-----------------------------------------------------------------------------------+----------------------------------+ +| <<<NMaven.Plugin.Addin>>> | Generates Addin for NMaven +*-----------------------------------------------------------------------------------+----------------------------------+ +| <<<NMaven.Plugin.Devenv>>> | Starts up Visual Studio 2005 +*-----------------------------------------------------------------------------------+----------------------------------+ +| <<<NMaven.Plugin.Resx>>> | Generates .NET Resources +*-----------------------------------------------------------------------------------+----------------------------------+ +| <<<NMaven.Plugin.Settings>>> | Generates an nmaven-settings file +*-----------------------------------------------------------------------------------+----------------------------------+ +| <<<NMaven.Plugin.Solution>>> | Generates a Solution file from a pom *-----------------------------------------------------------------------------------+----------------------------------+ Added: incubator/nmaven/trunk/site/src/site/images/IdeMavenEmbedderInteraction.jpg URL: http://svn.apache.org/viewvc/incubator/nmaven/trunk/site/src/site/images/IdeMavenEmbedderInteraction.jpg?rev=567501&view=auto ============================================================================== Binary file - no diff available. Propchange: incubator/nmaven/trunk/site/src/site/images/IdeMavenEmbedderInteraction.jpg ------------------------------------------------------------------------------ svn:mime-type = image/jpeg