doc: fix up mangled nroff from mkrd.

Nested lists don't work (it puts the .RS at the end of the line
instead of on a line by itself), so we sed it.

	https://github.com/refi64/mrkd/issues/4

This fixes up formatting on a number of existing pages..

Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
This commit is contained in:
Rusty Russell 2021-05-26 15:11:01 +09:30
parent bca8427317
commit ebe8f37400
7 changed files with 17 additions and 8 deletions

View file

@ -86,8 +86,10 @@ MANPAGES := doc/lightning-cli.1 \
doc-all: $(MANPAGES) doc/index.rst
# mrkd doesn't format nested lists properly, so we fixup with sed (see doc/lightning-connect.7
# and https://github.com/refi64/mrkd/issues/4
$(MANPAGES): doc/%: doc/%.md
@if $(call SHA256STAMP_CHANGED); then $(call VERBOSE, "mrkd $<", mrkd $< $@ && $(call SHA256STAMP,\\\",)); else touch $@; fi
@if $(call SHA256STAMP_CHANGED); then $(call VERBOSE, "mrkd $<", mrkd $< $@.tmp && sed -e 's/\(.\)\.RS$$/\1\n.RS/' < $@.tmp > $@ && rm $@.tmp && $(call SHA256STAMP,\\\",)); else touch $@; fi
$(MANPAGES): $(FORCE)

View file

@ -40,7 +40,8 @@ On success, an object with the following information is returned:
.IP \[bu]
\fInum_inactive_channels\fR: A integer that represents the number of channel which are closing\.
.IP \[bu]
\fIaddress\fR: An array that represents all published addresses of the node, each object inside the array contains the following proprieties:.RS
\fIaddress\fR: An array that represents all published addresses of the node, each object inside the array contains the following proprieties:
.RS
.IP \[bu]
\fItype\fR: A string that represents the type of the address (currently \fBipv4\fR, \fBipv6\fR, \fBtorv3\fR or \fBtorv4\fR)\.
.IP \[bu]

View file

@ -39,7 +39,8 @@ On success, a object will be return with the following parameters:
.IP \[bu]
\fIbytes_max\fR: An integer that represents the max dimension in bytes of log file\.
.IP \[bu]
\fIlog\fR: An array of objects where each element contains the following proprieties:.RS
\fIlog\fR: An array of objects where each element contains the following proprieties:
.RS
.IP \[bu]
\fItype\fR: A string that represents the log level\. The propriety can have an value equal to SKIPPED to indicate the existence of omitted entries\.
.IP \[bu]

View file

@ -35,7 +35,8 @@ Additional members include:
.IP \[bu]
\fI# version\fR: A string that represents the version of node\.
.IP \[bu]
\fIplugins\fR: A array that represents the non-important plugin registered\. Each object contains the following members:.RS
\fIplugins\fR: A array that represents the non-important plugin registered\. Each object contains the following members:
.RS
.IP \[bu]
\fIpath\fR: A string that represents the path of plugin\.
.IP \[bu]

View file

@ -45,7 +45,8 @@ are also returned:
.IP \[bu]
\fIfeatures\fR: A string that represents the features value\.
.IP \[bu]
\fIaddresses\fR: An array that represents the addreses avaible\. Each address is represented with an object with the following properties:.RS
\fIaddresses\fR: An array that represents the addreses avaible\. Each address is represented with an object with the following properties:
.RS
.IP \[bu]
\fItype\fR: A string that represents the address type (ipv4 or ipv6)\.
.IP \[bu]

View file

@ -72,7 +72,8 @@ The objects in the \fIchannels\fR array will have at least these fields:
.RS
.IP \[bu]
\fIstate\fR: Any of these strings:.RS
\fIstate\fR: Any of these strings:
.RS
.IP \[bu]
\fB"OPENINGD"\fR: The channel funding protocol with the peer is ongoing
and both sides are negotiating parameters\.

View file

@ -38,7 +38,8 @@ On success, the command will return a list of transactions, each object represen
.IP \[bu]
\fIversion\fR: An integer that represents the nVersion field\.
.IP \[bu]
\fIinputs\fR: A list of spent transaction outputs, each spent transaction output is represented with an object with the following properties:.RS
\fIinputs\fR: A list of spent transaction outputs, each spent transaction output is represented with an object with the following properties:
.RS
.IP \[bu]
\fItxid\fR: A string that represents the hash of transaction\. This is the output index of the transaction output being spent\.
.IP \[bu]
@ -49,7 +50,8 @@ On success, the command will return a list of transactions, each object represen
.RE
.IP \[bu]
\fIoutputs\fR: A list of transactions, each transaction is represented with an object with the following proprieties:.RS
\fIoutputs\fR: A list of transactions, each transaction is represented with an object with the following proprieties:
.RS
.IP \[bu]
\fIindex\fR: An integer that represents the index of transaction\.
.IP \[bu]