Skip to content

Commit

Permalink
Improve docs for building on mac (APMSP-1425) (#6254)
Browse files Browse the repository at this point in the history
## Summary of changes

## Reason for change
I ran into a lot of difficulties building on Mac and these notes should
help future mac-based developers dodge these difficulties.
## Implementation details

## Test coverage

## Other details
<!-- Fixes #{issue} -->

<!-- ⚠️ Note: where possible, please obtain 2 approvals prior to
merging. Unless CODEOWNERS specifies otherwise, for external teams it is
typically best to have one review from a team member, and one review
from apm-dotnet. Trivial changes do not require 2 reviews. -->
  • Loading branch information
ajgajg1134 authored Nov 7, 2024
1 parent 0450aaa commit 3032e6d
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion tracer/README.MD
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,8 @@ Alternatively, on Windows:

### macOS

You can use Rider and CLion to develop on macOS. Building and testing can be done through the following Nuke targets:
You can use Rider and CLion, or Visual Studio Code to develop on macOS. When asked to select a solution file select `Datadog.Trace.OSX.slnf`. If using CLion for the native code make sure to select "Let CMake decide" for the generator.
Building and testing can be done through the following Nuke targets:

```bash
# Clean and build the main tracer project
Expand All @@ -115,6 +116,11 @@ docker-compose up StartDependencies.OSXARM64
docker-compose down
```

Troubleshooting tips for build errors:
* Try deleting the `cmake-build-debug` and `obj_*` directories.
* Verify your xcode developer tools installation with `xcode-select --install`. You may need to repeat this process after an operating system update.


## Additional Technical Documentation

* [Implementing an automatic instrumentation](../docs/development/AutomaticInstrumentation.md)
Expand Down

0 comments on commit 3032e6d

Please sign in to comment.