bugGNU Octave - Bugs: bug #61010, [octave forge] (control) gnuplot...

 
 

bug #61010: [octave forge] (control) gnuplot warning shows up in pzmap documentation build

Submitter:  Nicholas Jankowski <nrjank>
Submitted:  Wed 04 Aug 2021 09:09:06 PM UTC
   
 
Category:  Octave Package Severity:  3 - Normal
Priority:  5 - Normal Item Group:  Unexpected Error or Warning
Status:  Fixed Assigned to:  None
Originator Name:  Nicholas Jankowski Open/Closed:  * Closed
Release:  * dev Operating System:  * Any
Fixed Release:  None Planned Release:  None
* Mandatory Fields

Add a New Comment Rich Markup
   

Jump to the original submission

Thu 12 Aug 2021 05:53:18 AM UTC, comment #23: 

The first example in the attached pzmap (pzmap_101.png) seems to be missing.  Maybe it is better to upload the whole tarball again.

Can you attach the tarball here? https://sourceforge.net/p/octave/package-releases/448/

Otherwise, by private email is okay as well <k.ohlhus@gmail.com>.

Kai Torben Ohlhus <siko1056>
Group Member
Thu 12 Aug 2021 05:26:57 AM UTC, comment #22: 

Yes, definitely too big, is there another way? If not, I have now attached pzmap.html only.

