search

machinekit / machinekit-docs

Machinekit website
http://www.machinekit.io
16 stars 52 forks source link

Document `newthread cgname=/rt` #300

Closed zultron closed 5 years ago

zultron commented 5 years ago

Add new page about HAL threads and latency.

The newthread command seems to be undocumented outside of the brief description docs/man/man1/halcmd.asciidoc. This page serves as a stub for more in-depth documentation on threads and latency topics, and documents the newthread cgname=/rt argument.

Also cgname=/rt arg to halcmd(1) man page.

See machinekit/machinekit#1426

zultron commented 5 years ago

This page isn't linked into the rest of the documentation anywhere. @ArcEye said he'd help with that once the page was written.

zultron commented 5 years ago

Is there a way to preview the changes?

ArcEye commented 5 years ago

Yes, http://preview.machinekit.io It will last until the next PR, but take care to check the address in your browser. If you follow a link it will go to the main site not the preview

ArcEye commented 5 years ago

Thats great @zultron Couple of strange display glitches I noted on the code page

ArcEye commented 5 years ago

I'll tidy up any minor formatting glitches when I create the links etc

Probably need to use the [ source, bash] tag to ensure it displays as it was written, thinking about it

zultron commented 5 years ago

Thanks, @ArcEye!

zultron commented 5 years ago

Looking back at the result, IMO there should still be a "Threads" page that documents basic newthread usage, but this page is lengthy enough that it would do well on its own. Anyway, I'll leave it up to you to decide its fate. Thanks again.

ArcEye commented 5 years ago

http://www.machinekit.io/docs/man/man1/halcmd/ and http://machinekit.io/docs/basic-hal both cover newthread and link to your page as well as the standalone link under developing.

If you see something else feel free to shout.