You are viewing a plain text version of this content. The canonical link for it is here.
Posted to npanday-commits@incubator.apache.org by lc...@apache.org on 2011/04/05 16:31:55 UTC
svn commit: r1089117 - in /incubator/npanday/trunk/site/src/site/apt:
developers/building.apt.vm guide/installation/index.apt.vm
guide/reference/troubleshooting.apt
Author: lcorneliussen
Date: Tue Apr 5 16:31:54 2011
New Revision: 1089117
URL: http://svn.apache.org/viewvc?rev=1089117&view=rev
Log:
[NPANDAY-123] Removed/Rewrote all the documentation related to configure the PATH correctly.
Modified:
incubator/npanday/trunk/site/src/site/apt/developers/building.apt.vm
incubator/npanday/trunk/site/src/site/apt/guide/installation/index.apt.vm
incubator/npanday/trunk/site/src/site/apt/guide/reference/troubleshooting.apt
Modified: incubator/npanday/trunk/site/src/site/apt/developers/building.apt.vm
URL: http://svn.apache.org/viewvc/incubator/npanday/trunk/site/src/site/apt/developers/building.apt.vm?rev=1089117&r1=1089116&r2=1089117&view=diff
==============================================================================
--- incubator/npanday/trunk/site/src/site/apt/developers/building.apt.vm (original)
+++ incubator/npanday/trunk/site/src/site/apt/developers/building.apt.vm Tue Apr 5 16:31:54 2011
@@ -25,26 +25,15 @@ Building NPanday
* Pre-requisites
- You must first have any pre-requisites installed:
+ Since NPanday is built using NPanday, you must fulfil all the prerequisites documented in the
+ {{{../guide/installation/index.html} Installation Guide}}. NPanday trunk usually builds against one
+ of the latest releases. If you want
+
+ <<NPanday builds using .NET 2.0.>> So, if you do not have Visual Studio 2005 installed, you must install
+ .NET SDK 2.0 or Windows SDK 6.1 (includes .NET SDK 2.0) manually. This is, because neither VS 2008 or VS 2010
+ include the SDK for .NET 2.0. Find the download locations in the Installation Guide.
- * Visual Studio 2005 or above
-
- * .NET 2.0 runtime, or above
-
- * .NET 2.0 SDK, or above
-
- * NUnit 2.2.8 or above
-
- * Apache Maven 2.0.9 or above
-
- []
-
- See the {{{../guide/installation/index.html} Installation Guide}}, and particularly the information on how to
- {{{../guide/installation/index.html#Set_the_PATH} Set the PATH}} for more information. The easiest way to do this
- is to run the <Visual Studio 2005 Command Prompt> from the Windows Start menu.
-
- NUnit in particular must be installed and in the PATH. In some versions, you may need to include the <<<bin\net-2.0>>>
- directory instead of just the <<<bin>>> directory in your PATH to get the correct test runner version.
+ NUnit-Binaries must be on the PATH environment variable.
* Checking out the Source Code
@@ -58,29 +47,6 @@ Building NPanday
svn co https://svn.apache.org/repos/asf/incubator/npanday/trunk npanday
----
-* Enabling additional Remote Repositories
-
- NPanday has some dependencies that are not in Maven Central. In order to have them downloaded to your local
- repository you have to uncomment some additional repositories in the <<<repositories>>> section of NPanday's
- <<<pom.xml>>>, or you can add the following remote repositories to your local <<<settings.xml>>>.
-
-----
-<repository>
- <id>npanday.3rdparty</id>
- <name>NPanday 3rd-Party Repository</name>
- <url>http://repo.npanday.org/archiva/repository/3rdparty</url>
- <snapshots>
- <enabled>false</enabled>
- </snapshots>
-</repository>
-<repository>
- <id>aduna.org</id>
- <url>http://repository.aduna-software.org/maven2</url>
-</repository>
-----
-
- For performance reasons you should disable them again after the first successful build.
-
* Building All with Maven
Everything in the distribution, including the Visual Studio add-in, is built using the following command:
Modified: incubator/npanday/trunk/site/src/site/apt/guide/installation/index.apt.vm
URL: http://svn.apache.org/viewvc/incubator/npanday/trunk/site/src/site/apt/guide/installation/index.apt.vm?rev=1089117&r1=1089116&r2=1089117&view=diff
==============================================================================
--- incubator/npanday/trunk/site/src/site/apt/guide/installation/index.apt.vm (original)
+++ incubator/npanday/trunk/site/src/site/apt/guide/installation/index.apt.vm Tue Apr 5 16:31:54 2011
@@ -27,98 +27,27 @@ Pre-requisites
* Maven 2.0.9 or above (see {{{http://maven.apache.org/download.html} Maven's download page}} for instructions).
- * Java Development Kit (JDK) 1.6 or greater. Also, the <<<JAVA_HOME>>> environment variable
+ * Java Development Kit (JDK) 1.6 or greater ({{{http://www.oracle.com/technetwork/java/javase/downloads/index.html} Java SE Downloads}}). Also, the <<<JAVA_HOME>>> environment variable
must be set to the directory where the JDK is installed, for example, <<<C:\\Program Files\\Java\\jdk1.6.0>>>.
The <<<java>>> executable must also be available on your path.
- * Visual Studio 2005 (SP1) or the .NET 2.0 SDK for developing .NET 2.0 applications and libraries
+ * Visual Studio 2005 (SP1) or the .NET 2.0 SDK for developing .NET 2.0 applications and libraries (.NET 2.0 SDK: {{{http://www.microsoft.com/downloads/details.aspx?FamilyID=fe6f2099-b7b4-4f47-a244-c96d69c35dec&displaylang=en} x86}}, {{{http://www.microsoft.com/downloads/en/details.aspx?FamilyID=1AEF6FCE-6E06-4B66-AFE4-9AAD3C835D3D} x64}})
- * Visual Studio 2008 (SP1) or the {{{http://www.microsoft.com/downloads/en/details.aspx?FamilyID=c17ba869-9671-4330-a63e-1fd44e0e2505&displaylang=en} Windows 7 SDK for .NET 3.5 SP1 }} for developing .NET 3.5 (and earlier) applications and
- libraries
+ * Visual Studio 2008 (SP1) or the {{{http://www.microsoft.com/downloads/en/details.aspx?FamilyID=c17ba869-9671-4330-a63e-1fd44e0e2505&displaylang=en} Microsoft Windows SDK for Windows 7 and .NET 3.5 SP1 }} for developing .NET 3.5 applications and
+ libraries. Note: The SDK can be installed on XP or Vista, too.
- If you later have problems relating to being unable to find the SDK, refer to the
- {{{../reference/troubleshooting.html} Troubleshooting}} section.
+ * Visual Studio 2010 (SP1) or the {{{ http://www.microsoft.com/downloads/en/details.aspx?FamilyID=6b6c21d2-2006-4afa-9702-529fa782d63b&displaylang=en} Microsoft Windows SDK for Windows 7 and .NET 4 SP1 }} for developing .NET 4 applications and
+ libraries. Note: The SDK can be installed on XP or Vista, too.
-Preparation
+ * {{{http://www.nunit.org/?p=download} NUnit}} in order to run unit tests with NPanday. Make sure the <<<bin>>> directory is on the PATH.
- Before installing NPanday, you may need to do some further preparation.
+ If you later have problems relating to being unable to find the SDK, refer to the
+ {{{../reference/troubleshooting.html} Troubleshooting}} section.
-* Removing a Previous Version
+Removing a Previous Version
While it is generally safe to install the new version without uninstalling the previous version, to ensure a clean
system you may want to follow the {{{./uninstall.html} Uninstalling NPanday}} instructions.
-
-* {Set the PATH}
-
- All Maven commands must be run with the PATH set for the .NET SDKs. This can usually be achieved by
- starting the appropriate command prompt shortcuts supplied with the SDK or Visual Studio.
-
- In addition, at present the NPanday Add-in runs Maven directly and so also requires that all the SDKs are already on
- the path - something which is not usually the case when Visual Studio is run.
-
- The method you use to set the PATH environment can vary, depending on how you usually launch Visual Studio:
-
- * If you are starting Visual Studio from the Windows Start menu, use the following to set the PATH environment
- variable in the System Properties:
- <<<Start \> My Computer \> View System Information \> Advanced \> Environment variables>>>. The variable must have
- all the additional elements that are added when you run the Visual Studio Command Prompt.
-
- * From within the Visual Studio Command Prompt, you can start Visual Studio using the <<<devenv>>> command.
-
- []
-
- The easiest way to obtain the full PATH is to call <<<set path>>> from the Visual Studio Commmand Prompt of
- the corresponding Visual Studio version. Then use copy-paste to set this PATH permanently to your Environment Variables.
-
- The correct PATH should include the following:
-
- * The .NET framework runtime(s) - all that are needed (<<<C:\Windows\Microsoft.NET\Framework\v4.0.30319>>> and/or <<<C:\WINDOWS\Microsoft.NET\Framework\v3.5>>> and/or
- <<<C:\WINDOWS\Microsoft.NET\Framework\v2.0.50727>>>)
-
- * The .NET SDK - only the latest (<<<C:\Program Files (x86)\Microsoft SDKs\Windows\v7.0A\bin\NETFX 4.0 Tools>>> or <<<C:\Program Files\Microsoft SDKs\Windows\v6.0A\bin>>> or
- <<<C:\Program Files\Microsoft Visual Studio 8\SDK\v2.0\bin>>> or other location if installed aside from
- Visual Studio)
-
- * The Maven <<<bin>>> directory
-
- * The NUnit <<<bin>>> directory if writing NUnit tests
-
- If you are building .NET SDK 3.5 or Visual Studio 2008 projects, you must ensure that the elements for that
- environment are <before> any previous SDK versions.
-
- The additional PATH fragment for Visual Studio 2008 will probably look like the following:
-
-----
-C:\Program Files\Microsoft Visual Studio 9.0\Common7\IDE;C:\Program Files\Microsoft Visual Studio 9.0\VC\BIN;
-C:\Program Files\Microsoft Visual Studio 9.0\Common7\Tools;C:\WINDOWS\Microsoft.NET\Framework\v3.5;
-C:\WINDOWS\Microsoft.NET\Framework\v2.0.50727;C:\Program Files\Microsoft Visual Studio 9.0\VC\VCPackages;
-C:\Program Files\Microsoft SDKs\Windows\v6.0A\bin;
-----
-
- For Visual Studio 2005, it will likely be:
-
-----
-C:\Program Files\Microsoft Visual Studio 8\Common7\IDE;C:\Program Files\Microsoft Visual Studio 8\VC\BIN;
-C:\Program Files\Microsoft Visual Studio 8\Common7\Tools;C:\Program Files\Microsoft Visual Studio 8\Common7\Tools\bin;
-C:\Program Files\Microsoft Visual Studio 8\VC\PlatformSDK\bin;C:\Program Files\Microsoft Visual Studio 8\SDK\v2.0\bin;
-C:\WINDOWS\Microsoft.NET\Framework\v2.0.50727;C:\Program Files\Microsoft Visual Studio 8\VC\VCPackages;
-----
-
-Visual Studio 2008 or 2010
-
- If you only have a newer version, but no Visual Studio 2005 installed, you need to install .NET 2.0 SDK and
- add <<<C:\WINDOWS\Microsoft.NET\Framework\v2.0.50727>>> to the PATH.
-
- Found here: (.NET 2.0 SDK: {{{http://www.microsoft.com/downloads/details.aspx?FamilyID=fe6f2099-b7b4-4f47-a244-c96d69c35dec&displaylang=en} x86}}, {{{http://www.microsoft.com/downloads/en/details.aspx?FamilyID=1AEF6FCE-6E06-4B66-AFE4-9AAD3C835D3D} x64}})
-
-Visual Studio 2010
-
- Add the following to the path:
-
-----
-C:\Windows\Microsoft.NET\Framework\v4.0.30319;
-C:\Program Files (x86)\Microsoft SDKs\Windows\v7.0A\bin\NETFX 4.0 Tools;
-----
Obtaining NPanday
Modified: incubator/npanday/trunk/site/src/site/apt/guide/reference/troubleshooting.apt
URL: http://svn.apache.org/viewvc/incubator/npanday/trunk/site/src/site/apt/guide/reference/troubleshooting.apt?rev=1089117&r1=1089116&r2=1089117&view=diff
==============================================================================
--- incubator/npanday/trunk/site/src/site/apt/guide/reference/troubleshooting.apt (original)
+++ incubator/npanday/trunk/site/src/site/apt/guide/reference/troubleshooting.apt Tue Apr 5 16:31:54 2011
@@ -65,53 +65,15 @@ Version 3.5 SP1
The SDK usually installs automatically when you install Visual Studio, but you might have to download it
separately and put it into the right place.
-** .NET 2.0 SDK (Visual Studio 2005)
+ When NPanday runs the first time, it will try to detect all installed .NET Frameworks and their
+ corresponding SDKs. The findings are stored into <<<%HOME%\.m2\npanday-settings.xml>>>.
- To make sure you have the SDK, navigate to the following directory on your system: either in
- <<<C:\Program Files\Microsoft Visual Studio 8\SDK\v2.0>>> or <<<C:\Program Files\Microsoft.NET\SDK\v2.0>>>
+ After installing a required SDK, delete the file in order to let NPanday generate a fresh one.
- Make sure the \v2.0 directory shown above contains all the pieces of the SDK (for example, the \Bin, \include,
- \CompactFramework, and \Lib directories, among others).
+ Then check if the paths to the targeted .NET Framework and SDK are listed correctly. If not, feel free to
+ file a bug in the projects {{{../../issue-tracking.html} issue tracker}}.
- <<Note>>: These are the default directories and it may be installed elsewhere on your system.
-
- If the directory structure/folder shown above does not exist or is empty, download the SDK from the following
- location: {{http://msdn2.microsoft.com/enus/downloads/default.aspx}}
-
- <<Note>>: It is not necessary to move the SDK after you download it (for example, to the location where Visual Studio
- puts it). Just make sure your PATH environment variable points to its location, as described in the PATH environment
- variable prerequisite information, below.
-
-** .NET 3.5 SDK (Visual Studio 2008)
-
- Verify that your system includes the following .NET Install Root directory:
- <<<C:\WINDOWS\Microsoft.NET\Framework\v3.5>>>
-
- <<Note>>: This directory should be in place by default from your Microsoft installation procedures.
- If it is not, refer to the appropriate Microsoft documentation for help.
-
-** PATH
-
- The PATH environment variable must be set such that it can find the following:
-
- * The csc executable directory, the default path for which is: <<<C:\\WINDOWS\\Microsoft.NET\\Framework\\v3.5>>>
- (or equivalent for .NET 2.0)
-
- * The devenv executable directory, the default path is typically:
- <<<C:\\Program Files\\Microsoft Visual Studio 9.0\\Common7\\IDE>>> (or equivalent for Visual Studio 2005)
-
- []
-
- Typically, the the <<<PATH>>> environment variable will look similar to this:
-
-+------+
-PATH=%PATH%;C:\Program Files\Microsoft Visual Studio 9.0\Common7\IDE;C:\WINDOWS\Microsoft.NET\Framework\v3.5;
-C:\WINDOWS\Microsoft.NET\Framework\v2.0.50727;C:\Program Files\Microsoft Visual Studio 9\SDK\v3.5\bin;
-C:\Program Files\Microsoft Visual Studio 8\SDK\v2.0\bin
-+------+
-
- <<Note>>: To successfully install the NPanday add-in on machines with only Visual Studio 2008 installed, add this in
- the PATH: <<<C:\\Program Files\\Microsoft SDKs\\Windows\\v6.0A\bin>>>.
+ As a workaround, you can execute NPanday in the corresponding command prompt (e.g. Visual Studio 2010 Command Prompt).
* Clearing the Visual Studio Add-in Cache