mirror of
https://github.com/XRPLF/rippled.git
synced 2026-06-06 10:16:45 +00:00
1eb0fdac65
This change renames all occurrences of `namespace ripple` and `ripple::` to `namespace xrpl` and `xrpl::`, respectively, as well as the names of test suites. It also provides a script to allow developers to replicate the changes in their local branch or fork to avoid conflicts.
44 lines
2.0 KiB
Markdown
44 lines
2.0 KiB
Markdown
## Renaming ripple(d) to xrpl(d)
|
|
|
|
In the initial phases of development of the XRPL, the open source codebase was
|
|
called "rippled" and it remains with that name even today. Today, over 1000
|
|
nodes run the application, and code contributions have been submitted by
|
|
developers located around the world. The XRPL community is larger than ever.
|
|
In light of the decentralized and diversified nature of XRPL, we will rename any
|
|
references to `ripple` and `rippled` to `xrpl` and `xrpld`, when appropriate.
|
|
|
|
See [here](https://xls.xrpl.org/xls/XLS-0095-rename-rippled-to-xrpld.html) for
|
|
more information.
|
|
|
|
### Scripts
|
|
|
|
To facilitate this transition, there will be multiple scripts that developers
|
|
can run on their own PRs and forks to minimize conflicts. Each script should be
|
|
run from the repository root.
|
|
|
|
1. `.github/scripts/rename/definitions.sh`: This script will rename all
|
|
definitions, such as include guards, from `RIPPLE_XXX` and `RIPPLED_XXX` to
|
|
`XRPL_XXX`.
|
|
2. `.github/scripts/rename/copyright.sh`: This script will remove superflous
|
|
copyright notices.
|
|
3. `.github/scripts/rename/cmake.sh`: This script will rename all CMake files
|
|
from `RippleXXX.cmake` or `RippledXXX.cmake` to `XrplXXX.cmake`, and any
|
|
references to `ripple` and `rippled` (with or without capital letters) to
|
|
`xrpl` and `xrpld`, respectively. The name of the binary will remain as-is,
|
|
and will only be renamed to `xrpld` by a later script.
|
|
4. `.github/scripts/rename/binary.sh`: This script will rename the binary from
|
|
`rippled` to `xrpld`, and reverses the symlink so that `rippled` points to
|
|
the `xrpld` binary.
|
|
5. `.github/scripts/rename/namespace.sh`: This script will rename the C++
|
|
namespaces from `ripple` to `xrpl`.
|
|
|
|
You can run all these scripts from the repository root as follows:
|
|
|
|
```shell
|
|
./.github/scripts/rename/definitions.sh .
|
|
./.github/scripts/rename/copyright.sh .
|
|
./.github/scripts/rename/cmake.sh .
|
|
./.github/scripts/rename/binary.sh .
|
|
./.github/scripts/rename/namespace.sh .
|
|
```
|