Skip to content

Cleanups #3014

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
cdecker merged 5 commits into from
Sep 2, 2019
Merged

Cleanups #3014

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
c9473ac
docs: Update manpages to be recognized correctly by mrkd
cdecker Aug 31, 2019
4f2dd5a
pytest: Updated requirements.txt to latest versions
cdecker Jul 13, 2019
67465ca
pytest: Fix directory deletion on passed tests
cdecker Aug 28, 2019
9e78184
pytest: Remove --duration argument
cdecker Aug 28, 2019
b31ea82
doc/requirements.txt: update 'mrkd' dependency
darosior Sep 2, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ endif

# Timeout shortly before the 600 second travis silence timeout
# (method=thread to support xdist)
PYTEST_OPTS := -v --timeout=550 --timeout_method=thread -p no:logging --duration=0
PYTEST_OPTS := -v --timeout=550 --timeout_method=thread -p no:logging

# This is where we add new features as bitcoin adds them.
FEATURES :=
Expand Down
4 changes: 2 additions & 2 deletions doc/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ MANPAGES := doc/lightning-cli.1 \
doc-all: $(MANPAGES) doc/index.rst

$(MANPAGES): doc/%: doc/%.md
@if $(CHANGED_FROM_GIT); then echo mrkd $<; mrkd $<; else touch $@; fi
if $(CHANGED_FROM_GIT); then mrkd $< $@; else touch $@; fi
Copy link
Contributor

@darosior darosior Sep 1, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You should either mrkd $< -output $@ or remove the $@ otherwise you got a mrkd: error: unrecognized arguments: [the_manpage_name.manpage_number] when running make doc-all. It's weird that travis doesn't fail on this.

Copy link
Member Author

@cdecker cdecker Sep 1, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we may have different versions of mrkd. My help shows the following:

$ mrkd --help
usage: mrkd [-h] [-name NAME] [-section SECTION] [-template TEMPLATE]
            [-index INDEX] [-format roff] [-colors friendly]
            source output

positional arguments:
  source              The source man page
  output              The output file

optional arguments:
  -h, --help          show this help message and exit
  -name NAME          The name to use for the man page
  -section SECTION    The section to use for the man page
  -template TEMPLATE  The HTML template file to use
  -index INDEX        An index file to use for HTML links
  -format roff        The output format
  -colors friendly    The Pygments style to use for HTML syntax highlighting

Notice that output is a positional argument, not a flag argument. This is btw also the mrkd that is deployed on travis, and is the one installed via pip install mrkd

Copy link
Contributor

@darosior darosior Sep 1, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have the tweaked version introduced in #2936. I think you had problem because you used the original version : actually I think most of the modification I made in the tweaked version (https://github.com/darosior/mrkd/commits/master) are necessary to have a clean output. That's why I added this version in doc/requirements.txt

Copy link
Contributor

@darosior darosior Sep 1, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is btw also the mrkd that is deployed on travis

Ah I thought Travis would install the one in doc/requirements.txt

Copy link
Member Author

@cdecker cdecker Sep 1, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, I had not realized that you customized the mrkd utility.

All but the last commit seem to be also addressed by 14f4e3c. What's the purpose of that last commit? And would it be ok if we used the pypi version, in order to have less custom code?

Copy link
Member Author

@cdecker cdecker Sep 1, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fwiw I found LIGHTNING-CHECK(7) Manual Page (for the <h1/> title and the html <title/>) way too shouty and not really informative. With the switch to what formerly was the description we now get an <h1/> and <title/> similar to this lightning-fundchannel – Command for establishing a lightning channel which I find less shouty and more descriptive 😉

Copy link
Contributor

@darosior darosior Sep 1, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, I actually looked at the only diff which had a duplicated description x)

command-subcommand - Short description was more of a title anyway imho

I agree

Copy link
Contributor

@darosior darosior Sep 1, 2019 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

darosior/mrkd@dfbc8c3 has been dropped on my branch, so doc/requirements.txt needs to be updated

Copy link
Contributor

@darosior darosior Sep 1, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fwiw I gave you write access to the repo, since it is used as a dependency here.

Copy link
Contributor

@trueptolemy trueptolemy Sep 2, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

darosior/mrkd@dfbc8c3 has been dropped on my branch, so doc/requirements.txt needs to be updated

What about adding a tag?


doc/protocol-%.svg: test/test_protocol
test/test_protocol --svg < test/commits/$*.script > $@
Expand Down Expand Up @@ -91,6 +91,6 @@ doc-clean:
$(RM) doc/deployable-lightning.{aux,bbl,blg,dvi,log,out,tex}

