Category:Development: Difference between revisions

From Octave
Jump to navigation Jump to search
(β†’β€ŽOther: Remove outdated item.)
Β 
(53 intermediate revisions by 4 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]]
** [[Commit message guidelines]]


== [[:Category:Project_Ideas|Project ideas]] and work in progess ==
= πŸ”¬ Octave development =
* [[Short projects]] -- Good starting point to get into the Octave development.
Β 
* [[Summer of Code Project Ideas]] -- Ideas page for GSoC, SOCIS, ... projects.
: {{Note|'''Attend our next [[meet | Online Developer Meeting]]''' πŸ™‚πŸ’¬ (See [[:Category:Meetings | all previous meetings]])}}
* [[Projects]] -- Many things that would be nice to have done.
Β 
** [[Classdef]] -- Define own data types using <code>classdef</code>.
== πŸ› οΈ [[:Category:Building|Building]] ==
** [[JIT]] -- Just in time compiler for Octave.
Β 
** [[GUI terminal widget]] -- Ideas about a new improved terminal widget.
* [[Building]] -- General information how to build Octave from source.
** [[International Characters Support]] -- Using Octave in your own language.
** [[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 & techniques ==
=== πŸ”§ Tools ===


* [[Mercurial]] -- Version control scheme.
* [[Mercurial]] -- How to use Octave's version control scheme, creating patches (changesets).
* [[MXE]] -- Cross-compiling to Windows.
* [[Doxygen]] -- Documentation for C++ files
* gdb -- debugger.Β  Useful to obtain stack traces.
* [https://ccache.samba.org/ ccache] -- How to faster compile Octave.
** [[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.
* [[:Category:Editors|Editors]] -- A list of editors supporting Octave syntax highlighting.


== Documentation ==
== βš–οΈ [[:Category:Testing|Testing]] ==
* [[Help text]] -- Document m-files
* [[Doxygen]] -- Document C++ files


== [[:Category:Building|Building]] ==
* [[Building]] - General information.
* [[Continuous Build]]
* [[Enable large arrays: Build octave such that it can use arrays larger than 2Gb.|Large array support]]
== [[:Category:Testing|Testing]] ==
* [[Tests]]
* [[Tests]]
* [[BIST for m-files]]
* [[BIST for m-files]]
* [[Add BIST tests for octave functions written in C++|BIST for C++ files]]
* [[Add BIST tests for octave functions written in C++|BIST for C++ files]]


== [[:Category:Packaging|Packaging]] ==
== 🐞 Debugging ==
* Building binary distributions.
Β 
** [[Create a MacOS X App Bundle Using MacPorts|Create a macOS app using MacPorts]]
* [[Debugging Octave]] -- How to use [https://www.gnu.org/software/gdb/ gdb] to obtain stack traces.
** [[Windows_Installer|Create a Windows Installer using MXE]]
* [[Finding Memory Leaks]] -- How to use [https://www.valgrind.org/ valgrind].
Β 
== πŸŽ‰ [[:Category:Releases|Releasing]] ==
Β 
* The next minor release will be '''GNU Octave 9.2.0''' (a few months major release).
* The next major release will be [[9.1 Release Checklist | '''GNU Octave 9.1.0''']] (beginning of 2024).
* [[Release History]]
* [[:Category:Releases|Old release checklists]]
* "Nightly" Octave releases on https://octave.space
Β 
== 🎯 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.''
Β 
==== Large New Features ====
* Compatible arguments block ([https://savannah.gnu.org/bugs/?func=detailitem&item_id=59405 some work has been done]; need to execute actions when functions are called)
* Compatible local functions
* Compatible string class
** Define class itself ([[https://github.com/apjanke/octave-tablicious/inst initial implementation]?)
** Construct strings objects from double quoted strings (painful transition).
* Compatible table class ([https://github.com/apjanke/octave-tablicious initial implementation]?)
* 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
* Make import feature work
Β 
==== Internal Improvements ====
* Refactor/rewrite code for handling load path
* Refactor/rewrite exist and which functions
* Refactor function objects
* Refactor broadcasting and make it work for sparse matrices
* Replace the [[GUI terminal widget|terminal widget in the GUI]]
* Write stack-based byte-code interpreter that doesn't result in deeply nested function calls to evaluate code
* JIT compiler
* Move more code inside octave namespace
* Eliminate mutable class data where possible
* Eliminate singleton objects
* Use classdef for handle graphics?
Β 
==== Other ====
* 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
Β 
= πŸ’‘ [[:Category:Project_Ideas|Project ideas]] and work in progress =


== Code sprints ==
* [[Short projects]] -- Good starting point to get into the Octave development.
* [[2015 Code Sprint]]
* [[Summer of Code - Getting Started]] -- Ideas page for GSoC, SOCIS, ... projects.
* [[Code sprint Zurich]]
* [[Projects]] -- Many things that would be nice to have done.
** [[Classdef]] -- Define own data types using <code>classdef</code>.
** [[JIT]] -- Just in time compiler for Octave.
** [[GUI terminal widget]] -- Ideas about a new improved terminal widget.
** [[International Characters Support]] -- Using Octave in your own language.
** [[Pythonic]] -- Calling Python functions directly from Octave.


== [[:Category:Releases|Release procedures]] ==
= Other =
* [[Release Checklist]]
* [[5.0.0 Release Checklist]]
** [[Bug Fix List - 5.0 Release]]


== Other ==
* [[Project Infrastructure]]
* [[Project Infrastructure]]


[[Category:Contents]]
[[Category:Contents]]

Latest revision as of 14:11, 17 March 2024

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

πŸ’‘ Getting started πŸ”°[edit]

πŸ”¬ Octave development[edit]

Info icon.svg
Attend our next Online Developer Meeting πŸ™‚πŸ’¬ (See all previous meetings)

πŸ› οΈ Building[edit]

πŸ”§ Tools[edit]

  • 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[edit]

🐞 Debugging[edit]

πŸŽ‰ Releasing[edit]

🎯 Goals for upcoming releases[edit]

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[edit]

See also JWE Project Ideas for additional info about some of these items.

Large New Features[edit]

  • Compatible arguments block (some work has been done; need to execute actions when functions are called)
  • Compatible local functions
  • Compatible string class
    • Define class itself ([initial implementation?)
    • Construct strings objects from double quoted strings (painful transition).
  • Compatible table class (initial implementation?)
  • 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
  • Make import feature work

Internal Improvements[edit]

  • Refactor/rewrite code for handling load path
  • Refactor/rewrite exist and which functions
  • Refactor function objects
  • Refactor broadcasting and make it work for sparse matrices
  • Replace the terminal widget in the GUI
  • Write stack-based byte-code interpreter that doesn't result in deeply nested function calls to evaluate code
  • JIT compiler
  • Move more code inside octave namespace
  • Eliminate mutable class data where possible
  • Eliminate singleton objects
  • Use classdef for handle graphics?

Other[edit]

  • 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

πŸ’‘ Project ideas and work in progress[edit]

Other[edit]