Skip to content

Commit

Permalink
docs: Remove boost from dependencies and build instructions
Browse files Browse the repository at this point in the history
(Internal change: 2344867)
  • Loading branch information
sunyab authored and pixar-oss committed Oct 17, 2024
1 parent 7929cf8 commit 34ea96a
Show file tree
Hide file tree
Showing 4 changed files with 4 additions and 17 deletions.
12 changes: 1 addition & 11 deletions BUILDING.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,6 @@ Some examples:
cmake \
-DTBB_ROOT_DIR=/path/to/tbb \
-DOPENSUBDIV_ROOT_DIR=/path/to/opensubdiv \
-DBOOST_ROOT=/path/to/boost \
/path/to/USD/source

cmake --build . --target install -- -j <NUM_CORES>
Expand All @@ -51,7 +50,6 @@ cmake \
-G "Xcode" \
-DTBB_ROOT_DIR=/path/to/tbb \
-DOPENSUBDIV_ROOT_DIR=/path/to/opensubdiv \
-DBOOST_ROOT=/path/to/boost \
/path/to/USD/source

cmake --build . --target install -- -j <NUM_CORES>
Expand All @@ -67,7 +65,6 @@ build USD.
-G "Visual Studio 15 2017 Win64" ^
-DTBB_ROOT_DIR=C:\path\to\tbb ^
-DOPENSUBDIV_ROOT_DIR=C:\path\to\opensubdiv ^
-DBOOST_ROOT=C:\path\to\boost ^
\path\to\USD\source
cmake --build . --target install -- /m:%NUMBER_OF_PROCESSORS%
Expand Down Expand Up @@ -722,14 +719,7 @@ Client code can also override the default as needed.

## Build Issues FAQ

1. Boost_NO_BOOST_CMAKE:
We currently set Boost_NO_BOOST_CMAKE=ON explicitly in USD builds for all
platforms to avoid issues with Boost config files (introduced in Boost version
1.70) and python, program options component requirements. If the user wants
to use Boost specified config files for their USD build, specify
-DBoost_NO_BOOST_CMAKE=OFF when running cmake.

2. Windows and Python 3.8+ (non-Anaconda)
1. Windows and Python 3.8+ (non-Anaconda)
Python 3.8 and later on Windows will no longer search PATH for DLL dependencies.
Instead, clients can call `os.add_dll_directory(p)` to set paths to search.
By default on that platform USD will iterate over PATH and add all paths using
Expand Down
1 change: 0 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,6 @@ Optional:

Required:
- [Python](https://python.org)
- [Boost](https://boost.org)

**usdview**

Expand Down
1 change: 0 additions & 1 deletion VERSIONS.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@ Our test machines have the following software versions installed.
| C++ Compiler | gcc 9.3.1 | Apple clang 13.1.6 (Xcode 13.3)<br>Apple clang 15.0.0 (Xcode 15.4) for visionOS | Visual Studio 2017 15.9 |
| CMake | 3.17.5 | 3.19.5 | 3.25.3 |
| Python | 3.9.16 | 3.9.13 | 3.9.13 |
| Boost | 1.76.0 | 1.78.0 | 1.76.0 |
| Intel TBB | 2020 Update 3 | 2018 Update 1, 2020 Update 3 | 2020 Update 3 |
| OpenSubdiv | 3.6.0 | 3.6.0 | 3.6.0 |
| OpenImageIO | 2.3.21.0 | 2.3.21.0 | 2.3.21.0 |
Expand Down
7 changes: 3 additions & 4 deletions docs/doxygen/externalOverview.dox
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ Following is a deeper indexing of the four packages.

- \ref tf_page_front module is a catch-all for low-level,
commonly used services developed at Pixar, including facilities for memory
tracking, error reporting and debugging, string utilities, boost python
tracking, error reporting and debugging, string utilities, Python
wrapping aids, threading/synchronization tools, registry and singleton
management, smart pointers, and "observer pattern" support, which we call
"notification".
Expand All @@ -128,9 +128,8 @@ Following is a deeper indexing of the four packages.
is able to recognize and serialize. It provides a copy-on-write
array-type, VtArray, which is used for all array types in Usd, and an
efficient type-erasure wrapper class, VtValue, that also provides datatype
conversion facilities and support for unboxing python objects from boost
python. VtValue is supported in all Usd API for getting and setting
values.
conversion facilities and support for unboxing Python objects.
VtValue is supported in all Usd API for getting and setting values.

- \ref work_page_front module provides a thin abstraction layer on top of
Intel's TBB (Thread Building Blocks), and is leveraged extensively in Usd
Expand Down

0 comments on commit 34ea96a

Please sign in to comment.