Closed tq-steina closed 1 year ago
Apologies... Github was not sending me alerts for issues and pull requests on this repo. I did not see this until just now.
Is this still relevant? I'm working through some backlog.
Yes, it is. Without this patch. Docs are creating dstat.1
, but not dool.1
. But make docs
are only creating dstat.1
. name is taken from dool.1.adoc
headers, not file name!
See also https://github.com/openembedded/meta-openembedded/commit/a8055484f2829e8dfd03d5c8520b2c611aa7ebd2 which has this patch included to fix the build there.
Interesting... I inherited this codebase, so I'm not even familiar with .adoc
. I assume it's a markup language like markdown that used to generation documentation? make
understands how to read .adoc
files? It's not a separate tool I need to install?
Interesting... I inherited this codebase, so I'm not even familiar with
.adoc
. I assume it's a markup language like markdown that used to generation documentation?make
understands how to read.adoc
files? It's not a separate tool I need to install?
FTR: I'm by no means an expert to .adoc
myself. I just noticed the clean/(re)build failure in yocto. make
doesn't know anything about .adoc
, that's asciidoc
.
If running the commands insode doc/
manually, you'll get dool.1.xml
, but dstat.1
later on:
xmlto man dool.1.xml
Warn: AUTHOR sect.: no personblurb|contrib for Dag Wieers dstat
Note: AUTHOR sect.: see http://www.docbook.org/tdg5/en/html/contr dstat
Note: AUTHOR sect.: see http://www.docbook.org/tdg5/en/html/perso dstat
Note: Writing dstat.1
No wonder, as dool.1.xml
contains the line <title>dstat(1)</title>
, caused by the (wrong) document title set in .adoc
The content of dool.1.adoc is completly unchanged from dstat.1.adoc. Unfortunately the 'NAME' specifies the created file name. So building/cleaning docs is currently broken
ISSUE TYPE
DSTAT VERSION
SUMMARY
The (generated) man page
dool.1
has been modified manually, while ignoering the actual source filedool.1.adoc
.This PR renames remaining
dstat
names todool
, which fixes also the name of the generated man page file, which depends on theNAME
tag.This is essentially a follow-up to #28, allowing build systems do clean and generate docs at least