bugGNU Octave - Bugs: bug #37542, consider including doc-cache in...


bug #37542: consider including doc-cache in the release

Submitted by:  Mike Miller <mtmiller>
Submitted on:  Thu 11 Oct 2012 02:55:20 AM UTC  
Category:  Configuration and Build System Severity:  3 - Normal
Priority:  5 - Normal Item Group:  Feature Request
Status:  Fixed Assigned to:  None
Originator Name:  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)

Thu 11 Oct 2012 07:44:41 PM UTC, comment #6: 

Thanks Rik, much appreciated! I'll test this soon, should give me what I need.

John, I completely agree, which is why I tried to make this as minimally disruptive as possible.

At least I am not trying to get the latest Octave working on my RHEL4 system :) I have an Octave 3.0.1 that I am happy with there.

Mike Miller <mtmiller>
Project Administrator
Thu 11 Oct 2012 07:29:32 PM UTC, comment #5: 

I, for one, am really tired of having to deal with RHEL 5 as the least common denominator of broken systems.

I could not agree more!  But, you will not be happy
to learn that RedHat has extended the life of RHEL 5
with another update, to 5.9.

For folks stuck on RHEL 5, the move to 6 is pretty
challenging.  No update allowed, just new install and hope.

Michael Godfrey <godfrey>
Project Member
Thu 11 Oct 2012 07:16:07 PM UTC, comment #4: 

I added a changeset to export doc-cache in the tarball since we already ship everything else in that directory.  I used save_header_format_string() in mk_doc_cache.m to strip the user and host from the file for privacy.  See http://hg.savannah.gnu.org/hgweb/octave/rev/bd947371c2c9

Rik <rik5>
Project Administrator
Thu 11 Oct 2012 06:31:43 PM UTC, comment #3: 

I, for one, am really tired of having to deal with RHEL 5 as the least common denominator of broken systems.

John W. Eaton <jwe>
Project Administrator
Thu 11 Oct 2012 05:37:56 PM UTC, comment #2: 

That's true, the configure script will error out if makeinfo is not installed, I had forgotten about that change.

However, one of the systems I run Octave on is a RHEL5 system that does have (a much older version of) makeinfo, that can read the help supplied with the Octave release just fine, but cannot build the doc-cache. If the doc-cache were given to me, everything else would work out fine. This is where I'm coming from on this one.

It seemed to make the most sense to add this one file to the release, since everything else related to documentation is already built and supplied along with the source.

Mike Miller <mtmiller>
Project Administrator
Thu 11 Oct 2012 04:09:59 PM UTC, comment #1: 

We could work around the privacy concerns if necessary.  The file is straight text so it would be simple enough to remove the first line with Perl or awk.

I'm not sure that including it would get what you want though.  The end machine, wherever that is, needs the makeinfo program in order to read documentation.  Including doc-cache in the the tarball would only mean that the build-host would not have to have makeinfo.

This could be okay, but the build-host won't be able to verify part of Octave with 'make check' because tests for the help system, such as get_first_help_sentence.m, depend on makeinfo.

The inclusion of the html and pdf versions of the documentation is really to help people who don't have a full Tex distribution.  But the Octave help system does rely on Texinfo.

Rik <rik5>
Project Administrator
Thu 11 Oct 2012 02:55:20 AM UTC, original submission:  

Consider including doc/interpreter/doc-cache in the Octave release, i.e. add to EXTRA_DIST. All other intermediate and end products from building the documentation are included in the distributed source tree except for this one file. The only difference I can see in the file from build to build is the timestamp, username, and hostname on which it was built. Any privacy concerns there?

The problem I would like to fix here is to be able to build from an official octave-x.y.z.tar.bz2 release without texinfo or any other tools needed for building the documentation, but without needing to specify --disable-docs to configure.

Mike Miller <mtmiller>
Project Administrator


(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 godfrey (Posted a comment)
  • -email is unavailable- added by jwe (Posted a comment)
  • -email is unavailable- added by rik5 (Posted a comment)
  • -email is unavailable- added by mtmiller (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 2 latest changes.

    Date Changed by Updated Field Previous Value => Replaced by
    2012-10-11 rik5 StatusNone => Fixed
        Open/ClosedOpen => Closed

    Back to the top

    Powered by Savane 3.5