mirrors/core-lightning
1
0
Fork 0
mirror of https://github.com/ElementsProject/lightning.git synced 2025-03-10 17:19:15 +01:00
Code Issues Projects Releases Wiki Activity
core-lightning/doc/lightning-check.7.md

49 lines
1.3 KiB
Markdown
Raw Normal View History

docs: Update manpages to be recognized correctly by mrkd mrkd started enforcing the `name -- short description` style of top-level headings somewhere, and was thus failing to build the man-pages. I swapped the title and with the existing short description to make it work again. `mrkd` will automatically infer the section from the filename so no need to put it in the title as well. In addition I removed the "last updated" lines at the bottom since they are out of date at best, and misleading at the worst. If we want to keep them, I'd suggest generating them from the commit that last touched them.
2019-08-31 14:30:56 +02:00
lightning-check -- Command for verifying parameters
doc/manpages: replace asciidoc by markdown
2019-08-10 01:54:18 +02:00
==============================
SYNOPSIS
--------
Remove useless \
2022-01-26 18:18:49 +01:00
**check** *command\_to\_check* [*parameters*]
doc/manpages: replace asciidoc by markdown
2019-08-10 01:54:18 +02:00
DESCRIPTION
-----------
lightningd: use param_check on all commands which do extra checks. This makes `check` much more thorough, and useful. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au> Changelog-Added: JSON-RPC: `check` now does much more checking on every command (not just basic parameter types).
2023-10-25 07:39:04 +10:30
The **check** RPC command verifies another command without actually
making any changes.
doc/manpages: replace asciidoc by markdown
2019-08-10 01:54:18 +02:00
The *command\_to\_check* is the name of the relevant command.
doc: Remove non-ASCII character from docs mrkd doesn't like non-ASCII characters in ubuntu:18.04, used for repro-builds. This is the easiest way to sidestep this issue until we deprecate the old ubuntu version.
2021-10-24 11:44:56 +02:00
*parameters* is the command's parameters.
doc/manpages: replace asciidoc by markdown
2019-08-10 01:54:18 +02:00
lightningd: use param_check on all commands which do extra checks. This makes `check` much more thorough, and useful. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au> Changelog-Added: JSON-RPC: `check` now does much more checking on every command (not just basic parameter types).
2023-10-25 07:39:04 +10:30
This is guaranteed to be safe, and will do all checks up to the point
where something in the system would need to be altered (such as checking
that channels are in the right state, peers connected, etc).
It does not guarantee successful execution of the command in all
doc/manpages: replace asciidoc by markdown
2019-08-10 01:54:18 +02:00
cases. For example, a call to lightning-getroute(7) may still fail to
find a route even if checking the parameters succeeds.
RETURN VALUE
------------
doc/schemas: add some simple schemas and generate manpages from them addgossip, check, createinvoice, createonion. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-05-26 15:20:01 +09:30
[comment]: # (GENERATE-FROM-SCHEMA-START)
On success, an object is returned, containing:
doc: generate correct markdown from schemas. You can't start a list without a paragraph separator. ```diff --- /tmp/before 2022-07-20 22:02:23.485372596 +0930 +++ /tmp/after 2022-07-20 22:02:33.745528456 +0930 @@ -21,12 +21,16 @@ On startup of the daemon, no autoclean is set up. RETURN VALUE - On success, an object is returned, containing: - enabled (boolean): - whether invoice autocleaning is active + On success, an object is returned, containing: - If enabled is true: - expired_by (u64): how long an invoice must be ex‐ - pired (seconds) before we delete it - cycle_seconds (u64): how long an - invoice must be expired (seconds) before we delete it + • enabled (boolean): whether invoice autocleaning is active + + If enabled is true: + + • expired_by (u64): how long an invoice must be expired (seconds) be‐ + fore we delete it + • cycle_seconds (u64): how long an invoice must be expired (seconds) + before we delete it AUTHOR ZmnSCPxj <ZmnSCPxj@protonmail.com> is mainly responsible. ``` Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2022-09-06 07:03:09 +09:30
fromschema.py: escape underscores in descriptions
2022-11-10 21:03:13 -05:00
- **command\_to\_check** (string): the *command\_to\_check* argument
doc: fix GH/readthedocs rendering of manual pages. They render the comment as if it's in the list. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-09-03 19:37:59 +09:30
doc/schemas: add some simple schemas and generate manpages from them addgossip, check, createinvoice, createonion. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-05-26 15:20:01 +09:30
[comment]: # (GENERATE-FROM-SCHEMA-END)
doc/manpages: replace asciidoc by markdown
2019-08-10 01:54:18 +02:00
AUTHOR
------
Mark Beckwith <<wythe@intrig.com>> and Rusty Russell
<<rusty@rustcorp.com.au>> are mainly responsible.
RESOURCES
---------
Main web site: <https://github.com/ElementsProject/lightning>
doc: force refresh of all manpages. The idea is that you regenerate the man pages in the same commit you alter them: that's how we know whether to try regenerating them or not (git doesn't store timestamps, so it can't really tell). Travis will now check this, so force them all to sync to this commit. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2020-08-25 11:03:16 +09:30
tools/fromschema.py: don't try to handle more complex cases. We only handle top-level objects with an array of objects: make sure it is one before we call the routines. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2023-01-30 16:54:16 +10:30
[comment]: # ( SHA256STAMP:069205c0316e7096044ef71b3fa2525e389c907b45c73177469d06e69d03873c)
Reference in a new issue Copy permalink