Add more complete linux build instructions

[agocke]

I'm trying to make it slightly easier to install the needed requirements, and add some validation if a user hasn't installed the requirements.

Also, I validated that these instructions still work for Ubuntu 24.04 and have noted that other installs are only community-supported.

[am11]

I'm using eng/install-native-dependencies.sh in Debian/Ubuntu, Alpine and macOS. It works well. Do we need another mechanism; another list to maintain?

[dotnet-policy-service]

Tagging subscribers to this area: @dotnet/runtime-infrastructure
See info in area-owners.md if you want to be subscribed.

[agocke]

I'm using eng/install-native-dependencies.sh in Debian/Ubuntu, Alpine and macOS. It works well. Do we need another mechanism; another list to maintain?

I didn't know about that entry point. I'm happy to integrate with that.

[am11]

I'm happy to integrate with that.

I think it would be good to just point to the (self-documenting) helper script. On fresh machine (baremetal, cloud VM, CI, container) it installs the prereqs in a few second enough to build all default subsets.

# replace 'ubuntu' with 'alpine' without changing the steps
$ docker run --rm -v$(pwd):/runtime -w /runtime --platform linux/arm64/v8 ubuntu sh -c '	eng/install-native-dependencies.sh;	./build.sh -c Release'

[agocke]

I think it would be good to just point to the (self-documenting) helper script

I'm fine with this but the lists are currently inconsistent.

Our docs:

build-essential
clang
cmake
curl
git
libicu-dev
libkrb5-dev
liblttng-ust-dev
libssl-dev
lld
lldb
llvm
ninja-build
python-is-python3
zlib1g-dev

Script

build-essential
clang
cmake
gettext
libicu-dev
libkrb5-dev
liblldb-dev
liblttng-ust-dev
libssl-dev
libunwind8-dev
lldb
llvm
locales
zlib1g-dev

Diff:

build-essential
clang
cmake
-curl-git+gettext
libicu-dev
libkrb5-dev
+liblldb-dev
liblttng-ust-dev
libssl-dev
-lld+libunwind8-dev
lldb
llvm
-ninja-build-python-is-python3+locales
zlib1g-dev

Thoughts? I personally think ninja-build should be in there even if it's not strictly necessary.

[am11]

Yup, agreed.

• ninja-build can be added in both debian and alpine (it has the same package name).
• curl and python3 on debian, and python3 on alpine are implicitly installed (but we can explicitly specify them)
• lld can be added in both debian and alpine.
• git is not strictly needed (but can be added).

[agocke]

OK, I took the most conservative approach of just taking the union, since I'm not sure what's actually necessary.

Also, docs have been updated to point to the shell script.

[am11]

We are already testing it in gen-buildsys.sh. Also why is this linux only?

[agocke]

This check is happening earlier and is clearer. Ideally I'd like this check to happen even earlier, but I think that belongs in another PR.

[am11]

We used to have an upfront check for a while and it was deleted in #39044.

I think if we are bringing it back, we should do it for all platforms, not just linux. CMake is needed on all platforms alike.

[agocke]

And this is linux-only because I think checking for pkg-config is better on Mac. What we're looking for is the thing least-likely to have been installed by-default.

[am11]

If we use else instead of elif, that will cover mac+linux+{everything-else}:

else# Check presence of cmake on the pathcommand -v cmake 2>/dev/null || { echo>&2"Please install cmake before running this script, see https://github.com/dotnet/runtime/tree/main/docs/workflow/requirements";exit 1; }

User can then read {platform}-instructions.md.

[am11]

This check is happening earlier and is clearer.

It is rendering this check redundant which can be deleted:

runtime/eng/native/gen-buildsys.sh

Lines 87 to 88 in ed339b3

	if! cmake_command=$(command -v cmake);then
	echo"CMake was not found in PATH."

[agocke]

We used to have an upfront check for a while and it was deleted in #39044.

Not quite the same -- that's a version check, here I'm just doing a basic check to see if it exists at all. The intent is to catch people who have not installed the prereqs at all, not people who have misconfigured prereqs.

[jkotas]

/eng/debian-reqs.txt no longer exists

[agocke]

Ah, that's right. Now I remembered why I structured it like this: so that users could easily see exactly what they were installing without having to scan a bash script and also without having the risk of the list going out of date. I prefer my previous solution. I'm going to revert the last commit.

[am11]

Suggested change

	xargs apt-get install -y < eng/debian-reqs.txt
	apt install -y build-essential gettext locales cmake llvm clang lldb liblldb-dev libunwind8-dev libicu-dev liblttng-ust-dev \
	libssl-dev libkrb5-dev zlib1g-dev

lets keep them separate then. I was proposing to deduplicate it the other way around. Makes less sense to change it for one distro leaving others on the table.

[agocke]

Could you elaborate? Ubuntu is the only Linux dev platform we "officially" support developing on. Wouldn't it make sense to go through more work to make it a good "reference" platform?

[am11]

This script is idempotent in nature; as it just calls package managers of that nature (worst case: print "package is already installed"; exit 0). It supports multiple platforms and has room for more. In the context of this script, there is no official precedence. Currently, it is providing support for Ubuntu, Alpine and Apple platforms.

The suggestion above was to just point people to the usage of this self-documenting script regardless of the distro. If/when someone will hit Unsupported distro. distro: $ID branch, they will likely get encouraged to add support for their platform.

Unless we think listing the dependencies for Debian/Ubuntu (without further description) separately is meaningful, IMO, it's better to keep it simple. On the other hand, seeing that we have eng/Brewfile also separated (as opposed to brew install <the whole grocery list>), we can probably live with this separate file as well. 😅

If we are going to use the separate version, please make sure to use absolute path (so it can be called from any location as before): agocke/runtime@automated-workflow...am11:runtime:patch-35.

[agocke]

Yeah brewfile was what I was copying in spirit. I'm hoping this is useful for others -- if it's not we can fold back into the script.

