Category:Development: Difference between revisions

From Octave
Jump to navigation Jump to search
(→‎Release procedures: Overhaul section.)
m (Added a link to a new page)
(11 intermediate revisions by one other user 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.  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 release will be '''GNU Octave 6.1'''. See the '''[[6.1 Release Checklist]]''' for more information.
* [[:Category:Releases|Older releases]]
* [[:Category:Releases|Older releases]]


Line 24: Line 52:
** [[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 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