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
103dce63ef
core-lightning/doc/Makefile

104 lines
3.1 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
MANPAGES := doc/lightning-cli.1 \
doc/lightningd.8.txt: Initial manpage for lightningd itself. Closes: #1360
2019-08-04 15:30:44 +02: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 06:46:22 +02:00
doc/lightningd-config.5 \
invoices: Implement autocleaninvoice.
2018-03-17 16:12:37 +01:00
doc/lightning-autocleaninvoice.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 \
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 \
documentation: s/Protocol/Command/
2018-04-26 12:22:09 +02: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 17:51:28 +01:00
doc/lightning-createonion.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 12:21:33 +01:00
doc/lightning-decodepay.7 \
invoices: Add delexpiredinvoice command.
2018-02-26 13:37:53 +01:00
doc/lightning-delexpiredinvoice.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 \
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 16:32:49 +01:00
doc/lightning-dev-sendcustommsg.7 \
Man page for lightning-disconnect created
2018-12-03 06:20:25 +01:00
doc/lightning-disconnect.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 \
doc/lightning-fundchannel_complete.7 \
doc/lightning-fundchannel_cancel.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 \
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 06:53:17 +01:00
doc/lightning-getsharedsecret.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 \
Manpage for lightning-listchannels created
2019-01-07 20:09:59 +01:00
doc/lightning-listchannels.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 \
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 21:28:46 +01:00
doc/lightning-listinvoices.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 \
Created listpeers asciidoc, generated manpage using a2x and updated Makefile
2018-12-05 22:38:07 +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 \
documentation: s/Protocol/Command/
2018-04-26 12:22:09 +02:00
doc/lightning-newaddr.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 12:21:33 +01:00
doc/lightning-pay.7 \
doc/Makefile: Add lightning-plugin manpage
2019-08-10 01:22:23 +02:00
doc/lightning-plugin.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: 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 \
doc: adds manpage and changelog
2019-03-09 21:40:38 +01: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 07:19:37 +02: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 09:00:05 +02:00
doc/lightning-txprepare.7 \
doc/lightning-txdiscard.7 \
doc/lightning-txsend.7 \
doc: add lightning-waitinvoice man page. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2017-01-23 01:09:43 +01:00
doc/lightning-waitinvoice.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 \
documentation: newaddr, listfunds and withdraw
2018-04-26 12:12:17 +02:00
doc/lightning-waitsendpay.7 \
documentation: s/Protocol/Command/
2018-04-26 12:22:09 +02: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
doc/Makefile: update readthedocs pages on doc-all Stolen from @rustyrussell's #2928
2019-08-10 13:24:33 +02: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 01:05:27 +01:00
doc/Makefile: Use mrkd to generate manpages
2019-08-10 01:23:11 +02:00
$(MANPAGES): doc/%: doc/%.md
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
if $(CHANGED_FROM_GIT); then mrkd $< $@; else touch $@; fi
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 > $@
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 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.
check-manpages: all-programs
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: move Makefile parts into doc/ Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2017-01-23 01:05:27 +01:00
doc-maintainer-clean:
$(RM) doc/deployable-lightning.pdf
$(RM) $(MANPAGES)
doc-clean:
$(RM) doc/deployable-lightning.{aux,bbl,blg,dvi,log,out,tex}
doc/Makefile: update readthedocs pages on doc-all Stolen from @rustyrussell's #2928
2019-08-10 13:24:33 +02:00
doc/index.rst:
build: fix and simplify doc/index.rst generation * Fix usage of `echo "...\n..."` (without `-e`), generating a broken output: ``` lightningd-config <lightningd-config.5.md> lightningd\nlightning-autocleaninvoice.7.md <lightningd.8.md\nlightning-autocleaninvoice.7.md> ``` * Use `$(SORT)` instead of bare `sort` to avoid locale-dependent sort. * Strip the trailing .[0-9].md without invoking sed. * Sort all man pages as one block. Changelog-None
2020-01-31 11:28:10 +01:00
(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.$$$$ $@
doc/Makefile: update readthedocs pages on doc-all Stolen from @rustyrussell's #2928
2019-08-10 13:24:33 +02:00
.PHONY: doc/index.rst
Reference in New Issue Copy Permalink