[agocke]

I'm trying to make it slightly easier to install the needed requirements, and add some validation if a user hasn't installed the requirements.

Also, I validated that these instructions still work for Ubuntu 24.04 and have noted that other installs are only community-supported.

[am11]

I'm using eng/install-native-dependencies.sh in Debian/Ubuntu, Alpine and macOS. It works well. Do we need another mechanism; another list to maintain?

[dotnet-policy-service]

Tagging subscribers to this area: @dotnet/runtime-infrastructure
See info in area-owners.md if you want to be subscribed.

[agocke]

I'm using eng/install-native-dependencies.sh in Debian/Ubuntu, Alpine and macOS. It works well. Do we need another mechanism; another list to maintain?

I didn't know about that entry point. I'm happy to integrate with that.

[am11]

I'm happy to integrate with that.

I think it would be good to just point to the (self-documenting) helper script. On fresh machine (baremetal, cloud VM, CI, container) it installs the prereqs in a few second enough to build all default subsets.

# replace 'ubuntu' with 'alpine' without changing the steps
$ docker run --rm -v$(pwd):/runtime -w /runtime --platform linux/arm64/v8 ubuntu sh -c '	eng/install-native-dependencies.sh;	./build.sh -c Release'

[agocke]

I think it would be good to just point to the (self-documenting) helper script

I'm fine with this but the lists are currently inconsistent.

Our docs:

build-essential
clang
cmake
curl
git
libicu-dev
libkrb5-dev
liblttng-ust-dev
libssl-dev
lld
lldb
llvm
ninja-build
python-is-python3
zlib1g-dev

Script

build-essential
clang
cmake
gettext
libicu-dev
libkrb5-dev
liblldb-dev
liblttng-ust-dev
libssl-dev
libunwind8-dev
lldb
llvm
locales
zlib1g-dev

Diff:

build-essential
clang
cmake
-curl-git+gettext
libicu-dev
libkrb5-dev
+liblldb-dev
liblttng-ust-dev
libssl-dev
-lld+libunwind8-dev
lldb
llvm
-ninja-build-python-is-python3+locales
zlib1g-dev

Thoughts? I personally think ninja-build should be in there even if it's not strictly necessary.

[am11]

Yup, agreed.

• ninja-build can be added in both debian and alpine (it has the same package name).
• curl and python3 on debian, and python3 on alpine are implicitly installed (but we can explicitly specify them)
• lld can be added in both debian and alpine.
• git is not strictly needed (but can be added).

[agocke]

OK, I took the most conservative approach of just taking the union, since I'm not sure what's actually necessary.

Also, docs have been updated to point to the shell script.

[am11]

We are already testing it in gen-buildsys.sh. Also why is this linux only?

[agocke]

This check is happening earlier and is clearer. Ideally I'd like this check to happen even earlier, but I think that belongs in another PR.

[am11]

We used to have an upfront check for a while and it was deleted in #39044.

I think if we are bringing it back, we should do it for all platforms, not just linux. CMake is needed on all platforms alike.

[agocke]

And this is linux-only because I think checking for pkg-config is better on Mac. What we're looking for is the thing least-likely to have been installed by-default.

[am11]

If we use else instead of elif, that will cover mac+linux+{everything-else}:

else# Check presence of cmake on the pathcommand -v cmake 2>/dev/null || { echo>&2"Please install cmake before running this script, see https://github.com/dotnet/runtime/tree/main/docs/workflow/requirements";exit 1; }

User can then read {platform}-instructions.md.

[am11]

This check is happening earlier and is clearer.

It is rendering this check redundant which can be deleted:

runtime/eng/native/gen-buildsys.sh

Lines 87 to 88 in ed339b3

	if! cmake_command=$(command -v cmake);then
	echo"CMake was not found in PATH."

[agocke]

We used to have an upfront check for a while and it was deleted in #39044.

Not quite the same -- that's a version check, here I'm just doing a basic check to see if it exists at all. The intent is to catch people who have not installed the prereqs at all, not people who have misconfigured prereqs.

[jkotas]

/eng/debian-reqs.txt no longer exists

[agocke]

Ah, that's right. Now I remembered why I structured it like this: so that users could easily see exactly what they were installing without having to scan a bash script and also without having the risk of the list going out of date. I prefer my previous solution. I'm going to revert the last commit.

[am11]

Suggested change

	xargs apt-get install -y < eng/debian-reqs.txt
	apt install -y build-essential gettext locales cmake llvm clang lldb liblldb-dev libunwind8-dev libicu-dev liblttng-ust-dev \
	libssl-dev libkrb5-dev zlib1g-dev

lets keep them separate then. I was proposing to deduplicate it the other way around. Makes less sense to change it for one distro leaving others on the table.

[agocke]

Could you elaborate? Ubuntu is the only Linux dev platform we "officially" support developing on. Wouldn't it make sense to go through more work to make it a good "reference" platform?

[am11]

This script is idempotent in nature; as it just calls package managers of that nature (worst case: print "package is already installed"; exit 0). It supports multiple platforms and has room for more. In the context of this script, there is no official precedence. Currently, it is providing support for Ubuntu, Alpine and Apple platforms.

The suggestion above was to just point people to the usage of this self-documenting script regardless of the distro. If/when someone will hit Unsupported distro. distro: $ID branch, they will likely get encouraged to add support for their platform.

Unless we think listing the dependencies for Debian/Ubuntu (without further description) separately is meaningful, IMO, it's better to keep it simple. On the other hand, seeing that we have eng/Brewfile also separated (as opposed to brew install <the whole grocery list>), we can probably live with this separate file as well. 😅

If we are going to use the separate version, please make sure to use absolute path (so it can be called from any location as before): agocke/runtime@automated-workflow...am11:runtime:patch-35.

[agocke]

Yeah brewfile was what I was copying in spirit. I'm hoping this is useful for others -- if it's not we can fold back into the script.

