docs icon indicating copy to clipboard operation
docs copied to clipboard

Resolve discrepancies with dependency libraries between docs and code

Open mthalman opened this issue 6 years ago • 6 comments

The documentation at https://github.com/dotnet/docs/blob/master/docs/core/linux-prerequisites.md has a section on Linux distribution dependencies. The packages that are listed here don't line up with the packages that are specified in the packaging runtime deps.

For example, the doc shows these required libraries for Ubuntu:

  • liblttng-ust0
  • libcurl3 (for 14.x and 16.x)
  • libcurl4 (for 18.x)
  • libssl1.0.0
  • libkrb5-3
  • zlib1g
  • libicu52 (for 14.x)
  • libicu55 (for 16.x)
  • libicu57 (for 17.x)
  • libicu60 (for 18.x)

But the Debian runtime deps shows these:

  • libc6
  • libgcc1
  • libgssapi-krb5-2
  • libstdc++6
  • zlib1g
  • libssl*
  • libicu*

edit by @mairaw: add topic details


Document Details

Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

mthalman avatar Oct 29 '19 21:10 mthalman

Thanks for your feedback @mthalman. @leecow Can you please take a look at this issue for Linux prereqs?

mairaw avatar Oct 29 '19 22:10 mairaw

The problem is that while packagename* works when the dependency is expressed in a deb, doing the same from a bash script or directly with the package manager does not work (that I can tell anyway).

For example, attempting apt-get install libicu* will literally install every package that starts wtih "libicu".

I'm all for it if there's a way to express this in the docs to simplify things a bit.

leecow avatar Oct 31 '19 20:10 leecow

The problem is that while packagename* works when the dependency is expressed in a deb, doing the same from a bash script or directly with the package manager does not work (that I can tell anyway).

For example, attempting apt-get install libicu* will literally install every package that starts wtih "libicu".

I'm all for it if there's a way to express this in the docs to simplify things a bit.

The * wasn't meant to be the literal value used in a shell command; it was merely meant to indicate multiple versions (https://github.com/dotnet/core-setup/blob/fd3b3421d7b901aaac28ad34e63b6480f88973d3/src/pkg/packaging/deb/package.targets#L327).

mthalman avatar Oct 31 '19 21:10 mthalman

This issue is somewhat related to https://github.com/dotnet/coreclr/issues/26303. In an ideal world, we'd have one master list of native dependencies. Documentation could be updated programatically by reading from this master list.

mthalman avatar Jan 02 '20 21:01 mthalman

This issue has been closed as part of the issue backlog grooming process outlined in #22351.

That automated process may have closed some issues that should be addressed. If you think this is one of them, reopen it with a comment explaining why. Tag the @dotnet/docs team for visibility.

dotnet-bot avatar Jan 25 '21 14:01 dotnet-bot

Reopening because this is still relevant. There is a larger effort to better manage the descriptions of native dependencies at https://github.com/dotnet/core/issues/5651.

mthalman avatar Jan 25 '21 15:01 mthalman