LinuxCNC / linuxcnc

LinuxCNC controls CNC machines. It can drive milling machines, lathes, 3d printers, laser cutters, plasma cutters, robot arms, hexapods, and more.
http://linuxcnc.org/
GNU General Public License v2.0
1.81k stars 1.16k forks source link

Add missing manual pages for remaining binaries (melfagui millturngui qtplasmac_gcode setup_designer tool_mmap_read tool_watch xyzab-tdr-gui z_level_compensation modcompile) #3025

Open petterreinholdtsen opened 4 months ago

petterreinholdtsen commented 4 months ago

The lintian check in Debian report that some programs in /usr/bin/ are missing manual pages: melfagui millturngui qtplasmac_gcode setup_designer tool_mmap_read tool_watch xyzab-tdr-gui z_level_compensation modcompile.

Please add manual pages for these.

Other lintian related issues are #745, #924, #1728, #1917 and #1964.

andypugh commented 4 months ago

Is it as simple as adding minimal pages with links to the main docs? If so, then please see the PR above.

petterreinholdtsen commented 4 months ago

[Andypugh]

Is it as simple as adding minimal pages with links to the main docs? If so, then please see the PR above.

It is a good start, at least. Someone can add more content later, if we want more in them.

-- Happy hacking Petter Reinholdtsen

andypugh commented 4 months ago

Is that a recommendation to merge?

petterreinholdtsen commented 4 months ago

[andypugh]

Is that a recommendation to merge?

Sure. I have not enough knowledge to judge the content, but see that there seem to be sensible man page headers and that it will provide some information to the man page readers. Good enough for me. :)

-- Happy hacking Petter Reinholdtsen

hansu commented 4 months ago

Can this be closed or are some man pages remain missing?

petterreinholdtsen commented 4 months ago

[Hans Unzner]

Can this be closed or are some man pages remain missing?

I belive everything was fixed in 2.9. Have not yet seen the merge in master, which I plan to convert to adoc before closing this issue.

-- Happy hacking Petter Reinholdtsen

andypugh commented 4 months ago

I tried to do the merge to master last night, but it was difficult. (for reasons not to do with the docs. Issues with interp_g7x.cc and emcrsh mainly) Also I was trying to test compile in an RTAI system, and that has been broken too ( https://github.com/LinuxCNC/linuxcnc/commit/87e4e4428a1d8012dc021596b02f4b9085641232#r144266518 )