mailarchive of the ptxdist mailing list
 help / color / mirror / Atom feed
From: Michael Olbrich <m.olbrich@pengutronix.de>
To: ptxdist@pengutronix.de
Subject: [ptxdist] PTXdist Documentation
Date: Thu, 10 Dec 2015 08:06:44 +0100	[thread overview]
Message-ID: <20151210070644.GE28645@pengutronix.de> (raw)

Hi,

On Wed, Dec 09, 2015 at 11:58:25PM +0100, Alan Martinovic wrote:
> And an off topic question:
> Is the "How to become a PTXdist Guru - Pengutronix" available for public
> contribution, and if so, how?

You have incredible timing :-). We decided some time a go, that the way we
handled the documentation was not really working any more. We turned the
latex sources for the Guru into something that can be processed by Sphinx
and added it to the PTXdist git tree. I've merged that last week. It's
still far from complete but it should be somewhat usable.
The source for the documentation is in doc/ and with "make docs" you'll get
html in Documentation/.
There is also a man-page containing the command-line reference. It's part
of the tarball an can be generated with 'make man'. This is now used for
'ptxdist --help'.

To get back to you're original questions: Yes, you can contribute to the
documentation. Just send patches that improve the files in doc/.

Regards,
Michael

-- 
Pengutronix e.K.                           |                             |
Industrial Linux Solutions                 | http://www.pengutronix.de/  |
Peiner Str. 6-8, 31137 Hildesheim, Germany | Phone: +49-5121-206917-0    |
Amtsgericht Hildesheim, HRA 2686           | Fax:   +49-5121-206917-5555 |

_______________________________________________
ptxdist mailing list
ptxdist@pengutronix.de

                 reply	other threads:[~2015-12-10  7:06 UTC|newest]

Thread overview: [no followups] expand[flat|nested]  mbox.gz  Atom feed

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20151210070644.GE28645@pengutronix.de \
    --to=m.olbrich@pengutronix.de \
    --cc=ptxdist@pengutronix.de \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox