bugGNU Octave - Bugs: bug #40284, Octave Release Notes pane's text...


bug #40284: Octave Release Notes pane's text source refers to build dir, not install dir

Submitted by:  Philip Nienhuis <philipnienhuis>
Submitted on:  Wed 16 Oct 2013 09:32:37 PM UTC  
Category:  GUI Severity:  3 - Normal
Priority:  5 - Normal Item Group:  Incorrect Result
Status:  Fixed Assigned to:  None
Originator Name:  Philip Nienhuis Open/Closed:  Closed
Release:  dev Operating System:  Any

Add a New Comment (Rich Markup)

You are not logged in

Please log in, so followups can be emailed to you.


( Jump to the original submission)

Sat 26 Oct 2013 04:54:18 PM UTC, comment #13: 

Now it works OK with 17766:7fc06bb4ab24 tip.
Perhaps related to fix of bug #40367?

Closing this report.

Philip Nienhuis <philipnienhuis>
Project Member
Sat 26 Oct 2013 11:55:54 AM UTC, comment #12: 

The bug (or issue) still exists on my MXE/MinGW builds. I can confirm that it works fine on Linux.

Perhaps it is better to re-title this bug, or close it and open a new bug for it as the focus has changed.

Philip Nienhuis <philipnienhuis>
Project Member
Fri 25 Oct 2013 02:49:08 AM UTC, comment #11: 

I just did a complete cycle of 'make dist' and then unpacking the tarball, configuring, building, and installing and the Release Notes pane works for me.  This is on a Linux system though.

The NEWS file should be found in the OCTAVE_OCTETCDIR, and run-octave doesn't adjust for that.  So, unless you have done at least one install to put the NEWS file in /usr/local/... then it will fail with run-octave.

Rik <rik5>
Project Administrator
Thu 24 Oct 2013 09:07:04 PM UTC, comment #10: 

Just occurred to me: could this be related to white text on a white background?
(although text copy controls are grayed out, which suggests there's imply no text in the pane)

Philip Nienhuis <philipnienhuis>
Project Member
Fri 18 Oct 2013 10:01:06 PM UTC, comment #9: 

Unfortunately, on my MXE build, the Release Notes pane remains empty; however, no more error message a la 'NEWS file not found' pops up.

On Linux, trying the NEWS pane using ./run-octave & did complain about NEWS not found in /usr/local/...... 
Because I didn't see this error message on MinGW, there is probably a different reason that the release notes aren't shown.

The 'news' command in the terminal works as always. BTW the release notes mention version 4.0 rather than 3.8.

Philip Nienhuis <philipnienhuis>
Project Member
Fri 18 Oct 2013 02:14:16 AM UTC, comment #8: 

Of course I meant "install-xxx", the bug tracker is converting my stars into bold text markup.

Mike Miller <mtmiller>
Project Administrator
Fri 18 Oct 2013 02:12:49 AM UTC, comment #7: 

I'm jumping in the middle here so I apologize if I'm not getting the complete context, but I think it would be unexpected if we made the "install" target also install pdf and html docs. It should be up to users/distributors/packagers to decide which "install-*" targets they want to run. The GNU standards say that "make install" should install info docs and man pages since they are the preferred format, and the other "install-*" formats should be kept separate.

Mike Miller <mtmiller>
Project Administrator
Thu 17 Oct 2013 08:48:45 PM UTC, comment #6: 

OK, I guess I haven't been paying attention to what docs are installed.

If you are looking for pdf docs, I suspect that we just need to do "make install-pdf" in the Octave doc/interpreter directory, or make some change to the automake setup so that happens automatically when running "make install".

It seems the only targets that are installed by default are the info and man pages plus whatever files are associated with octetc_DATA (currently doc-cache and macros.texi).

John W. Eaton <jwe>
Project Administrator
Thu 17 Oct 2013 08:26:39 PM UTC, comment #5: 

Thanks for the fix.

Yes, NEWS is in that share/..../etc location on my latest MXE 3.7.7+ build.

I'll try to make a new build tonight or otherwise tomorrow to test this (& a.o., Torsten's fix for #40283).
I'll close this bug if it works OK.

In the meantime I'd like to try to get the docs copied from an octave dist tarball into an MXE binary. Doesn't look hard - at least at first sight.

Philip Nienhuis <philipnienhuis>
Project Member
Thu 17 Oct 2013 04:56:47 PM UTC, comment #4: 

I checked in the following changeset:


I think this fixes the OCTAVE_HOME problem.  The NEWS file should be installed in OCTAVE_HOME/share/octave/VERSION/etc/NEWS on all systems.  Is it there in your mxe-octave build?  It seems to be in the latest one that I did.

John W. Eaton <jwe>
Project Administrator
Thu 17 Oct 2013 04:38:39 PM UTC, comment #3: 

I will take another look at the way we get the file location, but I thought OCTAVE_HOME was already being substituted.

John W. Eaton <jwe>
Project Administrator
Thu 17 Oct 2013 04:21:27 PM UTC, comment #2: 

Usually I first build on & for Linux, then after testing & make check I do 'make dist all'.
The resulting tarball (that is transplanted to mxe-octave/pkg/) does contain the complete documentation.

Where is the --disable-docs flag introduced in MXE?
In mxe-octave/src/octave.mk/ I see no --disable-docs flag.

If the docs are contained in the tarball, it should be possible to simply copy them over to the mxe-octave/dist/ subdir and add them into the installer directly.

Anyway the wrong path is still an issue. Could the docs be found using an OCTAVE_HOME - like construct?

Philip Nienhuis <philipnienhuis>
Project Member
Wed 16 Oct 2013 09:53:46 PM UTC, comment #1: 

Maybe we need to fix the --disable-docs feature so that it doesn't disable trivial things like installing the NEWS file.

If you are building from a tarball, you should not have to use --disable-docs to be able to cross compile Octave because the tarballs already include the formatted documentation.

But you can't cross compile Octave and build the docs because constructing them requires running Octave.

John W. Eaton <jwe>
Project Administrator
Wed 16 Oct 2013 09:32:37 PM UTC, original submission:  

( Already reported in passing here:
https://mailman.cae.wisc.edu/pipermail/octave-maintainers/2013-October/036755.html )

On Windows, running an MXE-built Octave-3.7.7+, and clicking the main manu bar News -> Release Notes, I get an empty Octave Release Notes pane and in the terminal I see:

>> QTextBrowser: No document for file:///home/philip/devel/octdev/mxe-octave/

I tried to track down where NEWS is kept; but in MXE builds for Windows there's no doc subdir as the docs simply aren't built (at least not on my MXE system) - perhaps Anirudha has fixed that as well but AFAIK his fixes still have to be merged in anyway.

That implies that the Octave Release Notes pane should actually be able to catch non-existent doc subdirs as well, or be grayed out if there's no doc subdir present in OCTAVE_HOME.

Philip Nienhuis <philipnienhuis>
Project Member


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

Attach Files:

No files currently attached


Depends on the following items: None found

Items that depend on this one: None found


Carbon-Copy List
  • -email is unavailable- added by rik5 (Posted a comment)
  • -email is unavailable- added by mtmiller (Posted a comment)
  • -email is unavailable- added by jwe (Posted a comment)
  • -email is unavailable- added by philipnienhuis (Submitted the item)

    Do you think this task is very important?
    If so, you can add your encouragement to it.
    This task has 0 encouragements so far.

    Only project members can vote.




    Follow 3 latest changes.

    Date Changed by Updated Field Previous Value => Replaced by
    2013-10-26 philipnienhuis StatusWorks For Me => Fixed
        Open/ClosedOpen => Closed
    2013-10-25 rik5 StatusNone => Works For Me

    Back to the top

    Powered by Savane 3.5