doc/index.rst:
(grep -v '^ lightning-.*\.[0-9]\.md>$$' $@; for m in $$(cd doc && ls lightning*.[0-9].md | sort); do echo " $$(echo $$m | sed 's/.[0-9].md//') <$$m>"; done) > $@.tmp.$$$$ && mv $@.tmp.$$$$ $@
(grep -v '^ lightning.*\.[0-9]\.md>$$' $@; for m in $$(cd doc && ls lightning*.[0-9].md | sort); do echo " $$(echo $$m | sed 's/.[0-9].md//') <$$m>"; done) > $@.tmp.$$$$ && mv $@.tmp.$$$$ $@

.PHONY: doc/index.rst
6 changes: 6 additions & 0 deletions doc/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,12 @@ c-lightning Documentation
:maxdepth: 1
:caption: Manpages

lightningd <lightningd.8.md>
lightningd-config <lightningd-config.5.md>
lightningd <lightningd.8.md>
lightningd-config <lightningd-config.5.md>
lightningd <lightningd.8.md>
lightningd-config <lightningd-config.5.md>
lightning-autocleaninvoice <lightning-autocleaninvoice.7.md>
lightning-check <lightning-check.7.md>
lightning-cli <lightning-cli.1.md>
Expand Down
10 changes: 3 additions & 7 deletions doc/lightning-autocleaninvoice.7
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.TH "LIGHTNING-AUTOCLEANINVOICE" "7" "" "" "lightning-autocleaninvoice"
.SH NAME

lightning-autocleaninvoice - Set up auto-delete of expired invoice

lightning-autocleaninvoice - Set up auto-delete of expired invoice

Expand Down Expand Up @@ -32,17 +32,13 @@ On success, an empty object is returned\.

.SH AUTHOR

ZmnSCPxj \fBNone\fR (\fI<ZmnSCPxj@protonmail.com\fR)> is mainly responsible\.
ZmnSCPxj \fI<ZmnSCPxj@protonmail.com\fR> is mainly responsible\.

.SH SEE ALSO

\fBlightning-delexpiredinvoice\fR(7), \fBlightning-delinvoice\fR(7)

.SH RESOURCES

