Skip to content
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.

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

[Doc] Update GetStartedGuide.md to add instructions on obtaining zstd #15949

Open
wants to merge 2 commits into
base: sycl
Choose a base branch
from

Conversation

uditagarwal97
Copy link
Contributor

No description provided.

@uditagarwal97 uditagarwal97 self-assigned this Oct 31, 2024
@uditagarwal97 uditagarwal97 requested a review from a team as a code owner October 31, 2024 19:00
@@ -48,6 +48,9 @@ and a wide range of compute accelerators such as GPU and FPGA.
* libhwloc-dev or hwloc-devel package on linux
* C++ compiler
* See LLVM's [host compiler toolchain requirements](https://github.com/intel/llvm/blob/sycl/llvm/docs/GettingStarted.rst#host-c-toolchain-both-compiler-and-standard-library)
* `zstd` version 1.5.6 or later (Optional)
* For Ubuntu, you can obtain it by `apt install libzstd-dev`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* For Ubuntu, you can obtain it by `apt install libzstd-dev`
* For Ubuntu, you can obtain it by `sudo apt install libzstd-dev`

https://launchpad.net/ubuntu/+source/libzstd - 1.5.6 is supported by default starting 24.10. The latest LTS version (i.e. 24.04) provides 1.5.5.
Do we really need at least 1.5.6?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Aah, you're right. Now that I look at it, even zstd 1.4.8 (supported by Ubuntu 22.04) will work as the zstd APIs used in LLVM and SYCL RT haven't changed since v1.4.8. In intel/llvm CI, we use v1.4.8 on Ubuntu 22.04 docker images and it seems to fine there.

@@ -48,6 +48,9 @@ and a wide range of compute accelerators such as GPU and FPGA.
* libhwloc-dev or hwloc-devel package on linux
* C++ compiler
* See LLVM's [host compiler toolchain requirements](https://github.com/intel/llvm/blob/sycl/llvm/docs/GettingStarted.rst#host-c-toolchain-both-compiler-and-standard-library)
* `zstd` version 1.5.6 or later (Optional)
* For Ubuntu, you can obtain it by `apt install libzstd-dev`
* For Windows, you can build `zstd` manually from source [using Visual Studio](https://github.com/facebook/zstd?tab=readme-ov-file#visual-studio-windows) and then add the `zstd` install directory to the `PATH` environment variable.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see pre-built library is attached to the release page. E.g. latest release: https://github.com/facebook/zstd/releases/tag/v1.5.6
Would it be easier to download the archive, unpack and configure the environment variables instead?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants