Cleanups#3014
Cleanups#3014cdecker merged 5 commits intoElementsProject:masterElementsProject/lightning:masterfrom
Conversation
|
|
||
| $(MANPAGES): doc/%: doc/%.md | ||
| @if $(CHANGED_FROM_GIT); then echo mrkd $<; mrkd $<; else touch $@; fi | ||
| if $(CHANGED_FROM_GIT); then mrkd $< $@; else touch $@; fi |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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 highlightingNotice 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
There was a problem hiding this comment.
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
There was a problem hiding this comment.
This is btw also the mrkd that is deployed on travis
Ah I thought Travis would install the one in doc/requirements.txt
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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 😉
There was a problem hiding this comment.
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
There was a problem hiding this comment.
darosior/mrkd@dfbc8c3 has been dropped on my branch, so doc/requirements.txt needs to be updated
There was a problem hiding this comment.
Fwiw I gave you write access to the repo, since it is used as a dependency here.
There was a problem hiding this comment.
darosior/mrkd@dfbc8c3 has been dropped on my branch, so doc/requirements.txt needs to be updated
What about adding a tag?
That's exactly the reason for the first commit :-) |
doc/lightning-autocleaninvoice.7.md
Outdated
| ========================================= | ||
| lightning-autocleaninvoice -- Set up auto-delete of expired invoice | ||
| =================================================================== | ||
| lightning-autocleaninvoice - Set up auto-delete of expired invoice |
|
Tagged |
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.
This is an issue that was raised in ElementsProject#2665: some of the dependencies where causing warnings to be added to the logs about deprecated dependencies. Since I did not get these warnings I just blanket updated all the dependencies in the hopes of getting the warnings to resolve. Signed-off-by: Christian Decker <@cdecker>
We were checking the test request against the searched for string. This fixes it by actually looking at the outcome instead and should clean up correctly if tests do not fail. Signed-off-by: Christian Decker <decker.christian@gmail.com>
We're not going to optimize travis any longer so let's no fill logs with useless measurements.
Just some cleanups regarding the python tests.