Skip to content

Commit a423246

Browse files
authored
[build] Update docs and remove xabuild mentions (#8406)
Removes mentions and references to `xabuild` as it is not used as part of .NET Android.
1 parent 0945978 commit a423246

File tree

18 files changed

+8
-687
lines changed

18 files changed

+8
-687
lines changed

.vscode/tasks.json

Lines changed: 0 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -109,30 +109,6 @@
109109
"$msCompile"
110110
]
111111
},
112-
{
113-
"label": "build-sample",
114-
"type": "shell",
115-
"command": "bin/${input:configuration}/bin/xabuild ${input:project} /t:${input:target} /p:Configuration=${input:configuration}",
116-
"group": {
117-
"kind": "build",
118-
"isDefault": true
119-
},
120-
"problemMatcher": [
121-
"$msCompile"
122-
]
123-
},
124-
{
125-
"label": "run-sample",
126-
"type": "shell",
127-
"command": "bin/${input:configuration}/bin/xabuild ${input:project} /restore \"/t:Install;_Run\" /p:AndroidAttachDebugger=${input:attach} /p:Configuration=${input:configuration}",
128-
"group": {
129-
"kind": "build",
130-
"isDefault": true
131-
},
132-
"problemMatcher": [
133-
"$msCompile"
134-
]
135-
},
136112
{
137113
"label": "prepare-sample-under-dotnet",
138114
"type": "shell",

Documentation/README.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,6 @@
3838
# Development Workflow
3939

4040
* [How to add support for a new Android API level](workflow/HowToAddNewApiLevel.md)
41-
* [Using Your Build](workflow/UsingYourBuild.md)
42-
* [OSS Build Artifacts](workflow/OSSBuildArtifacts.md)
4341
* [Development tips and native debugging](workflow/DevelopmentTips.md)
4442
* [Localization](workflow/Localization.md)
4543
* [Custom system properties](workflow/SystemProperties.md)

Documentation/building/unix/instructions.md

Lines changed: 2 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -111,13 +111,6 @@ Several `.nupkg` files will be output in `./bin/Build$(Configuration)/nuget-unsi
111111
Commercial installers will be created by this command if the
112112
`make prepare-external-git-dependencies` command was ran before building.
113113

114-
# Building Unit Tests
115-
116-
Once `make all` or `make jenkins` have completed, the unit tests may
117-
be built with:
118-
119-
make all-tests
120-
121114

122115
# Running Unit Tests
123116

@@ -199,13 +192,6 @@ All `.apk`-based unit test projects provide the following targets:
199192
To run an individual `.apk`-based test project, a package must be built, using the
200193
`SignAndroidPackage` target, installed, and executed.
201194

202-
For example:
203-
204-
$ bin/Debug/bin/xabuild /t:SignAndroidPackage tests/locales/Xamarin.Android.Locale-Tests/Xamarin.Android.Locale-Tests.csproj
205-
$ bin/Debug/bin/xabuild /t:DeployTestApks tests/locales/Xamarin.Android.Locale-Tests/Xamarin.Android.Locale-Tests.csproj
206-
$ bin/Debug/bin/xabuild /t:RunTestApks tests/locales/Xamarin.Android.Locale-Tests/Xamarin.Android.Locale-Tests.csproj
207-
208-
209195
## Running `.apk` Projects with Include/Exclude
210196

211197
If an `.apk`-based unit test uses the NUnit `[Category]` custom attribute, then
@@ -227,11 +213,7 @@ A single NUnit *Test Fixture* -- a class with the `[TestFixture]`
227213
custom attribute -- may be executed instead of executing *all* test fixtures.
228214

229215
The `RunTestApks` target accepts a `TestFixture` MSBuild property
230-
to specify the test fixture class to execute:
231-
232-
$ bin/Debug/bin/xabuild /t:RunTestApks \
233-
/p:TestFixture=Xamarin.Android.LocaleTests.SatelliteAssemblyTests \
234-
tests/locales/Xamarin.Android.Locale-Tests/Xamarin.Android.Locale-Tests.csproj
216+
to specify the test fixture class to execute.
235217

236218
If using `Xamarin.Android.NUnitLite` for projects outside the `xamarin-android`
237219
repository, such as NUnit tests for a custom app, the `RunTestApks` target
@@ -360,7 +342,7 @@ where the "relevant directory" is the target of interest within
360342
`src/mono-runtimes/obj/$(Configuration)`. When `make` has completed,
361343
invoke the `_InstallRuntimes` target so that the updated native libraries
362344
are copied into `bin/$(Configuration)/lib`, which will allow subsequent
363-
top-level `make` and [`xabuild`](../../../tools/xabuild) invocations to use them.
345+
top-level `make` invocations to use them.
364346

365347
For example, to rebuild Mono for armeabi-v7a:
366348

Documentation/building/windows/instructions.md

Lines changed: 3 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -39,17 +39,9 @@ MSBuild version 15 or later is required.
3939

4040
This will clone and build external proprietary components such as `monodroid`.
4141

42-
After the solution has built successfully, you can [use your
43-
build][using-your-build] to build Xamarin.Android application and library
44-
projects. Note that by default `Xamarin.Android.sln` only builds support for
45-
the `$(TargetFrameworkVersion)` specified in the `$(AndroidFrameworkVersion)`
46-
property of the [`Configuration.props`][configprops-main] file (`v12.0` when
47-
this guide was last updated), so you will need to ensure that your application
48-
and library projects are configured to use that particular target framework
49-
version.
42+
After the solution has built successfully, you can use `dotnet-local.cmd` to create and build Android projects.
5043

5144
[developer-prompt]: https://docs.microsoft.com/dotnet/framework/tools/developer-command-prompt-for-vs
52-
[using-your-build]: https://github.com/xamarin/xamarin-android/blob/main/Documentation/workflow/UsingYourBuild.md
5345
[configprops-main]: https://github.com/xamarin/xamarin-android/blob/main/Configuration.props
5446

5547
## Windows Build Notes
@@ -141,10 +133,10 @@ command was ran before building.
141133

142134
# Building Unit Tests
143135

144-
Once `msbuild Xamarin.Android.sln` has completed, the unit tests may
136+
Once `dotnet msbuild Xamarin.Android.sln` has completed, the unit tests may
145137
be built with e.g.:
146138

147-
bin\Debug\bin\xabuild.exe Xamarin.Android-Tests.sln /restore /p:Configuration=Debug /bl:bin\TestDebug\msbuild-build-tests.binlog
139+
dotnet-local.cmd build Xamarin.Android-Tests.sln /restore /p:Configuration=Debug /bl:bin\TestDebug\msbuild-build-tests.binlog
148140

149141
Note that the `Debug` in `bin\Debug` must match the Configuration which was
150142
built. If xamarin-android was built with `msbuild /p:Configuration=Release ...`,
@@ -193,13 +185,6 @@ All `.apk`-based unit test projects provide the following targets:
193185
To run an individual `.apk`-based test project, a package must be built, using the
194186
`SignAndroidPackage` target, installed, and executed.
195187

196-
For example:
197-
198-
$ bin/Debug/bin/xabuild /t:SignAndroidPackage tests/locales/Xamarin.Android.Locale-Tests/Xamarin.Android.Locale-Tests.csproj
199-
$ bin/Debug/bin/xabuild /t:DeployTestApks tests/locales/Xamarin.Android.Locale-Tests/Xamarin.Android.Locale-Tests.csproj
200-
$ bin/Debug/bin/xabuild /t:RunTestApks tests/locales/Xamarin.Android.Locale-Tests/Xamarin.Android.Locale-Tests.csproj
201-
202-
203188
## Running `.apk` Projects with Include/Exclude
204189

205190
If an `.apk`-based unit test uses the NUnit `[Category]` custom attribute, then

Documentation/project-docs/ExploringSources.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,8 +47,6 @@ is used within many of the output directories which are created.
4747
* `Xamarin.Android.Tools.BootstrapTasks`: supplemental build tasks used by
4848
some build-tools. (This should be in `build-tools`; oops.)
4949
* `tools`: Utilities which are built into `bin/$(Configuration)`.
50-
* `xabuild`: MSBuild "wrapper" to easily build Xamarin.Android projects without
51-
requiring system-wide installation of Xamarin.Android
5250

5351
<a name="tfv" />
5452

Documentation/workflow/OSSBuildArtifacts.md

Lines changed: 0 additions & 188 deletions
This file was deleted.

0 commit comments

Comments
 (0)