mirror of https://github.com/XRPLF/rippled.git synced 2025-11-20 11:05:54 +00:00

Files

John Freeman d7725837f5 build: add interface library libxrpl: (#4449 )

Make it easy for projects to depend on libxrpl by adding an `ALIAS`
target named `xrpl::libxrpl` for projects to link.

The name was chosen because:

* The current library target is named `xrpl_core`. There is no other
  "non-core" library target against which we need to distinguish the
  "core" library. We only export one library target, and it should just
  be named after the project to keep things simple and predictable.
* Underscores in target or library names are generally discouraged.
* Every target exported in CMake should be prefixed with the project
  name.

By adding an `ALIAS` target, existing consumers who use the `xrpl_core`
target will not be affected.

* In the future, there can be a migration plan to make `xrpl_core` the
  `ALIAS` target (and `libxrpl` the "real" target, which will affect the
  filename of the compiled binary), and eventually remove it entirely.

Also:

* Fix the Conan recipe so that consumers using Conan import a target
  named `xrpl::libxrpl`. This way, every consumer can use the same
  instructions.
* Document the two easiest methods to depend on libxrpl. Both have been
  tested.
* See #4443.

2023-03-22 17:21:03 -07:00

0001-negative-unl

Implement negative UNL functionality:

2020-06-30 09:15:37 -07:00

0010-ledger-replay

Implement ledger forward replay

2021-01-25 18:49:49 -08:00

build

build: add interface library libxrpl: (#4449 )

2023-03-22 17:21:03 -07:00

images

Set version to 1.5.0

2020-03-30 18:57:35 -04:00

.gitignore

Add HTML documentation framework

2016-10-17 15:18:40 -04:00

CheatSheet.md

Add dev docs generation to Jenkins:

2018-03-02 07:37:15 -08:00

CodingStyle.md

Add .clang-format rules and update code style

2018-07-16 17:49:42 -07:00

consensus.md

Fix typo in consensus.md

2021-12-14 17:47:04 -08:00

Docker.md

Update Docker.md (#4432 )

2023-03-02 10:07:09 -08:00

Dockerfile

Fix Doxygen build

2020-04-06 17:28:53 -07:00

Doxyfile

Fix Doxygen build

2020-04-06 17:28:53 -07:00

HeapProfiling.md

Add dev docs generation to Jenkins:

2018-03-02 07:37:15 -08:00

NodeStoreRefactoringCaseStudy.pdf

Add dev docs generation to Jenkins:

2018-03-02 07:37:15 -08:00

README.md

Improve the Doxygen Workflow

2020-04-14 19:42:42 -07:00

sample_chart.doc

Add dev docs generation to Jenkins:

2018-03-02 07:37:15 -08:00

README.md

Building documentation

Dependencies

Install these dependencies:

Doxygen: All major platforms have official binary distributions, or you can build from source.
- MacOS: We recommend installing via Homebrew: brew install doxygen. The executable will be installed in /usr/local/bin which is already in the default PATH.
  
  If you use the official binary distribution, then you'll need to make Doxygen available to your command line. You can do this by adding a symbolic link from /usr/local/bin to the doxygen executable. For example,
```
$ ln -s /Applications/Doxygen.app/Contents/Resources/doxygen /usr/local/bin/doxygen
```
PlantUML:
1. Install a functioning Java runtime, if you don't already have one.
2. Download plantuml.jar.
Graphviz:
- Linux: Install from your package manager.
- Windows: Use an official installer.
- MacOS: Install via Homebrew: brew install graphviz.

Docker

Instead of installing the above dependencies locally, you can use the official build environment Docker image, which has all of them installed already.

Install Docker
Pull the image:

sudo docker pull rippleci/rippled-ci-builder:2944b78d22db

Run the image from the project folder:

sudo docker run -v $PWD:/opt/rippled --rm rippleci/rippled-ci-builder:2944b78d22db

Build

There is a docs target in the CMake configuration.

mkdir build
cd build
cmake ..
cmake --build . --target docs

The output will be in build/docs/html.