mirrors/core-lightning
1
0
Fork 0
mirror of https://github.com/ElementsProject/lightning.git synced 2024-11-19 01:43:36 +01:00
Code Issues Projects Releases Wiki Activity
d6ae456309
core-lightning/doc/Makefile

249 lines
8.5 KiB
Makefile
Raw Normal View History

doc: move Makefile parts into doc/ Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2017-01-23 01:05:27 +01:00
#! /usr/bin/make
# Designed to be run one level up
doc-wrongdir:
$(MAKE) -C .. doc-all
script: Update scripts - Update `make doc-all` script - `fromschema.py` script - Updated to generate whole doc/lightning-*.md via doc/schemas/lightning-*.json file - Updated to print request params - Added `oneOfMany` condition for request params - Added `pairedWith` condition for request params - Added `dependentUpon` condition for request params - Updated for pre and post_return_value for response - Hiding `hidden` fields - `descriptions` are array now - Unified gaps between titles - Added default key-value pair - script: msggen, sql-schema, listconfig and pyln-testing script updates This does not add created markdowns for cleaner review. We will add the markdown files in a separate commit.
2024-03-04 03:30:24 +01:00
GENERATE_MARKDOWN := doc/lightning-addgossip.7 \
doc/lightning-addpsbtoutput.7 \
doc: document autoclean-once command. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2022-12-05 20:05:01 +01:00
doc/lightning-autoclean-once.7 \
doc: manpages and schemas for autoclean-status. And remove deprecated autocleaninvoice docs. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au> Changelog-Added: Plugins: `autoclean-status` command to see what autoclean is doing. Changelog-Deprecated: JSON-RPC: `autocleaninvoice` (use option `autoclean-expiredinvoices-age`)
2022-09-19 02:53:00 +02:00
doc/lightning-autoclean-status.7 \
lightningd: allow a connection to specify db batching. Previous commit was a hack which *always* batched where possible, this is a more sophisticated opt-in varaint, with a timeout sanity check. Final performance for cleaning up 1M pays/forwards/invoices: ``` $ time l1-cli autoclean-once succeededpays 1 { "autoclean": { "succeededpays": { "cleaned": 1000000, "uncleaned": 26895 } } } real 6m9.828s user 0m0.003s sys 0m0.001s $ time l2-cli autoclean-once succeededforwards 1 { "autoclean": { "succeededforwards": { "cleaned": 1000000, "uncleaned": 40 } } } real 3m20.789s user 0m0.004s sys 0m0.001s $ time l3-cli autoclean-once paidinvoices 1 { "autoclean": { "paidinvoices": { "cleaned": 1000000, "uncleaned": 0 } } } real 6m47.941s user 0m0.001s sys 0m0.000s ``` Signed-off-by: Rusty Russell <rusty@rustcorp.com.au> Changelog-Added: JSON-RPC: `batching` command to allow database transactions to cross multiple back-to-back JSON commands.
2022-09-19 02:54:23 +02:00
doc/lightning-batching.7 \
bkpr: add docs, change names to 'bkpr-*' Adds schema definitions and manpages for bkpr- commands; also renames the commands to all start with 'bkpr-', so they're easier to identify/ make runes about.
2022-07-19 09:34:39 +02:00
doc/lightning-bkpr-channelsapy.7 \
doc/lightning-bkpr-dumpincomecsv.7 \
doc/lightning-bkpr-inspect.7 \
doc/lightning-bkpr-listaccountevents.7 \
doc/lightning-bkpr-listbalances.7 \
doc/lightning-bkpr-listincome.7 \
docs: document all the rune commands which look like the now-deprecated commando ones. Rune functionality moved into core from commando plugin. Changelog-Added: JSON-RPC: `checkrune`: check rune validity for authorization; `createrune` to create/modify rune; `listrunes` to list existing runes; `blacklistrune` to revoke permission of rune Changelog-Deprecated: JSON-RPC: `commando-rune`, `commando-listrunes` and `commando-blacklist`. No-schema-diff-check
2023-07-21 03:25:45 +02:00
doc/lightning-blacklistrune.7 \
doc: check manpage Signed-off-by: Mark Beckwith <wythe@intrig.com>
2018-12-07 18:31:16 +01:00
doc/lightning-check.7 \
doc: man pages for checkmessage and signmessage. They're a little subtle, so let's spell out exactly what checkmessage means. In particular, we avoid discussing key derivation from a signature, as it tends to get people (like me!) into trouble: we describe it instead as iterating through every known node. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2019-10-13 07:19:37 +02:00
doc/lightning-checkmessage.7 \
docs: document all the rune commands which look like the now-deprecated commando ones. Rune functionality moved into core from commando plugin. Changelog-Added: JSON-RPC: `checkrune`: check rune validity for authorization; `createrune` to create/modify rune; `listrunes` to list existing runes; `blacklistrune` to revoke permission of rune Changelog-Deprecated: JSON-RPC: `commando-rune`, `commando-listrunes` and `commando-blacklist`. No-schema-diff-check
2023-07-21 03:25:45 +02:00
doc/lightning-checkrune.7 \
peer_control: Make close wait for complete closure, with timeout. Also report tx and txid, and whether we closed unilaterally or bilaterally, if we could close the channel. Also make a manpage. Fixes: #1207 Fixes: #714 Fixes: #622
2018-04-10 08:03:15 +02:00
doc/lightning-close.7 \
doc: commando-listrunes & commando-blacklist
2023-03-31 03:56:18 +02:00
doc/lightning-commando-blacklist.7 \
script: Update scripts - Update `make doc-all` script - `fromschema.py` script - Updated to generate whole doc/lightning-*.md via doc/schemas/lightning-*.json file - Updated to print request params - Added `oneOfMany` condition for request params - Added `pairedWith` condition for request params - Added `dependentUpon` condition for request params - Updated for pre and post_return_value for response - Hiding `hidden` fields - `descriptions` are array now - Unified gaps between titles - Added default key-value pair - script: msggen, sql-schema, listconfig and pyln-testing script updates This does not add created markdowns for cleaner review. We will add the markdown files in a separate commit.
2024-03-04 03:30:24 +01:00
doc/lightning-commando.7 \
doc: commando-listrunes & commando-blacklist
2023-03-31 03:56:18 +02:00
doc/lightning-commando-listrunes.7 \
doc: document commando and commando-rune. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2022-07-16 15:18:27 +02:00
doc/lightning-commando-rune.7 \
script: Update scripts - Update `make doc-all` script - `fromschema.py` script - Updated to generate whole doc/lightning-*.md via doc/schemas/lightning-*.json file - Updated to print request params - Added `oneOfMany` condition for request params - Added `pairedWith` condition for request params - Added `dependentUpon` condition for request params - Updated for pre and post_return_value for response - Hiding `hidden` fields - `descriptions` are array now - Unified gaps between titles - Added default key-value pair - script: msggen, sql-schema, listconfig and pyln-testing script updates This does not add created markdowns for cleaner review. We will add the markdown files in a separate commit.
2024-03-04 03:30:24 +01:00
doc/lightning-connect.7 \
lightningd: createinvoice low-level invoice creation command. This takes an unsigned bolt11 (or bolt12 if EXPERIMENTAL_FEATURES) string and signs it and puts it in the database. The invoice command could now be moved out to a plugin, in fact. Changelog-Added: JSON-RPC: `createinvoice` new low-level invoice creation API. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2020-12-14 02:21:48 +01:00
doc/lightning-createinvoice.7 \
script: Update scripts - Update `make doc-all` script - `fromschema.py` script - Updated to generate whole doc/lightning-*.md via doc/schemas/lightning-*.json file - Updated to print request params - Added `oneOfMany` condition for request params - Added `pairedWith` condition for request params - Added `dependentUpon` condition for request params - Updated for pre and post_return_value for response - Hiding `hidden` fields - `descriptions` are array now - Unified gaps between titles - Added default key-value pair - script: msggen, sql-schema, listconfig and pyln-testing script updates This does not add created markdowns for cleaner review. We will add the markdown files in a separate commit.
2024-03-04 03:30:24 +01:00
doc/lightning-createonion.7 \
docs: document all the rune commands which look like the now-deprecated commando ones. Rune functionality moved into core from commando plugin. Changelog-Added: JSON-RPC: `checkrune`: check rune validity for authorization; `createrune` to create/modify rune; `listrunes` to list existing runes; `blacklistrune` to revoke permission of rune Changelog-Deprecated: JSON-RPC: `commando-rune`, `commando-listrunes` and `commando-blacklist`. No-schema-diff-check
2023-07-21 03:25:45 +02:00
doc/lightning-createrune.7 \
datastore: docs, schemas, and a test. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-08-25 04:50:12 +02:00
doc/lightning-datastore.7 \
datastore: Add datastoreusage command datastoreusage returns the total_bytes that are stored under a given {Key} or from root. {Key} is the entry point from which we begin to traverse the datastore. Changelog-Added: JSON-RPC: `datastoreusage`: returns the total bytes that are stored under a given key. Signed-off-by: Peter Neuroth <pet.v.ne@gmail.com>
2023-07-24 20:47:46 +02:00
doc/lightning-datastoreusage.7 \
decode: new generic API to decode bolt11 and bolt12. This is experimental for now, but can eventually deprecated 'decodepay' and even decode other kinds of messages. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-01-07 19:48:47 +01:00
doc/lightning-decode.7 \
script: Update scripts - Update `make doc-all` script - `fromschema.py` script - Updated to generate whole doc/lightning-*.md via doc/schemas/lightning-*.json file - Updated to print request params - Added `oneOfMany` condition for request params - Added `pairedWith` condition for request params - Added `dependentUpon` condition for request params - Updated for pre and post_return_value for response - Hiding `hidden` fields - `descriptions` are array now - Unified gaps between titles - Added default key-value pair - script: msggen, sql-schema, listconfig and pyln-testing script updates This does not add created markdowns for cleaner review. We will add the markdown files in a separate commit.
2024-03-04 03:30:24 +01:00
doc/lightning-decodepay.7 \
datastore: docs, schemas, and a test. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-08-25 04:50:12 +02:00
doc/lightning-deldatastore.7 \
lightningd: add `delforward` command. Changelog-Added: JSON-RPC: `delforward` command to delete listforwards entries. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2022-09-19 02:52:58 +02:00
doc/lightning-delforward.7 \
doc: move Makefile parts into doc/ Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2017-01-23 01:05:27 +01:00
doc/lightning-delinvoice.7 \
delpay: code style changes and fixed docs Changelog-Added: JSON-RPC: delpay a new method to delete the payment completed or failed. Signed-off-by: Vincenzo Palazzo <vincenzopalazzodev@gmail.com>
2020-08-08 17:47:53 +02:00
doc/lightning-delpay.7 \
jsonrpc: add deprecations command to locally set deprecated apis on/off. This command allows more fine-grained testing, without having to change the config of the lightning node. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au> Changelog-Added: JSON-RPC: `deprecations` to enable/disable deprecated APIs from this caller.
2024-01-25 01:28:54 +01:00
doc/lightning-deprecations.7 \
doc: add dev-forget-channel to Makefile
2024-02-06 06:56:24 +01:00
doc/lightning-dev-forget-channel.7 \
doc: add documentation for invoicerequest commands. As reported on Discord, these are undocumented. And thus, um, hard to find! Reported-by: Aaron Barnard Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2023-03-06 04:00:58 +01:00
doc/lightning-disableinvoicerequest.7 \
doc: add disableoffer and listoffers manpages. I noticed that offer(7) referred to `deloffer` which doesn't exist. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-02-18 00:56:19 +01:00
doc/lightning-disableoffer.7 \
Man page for lightning-disconnect created
2018-12-03 06:20:25 +01:00
doc/lightning-disconnect.7 \
doc: Add documentation for new RPCs and a FIXME: in fromschema.py
2022-06-24 03:39:12 +02:00
doc/lightning-emergencyrecover.7 \
doc/lightning-feerates.7.md: Document `feerates` command. Changelog-None
2020-07-12 05:30:35 +02:00
doc/lightning-feerates.7 \
doc: document experimental commands. Not the low-level ones, just enough that people can play with the APIs. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-01-07 19:45:47 +01:00
doc/lightning-fetchinvoice.7 \
script: Update scripts - Update `make doc-all` script - `fromschema.py` script - Updated to generate whole doc/lightning-*.md via doc/schemas/lightning-*.json file - Updated to print request params - Added `oneOfMany` condition for request params - Added `pairedWith` condition for request params - Added `dependentUpon` condition for request params - Updated for pre and post_return_value for response - Hiding `hidden` fields - `descriptions` are array now - Unified gaps between titles - Added default key-value pair - script: msggen, sql-schema, listconfig and pyln-testing script updates This does not add created markdowns for cleaner review. We will add the markdown files in a separate commit.
2024-03-04 03:30:24 +01:00
doc/lightning-fundchannel_cancel.7 \
doc/lightning-fundchannel_complete.7 \
Added fundchannel man page. This describes 'fundchannel' as it works today. It definitely could use better error codes instead of -1 for everything.
2018-05-03 16:54:39 +02:00
doc/lightning-fundchannel.7 \
doc: add manpages for fundchannel_[start,complete,cancel] Manpages for the manpage-god!!
2019-06-06 01:32:04 +02:00
doc/lightning-fundchannel_start.7 \
funderupdate: add documentation, update some params Documentation for the funderupdate command on the funder plugin. Realized we were missing the "leases_only" in the output; also adds '_msat' to msat denominated outputs so they're parsed correctly by our python bindings (also matches our naming conventions) Changelog-EXPERIMENTAL: funder: `funderupdate` command to view and update params for contributing our wallet funds to v2 channel openings. Provides params for enabling `option_will_fund`.
2021-07-15 18:48:36 +02:00
doc/lightning-funderupdate.7 \
doc: document fundpsbt. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2020-07-15 07:39:47 +02:00
doc/lightning-fundpsbt.7 \
script: Update scripts - Update `make doc-all` script - `fromschema.py` script - Updated to generate whole doc/lightning-*.md via doc/schemas/lightning-*.json file - Updated to print request params - Added `oneOfMany` condition for request params - Added `pairedWith` condition for request params - Added `dependentUpon` condition for request params - Updated for pre and post_return_value for response - Hiding `hidden` fields - `descriptions` are array now - Unified gaps between titles - Added default key-value pair - script: msggen, sql-schema, listconfig and pyln-testing script updates This does not add created markdowns for cleaner review. We will add the markdown files in a separate commit.
2024-03-04 03:30:24 +01:00
doc/lightning-getinfo.7 \
doc/lightning-getlog.7 \
doc: move Makefile parts into doc/ Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2017-01-23 01:05:27 +01:00
doc/lightning-getroute.7 \
script: Update scripts - Update `make doc-all` script - `fromschema.py` script - Updated to generate whole doc/lightning-*.md via doc/schemas/lightning-*.json file - Updated to print request params - Added `oneOfMany` condition for request params - Added `pairedWith` condition for request params - Added `dependentUpon` condition for request params - Updated for pre and post_return_value for response - Hiding `hidden` fields - `descriptions` are array now - Unified gaps between titles - Added default key-value pair - script: msggen, sql-schema, listconfig and pyln-testing script updates This does not add created markdowns for cleaner review. We will add the markdown files in a separate commit.
2024-03-04 03:30:24 +01:00
doc/lightning-help.7 \
doc: move Makefile parts into doc/ Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2017-01-23 01:05:27 +01:00
doc/lightning-invoice.7 \
doc: add documentation for invoicerequest commands. As reported on Discord, these are undocumented. And thus, um, hard to find! Reported-by: Aaron Barnard Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2023-03-06 04:00:58 +01:00
doc/lightning-invoicerequest.7 \
doc: Add a man-page for the new keysend command
2020-07-01 13:35:58 +02:00
doc/lightning-keysend.7 \
Manpage for lightning-listchannels created
2019-01-07 20:09:59 +01:00
doc/lightning-listchannels.7 \
lightningd: add listclosedchannels command. Changelog-Added: JSON-RPC: `listclosedchannels` to show old, dead channels we previously had with peers. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2023-03-20 01:21:50 +01:00
doc/lightning-listclosedchannels.7 \
script: Update scripts - Update `make doc-all` script - `fromschema.py` script - Updated to generate whole doc/lightning-*.md via doc/schemas/lightning-*.json file - Updated to print request params - Added `oneOfMany` condition for request params - Added `pairedWith` condition for request params - Added `dependentUpon` condition for request params - Updated for pre and post_return_value for response - Hiding `hidden` fields - `descriptions` are array now - Unified gaps between titles - Added default key-value pair - script: msggen, sql-schema, listconfig and pyln-testing script updates This does not add created markdowns for cleaner review. We will add the markdown files in a separate commit.
2024-03-04 03:30:24 +01:00
doc/lightning-listconfigs.7 \
datastore: docs, schemas, and a test. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-08-25 04:50:12 +02:00
doc/lightning-listdatastore.7 \
manually added a list-forward manpage because I have no idea how a2x works
2019-01-11 23:05:46 +01:00
doc/lightning-listforwards.7 \
documentation: s/Protocol/Command/
2018-04-26 12:22:09 +02:00
doc/lightning-listfunds.7 \
lightningd: add `listhtlcs` to list all the HTLCs we know about. Using `listfowards` for this wrong; expose this directly if people care (and unlike listforwards, which could be deleted, we have to remember these while the channel is still open!). Signed-off-by: Rusty Russell <rusty@rustcorp.com.au> Changelog-Added: JSON-RPC: `listhtlcs` new command to list all known HTLCS.
2022-09-19 02:49:53 +02:00
doc/lightning-listhtlcs.7 \
doc: add documentation for invoicerequest commands. As reported on Discord, these are undocumented. And thus, um, hard to find! Reported-by: Aaron Barnard Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2023-03-06 04:00:58 +01:00
doc/lightning-listinvoicerequests.7 \
script: Update scripts - Update `make doc-all` script - `fromschema.py` script - Updated to generate whole doc/lightning-*.md via doc/schemas/lightning-*.json file - Updated to print request params - Added `oneOfMany` condition for request params - Added `pairedWith` condition for request params - Added `dependentUpon` condition for request params - Updated for pre and post_return_value for response - Hiding `hidden` fields - `descriptions` are array now - Unified gaps between titles - Added default key-value pair - script: msggen, sql-schema, listconfig and pyln-testing script updates This does not add created markdowns for cleaner review. We will add the markdown files in a separate commit.
2024-03-04 03:30:24 +01:00
doc/lightning-listinvoices.7 \
doc/lightning-listnodes.7 \
doc: add disableoffer and listoffers manpages. I noticed that offer(7) referred to `deloffer` which doesn't exist. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-02-18 00:56:19 +01:00
doc/lightning-listoffers.7 \
listpays: new command to summarize pay commands. This is to future-proof against multi-part-payments: the low-level commands will start returning multiple results once we have that, so prepare transition plan now. Closes: #2372 Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2019-02-23 06:00:04 +01:00
doc/lightning-listpays.7 \
lightningd: add listpeerchannels command Changelog-Added: JSON-RPC: new command `listpeerchannels` now contains information on direct channels with our peers. Signed-off-by: Vincenzo Palazzo <vincenzopalazzodev@gmail.com>
2023-01-12 02:16:10 +01:00
doc/lightning-listpeerchannels.7 \
script: Update scripts - Update `make doc-all` script - `fromschema.py` script - Updated to generate whole doc/lightning-*.md via doc/schemas/lightning-*.json file - Updated to print request params - Added `oneOfMany` condition for request params - Added `pairedWith` condition for request params - Added `dependentUpon` condition for request params - Updated for pre and post_return_value for response - Hiding `hidden` fields - `descriptions` are array now - Unified gaps between titles - Added default key-value pair - script: msggen, sql-schema, listconfig and pyln-testing script updates This does not add created markdowns for cleaner review. We will add the markdown files in a separate commit.
2024-03-04 03:30:24 +01:00
doc/lightning-listpeers.7 \
listsendpays: updated version of listpayments. New name is less confusing, and most people should be transitioning to listpays rather than this anyway. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2019-02-23 06:00:04 +01:00
doc/lightning-listsendpays.7 \
script: Update scripts - Update `make doc-all` script - `fromschema.py` script - Updated to generate whole doc/lightning-*.md via doc/schemas/lightning-*.json file - Updated to print request params - Added `oneOfMany` condition for request params - Added `pairedWith` condition for request params - Added `dependentUpon` condition for request params - Updated for pre and post_return_value for response - Hiding `hidden` fields - `descriptions` are array now - Unified gaps between titles - Added default key-value pair - script: msggen, sql-schema, listconfig and pyln-testing script updates This does not add created markdowns for cleaner review. We will add the markdown files in a separate commit.
2024-03-04 03:30:24 +01:00
doc/lightning-listtransactions.7 \
doc: Add documentation for new RPCs and a FIXME: in fromschema.py
2022-06-24 03:39:12 +02:00
doc/lightning-makesecret.7 \
doc/, contrib/: Additional support etc. for multifundchannel.
2020-09-09 05:11:37 +02:00
doc/lightning-multifundchannel.7 \
plugins/spender/multiwithdraw.c: Implement multiwithdraw command. Fixes: #2679 Changelog-Added: JSON-RPC: New `multiwithdraw` command to batch multiple onchain sends in a single transaction. Note it shuffles inputs and outputs, does not use BIP69.
2020-09-09 12:26:14 +02:00
doc/lightning-multiwithdraw.7 \
documentation: s/Protocol/Command/
2018-04-26 12:22:09 +02:00
doc/lightning-newaddr.7 \
JSON-RPC: notifications command. This lets callers enable notifications; we won't send any if they don't. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au> Changelog-Added: JSON-RPC: `notifications` command to enable notifications.
2020-10-12 07:33:50 +02:00
doc/lightning-notifications.7 \
doc: document experimental commands. Not the low-level ones, just enough that people can play with the APIs. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-01-07 19:45:47 +01:00
doc/lightning-offer.7 \
df: add openchannel_abort command Allows us to clean up an in-progress open that we won't be completing Changelog-Added: EXPERIMENTAL JSON-RPC: Permit user-initiated aborting of in-progress opens. Only valid for not-yet-committed opens and RBF-attempts
2021-03-09 22:14:08 +01:00
doc/lightning-openchannel_abort.7 \
df-doc: add docs for openchannel_bump, more checks for valid psbt Add docs for openchannel_bump, plus some checks that were missed for verifying the amount is valid.
2021-03-11 05:33:47 +01:00
doc/lightning-openchannel_bump.7 \
dualfund: opener, openchannel_init command (1/3) There are 3 commands for opening a channel with dualfunding. `openchannel_init` is the first of these. It initializes the open-channel dialog, and stops once we've run out of updates (input/outputs) to send to the peer.
2020-09-03 20:01:45 +02:00
doc/lightning-openchannel_init.7 \
df-open: commands to update a PSBT or submit a signed PSBT `openchannel_signed` and `openchannel_update` which allow a user to continue a openchannel or kick off the completion of a openchannel. `openchannel_update` should be called until it returns with `commitments_secured`.
2020-09-10 21:43:40 +02:00
doc/lightning-openchannel_signed.7 \
doc/lightning-openchannel_update.7 \
chaintopology: new command 'parsefeerate' Useful for parsing a passed in feerate before calling lightningd with it, e.g. when you need to know what the feerate is for a fundpsbt before calling fundpsbt Changelog-Added: JSON-RPC: new command `parsefeerate` which takes a feerate string and returns the calculated perkw/perkb
2021-06-23 21:31:47 +02:00
doc/lightning-parsefeerate.7 \
script: Update scripts - Update `make doc-all` script - `fromschema.py` script - Updated to generate whole doc/lightning-*.md via doc/schemas/lightning-*.json file - Updated to print request params - Added `oneOfMany` condition for request params - Added `pairedWith` condition for request params - Added `dependentUpon` condition for request params - Updated for pre and post_return_value for response - Hiding `hidden` fields - `descriptions` are array now - Unified gaps between titles - Added default key-value pair - script: msggen, sql-schema, listconfig and pyln-testing script updates This does not add created markdowns for cleaner review. We will add the markdown files in a separate commit.
2024-03-04 03:30:24 +01:00
doc/lightning-pay.7 \
doc/lightning-ping.7 \
doc/Makefile: Add lightning-plugin manpage
2019-08-10 01:22:23 +02:00
doc/lightning-plugin.7 \
hsmd: add hsmd_preapprove_invoice and check_preapproveinvoice pay modifier Changelog-added: hsmd: A new message `hsmd_preapprove_invoice` is added. Changelog-added: JSON-RPC: A new command `preapproveinvoice` is added.
2022-09-13 18:37:05 +02:00
doc/lightning-preapproveinvoice.7 \
hsmd: add hsmd_preapprove_keysend and check_preapprovekeysend pay modifier Changelog-added: hsmd: A new message `hsmd_preapprove_keysend` is added. Changelog-added: JSON-RPC: A new command `preapprovekeysend` is added.
2022-12-06 05:11:36 +01:00
doc/lightning-preapprovekeysend.7 \
doc: Add documentation for new RPCs and a FIXME: in fromschema.py
2022-06-24 03:39:12 +02:00
doc/lightning-recoverchannel.7 \
script: Update scripts - Update `make doc-all` script - `fromschema.py` script - Updated to generate whole doc/lightning-*.md via doc/schemas/lightning-*.json file - Updated to print request params - Added `oneOfMany` condition for request params - Added `pairedWith` condition for request params - Added `dependentUpon` condition for request params - Updated for pre and post_return_value for response - Hiding `hidden` fields - `descriptions` are array now - Unified gaps between titles - Added default key-value pair - script: msggen, sql-schema, listconfig and pyln-testing script updates This does not add created markdowns for cleaner review. We will add the markdown files in a separate commit.
2024-03-04 03:30:24 +01:00
doc/lightning-recover.7 \
renepay: add help for renepay & renepaystatus Signed-off-by: Lagrang3 <eduardo.quintana@pm.me>
2023-08-07 11:30:20 +02:00
doc/lightning-renepay.7 \
doc/lightning-renepaystatus.7 \
add manpages for reserve/unreserve
2020-06-10 02:20:18 +02:00
doc/lightning-reserveinputs.7 \
script: Update scripts - Update `make doc-all` script - `fromschema.py` script - Updated to generate whole doc/lightning-*.md via doc/schemas/lightning-*.json file - Updated to print request params - Added `oneOfMany` condition for request params - Added `pairedWith` condition for request params - Added `dependentUpon` condition for request params - Updated for pre and post_return_value for response - Hiding `hidden` fields - `descriptions` are array now - Unified gaps between titles - Added default key-value pair - script: msggen, sql-schema, listconfig and pyln-testing script updates This does not add created markdowns for cleaner review. We will add the markdown files in a separate commit.
2024-03-04 03:30:24 +01:00
doc/lightning-sendcustommsg.7 \
doc: document experimental commands. Not the low-level ones, just enough that people can play with the APIs. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-01-07 19:45:47 +01:00
doc/lightning-sendinvoice.7 \
doc: Add manpages for `createonion` and `sendonion` Changelog-Added: Added `createonion` and `sendonion` JSON-RPC methods allowing the implementation of custom protocol extensions that are not directly implemented in c-lightning itself.
2019-11-14 17:51:28 +01:00
doc/lightning-sendonion.7 \
doc: Manual page for sendonionmessage. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-01-14 04:36:49 +01:00
doc/lightning-sendonionmessage.7 \
doc: move Makefile parts into doc/ Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2017-01-23 01:05:27 +01:00
doc/lightning-sendpay.7 \
script: Update scripts - Update `make doc-all` script - `fromschema.py` script - Updated to generate whole doc/lightning-*.md via doc/schemas/lightning-*.json file - Updated to print request params - Added `oneOfMany` condition for request params - Added `pairedWith` condition for request params - Added `dependentUpon` condition for request params - Updated for pre and post_return_value for response - Hiding `hidden` fields - `descriptions` are array now - Unified gaps between titles - Added default key-value pair - script: msggen, sql-schema, listconfig and pyln-testing script updates This does not add created markdowns for cleaner review. We will add the markdown files in a separate commit.
2024-03-04 03:30:24 +01:00
doc/lightning-sendpsbt.7 \
lightningd: new setchannel command. Based on setchannelfee, but expanded to allow setting max htlc amount (and others in future?). The main differences: 1. It doesn't change values which are not specified (that would be hard to add fields to!) 2. It says exactly what all values are in any potentially changed channels. Changelog-Added: JSON-RPC: new `setchannel` command generalizes `setchannelfee`. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2022-03-21 01:58:28 +01:00
doc/lightning-setchannel.7 \
lightningd: setconfig command. Currently only implemented for min-capacity-sat. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au> Changelog-Added: JSON-RPC: new command `setconfig` allows a limited number of configuration settings to be changed without restart.
2023-06-06 02:38:52 +02:00
doc/lightning-setconfig.7 \
Add PSBT version setting RPC to aid with debugging and compatibility PSBTv2 support is quite low in the ecosystem, so having a call to convert log messages and the like should be useful since they'll often be in v2. Changelog-Added: Added setpsbtversion RPC to aid debugging and compatibility
2023-03-02 21:45:40 +01:00
doc/lightning-setpsbtversion.7 \
script: Update scripts - Update `make doc-all` script - `fromschema.py` script - Updated to generate whole doc/lightning-*.md via doc/schemas/lightning-*.json file - Updated to print request params - Added `oneOfMany` condition for request params - Added `pairedWith` condition for request params - Added `dependentUpon` condition for request params - Updated for pre and post_return_value for response - Hiding `hidden` fields - `descriptions` are array now - Unified gaps between titles - Added default key-value pair - script: msggen, sql-schema, listconfig and pyln-testing script updates This does not add created markdowns for cleaner review. We will add the markdown files in a separate commit.
2024-03-04 03:30:24 +01:00
doc/lightning-showrunes.7 \
lightningd: Add `signinvoice` to sign a BOLT11 invoice. Though there's already a `createinvoice` command, there are usecases where a user may want to sign an invoice that they don't yet have the preimage to. For example, they may have an htlc_accepted plugin that pays to obtain the preimage from someone else and returns a `{ "result": "resolve", ... }`. This RPC command addresses this usecase without overly complicating the semantics of the existing `createinvoice` command. Changelog-Added: JSON-RPC: `signinvoice` new command to sign BOLT11 invoices.
2022-11-07 01:45:47 +01:00
doc/lightning-signinvoice.7 \
doc: man pages for checkmessage and signmessage. They're a little subtle, so let's spell out exactly what checkmessage means. In particular, we avoid discussing key derivation from a signature, as it tends to get people (like me!) into trouble: we describe it instead as iterating through every known node. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2019-10-13 07:19:37 +02:00
doc/lightning-signmessage.7 \
script: Update scripts - Update `make doc-all` script - `fromschema.py` script - Updated to generate whole doc/lightning-*.md via doc/schemas/lightning-*.json file - Updated to print request params - Added `oneOfMany` condition for request params - Added `pairedWith` condition for request params - Added `dependentUpon` condition for request params - Updated for pre and post_return_value for response - Hiding `hidden` fields - `descriptions` are array now - Unified gaps between titles - Added default key-value pair - script: msggen, sql-schema, listconfig and pyln-testing script updates This does not add created markdowns for cleaner review. We will add the markdown files in a separate commit.
2024-03-04 03:30:24 +01:00
doc/lightning-signpsbt.7 \
splicing: Update documentation Added documentation for splice_update & splice_signed and tweaked splice_init. Added corresponding schemas for splice_* commands Changelog-None
2023-08-03 21:34:14 +02:00
doc/lightning-splice_init.7 \
doc/lightning-splice_signed.7 \
script: Update scripts - Update `make doc-all` script - `fromschema.py` script - Updated to generate whole doc/lightning-*.md via doc/schemas/lightning-*.json file - Updated to print request params - Added `oneOfMany` condition for request params - Added `pairedWith` condition for request params - Added `dependentUpon` condition for request params - Updated for pre and post_return_value for response - Hiding `hidden` fields - `descriptions` are array now - Unified gaps between titles - Added default key-value pair - script: msggen, sql-schema, listconfig and pyln-testing script updates This does not add created markdowns for cleaner review. We will add the markdown files in a separate commit.
2024-03-04 03:30:24 +01:00
doc/lightning-splice_update.7 \
lightningd: remove delexpiredinvoice Changelog-Removed: JSON-RPC: `delexpiredinvoice` (deprecated v22.11, EOL v24.02) Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2024-03-25 01:37:45 +01:00
doc/lightning-staticbackup.7 \
script: Update scripts - Update `make doc-all` script - `fromschema.py` script - Updated to generate whole doc/lightning-*.md via doc/schemas/lightning-*.json file - Updated to print request params - Added `oneOfMany` condition for request params - Added `pairedWith` condition for request params - Added `dependentUpon` condition for request params - Updated for pre and post_return_value for response - Hiding `hidden` fields - `descriptions` are array now - Unified gaps between titles - Added default key-value pair - script: msggen, sql-schema, listconfig and pyln-testing script updates This does not add created markdowns for cleaner review. We will add the markdown files in a separate commit.
2024-03-04 03:30:24 +01:00
doc/lightning-stop.7 \
wallet: new commands 'txprepare', 'txsend' and 'txdiscard'. This allows you to prepare a tx, then release or discard it later. Shares almost all the code with json_withdraw (which is now technically superfluous). Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2019-06-05 09:00:05 +02:00
doc/lightning-txdiscard.7 \
script: Update scripts - Update `make doc-all` script - `fromschema.py` script - Updated to generate whole doc/lightning-*.md via doc/schemas/lightning-*.json file - Updated to print request params - Added `oneOfMany` condition for request params - Added `pairedWith` condition for request params - Added `dependentUpon` condition for request params - Updated for pre and post_return_value for response - Hiding `hidden` fields - `descriptions` are array now - Unified gaps between titles - Added default key-value pair - script: msggen, sql-schema, listconfig and pyln-testing script updates This does not add created markdowns for cleaner review. We will add the markdown files in a separate commit.
2024-03-04 03:30:24 +01:00
doc/lightning-txprepare.7 \
wallet: new commands 'txprepare', 'txsend' and 'txdiscard'. This allows you to prepare a tx, then release or discard it later. Shares almost all the code with json_withdraw (which is now technically superfluous). Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2019-06-05 09:00:05 +02:00
doc/lightning-txsend.7 \
add manpages for reserve/unreserve
2020-06-10 02:20:18 +02:00
doc/lightning-unreserveinputs.7 \
script: Update scripts - Update `make doc-all` script - `fromschema.py` script - Updated to generate whole doc/lightning-*.md via doc/schemas/lightning-*.json file - Updated to print request params - Added `oneOfMany` condition for request params - Added `pairedWith` condition for request params - Added `dependentUpon` condition for request params - Updated for pre and post_return_value for response - Hiding `hidden` fields - `descriptions` are array now - Unified gaps between titles - Added default key-value pair - script: msggen, sql-schema, listconfig and pyln-testing script updates This does not add created markdowns for cleaner review. We will add the markdown files in a separate commit.
2024-03-04 03:30:24 +01:00
doc/lightning-upgradewallet.7 \
utxopsbt: new command to create PSBT from given utxos. It's *possible* to do this using various RPC calls, but it's unfriendly: 1. Call getinfo to get the current block height. 2. Call listfunds to map the UTXOs. 3. Create the PSBT and hope you get all the fields correct. Instead, this presents an interface just like `fundpsbt`, with identical returns. I think it's different enough to justify a new command (though it shares much internally, of course). In particular, it's now quite simple to create a command which uses specified utxos, and then adds more to meet any shortfall. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2020-08-18 04:22:53 +02:00
doc/lightning-utxopsbt.7 \
doc: Update sendpay and waitsendpay manpages.
2018-03-08 01:19:55 +01:00
doc/lightning-waitanyinvoice.7 \
lightningd/peer_control.c: Implement waitblockheight. This is needed to fully implement handling of blockheight disagreements between us and payee. If payee believes the blockheight is higher than ours, then `pay` should wait for our node to achieve that blockheight. Changelog-Add: Implement `waitblockheight` to wait for a specific blockheight.
2019-12-26 11:19:09 +01:00
doc/lightning-waitblockheight.7 \
script: Update scripts - Update `make doc-all` script - `fromschema.py` script - Updated to generate whole doc/lightning-*.md via doc/schemas/lightning-*.json file - Updated to print request params - Added `oneOfMany` condition for request params - Added `pairedWith` condition for request params - Added `dependentUpon` condition for request params - Updated for pre and post_return_value for response - Hiding `hidden` fields - `descriptions` are array now - Unified gaps between titles - Added default key-value pair - script: msggen, sql-schema, listconfig and pyln-testing script updates This does not add created markdowns for cleaner review. We will add the markdown files in a separate commit.
2024-03-04 03:30:24 +01:00
doc/lightning-waitinvoice.7 \
doc/lightning-wait.7 \
documentation: newaddr, listfunds and withdraw
2018-04-26 12:12:17 +02:00
doc/lightning-waitsendpay.7 \
script: Update scripts - Update `make doc-all` script - `fromschema.py` script - Updated to generate whole doc/lightning-*.md via doc/schemas/lightning-*.json file - Updated to print request params - Added `oneOfMany` condition for request params - Added `pairedWith` condition for request params - Added `dependentUpon` condition for request params - Updated for pre and post_return_value for response - Hiding `hidden` fields - `descriptions` are array now - Unified gaps between titles - Added default key-value pair - script: msggen, sql-schema, listconfig and pyln-testing script updates This does not add created markdowns for cleaner review. We will add the markdown files in a separate commit.
2024-03-04 03:30:24 +01:00
doc/lightning-withdraw.7
doc: move Makefile parts into doc/ Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2017-01-23 01:05:27 +01:00
Makefile: don't try to build sql plugin if there's no sqlite3 support. Reported-by: @whitslack Fixes: #5940 Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2023-02-06 02:51:30 +01:00
ifeq ($(HAVE_SQLITE3),1)
script: Update scripts - Update `make doc-all` script - `fromschema.py` script - Updated to generate whole doc/lightning-*.md via doc/schemas/lightning-*.json file - Updated to print request params - Added `oneOfMany` condition for request params - Added `pairedWith` condition for request params - Added `dependentUpon` condition for request params - Updated for pre and post_return_value for response - Hiding `hidden` fields - `descriptions` are array now - Unified gaps between titles - Added default key-value pair - script: msggen, sql-schema, listconfig and pyln-testing script updates This does not add created markdowns for cleaner review. We will add the markdown files in a separate commit.
2024-03-04 03:30:24 +01:00
GENERATE_MARKDOWN += doc/lightning-listsqlschemas.7 \
doc/lightning-sql.7
Makefile: don't try to build sql plugin if there's no sqlite3 support. Reported-by: @whitslack Fixes: #5940 Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2023-02-06 02:51:30 +01:00
endif
script: Update scripts - Update `make doc-all` script - `fromschema.py` script - Updated to generate whole doc/lightning-*.md via doc/schemas/lightning-*.json file - Updated to print request params - Added `oneOfMany` condition for request params - Added `pairedWith` condition for request params - Added `dependentUpon` condition for request params - Updated for pre and post_return_value for response - Hiding `hidden` fields - `descriptions` are array now - Unified gaps between titles - Added default key-value pair - script: msggen, sql-schema, listconfig and pyln-testing script updates This does not add created markdowns for cleaner review. We will add the markdown files in a separate commit.
2024-03-04 03:30:24 +01:00
MANPAGES := $(GENERATE_MARKDOWN) \
doc/lightning-cli.1 \
doc/lightningd.8 \
doc/lightningd-config.5 \
doc/lightningd-rpc.7 \
doc/lightning-hsmtool.8 \
doc/reckless.7
MARKDOWN_WITH_SCHEMA := $(GENERATE_MARKDOWN:=.md)
docs: Updates script and fixed test to generate lightning-sql - Updated doc/Makefile for generating schemas/lightning-sql.json - Read the lightning-sql template from schemas/lightning-sql-template.json - Generate sql tables data and merge it with json object read from above template - Save final merged object in schemas/lightning-sql.json - Updated doc/Makefile to auto generate lightning-sql.7.md and lightning-sql.7 - Deleted schemas/lightning-sql.json and adding it into .gitignore - Added lightning-sql specific titles in the fromschema.py script - Fixed test_sql by changing the sequence for listpeerchannels `reestablished` field - Ignoring lightning-sql.json for msggen schema.json because it is auto generated by sql plugin and lightning-sql-template.json.
2024-02-23 06:45:08 +01:00
# - Read the json template from schemas/lightning-sql-template.json
# - Generate the tables schema via plugins/sql
# - Merge both and generate final schemas/lightning-sql.json
doc/schemas/lightning-sql.json: doc/schemas/lightning-sql-template.json plugins/sql
@plugins/sql --print-docs | jq --arg sqldata "$$(awk '{printf "%s\n", $$0}')" '.tables += [$$sqldata]' $< > "$@.tmp" && mv "$@.tmp" "$@";
script: Update scripts - Update `make doc-all` script - `fromschema.py` script - Updated to generate whole doc/lightning-*.md via doc/schemas/lightning-*.json file - Updated to print request params - Added `oneOfMany` condition for request params - Added `pairedWith` condition for request params - Added `dependentUpon` condition for request params - Updated for pre and post_return_value for response - Hiding `hidden` fields - `descriptions` are array now - Unified gaps between titles - Added default key-value pair - script: msggen, sql-schema, listconfig and pyln-testing script updates This does not add created markdowns for cleaner review. We will add the markdown files in a separate commit.
2024-03-04 03:30:24 +01:00
doc/Makefile: speed up schema check, only do on check-doc. Don't do this on every build, it takes 4 seconds. And split it into individual targets, so make can parallelize (1.6 seconds here). Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-12-06 01:03:52 +01:00
doc-all: $(MANPAGES) doc/index.rst
tools: add a tool to formatting schema, and fixed (hack) the Makefile code checking. This include the following commits: - review 1/2: move from tab to space, and remove the exp. prop from doc; - review 2/2: remove experimental features; Signed-off-by: Vincenzo Palazzo <vincenzopalazzodev@gmail.com>
2021-11-04 15:13:43 +01:00
script: Update scripts - Update `make doc-all` script - `fromschema.py` script - Updated to generate whole doc/lightning-*.md via doc/schemas/lightning-*.json file - Updated to print request params - Added `oneOfMany` condition for request params - Added `pairedWith` condition for request params - Added `dependentUpon` condition for request params - Updated for pre and post_return_value for response - Hiding `hidden` fields - `descriptions` are array now - Unified gaps between titles - Added default key-value pair - script: msggen, sql-schema, listconfig and pyln-testing script updates This does not add created markdowns for cleaner review. We will add the markdown files in a separate commit.
2024-03-04 03:30:24 +01:00
SCHEMAS := $(wildcard doc/schemas/lightning-*.json)
# Don't try to build lightning-sql.json tables with plugins/sql if we don't have sqlite3
ifeq ($(HAVE_SQLITE3),0)
SCHEMAS := $(filter-out doc/schemas/lightning-sql.json, $(SCHEMAS))
endif
doc/Makefile: speed up schema check, only do on check-doc. Don't do this on every build, it takes 4 seconds. And split it into individual targets, so make can parallelize (1.6 seconds here). Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-12-06 01:03:52 +01:00
check-fmt-schemas: $(SCHEMAS:%=check-fmt-schema/%)
doc: reintroduce the fmt command to fmt the schema Signed-off-by: Vincenzo Palazzo <vincenzopalazzodev@gmail.com>
2022-02-05 14:38:18 +01:00
fmt-schemas: $(SCHEMAS:%=fmt-schema/%)
tools: add a tool to formatting schema, and fixed (hack) the Makefile code checking. This include the following commits: - review 1/2: move from tab to space, and remove the exp. prop from doc; - review 2/2: remove experimental features; Signed-off-by: Vincenzo Palazzo <vincenzopalazzodev@gmail.com>
2021-11-04 15:13:43 +01:00
doc/Makefile: speed up schema check, only do on check-doc. Don't do this on every build, it takes 4 seconds. And split it into individual targets, so make can parallelize (1.6 seconds here). Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-12-06 01:03:52 +01:00
check-fmt-schema/%: %
@jq . < "$*" > "$*".fmt && diff -u "$*" "$*.fmt" && rm "$*.fmt"
doc: reintroduce the fmt command to fmt the schema Signed-off-by: Vincenzo Palazzo <vincenzopalazzodev@gmail.com>
2022-02-05 14:38:18 +01:00
fmt-schema/%: %
@jq . < "$*" > "$*".fmt && cat "$*".fmt > "$*" && rm "$*.fmt"
doc/Makefile: speed up schema check, only do on check-doc. Don't do this on every build, it takes 4 seconds. And split it into individual targets, so make can parallelize (1.6 seconds here). Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-12-06 01:03:52 +01:00
check-doc: check-config-docs check-manpages check-fmt-schemas
doc: move Makefile parts into doc/ Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2017-01-23 01:05:27 +01:00
doc/schemas: generate manpage section from schema. We start with the listpays manpage. Which is now complete! Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-05-26 07:49:01 +02:00
# These are hard to use in $(call) functions.
LBRACKET=(
RBRACKET=)
script: Update scripts - Update `make doc-all` script - `fromschema.py` script - Updated to generate whole doc/lightning-*.md via doc/schemas/lightning-*.json file - Updated to print request params - Added `oneOfMany` condition for request params - Added `pairedWith` condition for request params - Added `dependentUpon` condition for request params - Updated for pre and post_return_value for response - Hiding `hidden` fields - `descriptions` are array now - Unified gaps between titles - Added default key-value pair - script: msggen, sql-schema, listconfig and pyln-testing script updates This does not add created markdowns for cleaner review. We will add the markdown files in a separate commit.
2024-03-04 03:30:24 +01:00
$(MARKDOWN_WITH_SCHEMA): doc/lightning-%.7.md: doc/schemas/lightning-%.json tools/fromschema.py
@tools/fromschema.py --markdownfile=$@ $< > $@.tmp && mv $@.tmp $@
doc/schemas: generate manpage section from schema. We start with the listpays manpage. Which is now complete! Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-05-26 07:49:01 +02:00
external: build lowdown if not already found. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2022-09-06 06:10:32 +02:00
# If we need to build lowdown, make tools/md2man.sh depend on it.
# That way it's not used in SHA256STAMP (which only uses direct
# dependencies), but make will be forced to build it.
ifeq ($(HAVE_LOWDOWN),0)
LOWDOWN := $(TARGET_DIR)/lowdown-build/bin/lowdown
tools/md2man.sh: $(LOWDOWN)
touch $@
else
LOWDOWN := lowdown
endif
Makefile: replace mrkd with lowdown(1). Here's the before-vs-after comparison (ignoring whitespace changes): ```diff --- /tmp/before 2022-07-20 21:52:44.336641810 +0930 +++ /tmp/after 2022-07-20 21:55:54.355487769 +0930 @@ -1,7 +1,7 @@ -LIGHTNING-CLI(1) lightning-cli LIGHTNING-CLI(1) +LIGHTNING-CLI(1) LIGHTNING-CLI(1) NAME - lightning-cli - Control lightning daemon + lightning-cli -- Control lightning daemon SYNOPSIS lightning-cli [OPTIONS] command @@ -14,10 +14,7 @@ --conf=PATH Sets configuration file (default: lightning-dir/config ). - --network=network - --mainnet - --testnet - --signet Sets network explicitly. + --network=network --mainnet --testnet --signet Sets network explicitly. --rpc-file=FILE Named pipe to use to talk to lightning daemon: default is lightning-rpc in the lightning directory. @@ -43,8 +40,8 @@ --version/-V Print version number to standard output and exit. - allow-deprecated-apis=BOOL Enable deprecated options. It defaults to true, but you should set it to false when testing - to ensure that an upgrade won't break your configuration. + allow-deprecated-apis=BOOL Enable deprecated options. It defaults to true, but you should set it to false when testing to + ensure that an upgrade won't break your configuration. COMMANDS lightning-cli simply uses the JSON RPC interface to talk to lightningd, and prints the results. Thus the commands avail‐ @@ -67,7 +64,7 @@ lightning-cli help - 1. Fund a 10k sat channel using uncomfirmed outputs + 2. Fund a 10k sat channel using uncomfirmed outputs lightning-cli --keywords fundchannel id=028f...ae7d amount=10000sat minconf=0 @@ -84,4 +81,4 @@ Note: the modules in the ccan/ directory have their own licenses, but the rest of the code is covered by the BSD-style MIT license. - LIGHTNING-CLI(1) +Core Lightning v0.11.0.1-350-gac2e137 LIGHTNING-CLI(1) ``` Signed-off-by: Rusty Russell <rusty@rustcorp.com.au> Fixes: #5437
2022-08-31 20:42:41 +02:00
$(MANPAGES): doc/%: doc/%.md tools/md2man.sh version_gen.h
script: Update scripts - Update `make doc-all` script - `fromschema.py` script - Updated to generate whole doc/lightning-*.md via doc/schemas/lightning-*.json file - Updated to print request params - Added `oneOfMany` condition for request params - Added `pairedWith` condition for request params - Added `dependentUpon` condition for request params - Updated for pre and post_return_value for response - Hiding `hidden` fields - `descriptions` are array now - Unified gaps between titles - Added default key-value pair - script: msggen, sql-schema, listconfig and pyln-testing script updates This does not add created markdowns for cleaner review. We will add the markdown files in a separate commit.
2024-03-04 03:30:24 +01:00
@VERSION=$(VERSION) tools/md2man.sh $(LOWDOWN) $< > $@
doc: move Makefile parts into doc/ Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2017-01-23 01:05:27 +01:00
doc/protocol-%.svg: test/test_protocol
test/test_protocol --svg < test/commits/$*.script > $@
protocol-diagrams: $(patsubst %.script, doc/protocol-%.svg, $(notdir $(wildcard test/commits/*.script)))
doc/deployable-lightning.pdf: doc/deployable-lightning.lyx doc/bitcoin.bib
lyx -E pdf $@ $<
doc/deployable-lightning.tex: doc/deployable-lightning.lyx
lyx -E latex $@ $<
state-diagrams: doc/normal-states.svg doc/simplified-states.svg doc/error-states.svg doc/full-states.svg
%.svg: %.dot
dot -Tsvg $< > $@ || (rm -f $@; false)
doc/simplified-states.dot: test/test_state_coverage
test/test_state_coverage --dot --dot-simplify > $@
doc/normal-states.dot: test/test_state_coverage
test/test_state_coverage --dot > $@
doc/error-states.dot: test/test_state_coverage
test/test_state_coverage --dot-all --dot-include-errors > $@
doc/full-states.dot: test/test_state_coverage
test/test_state_coverage --dot-all --dot-include-errors --dot-include-nops > $@
clean: doc-clean
Makefile: add check that manpage and command options match. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2018-05-17 06:46:22 +02:00
check: check-manpages
Makefile: fix race when checking manpages. By not depending on plugins, we can call lightningd before plugins are built, and not get all options: diff of command names vs manpage names: --- /dev/fd/63 2019-08-22 05:06:55.265659216 +0000 +++ /dev/fd/62 2019-08-22 05:06:55.265659216 +0000 @@ -3,6 +3,8 @@ allow-deprecated-apis= always-use-proxy= announce-addr= +autocleaninvoice-cycle= +autocleaninvoice-expired-by= autolisten= bind-addr= bitcoin-cli= Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2019-08-22 08:17:24 +02:00
# This needs plugins, too.
doc/Makefile: make check-manpages require the cln-grpc plugin. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2022-04-12 06:59:30 +02:00
check-manpages: all-programs check-config-docs default-targets
doc/Makefile: adapt 'check-manpages' to markdown
2019-08-10 12:50:31 +02:00
@tools/check-manpage.sh cli/lightning-cli doc/lightning-cli.1.md
@tools/check-manpage.sh "lightningd/lightningd --lightning-dir=/tmp/" doc/lightningd-config.5.md
doc: check-manpages: add check for unescaped underscores
2022-11-11 02:49:29 +01:00
@awk '/^$$/ { do { getline } while ($$0 ~ /^( {4,}|\t)/) } /^\s*```/ { do { getline } while ($$0 !~ /^\s*```/) } /^([^`_\\]|`([^`\\]|\\.)*`|\b_|_\b|\\.)*\B_\B/ { print "" ; print "Unescaped underscore at " FILENAME ":" NR ":" ; print ; ret = 1 } ENDFILE { NR = 0 } END { exit ret }' doc/*.[0-9].md
doc: move Makefile parts into doc/ Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2017-01-23 01:05:27 +01:00
doc: schema for listconfigs, compare with documentation. This made me document what are options are now in plugins, too. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-06-16 03:12:17 +02:00
# Makes sure that fields mentioned in schema are in man page, and vice versa.
check-config-docs:
script: Update scripts - Update `make doc-all` script - `fromschema.py` script - Updated to generate whole doc/lightning-*.md via doc/schemas/lightning-*.json file - Updated to print request params - Added `oneOfMany` condition for request params - Added `pairedWith` condition for request params - Added `dependentUpon` condition for request params - Updated for pre and post_return_value for response - Hiding `hidden` fields - `descriptions` are array now - Unified gaps between titles - Added default key-value pair - script: msggen, sql-schema, listconfig and pyln-testing script updates This does not add created markdowns for cleaner review. We will add the markdown files in a separate commit.
2024-03-04 03:30:24 +01:00
@for c in `sed -n 's/^ "\(.*\)": {/\1/p' doc/schemas/lightning-listconfigs.json | grep -v '^# version$$' | grep -v '^plugins$$' | grep -v '^important-plugins$$'`; do if ! grep -q "^ \*\*$$c\*\*" doc/lightningd-config.5.md; then echo "$$c undocumented!"; exit 1; fi; done
@for c in `grep -v '\[plugin ' doc/lightningd-config.5.md | sed -n 's/^ \*\*\([^*]*\)\*\*.*/\1/p' | grep -v '^\(help\|version\|mainnet\|testnet\|signet\|plugin\|important-plugin\|plugin-dir\|clear-plugins\)$$'`; do if ! grep -q '"'"$$c"'"' doc/schemas/lightning-listconfigs.json; then echo "$$c documented but not in schema!"; exit 1; fi; done
doc: schema for listconfigs, compare with documentation. This made me document what are options are now in plugins, too. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-06-16 03:12:17 +02:00
doc: move Makefile parts into doc/ Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2017-01-23 01:05:27 +01:00
doc-clean:
doc: correctly remove generated schemas on `make clean`. We also remove manpages, since they're no longer in git anyway. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2024-03-25 01:37:52 +01:00
$(RM) $(MANPAGES) $(MARKDOWN_WITH_SCHEMA)
doc: move Makefile parts into doc/ Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2017-01-23 01:05:27 +01:00
$(RM) doc/deployable-lightning.{aux,bbl,blg,dvi,log,out,tex}
Makefile: respect --quiet and V=1 in doc/Makefile. And don't regen doc/index.rst unless there's good reason. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2020-08-25 03:33:08 +02:00
doc/index.rst: $(MANPAGES:=.md)
doc: Create a blockreplace tool to update generated blocks in docs We introduced a minor issue in #5757 that was causing the manpages to be added every time we regenerate instead of replacing them. The script was a bit unscrutable, and we do this block-replacement in several places I thought it might be a good idea to have a dedicated tool to do it. This allows us to have simpler Makefiles whenever we update a generated block inside another file. It's python, but does not have dependencies :-) Changelog-None
2022-12-01 13:31:30 +01:00
@$(call VERBOSE, "genidx $@", \
find doc -maxdepth 1 -name '*\.[0-9]\.md' | \
cut -b 5- | LC_ALL=C sort | \
make: fix make doc error This seems to fix issue #5941 Certain make version(?) will parse the ')' as function end when not inside "" but ''. Changelog-None
2023-01-31 16:06:27 +01:00
sed "s/\(.*\)\.\(.*\).*\.md/\1 <\1.\2.md>/" | \
configure: don't assume python3, create $PYTHON var. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2023-08-28 04:12:08 +02:00
$(PYTHON) devtools/blockreplace.py doc/index.rst manpages --language=rst --indent " " \
doc: Create a blockreplace tool to update generated blocks in docs We introduced a minor issue in #5757 that was causing the manpages to be added every time we regenerate instead of replacing them. The script was a bit unscrutable, and we do this block-replacement in several places I thought it might be a good idea to have a dedicated tool to do it. This allows us to have simpler Makefiles whenever we update a generated block inside another file. It's python, but does not have dependencies :-) Changelog-None
2022-12-01 13:31:30 +01:00
)
CI: rough check that schema changes seem to mention added, don't delete non-deprcated. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2023-01-10 00:53:26 +01:00
doc/Makefile: restore CI check for schema changes. We now know the base reference, and we've rebased, so we can do a simple diff. Also, this means we can use a magic commit message `No-schema-diff-check` to suppress false positives. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2023-06-01 08:17:20 +02:00
# Overridden by GH CI if necessary.
BASE_REF=master
doc: Remove redundant schema check
2023-10-03 16:16:44 +02:00
check-source:
Reference in New Issue Copy Permalink