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 (Added a link to a new page)
(29 intermediate revisions by one other 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 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]]
* [[Contributing to the development of packages/modules]]
** [[Help text style guide]]
* [[Octave's file types]]
* [[Easy projects]]


==Project suggestions==
== Octave development ==
* [[Easy projects]]
* [[GSoC Project Ideas]]
* [[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?)


==Tools==
=== [[:Category:Building|Building]] ===


* [[Mercurial]] -- version control scheme.
* [[Building]] -- General information how to build Octave from source.
* [[MXE]] -- cross-compiling to Windows or OSX.
** [[Building on Microsoft Windows]]
* [[Doxygen]] -- "Literate programming" documentation generator.
** [[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]] --


* gdb -- debugger.  Useful to obtain stack traces.
==== Tools ====
* valgrind -- memory leak detector, profiler etc.
* [https://ccache.samba.org/ ccache] -- cache compilation across builds.


==Bugs and testing==
* [[Mercurial]] -- How to use Octave's version control scheme, creating patches (changesets).
* [[Status of bugs]]
* [[Doxygen]] -- Documentation for C++ files
* [[Bug Fix List - 4.0 Release]]
* [https://ccache.samba.org/ ccache] -- How to faster compile Octave.
* [[Debugging Octave]], particularly using .oct files and gdb
* [[:Category:Editors|Editors]] -- A list of editors supporting Octave syntax highlighting.
* [[Finding Memory Leaks]]
 
* [[Add BIST tests for octave functions written in C++]]
=== [[:Category:Testing|Testing]] ===
 
* [[Tests]]
* [[BIST for m-files]]
* [[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 release will be '''GNU Octave 6.1'''. See the '''[[6.1 Release Checklist]]''' for more information.
* [[:Category:Releases|Older releases]]


==Works in Progress==
== [[:Category:Project_Ideas|Project ideas]] and work in progess ==
* [[Classdef]]
* [[Short projects]] -- Good starting point to get into the Octave development.
* [[Java interface]]
* [[Summer of Code Project Ideas]] -- Ideas page for GSoC, SOCIS, ... projects.
* [[JIT]]
* [[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.


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


==Release procedures==
* Read about past [[:Category:Meetings | developer meetings]].
* [[Release Checklist]]


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


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

Revision as of 20:02, 29 August 2020

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

Project ideas and work in progess

Meetings

Other