vincenzopalazzo
/
rgb-cln
1
0
Fork 0
Code Issues 1 Pull Requests Packages Projects Releases Wiki Activity
rgb-cln/doc/Makefile

138 lines
4.2 KiB
Makefile
Raw Normal View History

doc: move Makefile parts into doc/ Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2017-01-23 00:05:27 +00:00
#! /usr/bin/make
# Designed to be run one level up
doc-wrongdir:
$(MAKE) -C .. doc-all
MANPAGES := doc/lightning-cli.1 \
doc/lightningd.8.txt: Initial manpage for lightningd itself. Closes: #1360
2019-08-04 14:30:44 +01:00
doc/lightningd.8 \
doc/lightningd-config.5: manual page for all our configuration options. In particular, the subtleties of 'addr' vs 'bind-addr' and 'announce-addr' needed spelling out. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2018-05-17 05:46:22 +01:00
doc/lightningd-config.5 \
docs: document addgossip API. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au> Changelog-Added: JSON-RPC: `addgossip` allows direct injection of network gossip messages.
2021-02-02 05:16:22 +00:00
doc/lightning-addgossip.7 \
invoices: Implement autocleaninvoice.
2018-03-17 15:12:37 +00:00
doc/lightning-autocleaninvoice.7 \
doc: check manpage Signed-off-by: Mark Beckwith <wythe@intrig.com>
2018-12-07 17:31:16 +00: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 06:19:37 +01:00
doc/lightning-checkmessage.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 07:03:15 +01:00
doc/lightning-close.7 \
documentation: s/Protocol/Command/
2018-04-26 11:22:09 +01:00
doc/lightning-connect.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 16:51:28 +00:00
doc/lightning-createonion.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 01:21:48 +00:00
doc/lightning-createinvoice.7 \
doc: manpages for pay, listpayments and decodepay. Also contains some help message clarifications. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2018-01-13 11:21:33 +00:00
doc/lightning-decodepay.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 18:48:47 +00:00
doc/lightning-decode.7 \
invoices: Add delexpiredinvoice command.
2018-02-26 12:37:53 +00:00
doc/lightning-delexpiredinvoice.7 \
doc: move Makefile parts into doc/ Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2017-01-23 00:05:27 +00: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 16:47:53 +01:00
doc/lightning-delpay.7 \
docs: Add manpage for dev-sendcustommsg It's a dev-* command for now, but better document it so people can use it rather than having them guess how it's supposed to work.
2019-12-09 15:32:49 +00:00
doc/lightning-dev-sendcustommsg.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-17 23:56:19 +00:00
doc/lightning-disableoffer.7 \
Man page for lightning-disconnect created
2018-12-03 05:20:25 +00:00
doc/lightning-disconnect.7 \
doc/lightning-feerates.7.md: Document `feerates` command. Changelog-None
2020-07-12 04:30:35 +01: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 18:45:47 +00:00
doc/lightning-fetchinvoice.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 15:54:39 +01:00
doc/lightning-fundchannel.7 \
doc: add manpages for fundchannel_[start,complete,cancel] Manpages for the manpage-god!!
2019-06-06 00:32:04 +01:00
doc/lightning-fundchannel_start.7 \
doc/lightning-fundchannel_complete.7 \
doc/lightning-fundchannel_cancel.7 \
doc: document fundpsbt. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2020-07-15 06:39:47 +01:00
doc/lightning-fundpsbt.7 \
doc: move Makefile parts into doc/ Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2017-01-23 00:05:27 +00:00
doc/lightning-getroute.7 \
lightningd/hsm_control.c: Implement `getsharedsecret`. ChangeLog-Added: New `getsharedsecret` command, which lets you compute a shared secret with this node knowing only a public point. This implements the BOLT standard of hashing the ECDH point, and is incompatible with ECIES.
2020-02-04 05:53:17 +00:00
doc/lightning-getsharedsecret.7 \
Makefile: Install `tools/hsmtool` as `lightning-hsmtool`. Changelog-Added: We now install `lightning-hsmtool` for your `hsm_secret` needs. See: https://github.com/ElementsProject/lightning/issues/3717#issuecomment-644844594 It seems reasonable to add this to the standard install, and to document it properly as well, hopefully we can fill in the documentation better later on.
2020-06-29 07:28:46 +01:00
doc/lightning-hsmtool.8 \
doc: move Makefile parts into doc/ Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2017-01-23 00:05:27 +00:00
doc/lightning-invoice.7 \
doc: Add a man-page for the new keysend command
2020-07-01 12:35:58 +01:00
doc/lightning-keysend.7 \
Manpage for lightning-listchannels created
2019-01-07 19:09:59 +00:00
doc/lightning-listchannels.7 \
manually added a list-forward manpage because I have no idea how a2x works
2019-01-11 22:05:46 +00:00
doc/lightning-listforwards.7 \
documentation: s/Protocol/Command/
2018-04-26 11:22:09 +01:00
doc/lightning-listfunds.7 \
JSONRPC: Make listinvoice an deprecated alias for listinvoices. This matches the other names, and also the return value is about to change. This will be removed before release! Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2018-01-16 20:28:46 +00:00
doc/lightning-listinvoices.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-17 23:56:19 +00: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 05:00:04 +00:00
doc/lightning-listpays.7 \
Created listpeers asciidoc, generated manpage using a2x and updated Makefile
2018-12-05 21:38:07 +00: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 05:00:04 +00:00
doc/lightning-listsendpays.7 \
doc/, contrib/: Additional support etc. for multifundchannel.
2020-09-09 04:11:37 +01: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 11:26:14 +01:00
doc/lightning-multiwithdraw.7 \
documentation: s/Protocol/Command/
2018-04-26 11:22:09 +01: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 06:33:50 +01: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 18:45:47 +00:00
doc/lightning-offer.7 \
offers: split offer send_invoice generation into new JSON command We split `send_invoice` offers inoo offerout (for want of a better name). This simplifies the API. Also took the opportunity to move the `vendor` tag to immediately follow `description` (our tests use arguments by keywords, so no change there). Suggested-by: shesek Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-01-07 18:46:47 +00:00
doc/lightning-offerout.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 04:33:47 +00: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 19:01:45 +01: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 20:43:40 +01:00
doc/lightning-openchannel_signed.7 \
doc/lightning-openchannel_update.7 \
doc: manpages for pay, listpayments and decodepay. Also contains some help message clarifications. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2018-01-13 11:21:33 +00:00
doc/lightning-pay.7 \
doc/Makefile: Add lightning-plugin manpage
2019-08-10 00:22:23 +01:00
doc/lightning-plugin.7 \
add manpages for reserve/unreserve
2020-06-10 01:20:18 +01:00
doc/lightning-reserveinputs.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 18:45:47 +00: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 16:51:28 +00:00
doc/lightning-sendonion.7 \
doc: Manual page for sendonionmessage. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-01-14 03:36:49 +00:00
doc/lightning-sendonionmessage.7 \
doc: move Makefile parts into doc/ Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2017-01-23 00:05:27 +00:00
doc/lightning-sendpay.7 \
doc: adds manpage and changelog
2019-03-09 20:40:38 +00:00
doc/lightning-setchannelfee.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 06:19:37 +01:00
doc/lightning-signmessage.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 08:00:05 +01:00
doc/lightning-txprepare.7 \
doc/lightning-txdiscard.7 \
doc/lightning-txsend.7 \
add manpages for reserve/unreserve
2020-06-10 01:20:18 +01:00
doc/lightning-unreserveinputs.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 03:22:53 +01:00
doc/lightning-utxopsbt.7 \
doc: add lightning-waitinvoice man page. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2017-01-23 00:09:43 +00:00
doc/lightning-waitinvoice.7 \
doc: Update sendpay and waitsendpay manpages.
2018-03-08 00:19:55 +00: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 10:19:09 +00:00
doc/lightning-waitblockheight.7 \
documentation: newaddr, listfunds and withdraw
2018-04-26 11:12:17 +01:00
doc/lightning-waitsendpay.7 \
Start ping command and fix some convention in other new doc file Signed-off-by: Vincenzo Palazzo <vincenzopalazzodev@gmail.com>
2020-08-21 14:59:24 +01:00
doc/lightning-withdraw.7 \
Fixed mistake inside the docs Thanks @rustyrussell. Signed-off-by: Vincenzo Palazzo <vincenzopalazzodev@gmail.com>
2020-08-31 13:42:28 +01:00
doc/lightning-ping.7 \
doc/lightning-stop.7 \
doc/lightning-signpsbt.7 \
doc/lightning-sendpsbt.7 \
doc/lightning-getinfo.7 \
doc/lightning-listtransactions.7 \
doc/lightning-listnodes.7 \
doc/lightning-listconfigs.7 \
doc/lightning-help.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 20:43:40 +01:00
doc/lightning-getlog.7
doc: move Makefile parts into doc/ Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2017-01-23 00:05:27 +00:00
doc/Makefile: update readthedocs pages on doc-all Stolen from @rustyrussell's #2928
2019-08-10 12:24:33 +01:00
doc-all: $(MANPAGES) doc/index.rst
doc: move Makefile parts into doc/ Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2017-01-23 00:05:27 +00:00
doc/Makefile: Use mrkd to generate manpages
2019-08-10 00:23:11 +01:00
$(MANPAGES): doc/%: doc/%.md
Makefile: fix up sqlgen and docgen rules. Omitted in commit d8e8426b52d9dd097c361e3cf405edbdfc20cffe Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2020-09-08 02:13:18 +01:00
@if $(call SHA256STAMP_CHANGED); then $(call VERBOSE, "mrkd $<", mrkd $< $@ && $(call SHA256STAMP,\")); else touch $@; fi
doc: move Makefile parts into doc/ Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2017-01-23 00:05:27 +00:00
Makefile: force regeneration of manpages, wire source. Now that SHA256STAMP protects us, we can avoid timestamps altogether so we don't get missing builds. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2020-08-31 02:13:25 +01:00
$(MANPAGES): FORCE
doc: move Makefile parts into doc/ Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2017-01-23 00:05:27 +00: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 > $@
maintainer-clean: doc-maintainer-clean
clean: doc-clean
Makefile: add check that manpage and command options match. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2018-05-17 05:46:22 +01: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 07:17:24 +01:00
# This needs plugins, too.
check-manpages: all-programs
doc/Makefile: adapt 'check-manpages' to markdown
2019-08-10 11:50:31 +01: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: move Makefile parts into doc/ Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2017-01-23 00:05:27 +00:00
doc-maintainer-clean:
$(RM) $(MANPAGES)
doc-clean:
$(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 02:33:08 +01:00
doc/index.rst: $(MANPAGES:=.md)
@$(call VERBOSE, "genidx $@",(grep -v "^ lightning.*\.[0-9]\.md>$$" $@; for m in $$(cd doc && ls lightningd*.[0-9].md lightning-*.[0-9].md); do echo " $${m%.[0-9].md} <$$m>"; done |$(SORT)) > $@.tmp.$$$$ && mv $@.tmp.$$$$ $@)