bugGNU Octave - Bugs: bug #65174, [octave forge] (sockets) Add...


bug #65174: [octave forge] (sockets) Add mkfuncdocs.py to the release tarball

Submitter:  Rafael Laboissière <rlaboiss>
Submitted:  Wed 17 Jan 2024 06:49:11 AM UTC
Category:  Octave Package Severity:  3 - Normal
Priority:  5 - Normal Item Group:  Documentation
Status:  Ready For Test Assigned to:  lostbard
Originator Name:  Open/Closed:  * Open
Release:  * other Operating System:  * Any
Fixed Release:  None Planned Release:  None
* Mandatory Fields

Add a New Comment Rich Markup

Jump to the original submission

Wed 24 Jan 2024 04:44:06 PM UTC, comment #9: 

In the docs directory with the other documentation files for that package.

The PKG_ADD calls octave to add the doc link for the octave help on pkg load/unload

John Donoghue <lostbard>
Group Member
Wed 24 Jan 2024 07:13:34 AM UTC, comment #8: 

Thanks for that.

Another question: where for the generated .qh files get installed, such that they are found by the Octave Qt GUI?

Rafael Laboissière <rlaboiss>
Fri 19 Jan 2024 01:19:49 PM UTC, comment #7: 

Will also do for the rest of the packages i am maintaining with docs: arduino, cfitsio, netcdf, mqtt, joystick, raspi, signal, sqlite

John Donoghue <lostbard>
Group Member
Thu 18 Jan 2024 06:34:58 PM UTC, comment #6: 

Great, thanks!

As you are at it, you might also make similar changes on the audio, dicom, instrument-control, and zeromq packages.

Rafael Laboissière <rlaboiss>
Thu 18 Jan 2024 01:24:20 PM UTC, comment #5: 

ok - i updated the toplevel make to not remove them when making the package.

At some point I may move them to a build tools directory so they dont get installed.

John Donoghue <lostbard>
Group Member
Thu 18 Jan 2024 07:36:59 AM UTC, comment #4: 

Thanks for this reminder. The Qt docs are not currently generated when building the Debian packages, but we might consider doing it in the future.

Rafael Laboissière <rlaboiss>
Wed 17 Jan 2024 09:40:20 PM UTC, comment #3: 

How about the qt docs generated using mkqhcp.py

John Donoghue <lostbard>
Group Member
Wed 17 Jan 2024 07:16:52 PM UTC, comment #2: 

From the perspective of a user using "pkg install", I guess you are right (even though the files doc/*.texi in the tarball get installed, and they are useless for the user).

I made my request as the maintainer of the Debian package octave-sockets. In the process of building the package, the documentation is compiled from source.

At any rate, if you think that including mkfuncdocs.py in the tarball is inappropriate, this is fine at our side. We are patching the Debian package in order to include the file, taken from the upstream Git repository.

Rafael Laboissière <rlaboiss>
Wed 17 Jan 2024 02:19:29 PM UTC, comment #1: 

Not that adding it makes any real difference I guess, but if its left in the docdir in the release tarball, it will also be installed for anyone using pkg install.

Doesnt the documentation get built as part of the release so it doesnt have to be built

vs the sources that tarball that also contains the top level makefile etc

or am I missing something ?

John Donoghue <lostbard>
Group Member
Wed 17 Jan 2024 06:49:11 AM UTC, original submission:  

Please, add file doc/mkfuncdocs.py to the tarball in the next release, such that it will be possible to build the documentation from source.

Rafael Laboissière <rlaboiss>


(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 lostbard (Posted a comment)
  • -email is unavailable- added by rlaboiss (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 2 latest changes.

    Date Changed by Updated Field Previous Value => Replaced by
    2024-01-18 lostbard StatusNone Ready For Test
        Assigned toNone lostbard

    Back to the top

    Powered by Savane 3.13-ee12.
    Corresponding source code