What changed, and why it matters
This commit only updates documentation. It adds the '--frozen' flag to 'uv sync' commands in the installation guide so that the build tool does not update the dependency lock file automatically. This prevents the working directory from becoming 'dirty' during a build, which could otherwise cause the compiled Core Lightning version string to incorrectly show as modified. There is no code change and no security vulnerability is introduced or fixed.
No security action needed. This is a documentation-only quality improvement. Reviewers may optionally verify that the --frozen flag is appropriate for the documented build workflows.
Security signals we found
No strong security signals were identified.
Evidence from the diff
The diff modifies doc/getting-started/getting-started/installation.md, replacing occurrences of ‘uv sync –all-extras –all-groups’ with ‘uv sync –all-extras –all-groups –frozen’. The –frozen flag tells uv to use the existing uv.lock file without modifying it. The commit message states the purpose is to avoid a dirty working directory that would produce a ‘modded cln version build’. The remaining changes are whitespace/line-ending cleanups. No source code, build scripts, or dependency files are changed.
Changed components
doc/getting-started/getting-started/installation.mdInspect captured patch +20 / −20
diff --git a/doc/getting-started/getting-started/installation.md b/doc/getting-started/getting-started/installation.md
index c9ea9757..045bfbc0 100644
--- a/doc/getting-started/getting-started/installation.md
+++ b/doc/getting-started/getting-started/installation.md
@@ -29,7 +29,7 @@ If you're on a different distribution or OS, you can compile the source by follo
# Docker
-To install the Docker image for the latest stable release:
+To install the Docker image for the latest stable release:
```shell
docker pull elementsproject/lightningd:latest
@@ -129,8 +129,8 @@ If you want to build the Rust plugins (cln-grpc, clnrest, cln-bip353 and wss-pro
sudo apt-get install -y cargo rustfmt protobuf-compiler
```
-> 📘
->
+> 📘
+>
> If your build fails because of your Rust version, you might want to check out [rustup](https://rustup.rs/) to install a newer version
@@ -139,20 +139,20 @@ There are two ways to build core lightning, and this depends on how you want use
To build CLN for production:
```shell
-uv sync --all-extras --all-groups
+uv sync --all-extras --all-groups --frozen
./configure
RUST_PROFILE=release uv run make
sudo RUST_PROFILE=release make install
```
-> 📘
->
+> 📘
+>
> If you want to disable Rust because you don’t need it or its plugins (cln-grpc, clnrest, cln-bip353 or wss-proxy), you can use `./configure --disable-rust`.
To build CLN for development:
```shell
-uv sync --all-extras --all-groups
+uv sync --all-extras --all-groups --frozen
./configure
uv run make
uv run make check VALGRIND=0
@@ -262,15 +262,15 @@ If you want to compile locally and fiddle with compile time options:
See `/usr/ports/net-p2p/c-lightning/Makefile` for instructions on how to build from an arbitrary git commit, instead of the latest release tag.
-> 📘
->
+> 📘
+>
> Make sure you've set an utf-8 locale, e.g. `export LC_CTYPE=en_US.UTF-8`, otherwise manpage installation may fail.
Running lightning:
Configure bitcoind, if not already: add `rpcuser=<foo>` and `rpcpassword=<bar>` to `/usr/local/etc/bitcoin.conf`, maybe also `testnet=1`.
-Configure lightningd: copy `/usr/local/etc/lightningd-bitcoin.conf.sample` to
+Configure lightningd: copy `/usr/local/etc/lightningd-bitcoin.conf.sample` to
`/usr/local/etc/lightningd-bitcoin.conf` and edit according to your needs.
```shell
@@ -385,15 +385,15 @@ git checkout v24.05
Build lightning:
```shell
-uv sync --all-extras --all-groups
+uv sync --all-extras --all-groups --frozen
./configure
uv run make
```
Running lightning:
-> 📘
->
+> 📘
+>
> Edit your `~/Library/Application\ Support/Bitcoin/bitcoin.conf`to include `rpcuser=<foo>` and `rpcpassword=<bar>` first, you may also need to include `testnet=1`.
```shell
@@ -446,7 +446,7 @@ Launch Core Lightning:
## To cross-compile for Android
-Make a standalone toolchain as per <https://developer.android.com/ndk/guides/standalone_toolchain.html>.
+Make a standalone toolchain as per <https://developer.android.com/ndk/guides/standalone_toolchain.html>.
For Core Lightning you must target an API level of 24 or higher.
Depending on your toolchain location and target arch, source env variables such as:
@@ -471,8 +471,8 @@ make clean -C ccan/ccan/cdump/tools \
&& make CC=clang -C ccan/ccan/cdump/tools
```
-Install the `qemu-user` package.
-This will allow you to properly configure the build for the target device environment.
+Install the `qemu-user` package.
+This will allow you to properly configure the build for the target device environment.
Build with:
```shell
@@ -499,8 +499,8 @@ export LD=$target_host-ld
export STRIP=$target_host-strip
```
-Install the `qemu-user` package. This will allow you to properly configure the
-build for the target device environment.
+Install the `qemu-user` package. This will allow you to properly configure the
+build for the target device environment.
Config the arm elf interpreter prefix:
```shell
@@ -544,7 +544,7 @@ For all the other Pi devices out there, consider using [Armbian](https://www.arm
You can compile in `customize-image.sh` using the instructions for Ubuntu.
-A working example that compiles both bitcoind and Core Lightning for Armbian can
+A working example that compiles both bitcoind and Core Lightning for Armbian can
be found [here](https://github.com/Sjors/armbian-bitcoin-core).
## To compile for Alpine
@@ -588,6 +588,6 @@ apk add libgcc libsodium sqlite-libs zlib
## Python plugins
-Python plugins will be installed with the `poetry install` step mentioned above fron development setup.
+Python plugins will be installed with the `poetry install` step mentioned above fron development setup.
Other users will need some Python packages if python plugins are used. Unfortunately there are some Python packages which are not packaged in Ubuntu, and so force installation will be needed (Flag `--user` is recommended which will install them in user's own .local directory, so at least the risk of breaking Python globally can be avoided!).
Why this scored 15/100
Community notes
Notes can correct, qualify, or add evidence to the AI analysis. Every note shown here has been validated by a human moderator.
The AI analysis stands alone for now. Submit a note if you can add evidence or important context.