ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2026-10-03 18:28:07 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
744355c1d9f40320740c8ef242fb3fb55d546647
rippled/.github/scripts/rename
History
Mayukha Vadari 9dde6c907f style: Collapse hard-wrapped Markdown prose to one line per paragraph 
Set prettier's proseWrap to never for Markdown files so paragraphs are
written and formatted as a single line rather than manually wrapped at
a fixed column, matching the convention already used in AGENTS.md.
2026-09-01 17:22:18 -04:00
..
binary.sh
docs: Rewrite the install guide (#8048)
2026-08-19 14:02:42 +00:00
cmake.sh
build: Create single test binary xrpl_tests (#7327)
2026-06-05 19:24:32 +00:00
config.sh
style: Use shfmt instead of bashate (#7326)
2026-05-26 18:28:23 +00:00
copyright.sh
style: Use shfmt instead of bashate (#7326)
2026-05-26 18:28:23 +00:00
definitions.sh
style: Use shfmt instead of bashate (#7326)
2026-05-26 18:28:23 +00:00
docs.sh
docs: Rewrite the install guide (#8048)
2026-08-19 14:02:42 +00:00
include.sh
style: Add bashate pre-commit hook to unify bash style (#6994)
2026-04-22 14:26:02 +00:00
namespace.sh
test: Migrate nodestore tests from Beast to GTest (#7292)
2026-07-27 13:00:14 +00:00
README.md
style: Collapse hard-wrapped Markdown prose to one line per paragraph
2026-09-01 17:22:18 -04:00

README.md

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 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 superfluous 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.
  6. .github/scripts/rename/config.sh: This script will rename the config from rippled.cfg to xrpld.cfg, and updating the code accordingly. The old filename will still be accepted.
  7. .github/scripts/rename/docs.sh: This script will rename any lingering references of ripple(d) to xrpl(d) in code, comments, and documentation.

You can run all these scripts from the repository root as follows:

./.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 .
./.github/scripts/rename/config.sh .
./.github/scripts/rename/docs.sh .