Skip to content

Commit

Permalink
Clean up build doc and coding guidelines.
Browse files Browse the repository at this point in the history
  • Loading branch information
Hamed Sabri committed Feb 17, 2021
1 parent bf4faab commit 119b3bf
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions doc/build.md
Original file line number Diff line number Diff line change
Expand Up @@ -189,11 +189,11 @@ Test project /Users/sabrih/Desktop/workspace/build/Debug/plugin/al

##### Boost:

Currently the Animal Logic plugin has a dependency on some of the boost components ( e.g thread ). When building Pixar USD, one needs to pass the following key,value paired arguments for boost to include those components:
Currently the Animal Logic plugin has a dependency on some of the boost components. When building Pixar USD, one needs to pass the following key,value paired arguments for boost to include those components:
e.g

```
python build_usd.py ~/Desktop/BUILD --build-args boost,"--with-date_time --with-thread"
python build_usd.py ~/Desktop/BUILD --build-args boost,"--with-date_time"
```

***NOTE:*** ```--build-args``` needs to be passed at the very end of command, after build/install location.
Expand Down
2 changes: 2 additions & 0 deletions doc/codingGuidelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -227,6 +227,8 @@ Our library currently has the following boost dependencies:
***Update:***
* `boost::filesystem` and `boost::system` are removed. Until the transition to C++17 std::filesystem, [ghc::filesystem](https://github.com/gulrak/filesystem) must be used as an alternative across the project.

* Dependency on `boost::thread` is removed from Animal Logic plugin.

## Modern C++
Our goal is to develop [maya-usd](https://github.com/autodesk/maya-usd) following modern C++ practices. We’ll follow the [C++ Core Guidelines](http://isocpp.github.io/CppCoreGuidelines/CppCoreGuidelines) and pay attention to:
* `using` (vs `typedef`) keyword
Expand Down
2 changes: 0 additions & 2 deletions plugin/al/lib/AL_USDMaya/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -171,8 +171,6 @@ target_compile_definitions(${LIBRARY_NAME}
AL_MAYA_MACROS_EXPORT
AL_USDMAYA_EXPORT
AL_USDMAYA_LOCATION_NAME="${AL_USDMAYA_LOCATION_NAME}"
# Prevent link dependency on the Boost::System on MacOS
$<$<BOOL:${IS_MACOSX}>:BOOST_SYSTEM_NO_DEPRECATED>
)

target_include_directories(
Expand Down

0 comments on commit 119b3bf

Please sign in to comment.