diff options
author | Michael Olbrich <m.olbrich@pengutronix.de> | 2015-11-13 17:13:25 +0100 |
---|---|---|
committer | Michael Olbrich <m.olbrich@pengutronix.de> | 2015-12-03 22:37:00 +0100 |
commit | a296da4a1eff93ce839cbda5b9c0c6c97a59ba90 (patch) | |
tree | 936496f144badb425b8bfe826722aee15d573d97 | |
parent | 57fe7eaa17835495b9c5dbdaf9ffcaafaee69b41 (diff) | |
download | ptxdist-a296da4a1eff93ce839cbda5b9c0c6c97a59ba90.tar.gz ptxdist-a296da4a1eff93ce839cbda5b9c0c6c97a59ba90.tar.xz |
generate basic man-page
Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
-rw-r--r-- | Makefile.in | 8 | ||||
-rw-r--r-- | configure.ac | 3 | ||||
-rw-r--r-- | doc/man.rst | 20 |
3 files changed, 30 insertions, 1 deletions
diff --git a/Makefile.in b/Makefile.in index 7ca79d3b6..7d9a5a572 100644 --- a/Makefile.in +++ b/Makefile.in @@ -71,6 +71,11 @@ environment: @ln -sf @MAKE@ "$(abs_srcdir)/bin/make" @echo " done" +man: man/ptxdist.1.gz +man/ptxdist.1.gz: doc/man.rst doc/ref_parameter.rst + @mkdir -pv man + $(RST2MAN) $< 2>/dev/null | gzip > $@ + clean: @rm -f .done @find "$(abs_srcdir)/bin" -type l -print0 | xargs -0 rm -f @@ -114,7 +119,7 @@ dist: dirty-check @git archive "$(project)" --prefix="$(project)"/ > "${project}.tar" tar xf "${project}.tar" echo -n "${version}" > "${project}/.tarball-version" - cd "$(project)" && ./autogen.sh + cd "$(project)" && ./autogen.sh && make man tar --owner=0 --group=0 -rf "${project}.tar" \ "${project}/configure" \ @@ -134,6 +139,7 @@ release: @scripts/make_$@.sh SPHINXBUILD = @SPHINX@ +RST2MAN = @RST2MAN@ docs: @. scripts/ptxdist_version.sh && \ diff --git a/configure.ac b/configure.ac index ffa8b3e9f..0ec396bc1 100644 --- a/configure.ac +++ b/configure.ac @@ -288,6 +288,9 @@ else fi AC_SUBST(SPHINX) +AC_PATH_PROGS(RST2MAN, rst2man,, $PATH) +AC_SUBST(RST2MAN) + dnl dnl Checks for Python, needed for ipkg-utils dnl diff --git a/doc/man.rst b/doc/man.rst new file mode 100644 index 000000000..23408abd7 --- /dev/null +++ b/doc/man.rst @@ -0,0 +1,20 @@ +PTXdist +======= + +build system for embedded Linux +------------------------------- + +Synopsis +~~~~~~~~ + +ptxdist <action [args]> [options] + +Description +~~~~~~~~~~~ + +This is the command line documentation for PTXdist. See FIXME for the +complete documentation. + +.. role:: ref(emphasis) + +.. include:: ref_parameter.rst |