docs: More clean-ups (smoe:docs_man_adoc_20240813-2) #3110

smoe · 2024-09-12T15:03:49Z

I took my local version of the #3066 and rebased it against master. Added another patch to remove empty blanks at the end of lines. Now looks clean, no exact idea what I did differently.

@petterreinholdtsen , @hansu , Please kindly review this one and then I see what I can do to save what is still important n #3066 .

Many thanks,
Steffen

smoe · 2024-09-12T15:50:06Z

The error is not caused by this PR:

Skipping disabled test: /home/runner/work/linuxcnc/linuxcnc/tests/save.1
Running test: /home/runner/work/linuxcnc/linuxcnc/tests/single-step
*** /home/runner/work/linuxcnc/linuxcnc/tests/single-step: XFAIL: test run exited with 1
************** result:
        Machine configuration file is 'test.ini'
        Starting LinuxCNC...
        linuxcncsvr (169910) emcsvr: machine 'unknown'  version '1.1'
        linuxcnc TPMOD=tpmod HOMEMOD=homemod EMCMOT=motmod
        milltask (169923) task: machine 'unknown'  version '1.1'
        emc/task/taskclass.cc 187: can't load tool table.
        Found file(LIB): /home/runner/work/linuxcnc/linuxcnc/lib/hallib/core_sim.hal
        USRMOT: ERROR: command 30 timeout
        emcMotionInit: emcTrajInit failed
        task: main loop took 0.018239 seconds
        task: main loop took 0.019244 seconds
        Shutting down and cleaning up LinuxCNC...
        task: 0 cycles, min=0.000004, max=0.019244, avg=-1.000000, 2 latency excursions (> 10x expected cycle time of 0.001000s)
        LinuxCNC terminated with an error.  You can find more information in the log:
            /home/runner/linuxcnc_debug.txt
        and
            /home/runner/linuxcnc_print.txt
        as well as in the output of the shell command 'dmesg' and in the terminal
************** stderr:
        + linuxcnc -r test.ini
        Note: Using POSIX non-realtime
        emc/tooldata/tooldata_common.cc, 304: Failed to open tool table file 'simpockets.tbl': No such file or directory
        emc/tooldata/tooldata_common.cc, 304: Failed to open tool table file 'simpockets.tbl': No such file or directory
        link (updating variable file): No such file or directory
        timeout in wait_complete_step()
        Note: Using POSIX non-realtime
**************
Running test: /home/runner/work/linuxcnc/linuxcnc/tests/source.0

petterreinholdtsen · 2024-09-13T19:26:06Z

[Steffen Möller]

The error is not caused by this PR:

Yes, there is a race condition in the single-step test. I restarted the test and now it succeeded. I do unfortunately not have time to review these changes for a while. I hope someone can have a look.

…

-- Happy hacking Petter Reinholdtsen

smoe · 2024-09-26T16:55:57Z

@hansu , may I ask you? Should not be too bad.

hansu

What is CMS_buffer.eps?

Please also remove the asterisks from linuxcncrsh.1.adoc:58 while you are at it :)

To use linuxcncrsh instead of a normal LinuxCNC GUI like AXIS or Touchy,
specify it in your INI file like this:

----
-*[DISPLAY]*
+[DISPLAY]

-*DISPLAY=linuxcncrsh*
+DISPLAY=linuxcncrsh
----

hansu · 2024-09-27T14:19:57Z

docs/src/gui/gscreen.adoc

@@ -122,7 +122,7 @@ gscreen-gaxis has a sample custom theme that looks for certain named widgets and
 The Estop and machine-on buttons use different colors then the rest of the buttons so that they stand out.
 This is done in the handler file by giving them specific names an by adding specific commands in the theme's gtkrc file.
 For some info on GTK theming (The sample theme uses the pixmap theme engine), see:
-https://wiki.gnome.org/Attic/GnomeArt/Tutorials/GtkThemes[GTK Themes], 
+https://wiki.gnome.org/Attic/GnomeArt/Tutorials/GtkThemes[GTK Themes],


This space should stay

This one is still remaining

docs/src/code/building-linuxcnc.adoc

docs/src/man/man1/linuxcncrsh.1.adoc

smoe · 2024-09-27T16:40:19Z

What is CMS_buffer.eps

It is the DIA (https://en.wikipedia.org/wiki/Dia_(software))-generated post script from which https://github.com/LinuxCNC/linuxcnc/blob/master/docs/src/code/CMS_buffer.png is derived. The EPS file itself is not used.

smoe · 2024-09-27T16:40:58Z

Looking at the bad quality of the PNG, it may be worthwhile to have a second look at my idea to remove the EPS.

andypugh · 2024-09-28T09:16:33Z

Would changing the EPS to an SVG work? (Do our tools display SVG? Web browsers display them by default)

smoe · 2024-09-28T11:32:20Z

Would changing the EPS to an SVG work?
Yes, nice idea, GIMP can do that, I am sure. Let me provide that alternative - and please also tell me if anything else should be changed in that image at that opportunity :-)

(Do our tools display SVG? Web browsers display them by default)
I do not know, but the PNG I'll make sure to look better.

…lost. Transformed the .eps to an editable .svg and exported the PNG in a 300 dpi resolution.

…ion.

smoe · 2024-09-29T13:01:54Z

Would changing the EPS to an SVG work? (Do our tools display SVG? Web browsers display them by default)
The SVG looks nice in inkscape and the PNG is also refreshed.
Have rebased to master, have addressed all of Hansu's changes, except for the one still disputed newline one :-) , and added some more lines on the introduction of linuxcncrsh.1 (feeling that tool to be a bit underrated).

smoe · 2024-09-30T09:06:02Z

The error in debian:bookworm is triggered by the tests:

Running test: ./tests/single-step
*** ./tests/single-step: XFAIL: test run exited with 1
************** result:
        Machine configuration file is 'test.ini'
        Starting LinuxCNC...
        linuxcncsvr (224663) emcsvr: machine 'unknown'  version '1.1'
        linuxcnc TPMOD=tpmod HOMEMOD=homemod EMCMOT=motmod
        milltask (224675) task: machine 'unknown'  version '1.1'
        emc/task/taskclass.cc 187: can't load tool table.
        Found file(LIB): /usr/share/linuxcnc/hallib/core_sim.hal
        USRMOT: ERROR: command 30 timeout
        emcMotionInit: emcTrajInit failed
        task: main loop took 0.018326 seconds
        task: main loop took 0.018875 seconds
        Shutting down and cleaning up LinuxCNC...
        task: 0 cycles, min=0.000004, max=0.018875, avg=-1.000000, 2 latency excursions (> 10x expected cycle time of 0.001000s)
        LinuxCNC terminated with an error.  You can find more information in the log:
            /home/testrunner/linuxcnc_debug.txt
        and
            /home/testrunner/linuxcnc_print.txt
        as well as in the output of the shell command 'dmesg' and in the terminal
************** stderr:
        + linuxcnc -r test.ini
        ERROR: ld.so: object 'libeatmydata.so' from LD_PRELOAD cannot be preloaded (cannot open shared object file): ignored.
        Note: Using POSIX non-realtime
        ERROR: ld.so: object 'libeatmydata.so' from LD_PRELOAD cannot be preloaded (cannot open shared object file): ignored.
        emc/tooldata/tooldata_common.cc, 304: Failed to open tool table file 'simpockets.tbl': No such file or directory
        emc/tooldata/tooldata_common.cc, 304: Failed to open tool table file 'simpockets.tbl': No such file or directory
        ERROR: ld.so: object 'libeatmydata.so' from LD_PRELOAD cannot be preloaded (cannot open shared object file): ignored.
        ERROR: ld.so: object 'libeatmydata.so' from LD_PRELOAD cannot be preloaded (cannot open shared object file): ignored.
        ERROR: ld.so: object 'libeatmydata.so' from LD_PRELOAD cannot be preloaded (cannot open shared object file): ignored.
        ERROR: ld.so: object 'libeatmydata.so' from LD_PRELOAD cannot be preloaded (cannot open shared object file): ignored.
        link (updating variable file): No such file or directory
        line=7; Xpos=5.00; Ypos=0.12; Zpos=0.00; counter=0

Tend to think that this PR is not triggering this.

smoe · 2024-10-03T15:45:15Z

@hansu, this patch needs to build and thus I want to push something else that is somehow trivial but useful. Concerning that blank that you wanted to be added back in, is this still a thing? I truly think that it would be wrong to add, and since I am likely to make that mistake (if any) again with the upcoming changes, please kindly explain what your concern is.

hansu · 2024-10-04T08:42:51Z

Simply look here: https://linuxcnc.org/docs/devel/html/gui/gscreen.html#_overview

This

For some info on GTK theming (The sample theme uses the pixmap theme engine), see: GTK Themes, Pixmap Theme Engine.
2.2. Build a GladeVCP Panel

would turn into

For some info on GTK theming (The sample theme uses the pixmap theme engine), see: GTK Themes,Pixmap Theme Engine.
2.2. Build a GladeVCP Panel