[agocke]

I'm trying to make it slightly easier to install the needed requirements, and add some validation if a user hasn't installed the requirements.

Also, I validated that these instructions still work for Ubuntu 24.04 and have noted that other installs are only community-supported.

[am11]

I'm using eng/install-native-dependencies.sh in Debian/Ubuntu, Alpine and macOS. It works well. Do we need another mechanism; another list to maintain?

[dotnet-policy-service]

Tagging subscribers to this area: @dotnet/runtime-infrastructure
See info in area-owners.md if you want to be subscribed.

[agocke]

I'm using eng/install-native-dependencies.sh in Debian/Ubuntu, Alpine and macOS. It works well. Do we need another mechanism; another list to maintain?

I didn't know about that entry point. I'm happy to integrate with that.

[am11]

I'm happy to integrate with that.

I think it would be good to just point to the (self-documenting) helper script. On fresh machine (baremetal, cloud VM, CI, container) it installs the prereqs in a few second enough to build all default subsets.

# replace 'ubuntu' with 'alpine' without changing the steps
$ docker run --rm -v$(pwd):/runtime -w /runtime --platform linux/arm64/v8 ubuntu sh -c '	eng/install-native-dependencies.sh;	./build.sh -c Release'

[agocke]

I think it would be good to just point to the (self-documenting) helper script

I'm fine with this but the lists are currently inconsistent.

Our docs:

build-essential
clang
cmake
curl
git
libicu-dev
libkrb5-dev
liblttng-ust-dev
libssl-dev
lld
lldb
llvm
ninja-build
python-is-python3
zlib1g-dev

Script

build-essential
clang
cmake
gettext
libicu-dev
libkrb5-dev
liblldb-dev
liblttng-ust-dev
libssl-dev
libunwind8-dev
lldb
llvm
locales
zlib1g-dev

Diff:

build-essential
clang
cmake
-curl-git+gettext
libicu-dev
libkrb5-dev
+liblldb-dev
liblttng-ust-dev
libssl-dev
-lld+libunwind8-dev
lldb
llvm
-ninja-build-python-is-python3+locales
zlib1g-dev

Thoughts? I personally think ninja-build should be in there even if it's not strictly necessary.

[am11]

Yup, agreed.

• ninja-build can be added in both debian and alpine (it has the same package name).
• curl and python3 on debian, and python3 on alpine are implicitly installed (but we can explicitly specify them)
• lld can be added in both debian and alpine.
• git is not strictly needed (but can be added).

[agocke]

OK, I took the most conservative approach of just taking the union, since I'm not sure what's actually necessary.

Also, docs have been updated to point to the shell script.

[am11]

We are already testing it in gen-buildsys.sh. Also why is this linux only?

[agocke]

This check is happening earlier and is clearer. Ideally I'd like this check to happen even earlier, but I think that belongs in another PR.

[am11]

We used to have an upfront check for a while and it was deleted in #39044.

I think if we are bringing it back, we should do it for all platforms, not just linux. CMake is needed on all platforms alike.

[agocke]

And this is linux-only because I think checking for pkg-config is better on Mac. What we're looking for is the thing least-likely to have been installed by-default.

[am11]

If we use else instead of elif, that will cover mac+linux+{everything-else}:

else# Check presence of cmake on the pathcommand -v cmake 2>/dev/null || { echo>&2"Please install cmake before running this script, see https://github.com/dotnet/runtime/tree/main/docs/workflow/requirements";exit 1; }

User can then read {platform}-instructions.md.

[am11]

This check is happening earlier and is clearer.

It is rendering this check redundant which can be deleted:

runtime/eng/native/gen-buildsys.sh

Lines 87 to 88 in ed339b3

	if! cmake_command=$(command -v cmake);then
	echo"CMake was not found in PATH."

[agocke]

We used to have an upfront check for a while and it was deleted in #39044.

Not quite the same -- that's a version check, here I'm just doing a basic check to see if it exists at all. The intent is to catch people who have not installed the prereqs at all, not people who have misconfigured prereqs.

[jkotas]

/eng/debian-reqs.txt no longer exists

[agocke]

Ah, that's right. Now I remembered why I structured it like this: so that users could easily see exactly what they were installing without having to scan a bash script and also without having the risk of the list going out of date. I prefer my previous solution. I'm going to revert the last commit.

[am11]

Suggested change

	xargs apt-get install -y < eng/debian-reqs.txt
	apt install -y build-essential gettext locales cmake llvm clang lldb liblldb-dev libunwind8-dev libicu-dev liblttng-ust-dev \
	libssl-dev libkrb5-dev zlib1g-dev

lets keep them separate then. I was proposing to deduplicate it the other way around. Makes less sense to change it for one distro leaving others on the table.

[agocke]

Could you elaborate? Ubuntu is the only Linux dev platform we "officially" support developing on. Wouldn't it make sense to go through more work to make it a good "reference" platform?

[am11]

This script is idempotent in nature; as it just calls package managers of that nature (worst case: print "package is already installed"; exit 0). It supports multiple platforms and has room for more. In the context of this script, there is no official precedence. Currently, it is providing support for Ubuntu, Alpine and Apple platforms.

The suggestion above was to just point people to the usage of this self-documenting script regardless of the distro. If/when someone will hit Unsupported distro. distro: $ID branch, they will likely get encouraged to add support for their platform.

Unless we think listing the dependencies for Debian/Ubuntu (without further description) separately is meaningful, IMO, it's better to keep it simple. On the other hand, seeing that we have eng/Brewfile also separated (as opposed to brew install <the whole grocery list>), we can probably live with this separate file as well. 😅

If we are going to use the separate version, please make sure to use absolute path (so it can be called from any location as before): agocke/runtime@automated-workflow...am11:runtime:patch-35.

[agocke]

Yeah brewfile was what I was copying in spirit. I'm hoping this is useful for others -- if it's not we can fold back into the script.