(file #51769)

Torsten Lilge <ttl>
Group Member
Thu 12 Aug 2021 02:17:49 AM UTC, comment #21: 

It is ~0.8M probably too big for savannah.

Dmitri.
--

Dmitri A. Sergatskov <dasergatskov>
Thu 12 Aug 2021 01:41:33 AM UTC, comment #20: 

@Torsten: I am afraid the attachment went missing 😓

Kai Torben Ohlhus <siko1056>
Group Member
Wed 11 Aug 2021 06:18:55 PM UTC, comment #19: 

The make files were calling octave with the option --no-window-system which also disables the qt graphics. Please find attached the new html tarball.

Closing this report.

Torsten Lilge <ttl>
Group Member
Wed 11 Aug 2021 08:46:27 AM UTC, comment #18: 

Regarding comment #17, I think that is beyond the scope of this report.  I plan to replace the abandoned generate_html package by
https://github.com/gnu-octave/generate_doc, please file a bug report there.  Of course you are welcome to work with me on that package 🙂

Kai Torben Ohlhus <siko1056>
Group Member
Wed 11 Aug 2021 01:52:17 AM UTC, comment #17: 

It is probably getting out of scope, but one possible improvements of "genrate_html" package is to change figures format from png to svg.

Dmitri.
--

Dmitri A. Sergatskov <dasergatskov>
Wed 11 Aug 2021 01:32:09 AM UTC, comment #16: 

@Torsten (comment #15): Yes, thanks, an updated documentation would be nice 🙂  Please attach it here.

After the update I think it is safe to close this report.

If flaws with other OF documentations exist, please report them for each individual package and the package maintainer can take care of it.

Kai Torben Ohlhus <siko1056>
Group Member
Tue 10 Aug 2021 08:11:42 PM UTC, comment #15: 

Okay, I finally understand what is the problem here. I am currently looking at the make process of the control package in order to find why and where gnuplot ant not qt is selected for the plots.

@Kai, should I provide an updated html tarball afterwards?

Torsten Lilge <ttl>
Group Member
Tue 10 Aug 2021 07:29:42 PM UTC, comment #14: 

ahh, ok.  so the warning does lie with whatever process the control package uses prior to building/submitting.

Nicholas Jankowski <nrjank>
Group Member
Tue 10 Aug 2021 05:07:58 AM UTC, comment #13: 

Regarding comment #10 and comment #11, thank you for the clarifications.

A small background:  The Octave Forge package documentation is built by the package maintainer for each individual package release.  She builds and uploads the HTML pages tarball.  Recently I take a short glimpse at them and upload those pages file-by-file via SFTP (this still takes about 10 minutes per release) a thorough review is missing due to lack of time.

However, the responsibility for a flawless documentation is by the package maintainer.  Bringing that responsibility to what remains of Octave Forge (which is effectively dead) probably means that this issue will never be addressed at all.

Kai Torben Ohlhus <siko1056>
Group Member
Tue 10 Aug 2021 04:09:36 AM UTC, comment #12: 

OK, so probably the build environment for the docs falls back to gnuplot. Rather than change that, is it easier to just add a line to the build process somewhere to disable and then reenable that "Octave:gnuplot-graphics" warning?

Nicholas Jankowski <nrjank>
Group Member
Tue 10 Aug 2021 03:37:19 AM UTC, comment #11: 

IMHO the bug is that octave-forge documentation plots are built with gnuplot rather than with qt graphics. There is no problem w/
generate_html pakg. I just build locally docs for control and it
used qt graphics (see attached). So the issue is with the build system for the actual octave-forge website.

Dmitri.
--



Dmitri A. Sergatskov <dasergatskov>
Tue 10 Aug 2021 02:44:57 AM UTC, comment #10: 

Regarding comment #8, sorry I probably lost the scope of this bug report.  If you suggest a suitable title, I'll apply it.  However I prefer the [octave forge] prefix, to know that I can basically ignore those emails.

Regarding OF documentation, this is usually built with the "generate_html" package (see https://octave.sourceforge.io/templates/Makefile)

Kai Torben Ohlhus <siko1056>
Group Member
Tue 10 Aug 2021 02:37:49 AM UTC, comment #9: 

alphabetically is control and pzmap the first package with rendered demo graphics? that would maybe suggest why it is the only one showing the warning, as it's set to 'warn once'.

is the simplest fix just disabling that warning in the build script.

Nicholas Jankowski <nrjank>
Group Member
Tue 10 Aug 2021 01:47:02 AM UTC, comment #8: 

And it is not only control package. All forge demos with plots seem to be made with gnuplot. I so not know forge web page is built, but it looks to me it is done on a headless system w/o
opengl buffer.

Dmitri.
--



Dmitri A. Sergatskov <dasergatskov>
Mon 09 Aug 2021 11:12:09 PM UTC, comment #7: 

there's nothing calling gnuplot specifically in the pzmap code, and the demo lines are simply:


%!demo
%! s = tf('s');
%! g = (s-1)/(s-2)/(s-3);
%! pzmap(g);

%!demo
%! s = tf('s');
%! g = 1/(2*s^2+3*s+4);
%! pzmap(g);


so the gnuplot directive would have to be coming from somewhere else? in the demo code?

Nicholas Jankowski <nrjank>
Group Member
Mon 09 Aug 2021 09:30:24 PM UTC, comment #6: 

pzmap is in the control package so I'm going to change the the Category to "Octave Forge Package".  Most likely the demo code was written to specifically select the gnuplot toolkit, which it shouldn't do.

Rik <rik5>
Group administrator
Thu 05 Aug 2021 04:34:18 AM UTC, comment #5: 

I actually saw the "it's" thing.  I thought I fixed it, but I was moving quickly.  It's fixed [notice how I got that one right ;)] now.  See http://hg.savannah.gnu.org/hgweb/octave/rev/7dbbdd00db4a.

Rik <rik5>
Group administrator
Thu 05 Aug 2021 01:49:04 AM UTC, comment #4: 

Warning is given once per octave session.

Dmitri.
--

Dmitri A. Sergatskov <dasergatskov>
Thu 05 Aug 2021 01:15:54 AM UTC, comment #3: 

I could be the pedantic one who points out that you missed it's-->its

:)

I searched a bit more and didn't see the warning showing up in any of the other demos or help docs, so I guess it is unique to pzmap, although just from the function code I don't see what makes the 'demo pzmap' produce that warning but not, say, 'demo bar'

Nicholas Jankowski <nrjank>
Group Member
Wed 04 Aug 2021 10:10:24 PM UTC, comment #2: 

I fixed the typo in the warning message and made the recommendation to use the qt toolkit stronger.  See http://hg.savannah.gnu.org/hgweb/octave/rev/5f1390d6b5b4.

The fact that the warning shows up seems to be a different issue with the build environment for pzmap.

Rik <rik5>
Group administrator
Wed 04 Aug 2021 09:24:27 PM UTC, comment #1: 

It looks like there are tow bugs: typos in the warning text and
use of gnuplot in the build process. The most likely reason for the latter is that the build process does not have access to a graphics buffer.

Dmitri.
--

Dmitri A. Sergatskov <dasergatskov>
Wed 04 Aug 2021 09:09:06 PM UTC, original submission:  

the recent warning added whenever the gnuplot package is used (https://hg.savannah.gnu.org/hgweb/octave/rev/a41c4b9ed64) shows up in some of the octave documentation when rendering demo code.  see:

https://octave.sourceforge.io/control/function/pzmap.html
and attached screenshot.

pzmap is the only one that comes up in a google search, so maybe it's isolated there.

(there are also a couple small typos in the warning text. the attached patch fixes that.)


Nicholas Jankowski <nrjank>
Group Member

 

(Note: upload size limit is set to 16384 kB, after insertion of the required escape characters.)

Attach Files:
   
   
Comment:
   

Attached Files
file #51769:  pzmap.html added by ttl (3KiB - text/html)
file #51756:  pzmap_das.png added by dasergatskov (87KiB - image/png)
file #51738:  gnuplot_warning_typos.diff added by nrjank (1KiB - application/octet-stream)

 

Depends on the following items: None found

Items that depend on this one: None found

 

Carbon-Copy List
  • -email is unavailable- added by ttl (Posted a comment)
  • -email is unavailable- added by siko1056 (Updated the item)
  • -email is unavailable- added by rik5 (Posted a comment)
  • -email is unavailable- added by dasergatskov (Posted a comment)
  • -email is unavailable- added by nrjank (Submitted the item)
  •  

    There are 0 votes so far. Votes easily highlight which items people would like to see resolved in priority, independently of the priority of the item set by tracker managers.

    Only group members can vote.

     

    Follow 13 latest changes.

    Date Changed by Updated Field Previous Value => Replaced by
    2021-08-12 ttl Attached File- Added pzmap.html, #51769
    2021-08-11 ttl StatusIn Progress Fixed
        Open/ClosedOpen Closed
    2021-08-11 siko1056 StatusNone In Progress
    2021-08-10 siko1056 Summary[octave forge] (contro, gnuplot warning shows up in pzmap documentation build [octave forge] (control) gnuplot warning shows up in pzmap documentation build
    2021-08-10 siko1056 Summary[octave forge] gnuplot warning shows up in pzmap documentation build [octave forge] (contro, gnuplot warning shows up in pzmap documentation build
    2021-08-10 dasergatskov Attached File- Added pzmap_das.png, #51756
    2021-08-10 siko1056 Summary[octave forge] (control) gnuplot warning shows up in pzmap documentation build [octave forge] gnuplot warning shows up in pzmap documentation build
    2021-08-10 siko1056 Summarygnuplot warning shows up in pzmap documentation build [octave forge] (control) gnuplot warning shows up in pzmap documentation build
    2021-08-09 rik5 CategoryPlotting with gnuplot Octave Package
    2021-08-04 rik5 Summarygnuplot warning - typos &amp; shows up in pzmap documentation build gnuplot warning shows up in pzmap documentation build
    2021-08-04 nrjank Attached File- Added gnuplot_warning_typos.diff, #51738
        Attached File- Added unexpected_gnuplot_warning_in_pzmap.png, #51739

    Back to the top

    Powered by Savane 3.13-4b48.
    Corresponding source code