From 7e7358ec1e327756aa89a81eb2cf454c5f889dcd Mon Sep 17 00:00:00 2001 From: darosior Date: Sun, 19 May 2019 16:06:31 +0200 Subject: [PATCH] Doc: update 'waitsendpay' manpage We no longer disable a channel on routing error. --- doc/lightning-waitsendpay.7 | 6 +++--- doc/lightning-waitsendpay.7.txt | 8 ++++---- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/doc/lightning-waitsendpay.7 b/doc/lightning-waitsendpay.7 index 951cb5a4e..01ba3b150 100644 --- a/doc/lightning-waitsendpay.7 +++ b/doc/lightning-waitsendpay.7 @@ -2,12 +2,12 @@ .\" Title: lightning-waitsendpay .\" Author: [see the "AUTHOR" section] .\" Generator: DocBook XSL Stylesheets v1.79.1 -.\" Date: 02/23/2019 +.\" Date: 05/19/2019 .\" Manual: \ \& .\" Source: \ \& .\" Language: English .\" -.TH "LIGHTNING\-WAITSENDP" "7" "02/23/2019" "\ \&" "\ \&" +.TH "LIGHTNING\-WAITSENDP" "7" "05/19/2019" "\ \&" "\ \&" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -45,7 +45,7 @@ If the payment completed with success, this command returns with success\&. Othe .sp On success, an object similar to the output of \fBlistsendpays\fR will be returned\&. This object will have a \fIstatus\fR field that is the string \fI"complete"\fR\&. .sp -On error, if the error occurred from a node other than the final destination, the route table will be updated so that getroute(7) should return an alternate route (if any)\&. An error from the final destination implies the payment should not be retried\&. +On error, and even if the error occurred from a node other than the final destination, the route table will no longer be updated. Use the \fIexclude\fR parameter of the \fIgetroute\fR command to ignore the failing route\&. .sp The following error codes may occur: .sp diff --git a/doc/lightning-waitsendpay.7.txt b/doc/lightning-waitsendpay.7.txt index 0fa191c40..69c28872a 100644 --- a/doc/lightning-waitsendpay.7.txt +++ b/doc/lightning-waitsendpay.7.txt @@ -41,10 +41,10 @@ be returned. This object will have a 'status' field that is the string '"complete"'. -On error, if the error occurred from a node other than the final -destination, the route table will be updated so that getroute(7) -should return an alternate route (if any). An error from the final -destination implies the payment should not be retried. +On error, and even if the error occurred from a node other than the +final destination, the route table will no longer be updated. Use +the 'exclude' parameter of the `getroute` command to ignore the +failing route. The following error codes may occur: