From df36301c5bafbbdb5c7265b662797fded76f9d29 Mon Sep 17 00:00:00 2001 From: Louis Tricot Date: Fri, 13 Sep 2024 14:25:19 +0200 Subject: [PATCH 1/2] docs: fix broken links in maintainers.md and hasher's README --- doc/maintainers.md | 32 ++++++++++++++++---------------- examples/hasher/README.md | 2 +- 2 files changed, 17 insertions(+), 17 deletions(-) diff --git a/doc/maintainers.md b/doc/maintainers.md index 530701ad..8db4cd3a 100644 --- a/doc/maintainers.md +++ b/doc/maintainers.md @@ -652,21 +652,21 @@ TODO [1]: https://github.com/DataDog/dd-opentracing-cpp [2]: https://github.com/open-telemetry/opentelemetry-cpp -[3]: ../src/datadog/span.h +[3]: ../include/datadog/span.h [4]: ../src/datadog/span_data.h -[5]: ../src/datadog/span_config.h +[5]: ../include/datadog/span_config.h [6]: https://en.cppreference.com/w/cpp/language/raii -[7]: ../src/datadog/trace_segment.h +[7]: ../include/datadog/trace_segment.h [8]: ../src/datadog/trace_segment.cpp -[9]: ../src/datadog/tracer.h -[10]: ../src/datadog/tracer_config.h -[11]: ../src/datadog/dict_writer.h -[12]: ../src/datadog/collector.h +[9]: ../include/datadog/tracer.h +[10]: ../include/datadog/tracer_config.h +[11]: ../include/datadog/dict_writer.h +[12]: ../include/datadog/collector.h [13]: ../src/datadog/datadog_agent.h [14]: https://docs.datadoghq.com/agent/ -[15]: ../src/datadog/http_client.h -[16]: ../src/datadog/event_scheduler.h -[17]: ../src/datadog/datadog_agent_config.h +[15]: ../include/datadog/http_client.h +[16]: ../include/datadog/event_scheduler.h +[17]: ../include/datadog/datadog_agent_config.h [18]: ../src/datadog/curl.h [19]: ../src/datadog/threaded_event_scheduler.h [20]: https://curl.se/libcurl/c/libcurl-multi.html @@ -682,15 +682,15 @@ TODO [30]: https://github.com/envoyproxy/envoy/blob/main/source/extensions/tracers/datadog/event_scheduler.h [31]: https://lexi-lambda.github.io/about.html [32]: https://lexi-lambda.github.io/blog/2019/11/05/parse-don-t-validate/ -[33]: ../src/datadog/trace_sampler_config.h -[34]: ../src/datadog/span_sampler_config.h -[35]: ../src/datadog/rate.h -[36]: ../src/datadog/error.h -[37]: ../src/datadog/expected.h +[33]: ../include/datadog/trace_sampler_config.h +[34]: ../include/datadog/span_sampler_config.h +[35]: ../include/datadog/rate.h +[36]: ../include/datadog/error.h +[37]: ../include/datadog/expected.h [38]: https://en.cppreference.com/w/cpp/utility/expected [39]: https://en.cppreference.com/w/cpp/utility/variant/get_if [40]: https://en.cppreference.com/w/cpp/language/value_category -[41]: ../src/datadog/logger.h +[41]: ../include/datadog/logger.h [42]: ../src/datadog/cerr_logger.h [43]: https://en.cppreference.com/w/cpp/io/cerr [44]: https://en.cppreference.com/w/cpp/utility/functional/function diff --git a/examples/hasher/README.md b/examples/hasher/README.md index 30b901f1..4f6d4975 100644 --- a/examples/hasher/README.md +++ b/examples/hasher/README.md @@ -10,7 +10,7 @@ file or directory encountered. The program produces a trace of this calculation, where each file encountered is a span whose duration is the time it took to hash the file. -[../bin/hasher-example](../bin/hasher-example) builds and runs this example. +The [bin/hasher-example](../../bin/hasher-example) script builds and runs this example. ![example console usage](console.png) From 544091c8decd88a89de764a6044903585694b36c Mon Sep 17 00:00:00 2001 From: Louis Tricot Date: Fri, 13 Sep 2024 17:01:38 +0200 Subject: [PATCH 2/2] docs: fix additional broken links --- benchmark/README.md | 4 ++-- bin/README.md | 3 --- doc/sampling-delegation.md | 8 ++++---- test/README.md | 2 +- 4 files changed, 7 insertions(+), 10 deletions(-) diff --git a/benchmark/README.md b/benchmark/README.md index 99e4fcf9..e26f95dd 100644 --- a/benchmark/README.md +++ b/benchmark/README.md @@ -6,7 +6,7 @@ resource consumption of a test tracing scenario. The benchmark uses [Google Benchmark][1], whose source is included as a git submodule under `./google-benchmark`. -The scenario that's measured is similar to the [../example][3] setup. A trace +The scenario that's measured is similar to the [../examples/hasher][3] setup. A trace is created whose structure reflects that of a particular file directory structure. The directory structure, in this case, is the source tree of the [Tiny C Compiler][4], whose source is included as a git submodule under @@ -30,7 +30,7 @@ This benchmark is intended to be driven by Datadog's internal benchmarking platform. See [../.gitlab/benchmarks.yml][7]. [1]: https://github.com/google/benchmark -[3]: ../example +[3]: ../examples/hasher [4]: https://bellard.org/tcc/ [6]: ../bin/benchmark [7]: ../.gitlab/benchmarks.yml diff --git a/bin/README.md b/bin/README.md index ed7f565d..d4bc645a 100644 --- a/bin/README.md +++ b/bin/README.md @@ -24,9 +24,6 @@ This directory contains scripts that are useful during development. recent version is not installed already. - [install-lcov](install-lcov) installs a version of GNU's code coverage HTML report generator that's recent enough to support dark mode. -- [publish-coverage](publish-coverage) takes a coverage report previously - generated by, e.g., `test --coverage`, and pushes it to a related repository's - GitHub Pages branch. - [release](release) checks the provided version string (e.g. "v1.2.3") and then publishes a "draft" "prerelease" GitHub source release, which you then can alter and document in the GitHub web UI. diff --git a/doc/sampling-delegation.md b/doc/sampling-delegation.md index 2d653968..bafa7e29 100644 --- a/doc/sampling-delegation.md +++ b/doc/sampling-delegation.md @@ -182,8 +182,8 @@ This granularity of control is useful in NGINX, where one `location` (i.e. upstream or backend) might be configured for sampling delegation, while another `location` might not. -[1]: ../src/datadog/tracer_config.h -[2]: ../src/datadog/trace_segment.h +[1]: ../include/datadog/tracer_config.h +[2]: ../include/datadog/trace_segment.h [3]: ../src/datadog/trace_segment.cpp -[4]: ../src/datadog/sampling_decision.h -[5]: ../src/datadog/sampling_decision.h +[4]: ../include/datadog/sampling_decision.h +[5]: ../include/datadog/sampling_decision.h diff --git a/test/README.md b/test/README.md index 738402e0..b866aa5c 100644 --- a/test/README.md +++ b/test/README.md @@ -3,7 +3,7 @@ Unit Tests This directory contains the unit tests for dd-trace-cpp. The testing library used is [Catch2][1], vendored here as a single header, -[catch.hpp](catch.cpp) (see the [Makefile](Makefile)). +[catch.hpp](catch.hpp) (see the [Makefile](Makefile)). [../bin/test](../bin/test) builds and runs the unit tests.