Main web site: \fBNone\fR (\fIhttps://github.com/ElementsProject/lightning\fR)

.HL

Last updated 2019-04-07 14:23:17 CEST
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR

9 changes: 2 additions & 7 deletions doc/lightning-autocleaninvoice.7.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
LIGHTNING-AUTOCLEANINVOICE(7) Manual Page
=========================================
lightning-autocleaninvoice - Set up auto-delete of expired invoice
lightning-autocleaninvoice -- Set up auto-delete of expired invoice
===================================================================

SYNOPSIS
--------
Expand Down Expand Up @@ -42,7 +41,3 @@ RESOURCES
---------

Main web site: <https://github.com/ElementsProject/lightning>

------------------------------------------------------------------------

Last updated 2019-04-07 14:23:17 CEST
13 changes: 3 additions & 10 deletions doc/lightning-check.7
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,6 @@
.TH "LIGHTNING-CHECK" "7" "" "" "lightning-check"
.SH NAME


lightning-check - Command for verifying parameters

.SH SYNOPSIS

\fBcheck\fR \fIcommand_to_check\fR [\fIparameters\fR]
Expand Down Expand Up @@ -31,14 +28,10 @@ relevant RPC error is returned\.

.SH AUTHOR

Mark Beckwith \fBNone\fR (\fI<wythe@intrig.com\fR)> and Rusty Russell
\fBNone\fR (\fI<rusty@rustcorp.com.au\fR)> are mainly responsible\.
Mark Beckwith \fI<wythe@intrig.com\fR> and Rusty Russell
\fI<rusty@rustcorp.com.au\fR> are mainly responsible\.

.SH RESOURCES

Main web site: \fBNone\fR (\fIhttps://github.com/ElementsProject/lightning\fR)

.HL

Last updated 2019-04-30 17:12:10 CEST
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR

7 changes: 1 addition & 6 deletions doc/lightning-check.7.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
LIGHTNING-CHECK(7) Manual Page
lightning-check -- Command for verifying parameters
==============================
lightning-check - Command for verifying parameters

SYNOPSIS
--------
Expand Down Expand Up @@ -37,7 +36,3 @@ RESOURCES
---------

Main web site: <https://github.com/ElementsProject/lightning>

------------------------------------------------------------------------

Last updated 2019-04-30 17:12:10 CEST
11 changes: 2 additions & 9 deletions doc/lightning-cli.1
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,6 @@
.TH "LIGHTNING-CLI" "1" "" "" "lightning-cli"
.SH NAME


lightning-cli - Control lightning daemon

.SH SYNOPSIS

\fBlightning-cli\fR [\fIOPTIONS\fR] \fIcommand\fR…
Expand Down Expand Up @@ -83,18 +80,14 @@ pretty printing of results isn’t pretty\.

.SH AUTHOR

Rusty Russell \fBNone\fR (\fI<rusty@rustcorp.com.au\fR)> is mainly to blame\.
Rusty Russell \fI<rusty@rustcorp.com.au\fR> is mainly to blame\.

.SH RESOURCES

Main web site: \fBNone\fR (\fIhttps://github.com/ElementsProject/lightning\fR)
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR

.SH COPYING

Note: the modules in the ccan/ directory have their own licenses, but
the rest of the code is covered by the BSD-style MIT license\.

.HL

Last updated 2019-04-30 17:39:53 CEST

9 changes: 2 additions & 7 deletions doc/lightning-cli.1.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
LIGHTNING-CLI(1) Manual Page
============================
lightning-cli - Control lightning daemon
lightning-cli -- Control lightning daemon
=========================================

SYNOPSIS
--------
Expand Down Expand Up @@ -91,7 +90,3 @@ COPYING

Note: the modules in the ccan/ directory have their own licenses, but
the rest of the code is covered by the BSD-style MIT license.

------------------------------------------------------------------------

Last updated 2019-04-30 17:39:53 CEST
11 changes: 2 additions & 9 deletions doc/lightning-close.7
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,6 @@
.TH "LIGHTNING-CLOSE" "7" "" "" "lightning-close"
.SH NAME


lightning-close - Command for closing channels with direct peers

.SH SYNOPSIS

\fBclose\fR \fIid\fR [\fIunilateraltimeout\fR]
Expand Down Expand Up @@ -59,17 +56,13 @@ vary based on the peer \fIto_self_delay\fR setting, not your own setting\.

.SH AUTHOR

ZmnSCPxj \fBNone\fR (\fI<ZmnSCPxj@protonmail.com\fR)> is mainly responsible\.
ZmnSCPxj \fI<ZmnSCPxj@protonmail.com\fR> is mainly responsible\.

.SH SEE ALSO

\fBlightning-disconnect\fR(7), \fBlightning-fundchannel\fR(7)

.SH RESOURCES

Main web site: \fBNone\fR (\fIhttps://github.com/ElementsProject/lightning\fR)

.HL

Last updated 2019-08-09 11:12:04 CEST
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR

9 changes: 2 additions & 7 deletions doc/lightning-close.7.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
LIGHTNING-CLOSE(7) Manual Page
==============================
lightning-close - Command for closing channels with direct peers
lightning-close -- Command for closing channels with direct peers
=================================================================

SYNOPSIS
--------
Expand Down Expand Up @@ -68,7 +67,3 @@ RESOURCES
---------

Main web site: <https://github.com/ElementsProject/lightning>

------------------------------------------------------------------------

Last updated 2019-08-09 11:12:04 CEST
17 changes: 4 additions & 13 deletions doc/lightning-connect.7
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,6 @@
.TH "LIGHTNING-CONNECT" "7" "" "" "lightning-connect"
.SH NAME


lightning-connect - Command for connecting to another lightning node\.

lightning-connect - Command for connecting to another lightning node
.SH SYNOPSIS

\fBconnect\fR \fIid\fR [\fIhost\fR \fIport\fR]
Expand Down Expand Up @@ -46,17 +43,15 @@ On success the peer \fIid\fR is returned\.

The following error codes may occur:

.RS
.IP \[bu]
-1: Catchall nonspecific error\. This may occur if the host is not
valid or there are problems communicating with the peer\. \fBconnect\fR
will make up to 10 attempts to connect to the peer before giving up\.

.RE
.SH AUTHOR

Rusty Russell \fBNone\fR (\fI<rusty@rustcorp.com.au\fR)> is mainly responsible\.
Felix \fBNone\fR (\fI<fixone@gmail.com\fR)> is the original author of this manpage\.
Rusty Russell \fI<rusty@rustcorp.com.au\fR> is mainly responsible\.
Felix \fI<fixone@gmail.com\fR> is the original author of this manpage\.

.SH SEE ALSO

Expand All @@ -65,9 +60,5 @@ Felix \fBNone\fR (\fI<fixone@gmail.com\fR)> is the original author of this manpa

.SH RESOURCES

Main web site: \fBNone\fR (\fIhttps://github.com/ElementsProject/lightning\fR)

.HL

Last updated 2019-08-01 14:59:36 CEST
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR

9 changes: 2 additions & 7 deletions doc/lightning-connect.7.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
LIGHTNING-CONNECT(7) Manual Page
================================
lightning-connect - Command for connecting to another lightning node.
lightning-connect -- Command for connecting to another lightning node
=====================================================================

SYNOPSIS
--------
Expand Down Expand Up @@ -59,7 +58,3 @@ RESOURCES
---------

Main web site: <https://github.com/ElementsProject/lightning>

------------------------------------------------------------------------

Last updated 2019-08-01 14:59:36 CEST
15 changes: 2 additions & 13 deletions doc/lightning-decodepay.7
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,6 @@
.TH "LIGHTNING-DECODEPAY" "7" "" "" "lightning-decodepay"
.SH NAME


lightning-decodepay - Command for decoding a bolt11 string (low-level)

.SH SYNOPSIS

\fBdecodepay\fR \fIbolt11\fR [\fIdescription\fR]
Expand All @@ -18,7 +15,6 @@ specified by the BOLT 11 specification\.
On success, an object is returned with the following fields, as
specified by BOLT11:

.RS
.IP \[bu]
\fIcurrency\fR: the BIP173 name for the currency\.
.IP \[bu]
Expand All @@ -35,11 +31,9 @@ specified by BOLT11:
\fIdescription\fR: the description of the purpose of the purchase (see
below)

.RE

The following fields are optional:

.RS
.IP \[bu]
\fImsatoshi\fR: the number of millisatoshi requested (if any)\.
.IP \[bu]
Expand All @@ -56,7 +50,6 @@ each containing \fIpubkey\fR, \fIshort_channel_id\fR, \fIfee_base_msat\fR,
\fIextra\fR: an array of objects representing unknown fields, each with
one-character \fItag\fR and a \fIdata\fR bech32 string\.

.RE

Technically, the \fIdescription\fR field is optional if a
\fIdescription_hash\fR field is given, but in this case \fBdecodepay\fR will
Expand All @@ -65,7 +58,7 @@ the \fIdescription_hash\fR\. In practice, these are currently unused\.

.SH AUTHOR

Rusty Russell \fBNone\fR (\fI<rusty@rustcorp.com.au\fR)> is mainly responsible\.
Rusty Russell \fI<rusty@rustcorp.com.au\fR> is mainly responsible\.

.SH SEE ALSO

Expand All @@ -77,9 +70,5 @@ Rusty Russell \fBNone\fR (\fI<rusty@rustcorp.com.au\fR)> is mainly responsible\.

.SH RESOURCES

Main web site: \fBNone\fR (\fIhttps://github.com/ElementsProject/lightning\fR)

.HL

Last updated 2019-04-30 17:12:10 CEST
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR

9 changes: 2 additions & 7 deletions doc/lightning-decodepay.7.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
LIGHTNING-DECODEPAY(7) Manual Page
==================================
lightning-decodepay - Command for decoding a bolt11 string (low-level)
lightning-decodepay -- Command for decoding a bolt11 string (low-level)
=======================================================================

SYNOPSIS
--------
Expand Down Expand Up @@ -61,7 +60,3 @@ RESOURCES
---------

Main web site: <https://github.com/ElementsProject/lightning>

------------------------------------------------------------------------

Last updated 2019-04-30 17:12:10 CEST
13 changes: 3 additions & 10 deletions doc/lightning-delexpiredinvoice.7
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,6 @@
.TH "LIGHTNING-DELEXPIREDINVOICE" "7" "" "" "lightning-delexpiredinvoice"
.SH NAME


lightning-delexpiredinvoice - Command for removing expired invoices\.

lightning-delexpiredinvoice - Command for removing expired invoices
.SH SYNOPSIS

\fBdelexpiredinvoice\fR [\fImaxexpirytime\fR]
Expand All @@ -23,17 +20,13 @@ On success, an empty object is returned\.

.SH AUTHOR

ZmnSCPxj \fBNone\fR (\fI<ZmnSCPxj@protonmail.com\fR)> is mainly responsible\.
ZmnSCPxj \fI<ZmnSCPxj@protonmail.com\fR> is mainly responsible\.

.SH SEE ALSO

\fBlightning-delinvoice\fR(7), \fBlightning-autocleaninvoice\fR(7)

.SH RESOURCES

Main web site: \fBNone\fR (\fIhttps://github.com/ElementsProject/lightning\fR)

.HL

Last updated 2019-04-07 14:23:17 CEST
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR

Loading