pkgsrc-WIP-changes archive

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index][Old Index]

wla-dx-git: install the *.rst documentation files from doc/



Module Name:	pkgsrc-wip
Committed By:	Dean Matzkov <bapabooiee%gmail.com@localhost>
Pushed By:	bapa
Date:		Fri Jan 18 22:39:52 2019 -0700
Changeset:	b702114303bccae6f9f44ec112130b0cac5bc0ad

Modified Files:
	wla-dx-git/Makefile
	wla-dx-git/PLIST
	wla-dx-git/TODO

Log Message:
wla-dx-git: install the *.rst documentation files from doc/

Upstream no longer maintains a monolithic README, and has split-up
the documentation into multiple files.

They're meant to be processed by sphinx-build to generate manpages
or HTML docs, but for now we'll just install the *.rst files
straight-up as they're both useful and still perfectly human-readable.

To see a diff of this commit:
https://wip.pkgsrc.org/cgi-bin/gitweb.cgi?p=pkgsrc-wip.git;a=commitdiff;h=b702114303bccae6f9f44ec112130b0cac5bc0ad

Please note that diffs are not public domain; they are subject to the
copyright notices on the relevant files.

diffstat:
 wla-dx-git/Makefile |  2 +-
 wla-dx-git/PLIST    | 20 ++++++++++++++++++++
 wla-dx-git/TODO     |  8 +++++++-
 3 files changed, 28 insertions(+), 2 deletions(-)

diffs:
diff --git a/wla-dx-git/Makefile b/wla-dx-git/Makefile
index 836db1302b..c7816bc8a0 100644
--- a/wla-dx-git/Makefile
+++ b/wla-dx-git/Makefile
@@ -25,7 +25,7 @@ do-install:
 .for f in ${WLADX_BINARIES}
 	${INSTALL_PROGRAM} ${WRKSRC}/binaries/${f} ${DESTDIR}${PREFIX}/bin
 .endfor
-.for f in README.md FILE_FORMATS CHANGELOG
+.for f in README.md FILE_FORMATS CHANGELOG doc/*.rst
 	${INSTALL_DATA} ${WRKSRC}/${f} ${DESTDIR}${PREFIX}/share/doc/${PKGBASE}
 .endfor
 
diff --git a/wla-dx-git/PLIST b/wla-dx-git/PLIST
index 46a6eee0a1..741e0fdd5b 100644
--- a/wla-dx-git/PLIST
+++ b/wla-dx-git/PLIST
@@ -12,3 +12,23 @@ bin/wlalink
 share/doc/wla-dx/CHANGELOG
 share/doc/wla-dx/FILE_FORMATS
 share/doc/wla-dx/README.md
+share/doc/wla-dx/archoverview.rst
+share/doc/wla-dx/arithmetics.rst
+share/doc/wla-dx/asmdiv.rst
+share/doc/wla-dx/asmsyntax.rst
+share/doc/wla-dx/bintodb.rst
+share/doc/wla-dx/bugs.rst
+share/doc/wla-dx/codetoknow.rst
+share/doc/wla-dx/compiling.rst
+share/doc/wla-dx/errormsg.rst
+share/doc/wla-dx/extraflags.rst
+share/doc/wla-dx/files.rst
+share/doc/wla-dx/gb-support.rst
+share/doc/wla-dx/goodtoknow.rst
+share/doc/wla-dx/introduction.rst
+share/doc/wla-dx/legal.rst
+share/doc/wla-dx/linking.rst
+share/doc/wla-dx/symbols.rst
+share/doc/wla-dx/tempfiles.rst
+share/doc/wla-dx/wla-dx.rst
+share/doc/wla-dx/wlaflags.rst
diff --git a/wla-dx-git/TODO b/wla-dx-git/TODO
index b727accdd8..fd996b3db9 100644
--- a/wla-dx-git/TODO
+++ b/wla-dx-git/TODO
@@ -1 +1,7 @@
-DESCR could be more helpful and explanatory.
+- DESCR could be more helpful and explanatory.
+
+- Documentation is now maintained as *.rst files in doc/, and are supposed to be
+  processed by sphinx-build to be turned into manpages or HTML docs.
+
+  Until we can get sphinx and documentation conversion working, we'll just install
+  the *.rst files straight-up as they're plaintext and perfectly human-readable.


Home | Main Index | Thread Index | Old Index