From 92cac0fd6fd22eb160abaf3f88353493b026dcca Mon Sep 17 00:00:00 2001 From: Stefan Bodewig Date: Fri, 28 Nov 2003 11:39:44 +0000 Subject: [PATCH] Add documentation git-svn-id: https://svn.apache.org/repos/asf/ant/core/trunk@275716 13f79535-47bb-0310-9956-ffa450edef68 --- proposal/sandbox/dotnet/docs/dotnetexec.html | 32 +++++ proposal/sandbox/dotnet/docs/index.html | 119 +++++++++++++++++++ proposal/sandbox/dotnet/docs/msbuild.html | 110 +++++++++++++++++ proposal/sandbox/dotnet/docs/nant.html | 108 +++++++++++++++++ 4 files changed, 369 insertions(+) create mode 100644 proposal/sandbox/dotnet/docs/dotnetexec.html create mode 100644 proposal/sandbox/dotnet/docs/index.html create mode 100644 proposal/sandbox/dotnet/docs/msbuild.html create mode 100644 proposal/sandbox/dotnet/docs/nant.html diff --git a/proposal/sandbox/dotnet/docs/dotnetexec.html b/proposal/sandbox/dotnet/docs/dotnetexec.html new file mode 100644 index 000000000..2a4bdfb7b --- /dev/null +++ b/proposal/sandbox/dotnet/docs/dotnetexec.html @@ -0,0 +1,32 @@ + + + + DotNetExec Task + + + +

DotNetExec

+ +

Description

+ +

Executes a .NET assembly that's on your PATH or pointed to + directly by the executable attribute.

+ +

This task is an extension of Ant's exec + task and supports all attributes and nested child elements of that + task. Use the executable attribute to specify the name of the + assembly (including the extension).

+ +

This task allows you to choose the .NET framework via the + vm attribute. The default value is "microsoft" on + Windows and "mono" on all other platforms. "microsoft" is a magic + name that means "run the assembly as executable directly" - this + may also work for Mono on Linux systems with the binfmt feature + described in the Mono FAQ.

+ +
+

Copyright © 2003 Apache Software Foundation. All rights Reserved.

+ + \ No newline at end of file diff --git a/proposal/sandbox/dotnet/docs/index.html b/proposal/sandbox/dotnet/docs/index.html new file mode 100644 index 000000000..cb4b61ac8 --- /dev/null +++ b/proposal/sandbox/dotnet/docs/index.html @@ -0,0 +1,119 @@ + + + + Dotnet Ant Library + + + +

Introduction

+ +

This is a library of Ant tasks that support using .NET + executables accross different platforms and in particular support + using common .NET development tools like NAnt from within Ant.

+ +

Requirements

+ +

