Skip to content

[docs] Modernize building documentation for dotnet/android #10570

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 30, 2025
Merged

[docs] Modernize building documentation for dotnet/android #10570

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dd93951
Initial plan
Copilot Oct 30, 2025
5f921ec
Update Unix build documentation to match Windows changes
Copilot Oct 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions Documentation/building/unix/dependencies.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ to provide install instructions to obtain the missing dependency, e.g.:
## Homebrew

[Homebrew](https://brew.sh) must be installed and available via `$PATH` in
order to provision xamarin-android.
order to provision dotnet/android.

When building on Apple Silicon (arm64) machines, use the **arch**(1) command to
allow Homebrew to be installed:
Expand Down Expand Up @@ -88,7 +88,7 @@ On macOS, autotools are should be used from `brew`, and may be installed via:

## Android NDK, SDK

*Note*: A xamarin-android checkout maintains *its own* Android NDK + SDK
*Note*: A dotnet/android checkout maintains *its own* Android NDK + SDK
to ensure consistent builds and build behavior, permitting reproducible
builds and providing greater flexibility around when we need to perform
Android SDK + NDK updates. The Android SDK and NDK are maintained by default
Expand All @@ -101,7 +101,7 @@ via two directories in your home directory:

Developers may use these directories for their own use, but *please* **DO NOT**
update or alter the contents of the `$(AndroidToolchainDirectory)`, as that may
prevent the xamarin-android build from working as expected.
prevent the dotnet/android build from working as expected.

The files that will be downloaded and installed are controlled by
[build-tools/android-toolchain/android-toolchain.projitems][android-toolchain.projitems]
Expand Down
12 changes: 6 additions & 6 deletions Documentation/building/unix/instructions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ can also be used by setting the `$(MSBUILD)` make variable to `xbuild`.

1. Install the [build dependencies](dependencies.md).

2. Clone the xamarin-android repo:
2. Clone the dotnet/android repo:

git clone https://github.com/xamarin/xamarin-android.git
git clone https://github.com/dotnet/android.git

3. Navigate to the `xamarin-android` directory
3. Navigate to the `android` directory

4. (Optional) [Configure the build](../configuration.md).

Expand Down Expand Up @@ -77,7 +77,7 @@ Create a new project with `./dotnet-local.sh new android`:
```xml
<Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup>
<TargetFramework>net6.0-android</TargetFramework>
<TargetFramework>net10.0-android</TargetFramework>
<OutputType>Exe</OutputType>
</PropertyGroup>
</Project>
Expand Down Expand Up @@ -115,7 +115,7 @@ Commercial installers will be created by this command if the
# Running Unit Tests


The `xamarin-android` repo contains several unit tests:
The `dotnet/android` repo contains several unit tests:

* NUnit-based unit tests, for stand-alone assemblies and utilities.

Expand Down Expand Up @@ -215,7 +215,7 @@ custom attribute -- may be executed instead of executing *all* test fixtures.
The `RunTestApks` target accepts a `TestFixture` MSBuild property
to specify the test fixture class to execute.

If using `Xamarin.Android.NUnitLite` for projects outside the `xamarin-android`
If using `Xamarin.Android.NUnitLite` for projects outside the `dotnet/android`
repository, such as NUnit tests for a custom app, the `RunTestApks` target
will not exist. In such scenarios, the [`adb shell am`][adb-shell-am]
`instrument` command can be used instead. It follows the format:
Expand Down
Loading