ElementsProject / lightning

Core Lightning — Lightning Network implementation focusing on spec compliance and performance
Other
2.83k stars 899 forks source link

Not all commands have man pages, or complete descriptions of input/output fields #1877

Open rustyrussell opened 6 years ago

rustyrussell commented 6 years ago
ZmnSCPxj commented 6 years ago

Duplicates #1360

Alternatively we could close that and make a list of remaining commands that still need manpages.

darosior commented 4 years ago

The feerates command doesn't have a manpage.

jsarenik commented 3 years ago

experimental-dual-fund

~/src/lightning $ git describe
v0.10.0rc2
~/src/lightning $ make check
diff of command names vs manpage names:
--- /dev/fd/63  2021-03-28 14:15:22.170968182 +0200
+++ /dev/fd/62  2021-03-28 14:15:22.171968159 +0200
@@ -26,7 +26,6 @@
 disable-plugin=
 enable-autotor-v2-mode
 encrypted-hsm
-experimental-dual-fund
 experimental-offers
 experimental-onion-messages
 experimental-shutdown-wrong-funding
make: *** [doc/Makefile:129: check-manpages] Error 2
jsarenik commented 3 years ago

Reproduced again after a git clean -xffd and git submodule deinit --all --force.

The error happens with when make check-manpages runs this:

~/src/lightning $ make
...
~/src/lightning $ tools/check-manpage.sh "lightningd/lightningd --lightning-dir=/tmp/" doc/lightningd-config.5.md
... (the same output as in previous comment after make check) ...

EDIT: there were missing parts, now added

vincenzopalazzo commented 3 years ago

Maybe this plugin can help to have a complete list of all commands without docs

laanwj commented 3 years ago

Looks like fetchinvoice-noconnect, introduced in c974fbf0f1ec1899a7d0c375fb867e6d4a9950e1 is missing docs:

$ make check-config-docs
fetchinvoice-noconnect documented but not in schema!
make: *** [doc/Makefile:149: check-config-docs] Error 1
grubles commented 10 months ago
$ make check-manpages

diff of command names vs manpage names:
--- lightningd/lightningd --lightning-dir=/tmp/
+++ doc/lightningd-config.5.md
@@ -58,6 +58,7 @@
 fetchinvoice-noconnect
 force-feerates=
 funding-confirms=
+grpc-port=
 help
 htlc-maximum-msat=
 htlc-minimum-msat=
make: *** [doc/Makefile:222: check-manpages] Error 2