smoe · 2024-10-04T09:19:06Z

Simply look here: https://linuxcnc.org/docs/devel/html/gui/gscreen.html#_overview

This

For some info on GTK theming (The sample theme uses the pixmap theme engine), see: GTK Themes, Pixmap Theme Engine.
2.2. Build a GladeVCP Panel

would turn into

For some info on GTK theming (The sample theme uses the pixmap theme engine), see: GTK Themes,Pixmap Theme Engine.
2.2. Build a GladeVCP Panel

No, it would not? I mean, have you seen that happening? Definitely does not happen in the vscode preview. The patch intends to remove the blank that is still followed by a newline, not also the newline. We have lines ending with commas or periods all the time that have proper white space following in the HTML/pdf. I yet fail to see (and would want to understand) why is this now special.

?´+ü´[ <- baby-cat just contributed some extra characters ]

If you do not ultimately mind, please just accept the patch. I'll make a $100 donation to FreeCAD if there is no white space in the PDF after that comma ... and likely spend the rest of the year to find the bug in the autodoc parser.

hansu · 2024-10-04T11:18:23Z

No, it would not?

You are right, sorry. I missed the line break and thought just Github editor did the line break 😇
However I still would not trust the VSCode preview as it targets on asciidoctor not asciidoc-py and differs in some border cases.

smoe force-pushed the docs_man_adoc_20240813-2 branch from 1531bb5 to 049b59f Compare September 18, 2024 09:20

smoe changed the title ~~Docs man adoc 20240813 2~~ docs: More clean-ups (smoe:docs_man_adoc_20240813-2) Sep 18, 2024

hansu requested changes Sep 27, 2024

View reviewed changes

smoe marked this pull request as draft September 28, 2024 11:33

smoe added 5 commits September 29, 2024 14:58

docs: omitted '::' encountered while translating

a339873

docs: Remove blanks at ends of lines

d60c559

docs: Only the .png is used, the original (trivial) .dia file may be …

5de9913

…lost. Transformed the .eps to an editable .svg and exported the PNG in a 300 dpi resolution.

docs: linuxcncrsh.1: Syntax fix and additional paragraph in introduct…

342532e

…ion.

docs: building-linuxcnc.adoc: syntax on newlines

0efb01b

smoe force-pushed the docs_man_adoc_20240813-2 branch from b6be53d to 0efb01b Compare September 29, 2024 12:58

smoe marked this pull request as ready for review September 29, 2024 12:58

docs: gscreen.adoc: Fixed typo

930d5eb

Completed optical representation of index as subscript

a9bfeac

hansu merged commit bbabfab into LinuxCNC:master Oct 4, 2024
9 checks passed

smoe deleted the docs_man_adoc_20240813-2 branch October 4, 2024 13:13

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: More clean-ups (smoe:docs_man_adoc_20240813-2) #3110

docs: More clean-ups (smoe:docs_man_adoc_20240813-2) #3110

smoe commented Sep 12, 2024

smoe commented Sep 12, 2024

petterreinholdtsen commented Sep 13, 2024 via email

smoe commented Sep 26, 2024

hansu left a comment

hansu Sep 27, 2024

hansu Sep 29, 2024

smoe commented Sep 27, 2024

smoe commented Sep 27, 2024

andypugh commented Sep 28, 2024

smoe commented Sep 28, 2024

smoe commented Sep 29, 2024

smoe commented Sep 30, 2024

smoe commented Oct 3, 2024

hansu commented Oct 4, 2024

smoe commented Oct 4, 2024

hansu commented Oct 4, 2024

docs: More clean-ups (smoe:docs_man_adoc_20240813-2) #3110

docs: More clean-ups (smoe:docs_man_adoc_20240813-2) #3110

Conversation

smoe commented Sep 12, 2024

smoe commented Sep 12, 2024

petterreinholdtsen commented Sep 13, 2024 via email

smoe commented Sep 26, 2024

hansu left a comment

Choose a reason for hiding this comment

hansu Sep 27, 2024

Choose a reason for hiding this comment

hansu Sep 29, 2024

Choose a reason for hiding this comment

smoe commented Sep 27, 2024

smoe commented Sep 27, 2024

andypugh commented Sep 28, 2024

smoe commented Sep 28, 2024

smoe commented Sep 29, 2024

smoe commented Sep 30, 2024

smoe commented Oct 3, 2024

hansu commented Oct 4, 2024

smoe commented Oct 4, 2024

hansu commented Oct 4, 2024