[agocke]

I'm trying to make it slightly easier to install the needed requirements, and add some validation if a user hasn't installed the requirements.

Also, I validated that these instructions still work for Ubuntu 24.04 and have noted that other installs are only community-supported.

[am11]

I'm using eng/install-native-dependencies.sh in Debian/Ubuntu, Alpine and macOS. It works well. Do we need another mechanism; another list to maintain?

[dotnet-policy-service]

Tagging subscribers to this area: @dotnet/runtime-infrastructure
See info in area-owners.md if you want to be subscribed.

[agocke]

I'm using eng/install-native-dependencies.sh in Debian/Ubuntu, Alpine and macOS. It works well. Do we need another mechanism; another list to maintain?

I didn't know about that entry point. I'm happy to integrate with that.

[am11]

I'm happy to integrate with that.

I think it would be good to just point to the (self-documenting) helper script. On fresh machine (baremetal, cloud VM, CI, container) it installs the prereqs in a few second enough to build all default subsets.

# replace 'ubuntu' with 'alpine' without changing the steps
$ docker run --rm -v$(pwd):/runtime -w /runtime --platform linux/arm64/v8 ubuntu sh -c '	eng/install-native-dependencies.sh;	./build.sh -c Release'

[agocke]

I think it would be good to just point to the (self-documenting) helper script

I'm fine with this but the lists are currently inconsistent.

Our docs:

build-essential
clang
cmake
curl
git
libicu-dev
libkrb5-dev
liblttng-ust-dev
libssl-dev
lld
lldb
llvm
ninja-build
python-is-python3
zlib1g-dev

Script

build-essential
clang
cmake
gettext
libicu-dev
libkrb5-dev
liblldb-dev
liblttng-ust-dev
libssl-dev
libunwind8-dev
lldb
llvm
locales
zlib1g-dev

Diff:

build-essential
clang
cmake
-curl-git+gettext
libicu-dev
libkrb5-dev
+liblldb-dev
liblttng-ust-dev
libssl-dev
-lld+libunwind8-dev
lldb
llvm
-ninja-build-python-is-python3+locales
zlib1g-dev

Thoughts? I personally think ninja-build should be in there even if it's not strictly necessary.

[am11]

Yup, agreed.

• ninja-build can be added in both debian and alpine (it has the same package name).
• curl and python3 on debian, and python3 on alpine are implicitly installed (but we can explicitly specify them)
• lld can be added in both debian and alpine.
• git is not strictly needed (but can be added).

[agocke]

OK, I took the most conservative approach of just taking the union, since I'm not sure what's actually necessary.

Also, docs have been updated to point to the shell script.

[am11]

We are already testing it in gen-buildsys.sh. Also why is this linux only?

[agocke]

This check is happening earlier and is clearer. Ideally I'd like this check to happen even earlier, but I think that belongs in another PR.

[am11]

We used to have an upfront check for a while and it was deleted in #39044.

I think if we are bringing it back, we should do it for all platforms, not just linux. CMake is needed on all platforms alike.

[agocke]

And this is linux-only because I think checking for pkg-config is better on Mac. What we're looking for is the thing least-likely to have been installed by-default.

[am11]

If we use else instead of elif, that will cover mac+linux+{everything-else}:

else# Check presence of cmake on the pathcommand -v cmake 2>/dev/null || { echo>&2"Please install cmake before running this script, see https://github.com/dotnet/runtime/tree/main/docs/workflow/requirements";exit 1; }

User can then read {platform}-instructions.md.

[am11]

This check is happening earlier and is clearer.

It is rendering this check redundant which can be deleted:

runtime/eng/native/gen-buildsys.sh

Lines 87 to 88 in ed339b3

	if! cmake_command=$(command -v cmake);then
	echo"CMake was not found in PATH."

[agocke]

We used to have an upfront check for a while and it was deleted in #39044.

Not quite the same -- that's a version check, here I'm just doing a basic check to see if it exists at all. The intent is to catch people who have not installed the prereqs at all, not people who have misconfigured prereqs.

[jkotas]

/eng/debian-reqs.txt no longer exists

[agocke]

Ah, that's right. Now I remembered why I structured it like this: so that users could easily see exactly what they were installing without having to scan a bash script and also without having the risk of the list going out of date. I prefer my previous solution. I'm going to revert the last commit.

[am11]

Suggested change

	xargs apt-get install -y < eng/debian-reqs.txt
	apt install -y build-essential gettext locales cmake llvm clang lldb liblldb-dev libunwind8-dev libicu-dev liblttng-ust-dev \
	libssl-dev libkrb5-dev zlib1g-dev

lets keep them separate then. I was proposing to deduplicate it the other way around. Makes less sense to change it for one distro leaving others on the table.

[agocke]

Could you elaborate? Ubuntu is the only Linux dev platform we "officially" support developing on. Wouldn't it make sense to go through more work to make it a good "reference" platform?

[am11]

This script is idempotent in nature; as it just calls package managers of that nature (worst case: print "package is already installed"; exit 0). It supports multiple platforms and has room for more. In the context of this script, there is no official precedence. Currently, it is providing support for Ubuntu, Alpine and Apple platforms.

The suggestion above was to just point people to the usage of this self-documenting script regardless of the distro. If/when someone will hit Unsupported distro. distro: $ID branch, they will likely get encouraged to add support for their platform.

Unless we think listing the dependencies for Debian/Ubuntu (without further description) separately is meaningful, IMO, it's better to keep it simple. On the other hand, seeing that we have eng/Brewfile also separated (as opposed to brew install <the whole grocery list>), we can probably live with this separate file as well. 😅

If we are going to use the separate version, please make sure to use absolute path (so it can be called from any location as before): agocke/runtime@automated-workflow...am11:runtime:patch-35.

[agocke]

Yeah brewfile was what I was copying in spirit. I'm hoping this is useful for others -- if it's not we can fold back into the script.

