lukechilds
/
lightning
mirror of https://github.com/lukechilds/lightning.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
8583 Commits
55 Branches
107 Tags
38 MiB
Branch: bump-pyln-proto
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'bump-pyln-proto'
${ noResults }
lightning/doc/lightning-delinvoice.7

54 lines
1.4 KiB
Raw Permalink Normal View History

doc/manpages: regenerate manpages using markdown templates
5 years ago
.TH "LIGHTNING-DELINVOICE" "7" "" "" "lightning-delinvoice"
.SH NAME
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.
5 years ago
lightning-delinvoice - Command for removing an invoice
doc/manpages: regenerate manpages using markdown templates
5 years ago
.SH SYNOPSIS
JSONRPC: delinvoice: have a status argument. delinvoice was orginally documented to only allow deletion of unpaid invoices, but there might be reasons to delete paid ones or unexpired ones. But we have to avoid the race where someone pays as it's deleted: the easiest way is to have the caller tell us the status, and fail if it's wrong. Fixes: #477 Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
7 years ago
\fBdelinvoice\fR \fIlabel\fR \fIstatus\fR
doc/manpages: regenerate manpages using markdown templates
5 years ago
.SH DESCRIPTION
The \fBdelinvoice\fR RPC command removes an invoice with \fIstatus\fR as given
in \fBlistinvoices\fR\.
The caller should be particularly aware of the error case caused by the
\fIstatus\fR changing just before this command is invoked!
.SH RETURN VALUE
On success, an invoice description will be returned as per
\fBlightning-listinvoice\fR(7)\.
lightningd/invoice.c: Improve programmatic error reporting for `delinvoice`. Changelog-Changed: JSON-RPC: `delinvoice` will now report specific error codes: 905 for failing to find the invoice, 906 for the invoice status not matching the parameter.
5 years ago
.SH ERRORS
The following errors may be reported:
.RS
.IP \[bu]
-1: Database error\.
.IP \[bu]
905: An invoice with that label does not exist\.
.IP \[bu]
906: The invoice \fIstatus\fR does not match the parameter\.
An error object will be returned as error \fIdata\fR, containing
\fIcurrent_status\fR and \fIexpected_status\fR fields\.
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>
4 years ago
This is most likely due to the \fIstatus\fR of the invoice
changing just before this command is invoked\.
lightningd/invoice.c: Improve programmatic error reporting for `delinvoice`. Changelog-Changed: JSON-RPC: `delinvoice` will now report specific error codes: 905 for failing to find the invoice, 906 for the invoice status not matching the parameter.
5 years ago
.RE
doc/manpages: regenerate manpages using markdown templates
5 years ago
.SH AUTHOR
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.
5 years ago
Rusty Russell \fI<rusty@rustcorp.com.au\fR> is mainly responsible\.
doc/manpages: regenerate manpages using markdown templates
5 years ago
.SH SEE ALSO
\fBlightning-listinvoice\fR(7), \fBlightning-waitinvoice\fR(7),
\fBlightning-invoice\fR(7), \fBlightning-delexpiredinvoice\fR(7),
\fBlightning-autocleaninvoice\fR(7)
.SH RESOURCES
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 &#34;last updated&#34; lines at the bottom since they are out of date at best, and misleading at the worst. If we want to keep them, I&#39;d suggest generating them from the commit that last touched them.
5 years ago
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
doc/manpages: regenerate manpages using markdown templates
5 years ago
doc, wiregen: use SHA256 stamps instead of git versions. This should be more robust in future: we SHA256 all of the deps. For wiregen we prefix with EXPERIMENTAL_FEATURES, since it can effect them. Signed-off-by: Rusty Russell &lt;rusty@rustcorp.com.au&gt;
4 years ago
\" SHA256STAMP:92ad4501574b253334bb570960d1835c8bd84483e318ea058e6b565d34109832