The current version will only work for a CVS build of Ant + created from CVS HEAD (i.e. after Ant 1.6's feature freeze) of + 2003-11-27 or later. A version that can work with Ant 1.6 may be + provided at a later stage. This task library is never going to + work with Ant < 1.6.

+ +

Installation

+ +

If you are building this from sources, run the antlib target + and you'll get a file dotnet.jar. If you've + downloaded dotnet.jar, you are already ready.

+ +

There are several ways to use the tasks:

+ + + +

Tasks

+ + + +
+

Copyright © 2003 Apache Software Foundation. All rights Reserved.

+ + diff --git a/proposal/sandbox/dotnet/docs/msbuild.html b/proposal/sandbox/dotnet/docs/msbuild.html new file mode 100644 index 000000000..51b839ae4 --- /dev/null +++ b/proposal/sandbox/dotnet/docs/msbuild.html @@ -0,0 +1,110 @@ + + + + MSBuild Task + + + +

MSBuild

+ +

Description

+ +

Runs the MSBuild build tool presented at the 2003 PDC. This + task is completely untested as the developers have no access to + the tool, it has been implemented by looking at the docs only.

+ +

You can either use an existing build file or nest a build file + (snippet) as a child into the task. If you don't specify either, + MSBuild's default build file search algorithm will apply. Nesting + build file snippets is most probably not working correctly.

+ +

Parameters

+ + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
buildfileExternal build file to invoke MSBuild on.No.
vmSame as dotnetexec's vm attribute. + Specify the framework to use.No.
+ +

Parameters specified as nested elements

+

target

+ +

target has a single required attribute name - + specifies a target to be run.

+ +

property

+ +

property has two required attributes. name and + value that specify name and value of a property that is to be + defined in the MSBuild invocation.

+ +

build

+ +

This element allows no attributes. You can nest a MSBuild build + file into it and MSBuild will be executed on that. You can also nest + a build file snippet instead and Ant will wrap the necessary MSBuild + <Project> around it.

+ +

Examples

+ +

Let MSBuild search for a *.proj file in the (Ant) project's base + directory and execute the default target in it:

+ + 
<msbuild/>
+ +

Let MSBuild execute the targets named foo and bar in the build + file msbuild.proj in Ant's basedir and pass the property + /property:test=testvalue to it:

+ + 
+      <msbuild buildfile="msbuild.proj">
+        <target name="foo"/>
+        <target name="bar"/>
+        <property name="test" value="testvalue"/>
+      </msbuild>
+
+ +

Define a build file embeded into the task, let MSBuild execute the + echo target of that build file.

+ + 
+      <msbuild>
+        <target name="echo">
+        <build>
+          <Project DefaultTargets="empty">
+            <Target Name="empty"/>
+            <Target Name="echo">
+              <Task Name="Echo" Message="This is MSBuild"/>
+            </Target>
+          </Project>
+        </build>
+      </msbuild>
+
+ +

Run MSBuild's Echo task (if there actually is one):

+ + 
+      <msbuild>
+        <build>
+          <Task Name="Echo" Message="This is MSBuild"/>
+        </build>
+      </msbuild>
+
+ +
+

Copyright © 2003 Apache Software Foundation. All rights Reserved.

+ + \ No newline at end of file diff --git a/proposal/sandbox/dotnet/docs/nant.html b/proposal/sandbox/dotnet/docs/nant.html new file mode 100644 index 000000000..94c072835 --- /dev/null +++ b/proposal/sandbox/dotnet/docs/nant.html @@ -0,0 +1,108 @@ + + + + NAnt Task + + + +

NAnt

+ +

Description

+ +

Runs the NAnt build + tool.

+ +

You can either use an existing build file or nest a build file + (snippet) as a child into the task. If you don't specify either, + NAnt's default build file search algorithm will apply.

+ +

Parameters

+ + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
buildfileExternal build file to invoke NAnt on.No.
vmSame as dotnetexec's vm attribute. + Specify the framework to use.No.
+ +

Parameters specified as nested elements

+

target

+ +

target has a single required attribute name - + specifies a target to be run.

+ +

property

+ +

property has two required attributes. name and + value that specify name and value of a property that is to be + defined in the NAnt invocation.

+ +

build

+ +

This element allows no attributes. You can nest a NAnt build + file into it and NAnt will be executed on that. You can also nest + a build file snippet instead and Ant will wrap the necessary NAnt + <project> around it.

+ +

Examples

+ +

Let NAnt search for a *.build file in the (Ant) project's base + directory and execute the default target in it:

+ + 
<nant/>
+ +

Let NAnt execute the targets named foo and bar in the build + file nant.build in Ant's basedir and pass the property + -D:test=testvalue to it:

+ + 
+      <nant buildfile="nant.build">
+        <target name="foo"/>
+        <target name="bar"/>
+        <property name="test" value="testvalue"/>
+      </nant>
+
+ +

Define a build file embeded into the task, let NAnt execute the + echo target of that build file.

+ + 
+      <nant>
+        <target name="echo">
+        <build>
+          <project basedir="." default="empty">
+            <target name="empty"/>
+            <target name="echo">
+              <echo message="this is NAnt"/>
+            </target>
+          </project>
+        </build>
+      </nant>
+
+ +

Run NAnt's echo task:

+ + 
+      <nant>
+        <build>
+          <echo message="this is NAnt"/>
+        </build>
+      </nant>
+
+ +
+

Copyright © 2003 Apache Software Foundation. All rights Reserved.

+ + \ No newline at end of file