[agocke]

I'm trying to make it slightly easier to install the needed requirements, and add some validation if a user hasn't installed the requirements.

Also, I validated that these instructions still work for Ubuntu 24.04 and have noted that other installs are only community-supported.

[am11]

I'm using eng/install-native-dependencies.sh in Debian/Ubuntu, Alpine and macOS. It works well. Do we need another mechanism; another list to maintain?

[dotnet-policy-service]

Tagging subscribers to this area: @dotnet/runtime-infrastructure
See info in area-owners.md if you want to be subscribed.

[agocke]

I'm using eng/install-native-dependencies.sh in Debian/Ubuntu, Alpine and macOS. It works well. Do we need another mechanism; another list to maintain?

I didn't know about that entry point. I'm happy to integrate with that.

[am11]

I'm happy to integrate with that.

I think it would be good to just point to the (self-documenting) helper script. On fresh machine (baremetal, cloud VM, CI, container) it installs the prereqs in a few second enough to build all default subsets.

# replace 'ubuntu' with 'alpine' without changing the steps
$ docker run --rm -v$(pwd):/runtime -w /runtime --platform linux/arm64/v8 ubuntu sh -c '	eng/install-native-dependencies.sh;	./build.sh -c Release'

[agocke]

I think it would be good to just point to the (self-documenting) helper script

I'm fine with this but the lists are currently inconsistent.

Our docs:

build-essential
clang
cmake
curl
git
libicu-dev
libkrb5-dev
liblttng-ust-dev
libssl-dev
lld
lldb
llvm
ninja-build
python-is-python3
zlib1g-dev

Script

build-essential
clang
cmake
gettext
libicu-dev
libkrb5-dev
liblldb-dev
liblttng-ust-dev
libssl-dev
libunwind8-dev
lldb
llvm
locales
zlib1g-dev

Diff:

build-essential
clang
cmake
-curl-git+gettext
libicu-dev
libkrb5-dev
+liblldb-dev
liblttng-ust-dev
libssl-dev
-lld+libunwind8-dev
lldb
llvm
-ninja-build-python-is-python3+locales
zlib1g-dev

Thoughts? I personally think ninja-build should be in there even if it's not strictly necessary.

[am11]

Yup, agreed.

• ninja-build can be added in both debian and alpine (it has the same package name).
• curl and python3 on debian, and python3 on alpine are implicitly installed (but we can explicitly specify them)
• lld can be added in both debian and alpine.
• git is not strictly needed (but can be added).

[agocke]

OK, I took the most conservative approach of just taking the union, since I'm not sure what's actually necessary.

Also, docs have been updated to point to the shell script.

[am11]

We are already testing it in gen-buildsys.sh. Also why is this linux only?

[agocke]

This check is happening earlier and is clearer. Ideally I'd like this check to happen even earlier, but I think that belongs in another PR.

[am11]

We used to have an upfront check for a while and it was deleted in #39044.

I think if we are bringing it back, we should do it for all platforms, not just linux. CMake is needed on all platforms alike.

[agocke]

And this is linux-only because I think checking for pkg-config is better on Mac. What we're looking for is the thing least-likely to have been installed by-default.

[am11]

If we use else instead of elif, that will cover mac+linux+{everything-else}:

else# Check presence of cmake on the pathcommand -v cmake 2>/dev/null || { echo>&2"Please install cmake before running this script, see https://github.com/dotnet/runtime/tree/main/docs/workflow/requirements";exit 1; }

User can then read {platform}-instructions.md.

[am11]

This check is happening earlier and is clearer.

It is rendering this check redundant which can be deleted:

runtime/eng/native/gen-buildsys.sh

Lines 87 to 88 in ed339b3

	if! cmake_command=$(command -v cmake);then
	echo"CMake was not found in PATH."

[agocke]

We used to have an upfront check for a while and it was deleted in #39044.

Not quite the same -- that's a version check, here I'm just doing a basic check to see if it exists at all. The intent is to catch people who have not installed the prereqs at all, not people who have misconfigured prereqs.

[jkotas]

/eng/debian-reqs.txt no longer exists

[agocke]

Ah, that's right. Now I remembered why I structured it like this: so that users could easily see exactly what they were installing without having to scan a bash script and also without having the risk of the list going out of date. I prefer my previous solution. I'm going to revert the last commit.

[am11]

Suggested change

	xargs apt-get install -y < eng/debian-reqs.txt
	apt install -y build-essential gettext locales cmake llvm clang lldb liblldb-dev libunwind8-dev libicu-dev liblttng-ust-dev \
	libssl-dev libkrb5-dev zlib1g-dev

lets keep them separate then. I was proposing to deduplicate it the other way around. Makes less sense to change it for one distro leaving others on the table.

[agocke]

Could you elaborate? Ubuntu is the only Linux dev platform we "officially" support developing on. Wouldn't it make sense to go through more work to make it a good "reference" platform?

[am11]

This script is idempotent in nature; as it just calls package managers of that nature (worst case: print "package is already installed"; exit 0). It supports multiple platforms and has room for more. In the context of this script, there is no official precedence. Currently, it is providing support for Ubuntu, Alpine and Apple platforms.

The suggestion above was to just point people to the usage of this self-documenting script regardless of the distro. If/when someone will hit Unsupported distro. distro: $ID branch, they will likely get encouraged to add support for their platform.

Unless we think listing the dependencies for Debian/Ubuntu (without further description) separately is meaningful, IMO, it's better to keep it simple. On the other hand, seeing that we have eng/Brewfile also separated (as opposed to brew install <the whole grocery list>), we can probably live with this separate file as well. 😅

If we are going to use the separate version, please make sure to use absolute path (so it can be called from any location as before): agocke/runtime@automated-workflow...am11:runtime:patch-35.

[agocke]

Yeah brewfile was what I was copying in spirit. I'm hoping this is useful for others -- if it's not we can fold back into the script.

