On 07/08/2016 02:05, John Kasunich wrote:
Documentation frustrations continue...
I really don't want to be "that guy" who complains all the time
and doesn't actually fix anything. Today's complaints are the
results of an attempt to fix documentation.
I figured I would start with something simple. The HAL
"newthread" command is undocumented, I figured I would
contribute documentation.
I found this page:
http://www.machinekit.io/docs/developing/machinekit-developing/
And I followed those instructions to the letter to install machinekit
on my beaglebone green.
I was able to compile from source (it took an hour, the bone is SLOW).
I edited the source of halcmd to fix the built-in help. Built it and tested
it. Works great.
Then I wanted to update the halcmd man-page. "man halcmd" gave
me nothing. On this page:
http://www.machinekit.io/docs/hal/tools/
I discovered that RIP builds don't install man pages. Seems odd, the
script at scripts/rip-environment does attempt to set a man path, but
I don't know the finer points of that stuff.
Anyway, I try the "man -M docs/man halcmd" approach as shown on
that page. Nothing. Then I look at my checkout, and the man directory
tree contains only an empty man9 directory... Where are the damn
man pages?
https://groups.google.com/forum/#!topic/machinekit/8tHlQEbvq2I detailed
the change to man pages, some while back.
There is also a README in /man in the sources.
All the static manual pages plus the latest generated ones are on the
website.
http://www.machinekit.io/docs/man/man1/
http://www.machinekit.io/docs/man/man3/
http://www.machinekit.io/docs/man/man9/
There is a package which can be installed to give all those pages
locally if required, machinekit-manual-pages
The static manual pages are part of the ducumentation and can be edited
and added to there
https://github.com/machinekit/machinekit-docs/tree/master/docs/man
I am in the process of properly converting the manual pages, by removing
troff remnants and formatting for better viewing in .asciidoc / html.
The process is far from complete, got about as far as /man1/halui so far.
If you have problems contributing a new page, contact me directly, I am
quite happy to even format plain text to the required asciidoc.
regards
--
website: http://www.machinekit.io blog: http://blog.machinekit.io github:
https://github.com/machinekit
---
You received this message because you are subscribed to the Google Groups "Machinekit" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
Visit this group at https://groups.google.com/group/machinekit.
For more options, visit https://groups.google.com/d/optout.
