This is an archive of the discontinued LLVM Phabricator instance.

Differential D101779

[libcxx] Update docs regarding the need for bash/posix tools for tests on Windows. NFC.
ClosedPublic

Authored by mstorsjo on May 3 2021, 12:17 PM.

Details

Reviewers
ldionne
Group Reviewers
Restricted Project
Commits
rGe87fb6d38755: [libcxx] Update docs regarding the need for bash/posix tools for tests on…
Summary

After 39bbfb77264a4a7a216921c2b70a30ba0f27eb56, bash is no longer
a hard requirement.

Diff Detail

Event Timeline

mstorsjo requested review of this revision.May 3 2021, 12:17 PM
mstorsjo created this revision.
Herald added a project: Restricted Project. · View Herald TranscriptMay 3 2021, 12:17 PM
Herald added a reviewer: Restricted Project. · View Herald Transcript
Harbormaster completed remote builds in B102359: Diff 342505.May 3 2021, 3:52 PM
ldionne accepted this revision.May 4 2021, 7:00 AM
This revision is now accepted and ready to land.May 4 2021, 7:00 AM
Closed by commit rGe87fb6d38755: [libcxx] Update docs regarding the need for bash/posix tools for tests on… (authored by mstorsjo). · Explain WhyMay 4 2021, 12:13 PM
This revision was automatically updated to reflect the committed changes.
mstorsjo added a commit: rGe87fb6d38755: [libcxx] Update docs regarding the need for bash/posix tools for tests on….

Revision Contents

PathSize
libcxx/
docs/
5 lines

Diff 342822

libcxx/docs/BuildingLibcxx.rst

Show First 20 Lines • Show All 92 Lines • ▼ Show 20 Lines > cmake -G "Visual Studio 16 2019" ^
-DLIBCXX_ENABLE_EXPERIMENTAL_LIBRARY=NO ^ -DLIBCXX_ENABLE_EXPERIMENTAL_LIBRARY=NO ^
\path\to\libcxx \path\to\libcxx
> cmake --build . > cmake --build .
CMake + ninja (MSVC) CMake + ninja (MSVC)
~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~
Building with ninja is required for development to enable tests. Building with ninja is required for development to enable tests.
Running the tests also requires a Bash shell and Python to be available. A couple of tests require Bash to be available, and a couple dozens
of tests require other posix tools (cp, grep and similar - LLVM's tests
require the same). Without those tools the vast majority of tests
can still be ran successfully.
If Git for Windows is available, that can be used to provide the bash If Git for Windows is available, that can be used to provide the bash
shell by adding the right bin directory to the path, e.g. shell by adding the right bin directory to the path, e.g.
``set PATH=%PATH%;C:\Program Files\Git\usr\bin``. ``set PATH=%PATH%;C:\Program Files\Git\usr\bin``.
Alternatively, one can also choose to run the whole build in a MSYS2 Alternatively, one can also choose to run the whole build in a MSYS2
shell. That can be set up e.g. by starting a Visual Studio Tools Command shell. That can be set up e.g. by starting a Visual Studio Tools Command
Prompt (for getting the environment variables pointing to the headers and Prompt (for getting the environment variables pointing to the headers and
▲ Show 20 Lines • Show All 460 Lines • Show Last 20 Lines