[agocke]

I'm trying to make it slightly easier to install the needed requirements, and add some validation if a user hasn't installed the requirements.

Also, I validated that these instructions still work for Ubuntu 24.04 and have noted that other installs are only community-supported.

[am11]

I'm using eng/install-native-dependencies.sh in Debian/Ubuntu, Alpine and macOS. It works well. Do we need another mechanism; another list to maintain?

[dotnet-policy-service]

Tagging subscribers to this area: @dotnet/runtime-infrastructure
See info in area-owners.md if you want to be subscribed.

[agocke]

I'm using eng/install-native-dependencies.sh in Debian/Ubuntu, Alpine and macOS. It works well. Do we need another mechanism; another list to maintain?

I didn't know about that entry point. I'm happy to integrate with that.

[am11]

I'm happy to integrate with that.

I think it would be good to just point to the (self-documenting) helper script. On fresh machine (baremetal, cloud VM, CI, container) it installs the prereqs in a few second enough to build all default subsets.

# replace 'ubuntu' with 'alpine' without changing the steps
$ docker run --rm -v$(pwd):/runtime -w /runtime --platform linux/arm64/v8 ubuntu sh -c '	eng/install-native-dependencies.sh;	./build.sh -c Release'

[agocke]

I think it would be good to just point to the (self-documenting) helper script

I'm fine with this but the lists are currently inconsistent.

Our docs:

build-essential
clang
cmake
curl
git
libicu-dev
libkrb5-dev
liblttng-ust-dev
libssl-dev
lld
lldb
llvm
ninja-build
python-is-python3
zlib1g-dev

Script

build-essential
clang
cmake
gettext
libicu-dev
libkrb5-dev
liblldb-dev
liblttng-ust-dev
libssl-dev
libunwind8-dev
lldb
llvm
locales
zlib1g-dev

Diff:

build-essential
clang
cmake
-curl-git+gettext
libicu-dev
libkrb5-dev
+liblldb-dev
liblttng-ust-dev
libssl-dev
-lld+libunwind8-dev
lldb
llvm
-ninja-build-python-is-python3+locales
zlib1g-dev

Thoughts? I personally think ninja-build should be in there even if it's not strictly necessary.

[am11]

Yup, agreed.

• ninja-build can be added in both debian and alpine (it has the same package name).
• curl and python3 on debian, and python3 on alpine are implicitly installed (but we can explicitly specify them)
• lld can be added in both debian and alpine.
• git is not strictly needed (but can be added).

[agocke]

OK, I took the most conservative approach of just taking the union, since I'm not sure what's actually necessary.

Also, docs have been updated to point to the shell script.

[am11]

We are already testing it in gen-buildsys.sh. Also why is this linux only?

[agocke]

This check is happening earlier and is clearer. Ideally I'd like this check to happen even earlier, but I think that belongs in another PR.

[am11]

We used to have an upfront check for a while and it was deleted in #39044.

I think if we are bringing it back, we should do it for all platforms, not just linux. CMake is needed on all platforms alike.

[agocke]

And this is linux-only because I think checking for pkg-config is better on Mac. What we're looking for is the thing least-likely to have been installed by-default.

[am11]

If we use else instead of elif, that will cover mac+linux+{everything-else}:

else# Check presence of cmake on the pathcommand -v cmake 2>/dev/null || { echo>&2"Please install cmake before running this script, see https://github.com/dotnet/runtime/tree/main/docs/workflow/requirements";exit 1; }

User can then read {platform}-instructions.md.

[am11]

This check is happening earlier and is clearer.

It is rendering this check redundant which can be deleted:

runtime/eng/native/gen-buildsys.sh

Lines 87 to 88 in ed339b3

	if! cmake_command=$(command -v cmake);then
	echo"CMake was not found in PATH."

[agocke]

We used to have an upfront check for a while and it was deleted in #39044.

Not quite the same -- that's a version check, here I'm just doing a basic check to see if it exists at all. The intent is to catch people who have not installed the prereqs at all, not people who have misconfigured prereqs.

[jkotas]

/eng/debian-reqs.txt no longer exists

[agocke]

Ah, that's right. Now I remembered why I structured it like this: so that users could easily see exactly what they were installing without having to scan a bash script and also without having the risk of the list going out of date. I prefer my previous solution. I'm going to revert the last commit.

[am11]

Suggested change

	xargs apt-get install -y < eng/debian-reqs.txt
	apt install -y build-essential gettext locales cmake llvm clang lldb liblldb-dev libunwind8-dev libicu-dev liblttng-ust-dev \
	libssl-dev libkrb5-dev zlib1g-dev

lets keep them separate then. I was proposing to deduplicate it the other way around. Makes less sense to change it for one distro leaving others on the table.

[agocke]

Could you elaborate? Ubuntu is the only Linux dev platform we "officially" support developing on. Wouldn't it make sense to go through more work to make it a good "reference" platform?

[am11]

This script is idempotent in nature; as it just calls package managers of that nature (worst case: print "package is already installed"; exit 0). It supports multiple platforms and has room for more. In the context of this script, there is no official precedence. Currently, it is providing support for Ubuntu, Alpine and Apple platforms.

The suggestion above was to just point people to the usage of this self-documenting script regardless of the distro. If/when someone will hit Unsupported distro. distro: $ID branch, they will likely get encouraged to add support for their platform.

Unless we think listing the dependencies for Debian/Ubuntu (without further description) separately is meaningful, IMO, it's better to keep it simple. On the other hand, seeing that we have eng/Brewfile also separated (as opposed to brew install <the whole grocery list>), we can probably live with this separate file as well. 😅

If we are going to use the separate version, please make sure to use absolute path (so it can be called from any location as before): agocke/runtime@automated-workflow...am11:runtime:patch-35.

[agocke]

Yeah brewfile was what I was copying in spirit. I'm hoping this is useful for others -- if it's not we can fold back into the script.

[agocke]

I'm trying to make it slightly easier to install the needed requirements, and add some validation if a user hasn't installed the requirements.

Also, I validated that these instructions still work for Ubuntu 24.04 and have noted that other installs are only community-supported.

[am11]

I'm using eng/install-native-dependencies.sh in Debian/Ubuntu, Alpine and macOS. It works well. Do we need another mechanism; another list to maintain?

[dotnet-policy-service]

Tagging subscribers to this area: @dotnet/runtime-infrastructure
See info in area-owners.md if you want to be subscribed.

[agocke]

I'm using eng/install-native-dependencies.sh in Debian/Ubuntu, Alpine and macOS. It works well. Do we need another mechanism; another list to maintain?

I didn't know about that entry point. I'm happy to integrate with that.

[am11]

I'm happy to integrate with that.

I think it would be good to just point to the (self-documenting) helper script. On fresh machine (baremetal, cloud VM, CI, container) it installs the prereqs in a few second enough to build all default subsets.

# replace 'ubuntu' with 'alpine' without changing the steps
$ docker run --rm -v$(pwd):/runtime -w /runtime --platform linux/arm64/v8 ubuntu sh -c '	eng/install-native-dependencies.sh;	./build.sh -c Release'

[agocke]

I think it would be good to just point to the (self-documenting) helper script

I'm fine with this but the lists are currently inconsistent.

Our docs:

build-essential
clang
cmake
curl
git
libicu-dev
libkrb5-dev
liblttng-ust-dev
libssl-dev
lld
lldb
llvm
ninja-build
python-is-python3
zlib1g-dev

Script

build-essential
clang
cmake
gettext
libicu-dev
libkrb5-dev
liblldb-dev
liblttng-ust-dev
libssl-dev
libunwind8-dev
lldb
llvm
locales
zlib1g-dev

Diff:

build-essential
clang
cmake
-curl-git+gettext
libicu-dev
libkrb5-dev
+liblldb-dev
liblttng-ust-dev
libssl-dev
-lld+libunwind8-dev
lldb
llvm
-ninja-build-python-is-python3+locales
zlib1g-dev

Thoughts? I personally think ninja-build should be in there even if it's not strictly necessary.

[am11]

Yup, agreed.

• ninja-build can be added in both debian and alpine (it has the same package name).
• curl and python3 on debian, and python3 on alpine are implicitly installed (but we can explicitly specify them)
• lld can be added in both debian and alpine.
• git is not strictly needed (but can be added).

[agocke]

OK, I took the most conservative approach of just taking the union, since I'm not sure what's actually necessary.

Also, docs have been updated to point to the shell script.

[am11]

We are already testing it in gen-buildsys.sh. Also why is this linux only?

[agocke]

This check is happening earlier and is clearer. Ideally I'd like this check to happen even earlier, but I think that belongs in another PR.

[am11]

We used to have an upfront check for a while and it was deleted in #39044.

I think if we are bringing it back, we should do it for all platforms, not just linux. CMake is needed on all platforms alike.

[agocke]

And this is linux-only because I think checking for pkg-config is better on Mac. What we're looking for is the thing least-likely to have been installed by-default.

[am11]

If we use else instead of elif, that will cover mac+linux+{everything-else}:

else# Check presence of cmake on the pathcommand -v cmake 2>/dev/null || { echo>&2"Please install cmake before running this script, see https://github.com/dotnet/runtime/tree/main/docs/workflow/requirements";exit 1; }

User can then read {platform}-instructions.md.

[am11]

This check is happening earlier and is clearer.

It is rendering this check redundant which can be deleted:

runtime/eng/native/gen-buildsys.sh

Lines 87 to 88 in ed339b3

	if! cmake_command=$(command -v cmake);then
	echo"CMake was not found in PATH."

[agocke]

We used to have an upfront check for a while and it was deleted in #39044.

Not quite the same -- that's a version check, here I'm just doing a basic check to see if it exists at all. The intent is to catch people who have not installed the prereqs at all, not people who have misconfigured prereqs.

[jkotas]

/eng/debian-reqs.txt no longer exists

[agocke]

Ah, that's right. Now I remembered why I structured it like this: so that users could easily see exactly what they were installing without having to scan a bash script and also without having the risk of the list going out of date. I prefer my previous solution. I'm going to revert the last commit.

[am11]

Suggested change

	xargs apt-get install -y < eng/debian-reqs.txt
	apt install -y build-essential gettext locales cmake llvm clang lldb liblldb-dev libunwind8-dev libicu-dev liblttng-ust-dev \
	libssl-dev libkrb5-dev zlib1g-dev

lets keep them separate then. I was proposing to deduplicate it the other way around. Makes less sense to change it for one distro leaving others on the table.

[agocke]

Could you elaborate? Ubuntu is the only Linux dev platform we "officially" support developing on. Wouldn't it make sense to go through more work to make it a good "reference" platform?

[am11]

This script is idempotent in nature; as it just calls package managers of that nature (worst case: print "package is already installed"; exit 0). It supports multiple platforms and has room for more. In the context of this script, there is no official precedence. Currently, it is providing support for Ubuntu, Alpine and Apple platforms.

The suggestion above was to just point people to the usage of this self-documenting script regardless of the distro. If/when someone will hit Unsupported distro. distro: $ID branch, they will likely get encouraged to add support for their platform.

Unless we think listing the dependencies for Debian/Ubuntu (without further description) separately is meaningful, IMO, it's better to keep it simple. On the other hand, seeing that we have eng/Brewfile also separated (as opposed to brew install <the whole grocery list>), we can probably live with this separate file as well. 😅

If we are going to use the separate version, please make sure to use absolute path (so it can be called from any location as before): agocke/runtime@automated-workflow...am11:runtime:patch-35.

[agocke]

Yeah brewfile was what I was copying in spirit. I'm hoping this is useful for others -- if it's not we can fold back into the script.

