Skip to content

Commit 43177b8

Browse files
authored
Rename libddprof to libdatadog in docs (#15)
I've gone through all our docs and updated/renamed them to the new project name. Note that I did not fix any other places (such as scripts) where we still use the old name.
1 parent bd73f8a commit 43177b8

File tree

4 files changed

+21
-19
lines changed

4 files changed

+21
-19
lines changed

.github/ISSUE_TEMPLATE/bug.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -26,5 +26,5 @@ If possible, add logs and screenshots to help explain your problem, or even bett
2626
**Additional context**
2727
Add any other context about the problem here.
2828

29-
**How does `libddprof` help you?**
30-
Optionally, tell us why you're using `libddprof`, and what your overall experience with it is!
29+
**How does `libdatadog` help you?**
30+
Optionally, tell us why you're using `libdatadog`, and what your overall experience with it is!

CONTRIBUTING.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# Contributing
22

3-
Community contributions to `libddprof` are welcome 😃! See below for some basic guidelines.
3+
Community contributions to `libdatadog` are welcome 😃! See below for some basic guidelines.
44

55
## Want to request a new feature?
66

77
Many great ideas for new features come from the community, and we'd be happy to consider yours!
88

9-
To share your request, you can [open a Github issue](https://github.com/datadog/libddprof/issues/new) with the details
9+
To share your request, you can [open a Github issue](https://github.com/datadog/libdatadog/issues/new) with the details
1010
about what you'd like to see. At a minimum, please provide:
1111

1212
* The goal of the new feature
@@ -26,8 +26,8 @@ Additionally, if you can, include:
2626
For any urgent matters (such as outages) or issues concerning the Datadog service or UI, contact our support team via
2727
https://docs.datadoghq.com/help/ for direct, faster assistance.
2828

29-
You can submit bug reports concerning `libddprof` by
30-
[opening a Github issue](https://github.com/datadog/libddprof/issues/new). At a minimum, please provide:
29+
You can submit bug reports concerning `libdatadog` by
30+
[opening a Github issue](https://github.com/datadog/libdatadog/issues/new). At a minimum, please provide:
3131

3232
* A description of the problem
3333
* Steps to reproduce
@@ -38,7 +38,7 @@ You can submit bug reports concerning `libddprof` by
3838

3939
If at all possible, also provide:
4040

41-
* Logs (from the profiler/application/agent) or other diagnostics
41+
* Logs (from the library/profiler/application/agent) or other diagnostics
4242
* Screenshots, links, or other visual aids that are publicly accessible
4343
* Code sample or test that reproduces the problem
4444
* An explanation of what causes the bug and/or how it can be fixed
@@ -48,15 +48,15 @@ Reports that include rich detail are better, and ones with code that reproduce t
4848
## Have a patch?
4949

5050
We welcome code contributions to the library, which you can
51-
[submit as a pull request](https://github.com/datadog/libddprof/pull/new/main).
51+
[submit as a pull request](https://github.com/datadog/libdatadog/pull/new/main).
5252
To create a pull request:
5353

54-
1. **Fork the repository** from <https://github.com/datadog/libddprof>
54+
1. **Fork the repository** from <https://github.com/datadog/libdatadog>
5555
2. **Make any changes** for your patch
5656
3. **Write tests** that demonstrate how the feature works or how the bug is fixed
5757
4. **Update any documentation** especially for new features.
5858
5. **Submit the pull request** from your fork back to the latest revision of the `main` branch on
59-
<https://github.com/datadog/libddprof>
59+
<https://github.com/datadog/libdatadog>
6060

6161
The pull request will be run through our CI pipeline, and a project member will review the changes with you.
6262
At a minimum, to be accepted and merged, pull requests must:

NOTICE

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Datadog libddprof
2-
Copyright 2021 Datadog, Inc.
1+
Datadog libdatadog
2+
Copyright 2021-2022 Datadog, Inc.
33

44
This product includes software developed at Datadog (<https://www.datadoghq.com/>).

README.md

+9-7
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
1-
# libddprof
1+
# `libdatadog`
22

3-
`libddprof` provides a shared library containing common code used in the implementation of Datadog's
4-
[Continuous Profilers](https://docs.datadoghq.com/tracing/profiler/).
3+
`libdatadog` provides a shared library containing common code used in the implementation of Datadog's libraries,
4+
including [Continuous Profilers](https://docs.datadoghq.com/tracing/profiler/).
55

6+
(In a past life, `libdatadog` was known as [`libddprof`](https://github.com/DataDog/libddprof) but it was renamed when
7+
we decided to increase its scope).
68

7-
**NOTE**: If you're building a new profiler or want to contribute to Datadog's existing profilers, you've come to the
9+
**NOTE**: If you're building a new Datadog library/profiler or want to contribute to Datadog's existing tools, you've come to the
810
right place!
911
Otherwise, this is possibly not the droid you were looking for.
1012

@@ -16,11 +18,11 @@ See <CONTRIBUTING.md>.
1618

1719
### Building
1820

19-
Build libddprof as usual with `cargo build`. To package a release with the generated ffi header and CMake module,
20-
use the `ffi-build.sh` helper script. To stick the output in `/opt/libddprof`, you would do:
21+
Build `libdatadog` as usual with `cargo build`. To package a release with the generated ffi header and CMake module,
22+
use the `ffi-build.sh` helper script. To stick the output in `/opt/libdatadog`, you would do:
2123

2224
```bash
23-
bash ffi-build.sh /opt/libddprof
25+
bash ffi-build.sh /opt/libdatadog
2426
```
2527

2628
#### Build Dependencies

0 commit comments

Comments
 (0)