search

DataDog / nginx-datadog

Enhance NGINX Observability and Security with Datadog's Module
https://www.datadoghq.com
Apache License 2.0
25 stars 10 forks source link

Improve Build instructions: add note to do a git clone first #136

Closed borisceranic closed 3 weeks ago

borisceranic commented 4 weeks ago

When make build runs, it depends on being able to issue git commands within the source code folder (namely, to download submodules).

If someone downloads a source code archive from Releases, their build will fail with a somewhat cryptic error message:

git submodule update --init --recursive
fatal: not a git repository (or any of the parent directories): .git
make: *** [Makefile:31: dd-trace-cpp/.git] Error 128

Making a clear instruction that the build needs to run within a git clone'd working directory will solve this particular hurdle.

dmehala commented 3 weeks ago

Hi @borisceranic,

Thank you for taking the time to contribute.

We’re currently making some updates in #113 to address similar points, so I’ll go ahead and close this PR. But please know that your feedback is heard and will definitely be incorporated into the final documentation.