Skip to content

Commit f69ad4e

Browse files
authored
docs: Add remote to conan lock create command (#5770)
* docs: Add remote to `conan lock create` command * Document error resolution for conan package issues * Update BUILD.md * Add more info about lockfiles
1 parent 6fe0599 commit f69ad4e

File tree

1 file changed

+19
-2
lines changed

1 file changed

+19
-2
lines changed

BUILD.md

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,7 @@ higher index than the default Conan Center remote, so it is consulted first. You
132132
can do this by running:
133133

134134
```bash
135-
conan remote add --index 0 xrplf "https://conan.ripplex.io"
135+
conan remote add --index 0 xrplf https://conan.ripplex.io
136136
```
137137

138138
Alternatively, you can pull the patched recipes into the repository and use them
@@ -479,12 +479,24 @@ It is implicitly used when running `conan` commands, you don't need to specify i
479479
480480
You have to update this file every time you add a new dependency or change a revision or version of an existing dependency.
481481
482-
To do that, run the following command in the repository root:
482+
> [!NOTE]
483+
> Conan uses local cache by default when creating a lockfile.
484+
>
485+
> To ensure, that lockfile creation works the same way on all developer machines, you should clear the local cache before creating a new lockfile.
486+
487+
To create a new lockfile, run the following commands in the repository root:
483488
484489
```bash
490+
conan remove '*' --confirm
491+
rm conan.lock
492+
# This ensure that xrplf remote is the first to be consulted
493+
conan remote add --force --index 0 xrplf https://conan.ripplex.io
485494
conan lock create . -o '&:jemalloc=True' -o '&:rocksdb=True'
486495
```
487496

497+
> [!NOTE]
498+
> If some dependencies are exclusive for some OS, you may need to run the last command for them adding `--profile:all <PROFILE>`.
499+
488500
## Coverage report
489501

490502
The coverage report is intended for developers using compilers GCC
@@ -586,6 +598,11 @@ After any updates or changes to dependencies, you may need to do the following:
586598
4. [Regenerate lockfile](#conan-lockfile).
587599
5. Re-run [conan install](#build-and-test).
588600

601+
#### ERROR: Package not resolved
602+
603+
If you're seeing an error like `ERROR: Package 'snappy/1.1.10' not resolved: Unable to find 'snappy/1.1.10#968fef506ff261592ec30c574d4a7809%1756234314.246' in remotes.`,
604+
please add `xrplf` remote or re-run `conan export` for [patched recipes](#patched-recipes).
605+
589606
### `protobuf/port_def.inc` file not found
590607

591608
If `cmake --build .` results in an error due to a missing a protobuf file, then

0 commit comments

Comments
 (0)