Category:Development: Difference between revisions

From Octave
Jump to navigation Jump to search
m (→‎Release process: Style fix to find the link easier.)
(21 intermediate revisions by 3 users not shown)
Line 1: Line 1:
This page contains links to pages of interest to developers.
:''This page contains links to pages of interest to Octave developers.''


== Getting started ==
== Getting started ==
* [[Developer FAQ]]
* [[Developer FAQ]] -- Start here.
* [[Contribution guidelines]] for Octave
* [[Contribution guidelines]] for Octave
** [[C++ style guide]]
** [[C++ style guide]]
** [[Octave style guide]]
** [[Octave style guide]]
** [[Help text style guide]]


== [[:Category:Releases|Release]] process ==
== Octave development ==


{{Note|The '''GNU Octave 6.1''' release process has been started.<br>See the '''[[6.1 Release Checklist]]''' for more information.}}
=== [[:Category:Building|Building]] ===


* [[Release Checklist|Release Checklist template]]
* [[Building]] -- General information how to build Octave from source.
** [[Building on Microsoft Windows]]
** [[Building on Ubuntu Virtual Machine]]
* [[Continuous Build]] -- Check changes with [https://buildbot.net/ Buildbot].
* [[MXE]] -- Cross-compiling to MS Windows.
* [[Enable large arrays: Build octave such that it can use arrays larger than 2Gb.|Large array support]] --
 
==== Tools ====
 
* [[Mercurial]] -- How to use Octave's version control scheme, creating patches (changesets).
* [[Doxygen]] -- Documentation for C++ files
* [https://ccache.samba.org/ ccache] -- How to faster compile Octave.
* [[:Category:Editors|Editors]] -- A list of editors supporting Octave syntax highlighting.
 
=== [[:Category:Testing|Testing]] ===
 
* [[Tests]]
* [[BIST for m-files]]
* [[Add BIST tests for octave functions written in C++|BIST for C++ files]]
 
=== Debugging ===
 
* [[Debugging Octave]] -- How to use [https://www.gnu.org/software/gdb/ gdb] to obtain stack traces.
* [[Finding Memory Leaks]] -- How to use [https://www.valgrind.org/ valgrind].
 
=== [[:Category:Releases|Releasing]] ===
 
* The next major release will be '''GNU Octave 7.1'''.  The release procedure has not yet started.  Use '''[[6.1 Release Checklist]]''' as template for organization.
* [[:Category:Releases|Older releases]]
* [[:Category:Releases|Older releases]]
* "Nightly" Octave releases on https://octave.space


== [[:Category:Project_Ideas|Project ideas]] and work in progess ==
=== Goals for upcoming releases ===
 
As discussed in the [[Online Developer Meeting (2020-10-27)]], this wiki section is for a list of possible goals for the next release.  Although anyone may edit the wiki, '''this section is intended for active developers, not a place to dump wishlist items or feature requests'''.  Please create a subsection for your ideas/priorities.
 
==== jwe priorities ====
:''See also [[JWE Project Ideas]] for additional info about some of these items.''
 
* Bug fixes, especially those related to compatibility issues.
* Work through the open bug reports for which patches have been submitted.  Review/apply/reject and close as many of these reports as possible.
* Refactor/rewrite code for handling load path.
* Refactor/rewrite exist and which functions.
* Create a low-level interface to HDF5 functions.
* Support Matlab's HDF5-based MAT file format using the proposed low-level interface to HDF5 functions.
** Allow all types of function handles to be saved and loaded.
** Allow [[classdef]] objects to be saved and loaded.
* Replace the [[GUI terminal widget|terminal widget in the GUI]].
* Accept Matlab's new argument validation syntax in parser.
 
== [[:Category:Project_Ideas|Project ideas]] and work in progress ==
* [[Short projects]] -- Good starting point to get into the Octave development.
* [[Short projects]] -- Good starting point to get into the Octave development.
* [[Summer of Code Project Ideas]] -- Ideas page for GSoC, SOCIS, ... projects.
* [[Summer of Code - Getting Started]] -- Ideas page for GSoC, SOCIS, ... projects.
* [[Projects]] -- Many things that would be nice to have done.
* [[Projects]] -- Many things that would be nice to have done.
** [[Classdef]] -- Define own data types using <code>classdef</code>.
** [[Classdef]] -- Define own data types using <code>classdef</code>.
Line 24: Line 71:
** [[Pythonic]] -- Calling Python functions directly from Octave.
** [[Pythonic]] -- Calling Python functions directly from Octave.


== Tools & techniques ==
== Meetings ==
 
* [[Mercurial]] -- Version control scheme.
* [[MXE]] -- Cross-compiling to Windows.
* gdb -- debugger.  Useful to obtain stack traces.
** [[Debugging Octave]] -- particularly .oct files using gdb.
* valgrind -- memory leak detector, profiler etc.
** [[Finding Memory Leaks]]
* [https://ccache.samba.org/ ccache] -- cache compilation across builds.
* [[:Category:Editors|Editors]] -- A list of editors supporting Octave syntax highlighting.
 
== Documentation ==
* [[Help text]] -- Document m-files
* [[Doxygen]] -- Document C++ files
 
== [[:Category:Building|Building]] ==
* [[Building]] -- General information how to build Octave from source.
* [[Continuous Build]]
* [[Enable large arrays: Build octave such that it can use arrays larger than 2Gb.|Large array support]]
 
== [[:Category:Testing|Testing]] ==
* [[Tests]]
* [[BIST for m-files]]
* [[Add BIST tests for octave functions written in C++|BIST for C++ files]]
 
== [[:Category:Packaging|Packaging]] -- Building binary distributions ==
* [[Create a MacOS X App Bundle Using MacPorts|Create a macOS app using MacPorts]]
* [[Windows_Installer|Create a Windows Installer using MXE]]


== Code sprints ==
* Read about past [[:Category:Meetings | developer meetings]].
* [[2015 Code Sprint]]
* [[Code sprint Zurich]]


== Other ==
== Other ==

Revision as of 01:39, 4 March 2021

This page contains links to pages of interest to Octave developers.

Getting started

Octave development

Building

Tools

  • Mercurial -- How to use Octave's version control scheme, creating patches (changesets).
  • Doxygen -- Documentation for C++ files
  • ccache -- How to faster compile Octave.
  • Editors -- A list of editors supporting Octave syntax highlighting.

Testing

Debugging

Releasing

Goals for upcoming releases

As discussed in the Online Developer Meeting (2020-10-27), this wiki section is for a list of possible goals for the next release. Although anyone may edit the wiki, this section is intended for active developers, not a place to dump wishlist items or feature requests. Please create a subsection for your ideas/priorities.

jwe priorities

See also JWE Project Ideas for additional info about some of these items.
  • Bug fixes, especially those related to compatibility issues.
  • Work through the open bug reports for which patches have been submitted. Review/apply/reject and close as many of these reports as possible.
  • Refactor/rewrite code for handling load path.
  • Refactor/rewrite exist and which functions.
  • Create a low-level interface to HDF5 functions.
  • Support Matlab's HDF5-based MAT file format using the proposed low-level interface to HDF5 functions.
    • Allow all types of function handles to be saved and loaded.
    • Allow classdef objects to be saved and loaded.
  • Replace the terminal widget in the GUI.
  • Accept Matlab's new argument validation syntax in parser.

Project ideas and work in progress

Meetings

Other