[agocke]

I'm trying to make it slightly easier to install the needed requirements, and add some validation if a user hasn't installed the requirements.

Also, I validated that these instructions still work for Ubuntu 24.04 and have noted that other installs are only community-supported.

[am11]

I'm using eng/install-native-dependencies.sh in Debian/Ubuntu, Alpine and macOS. It works well. Do we need another mechanism; another list to maintain?

[dotnet-policy-service]

Tagging subscribers to this area: @dotnet/runtime-infrastructure
See info in area-owners.md if you want to be subscribed.

[agocke]

I'm using eng/install-native-dependencies.sh in Debian/Ubuntu, Alpine and macOS. It works well. Do we need another mechanism; another list to maintain?

I didn't know about that entry point. I'm happy to integrate with that.

[am11]

I'm happy to integrate with that.

I think it would be good to just point to the (self-documenting) helper script. On fresh machine (baremetal, cloud VM, CI, container) it installs the prereqs in a few second enough to build all default subsets.

# replace 'ubuntu' with 'alpine' without changing the steps
$ docker run --rm -v$(pwd):/runtime -w /runtime --platform linux/arm64/v8 ubuntu sh -c '	eng/install-native-dependencies.sh;	./build.sh -c Release'

[agocke]

I think it would be good to just point to the (self-documenting) helper script

I'm fine with this but the lists are currently inconsistent.

Our docs:

build-essential
clang
cmake
curl
git
libicu-dev
libkrb5-dev
liblttng-ust-dev
libssl-dev
lld
lldb
llvm
ninja-build
python-is-python3
zlib1g-dev

Script

build-essential
clang
cmake
gettext
libicu-dev
libkrb5-dev
liblldb-dev
liblttng-ust-dev
libssl-dev
libunwind8-dev
lldb
llvm
locales
zlib1g-dev

Diff:

build-essential
clang
cmake
-curl-git+gettext
libicu-dev
libkrb5-dev
+liblldb-dev
liblttng-ust-dev
libssl-dev
-lld+libunwind8-dev
lldb
llvm
-ninja-build-python-is-python3+locales
zlib1g-dev

Thoughts? I personally think ninja-build should be in there even if it's not strictly necessary.

[am11]

Yup, agreed.

• ninja-build can be added in both debian and alpine (it has the same package name).
• curl and python3 on debian, and python3 on alpine are implicitly installed (but we can explicitly specify them)
• lld can be added in both debian and alpine.
• git is not strictly needed (but can be added).

[agocke]

OK, I took the most conservative approach of just taking the union, since I'm not sure what's actually necessary.

Also, docs have been updated to point to the shell script.

[am11]

We are already testing it in gen-buildsys.sh. Also why is this linux only?

[agocke]

This check is happening earlier and is clearer. Ideally I'd like this check to happen even earlier, but I think that belongs in another PR.

[am11]

We used to have an upfront check for a while and it was deleted in #39044.

I think if we are bringing it back, we should do it for all platforms, not just linux. CMake is needed on all platforms alike.

[agocke]

And this is linux-only because I think checking for pkg-config is better on Mac. What we're looking for is the thing least-likely to have been installed by-default.

[am11]

If we use else instead of elif, that will cover mac+linux+{everything-else}:

else# Check presence of cmake on the pathcommand -v cmake 2>/dev/null || { echo>&2"Please install cmake before running this script, see https://github.com/dotnet/runtime/tree/main/docs/workflow/requirements";exit 1; }

User can then read {platform}-instructions.md.

[am11]

This check is happening earlier and is clearer.

It is rendering this check redundant which can be deleted:

runtime/eng/native/gen-buildsys.sh

Lines 87 to 88 in ed339b3

	if! cmake_command=$(command -v cmake);then
	echo"CMake was not found in PATH."

[agocke]

We used to have an upfront check for a while and it was deleted in #39044.

Not quite the same -- that's a version check, here I'm just doing a basic check to see if it exists at all. The intent is to catch people who have not installed the prereqs at all, not people who have misconfigured prereqs.

[jkotas]

/eng/debian-reqs.txt no longer exists

[agocke]

Ah, that's right. Now I remembered why I structured it like this: so that users could easily see exactly what they were installing without having to scan a bash script and also without having the risk of the list going out of date. I prefer my previous solution. I'm going to revert the last commit.

[am11]

Suggested change

	xargs apt-get install -y < eng/debian-reqs.txt
	apt install -y build-essential gettext locales cmake llvm clang lldb liblldb-dev libunwind8-dev libicu-dev liblttng-ust-dev \
	libssl-dev libkrb5-dev zlib1g-dev

lets keep them separate then. I was proposing to deduplicate it the other way around. Makes less sense to change it for one distro leaving others on the table.

[agocke]

Could you elaborate? Ubuntu is the only Linux dev platform we "officially" support developing on. Wouldn't it make sense to go through more work to make it a good "reference" platform?

[am11]

This script is idempotent in nature; as it just calls package managers of that nature (worst case: print "package is already installed"; exit 0). It supports multiple platforms and has room for more. In the context of this script, there is no official precedence. Currently, it is providing support for Ubuntu, Alpine and Apple platforms.

The suggestion above was to just point people to the usage of this self-documenting script regardless of the distro. If/when someone will hit Unsupported distro. distro: $ID branch, they will likely get encouraged to add support for their platform.

Unless we think listing the dependencies for Debian/Ubuntu (without further description) separately is meaningful, IMO, it's better to keep it simple. On the other hand, seeing that we have eng/Brewfile also separated (as opposed to brew install <the whole grocery list>), we can probably live with this separate file as well. 😅

If we are going to use the separate version, please make sure to use absolute path (so it can be called from any location as before): agocke/runtime@automated-workflow...am11:runtime:patch-35.

[agocke]

Yeah brewfile was what I was copying in spirit. I'm hoping this is useful for others -- if it's not we can fold back into the script.