Skip to content

Commit e110a2b

Browse files
authored
chore(doc): fix broken links in maintainers.md and hasher's README (#153)
* docs: fix broken links in maintainers.md and hasher's README * docs: fix additional broken links
1 parent f8bbc8f commit e110a2b

File tree

6 files changed

+24
-27
lines changed

6 files changed

+24
-27
lines changed

benchmark/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ resource consumption of a test tracing scenario.
66
The benchmark uses [Google Benchmark][1], whose source is included as a git
77
submodule under `./google-benchmark`.
88

9-
The scenario that's measured is similar to the [../example][3] setup. A trace
9+
The scenario that's measured is similar to the [../examples/hasher][3] setup. A trace
1010
is created whose structure reflects that of a particular file directory
1111
structure. The directory structure, in this case, is the source tree of the
1212
[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
3030
platform. See [../.gitlab/benchmarks.yml][7].
3131

3232
[1]: https://github.com/google/benchmark
33-
[3]: ../example
33+
[3]: ../examples/hasher
3434
[4]: https://bellard.org/tcc/
3535
[6]: ../bin/benchmark
3636
[7]: ../.gitlab/benchmarks.yml

bin/README.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,6 @@ This directory contains scripts that are useful during development.
2424
recent version is not installed already.
2525
- [install-lcov](install-lcov) installs a version of GNU's code coverage HTML
2626
report generator that's recent enough to support dark mode.
27-
- [publish-coverage](publish-coverage) takes a coverage report previously
28-
generated by, e.g., `test --coverage`, and pushes it to a related repository's
29-
GitHub Pages branch.
3027
- [release](release) checks the provided version string (e.g. "v1.2.3") and then
3128
publishes a "draft" "prerelease" GitHub source release, which you then can
3229
alter and document in the GitHub web UI.

doc/maintainers.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -652,21 +652,21 @@ TODO
652652

653653
[1]: https://github.com/DataDog/dd-opentracing-cpp
654654
[2]: https://github.com/open-telemetry/opentelemetry-cpp
655-
[3]: ../src/datadog/span.h
655+
[3]: ../include/datadog/span.h
656656
[4]: ../src/datadog/span_data.h
657-
[5]: ../src/datadog/span_config.h
657+
[5]: ../include/datadog/span_config.h
658658
[6]: https://en.cppreference.com/w/cpp/language/raii
659-
[7]: ../src/datadog/trace_segment.h
659+
[7]: ../include/datadog/trace_segment.h
660660
[8]: ../src/datadog/trace_segment.cpp
661-
[9]: ../src/datadog/tracer.h
662-
[10]: ../src/datadog/tracer_config.h
663-
[11]: ../src/datadog/dict_writer.h
664-
[12]: ../src/datadog/collector.h
661+
[9]: ../include/datadog/tracer.h
662+
[10]: ../include/datadog/tracer_config.h
663+
[11]: ../include/datadog/dict_writer.h
664+
[12]: ../include/datadog/collector.h
665665
[13]: ../src/datadog/datadog_agent.h
666666
[14]: https://docs.datadoghq.com/agent/
667-
[15]: ../src/datadog/http_client.h
668-
[16]: ../src/datadog/event_scheduler.h
669-
[17]: ../src/datadog/datadog_agent_config.h
667+
[15]: ../include/datadog/http_client.h
668+
[16]: ../include/datadog/event_scheduler.h
669+
[17]: ../include/datadog/datadog_agent_config.h
670670
[18]: ../src/datadog/curl.h
671671
[19]: ../src/datadog/threaded_event_scheduler.h
672672
[20]: https://curl.se/libcurl/c/libcurl-multi.html
@@ -682,15 +682,15 @@ TODO
682682
[30]: https://github.com/envoyproxy/envoy/blob/main/source/extensions/tracers/datadog/event_scheduler.h
683683
[31]: https://lexi-lambda.github.io/about.html
684684
[32]: https://lexi-lambda.github.io/blog/2019/11/05/parse-don-t-validate/
685-
[33]: ../src/datadog/trace_sampler_config.h
686-
[34]: ../src/datadog/span_sampler_config.h
687-
[35]: ../src/datadog/rate.h
688-
[36]: ../src/datadog/error.h
689-
[37]: ../src/datadog/expected.h
685+
[33]: ../include/datadog/trace_sampler_config.h
686+
[34]: ../include/datadog/span_sampler_config.h
687+
[35]: ../include/datadog/rate.h
688+
[36]: ../include/datadog/error.h
689+
[37]: ../include/datadog/expected.h
690690
[38]: https://en.cppreference.com/w/cpp/utility/expected
691691
[39]: https://en.cppreference.com/w/cpp/utility/variant/get_if
692692
[40]: https://en.cppreference.com/w/cpp/language/value_category
693-
[41]: ../src/datadog/logger.h
693+
[41]: ../include/datadog/logger.h
694694
[42]: ../src/datadog/cerr_logger.h
695695
[43]: https://en.cppreference.com/w/cpp/io/cerr
696696
[44]: https://en.cppreference.com/w/cpp/utility/functional/function

doc/sampling-delegation.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -182,8 +182,8 @@ This granularity of control is useful in NGINX, where one `location` (i.e.
182182
upstream or backend) might be configured for sampling delegation, while another
183183
`location` might not.
184184

185-
[1]: ../src/datadog/tracer_config.h
186-
[2]: ../src/datadog/trace_segment.h
185+
[1]: ../include/datadog/tracer_config.h
186+
[2]: ../include/datadog/trace_segment.h
187187
[3]: ../src/datadog/trace_segment.cpp
188-
[4]: ../src/datadog/sampling_decision.h
189-
[5]: ../src/datadog/sampling_decision.h
188+
[4]: ../include/datadog/sampling_decision.h
189+
[5]: ../include/datadog/sampling_decision.h

examples/hasher/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ file or directory encountered.
1010
The program produces a trace of this calculation, where each file encountered
1111
is a span whose duration is the time it took to hash the file.
1212

13-
[../bin/hasher-example](../bin/hasher-example) builds and runs this example.
13+
The [bin/hasher-example](../../bin/hasher-example) script builds and runs this example.
1414

1515
![example console usage](console.png)
1616

test/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ Unit Tests
33
This directory contains the unit tests for dd-trace-cpp.
44

55
The testing library used is [Catch2][1], vendored here as a single header,
6-
[catch.hpp](catch.cpp) (see the [Makefile](Makefile)).
6+
[catch.hpp](catch.hpp) (see the [Makefile](Makefile)).
77

88
[../bin/test](../bin/test) builds and runs the unit tests.
99

0 commit comments

Comments
 (0)