Category:Development: Difference between revisions

From Octave
Jump to navigation Jump to search
(→‎Project suggestions: Drop Roadmap from the list, just an redirect to Release Checklist.)
m (→‎Packaging: Reorder.)
(12 intermediate revisions by the same user not shown)
Line 1: Line 1:
This page contains links to pages of interest to developers.  Some links appear in multiple sections.
This page contains links to pages of interest to developers.


==Getting started==
== Getting started ==
* [[Developer FAQ]]
* [[Developer FAQ]]
* [[Contribution guidelines]] for Octave
* [[Contribution guidelines]] for Octave
** [[C++ style guide]]
** [[C++ style guide]]
** [[Octave style guide]]
** [[Octave style guide]]
* [[Contributing to the development of packages/modules]]
* [[Octave's file types]]
* [[Easy projects]]


==Project suggestions==
== [[:Category:Project_Ideas|Project ideas]] and work in progess ==
* [[Easy projects]]
* [[Short projects]] -- Good starting point to get into the Octave development.
* [[GSoC Project Ideas]]
* [[Summer of Code Project Ideas]] -- Ideas page for GSoC, SOCIS, ... projects.
* [[Projects]] -- Many things that would be nice to have done. Not classified into things done or not done in Matlab. (Is that a project in itself?)
* [[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.


==Tools==
== Tools & techniques ==
 
* [[Mercurial]] -- version control scheme.
* [[MXE]] -- cross-compiling to Windows or OSX.
* [[Doxygen]] -- "Literate programming" documentation generator.


* [[Mercurial]] -- Version control scheme.
* [[MXE]] -- Cross-compiling to Windows.
* gdb -- debugger.  Useful to obtain stack traces.
* gdb -- debugger.  Useful to obtain stack traces.
** [[Debugging Octave]] -- particularly .oct files using gdb.
* valgrind -- memory leak detector, profiler etc.
* valgrind -- memory leak detector, profiler etc.
** [[Finding Memory Leaks]]
* [https://ccache.samba.org/ ccache] -- cache compilation across builds.
* [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.
* [[Continuous Build]]
* [[Enable large arrays: Build octave such that it can use arrays larger than 2Gb.|Large array support]]


==Bugs and testing==
== [[:Category:Testing|Testing]] ==
* [[Status of bugs]]
* [[Tests]]
* [[Bug Fix List - 4.0 Release]]
* [[Debugging Octave]], particularly using .oct files and gdb
* [[Finding Memory Leaks]]
* [[Add BIST tests for octave functions written in C++]]
* [[BIST for m-files]]
* [[BIST for m-files]]
* [[Add BIST tests for octave functions written in C++|BIST for C++ files]]


==Works in Progress==
== [[:Category:Packaging|Packaging]] -- Building binary distributions ==
* [[Classdef]]
* [[Create a MacOS X App Bundle Using MacPorts|Create a macOS app using MacPorts]]
* [[Java interface]]
* [[Windows_Installer|Create a Windows Installer using MXE]]
* [[JIT]]


==Code sprints==
== Code sprints ==
* [[2015 Code Sprint]]
* [[2015 Code Sprint]]
* [[Code sprint Zurich]]
* [[Code sprint Zurich]]


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


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


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

Revision as of 11:38, 14 June 2019

This page contains links to pages of interest to developers.

Getting started

Project ideas and work in progess

Tools & techniques

  • Mercurial -- Version control scheme.
  • MXE -- Cross-compiling to Windows.
  • gdb -- debugger. Useful to obtain stack traces.
  • valgrind -- memory leak detector, profiler etc.
  • ccache -- cache compilation across builds.
  • Editors -- A list of editors supporting Octave syntax highlighting.

Documentation

Building

Testing

Packaging -- Building binary distributions

Code sprints

Release procedures

Other