Mercurial (sometimes referred to as
hg) is the source code management system used for Octave development.
Everybody is free to run, copy, distribute, study, change and improve Octave's source code, given in the main repository at https://www.octave.org/hg/octave. Use Mercurial to get the latest version of Octave
hg clone https://www.octave.org/hg/octave
Creating and submitting patches (changesets)
If you want to share your modifications, for example to fix a nasty bug #42424, you cannot just submit your changes to Octave's main repository. You have to generate a patch (or changeset) so other Octave developers can include them into Octave's source code.
- Get the latest version of Octave (or some Octave package)
hg clone https://www.octave.org/hg/octaveor when already cloned
hg pull && hg update
- Make your changes (fix bug #42424) and save them. Make sure that your changes don't introduce new bugs! Thus it is recommended to build Octave and to run Octave's test suite before proceeding.Please follow the Contribution guidelines for C/C++ or Octave code files!
- Commit your changes
hg commitMercurial will open your default editor and ask you for a commit message. Please follow the commit message guidelines, e.g.
help.m: Display relevant topics first (bug #42424) * scripts/help/help.m: Describe what you changed to display relevant topics first. The maximal line width is 80 characters.
- Export the changes
hg export -r tip -o bug42424.patchThe final patch for submission will look like this
- Upload bug42424.patch to the bug or patch tracker. If your patch file is larger than the upload limit, you can compress it before uploading. Please use a free format!
Mercurial Tips for SoC students
This section is meant to provide tips for Summer of Code students working on new Octave features.
Students should publish their work as it progresses in a public repository. In this section we use for example
Bookmarks are useful for identifying a series of commits. They are a "lightweight" solution to named branches, which are not automatically updated for example. To create a bookmark
hg clone https://www.octave.org/hg/octave hg bookmark my-gsoc
To make the bookmark visible in the public repository use
hg push --bookmark ssh://email@example.com/octave
Staying up-to-date with the main repository
Octave development does not stand still while the students development proceeds. Octave's main repository gets updated, too. The following commands can be used to get these updated to the students clone of the main repository:
hg pull https://www.octave.org/hg/octave # Get latest remote "tip" hg update -r my-gsoc # Activate bookmark "my-gsoc" hg merge tip # Merge "tip" into "my-gsoc" hg commit -m "maint: merge default to my-gsoc" hg push ssh://firstname.lastname@example.org/octave
Preparing for code reviews
At the time of the mid-term or final review (or whenever the mentor requires it) students should prepare their code for review and possibly inclusion into the main repository.
- Create a full log of changes
hg log --template=changelog --no-merges --user student-nameIf students have been following the Commit message guidelines the output is a good starting point for the commit message in the next step. Some manual post-processing might be necessary:
- Each touched file should appear only once.
- Do not mention backed-out commits.
- Prepare a singe patch (changeset) including all code that should be submitted for review The file mid-term-review.patch can uploaded to the patch tracker.
hg pull https://www.octave.org/hg/octave # Get remote "tip" and "@" hg update -r @ # Activate bookmark "@" hg merge my-gsoc # Merge "my-gsoc" into "@" hg commit hg export -r tip -o mid-term-review.patch
Finally, there is a subtle difference between
"tip", which is a reference to the (local or remote) changeset added to the repository most recently and the bookmark
"@"used by the Octave developers to point to the latest remote changeset. Often both refer to the very same changeset and they can used interchangeably.
Example Mercurial configuration
Place the following file in your home directory, e.g. /home/username/.hgrc.
- ↑ https://www.gnu.org/philosophy/free-sw.en.html
- ↑ To set your default Mercurial editor, read https://www.mercurial-scm.org/wiki/editor .
- https://hginit.com/ -- Mercurial tutorial
- https://www.mercurial-scm.org/wiki/Tutorial -- Mercurial tutorial
- https://www.mercurial-scm.org/wiki/QuickStart -- Mercurial quick start
- https://tortoisehg.bitbucket.io/ -- TortoiseHg is a GUI for Mercurial (Linux, macOS, MS Windows)