1,847
edits
(→Mercurial configuration: Add missing color "gray". Minor changes of spelling and whitespace.) |
|||
(31 intermediate revisions by 10 users not shown) | |||
Line 1: | Line 1: | ||
[[wikipedia:Mercurial]] (sometimes referred to as {{codeline|hg}}) is the | [[wikipedia:Mercurial|Mercurial]] (sometimes referred to as {{codeline|hg}}) | ||
is the source code management system currently used to develop | |||
Octave. | |||
== Introduction to Mercurial == | |||
An introduction to Mercurial is completely outside the scope of this document. | |||
There are plenty of available documentation on the topic. Some recommendations | |||
are: | |||
* [http://hginit.com/ Hg Init] | |||
* [https://www.mercurial-scm.org/wiki/Tutorial Mercurial tutorial] | |||
* [https://www.mercurial-scm.org/wiki/QuickStart Mercurial quick start] | |||
== Contributing to Octave == | |||
The preferred method to contribute to Octave is with Mercurial changesets. | |||
Other forms of contributions (e.g., simple diff patches) are | |||
also acceptable, but they slow down the review process. | |||
If you plan on contributing to Octave: | |||
* See other [[Contribution guidelines]] | |||
* Always include commit messages in changesets. Please follow the Octave [[commit message guidelines]] | |||
* Follow the style guides for both [[Octave style guide|Octave]] and [[C++ style guide|C++]] languages. | |||
== Getting the development sources == | |||
To clone the Octave repository: | |||
hg clone http://www.octave.org/hg/octave octave | |||
Octave packages like image, signal, control, etc. are not parts of Octave | |||
itself, they belong to the Octave Forge. Each package has its own | |||
repository, a list of which can be found | |||
[http://sourceforge.net/p/octave/_list/hg?source=navbar here]. | |||
You can clone them in a similar way, for example, to clone the signal package | |||
hg clone http://hg.code.sf.net/p/octave/signal octave-signal | |||
== Mercurial configuration == | |||
You can use the following to start your hgrc | |||
{{File||<pre> | |||
[ui] | |||
username = Your Name <your@email> | |||
[extensions] | |||
color = | |||
histedit = | |||
pager = | |||
rebase = | |||
strip = | |||
[pager] | |||
pager = LESS='FSRX' less | |||
attend = help, annotate, cat, diff, export, glog, log, outgoing, incoming | |||
[diff] | |||
showfunc = True | |||
[color] | |||
mode = terminfo | |||
## Custom colors | |||
color.gray = 244 | |||
color.orange = 202 | |||
color.lightyellow = 191 | |||
color.darkorange = 220 | |||
color.brightyellow = 226 | |||
status.modified = magenta bold | |||
status.added = green bold | |||
status.removed = red bold | |||
status.deleted = cyan bold | |||
status.unknown = gray bold | |||
status.ignored = gray bold | |||
## Colours for each label | |||
log.branch = cyan | |||
log.summary = lightyellow | |||
log.description = lightyellow | |||
log.bookmark = green | |||
log.tag = darkorange | |||
log.graph = blue | |||
## Colors for each phase | |||
changeset.secret = blue bold | |||
changeset.draft = red bold | |||
changeset.public = orange | |||
desc.here = bold blue_background | |||
[bookmarks] | |||
track.current = True | |||
[alias] | |||
glog = log --graph | |||
top = log --graph -l | |||
</pre>}} | |||
== Submitting patches == | |||
When you do not have push permissions to the repository (you cannot add your changes using mercurial itself) and you have a modification to the current GNU Octave code, you have to generate a patch (or changeset) so developers with permissions can include them in the code. The overview of the process is as follows | When you do not have push permissions to the repository (you cannot add your changes using mercurial itself) and you have a modification to the current GNU Octave code, you have to generate a patch (or changeset) so developers with permissions can include them in the code. The overview of the process is as follows | ||
# Change the code and test that your changes do work (write tests, that's the best!). | # Change the code and test that your changes do work (write tests, that's the best!). | ||
Line 8: | Line 108: | ||
# Post your patch in the [https://savannah.gnu.org/patch/?group=octave Patch tracker]. | # Post your patch in the [https://savannah.gnu.org/patch/?group=octave Patch tracker]. | ||
Patch submissions is done via the [https://savannah.gnu.org/bugs/?group=octave bug] | |||
or [https://savannah.gnu.org/patch/?group=octave patch] trackers. Either | |||
way, you can submit via two different methods: pull requests on attaching | |||
a changeset file. | |||
=== Pull request === | |||
This is the cleaner way. You push your clone to public site, and ask on the | |||
bug tracker to pull a specific changeset from it. It makes special sense if | |||
you plan to send more patches in the future but requires to host the clone | |||
somewhere. Free mercurial repositories are available on [https://bitbucket.org/ bitbucket] | |||
=== Creating changesets with hg === | |||
=== Creating changesets files with hg === | |||
==== Simple way ==== | ==== Simple way ==== | ||
* Update to the latest revision. | * Update to the latest revision. | ||
<pre> hg up </pre> | <pre> hg up </pre> | ||
* Make your changes and save. | * Make your changes and save them. | ||
* Commit your code | * Commit your code. Mercurial will ask you for a commit message, which should follow the [[commit message guidelines]]. | ||
<pre> hg ci </pre> | <pre> hg ci </pre> | ||
* Export the modifications. | * Export the modifications. This creates a file (in the case of the example below, it is called mypatch.patch) that contains a description of the changes that you've made. Someone else can then apply the patch and end up with a repository that looks the same as yours. | ||
<pre> hg export -r tip -o mypatch.patch </pre> | <pre> hg export -r tip -o mypatch.patch </pre> | ||
* Save the output to a file and upload it | * Save the output to a file and upload it to the 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 SOCIS or GSoC students working on new Octave features. | |||
Students should publish their work as it progresses in a public repository | Students should publish their work as it progresses in a public repository | ||
merging regularly the main savannah repository to facilitate merging back their | merging regularly the main savannah repository to facilitate merging back their | ||
code at the end of the project. | code at the end of the project. | ||
Here are some useful hg commands that can be used to do this. | Here are some useful hg commands that can be used to do this. | ||
Line 102: | Line 171: | ||
<!--[[File:Hg-student-flow2.png]] <br/>--> | <!--[[File:Hg-student-flow2.png]] <br/>--> | ||
<code> hg merge @ </code> </li> | <code> hg merge @ </code> </li> | ||
<li> Apply the change and publish it | <li> Apply the change and publish it <br/> | ||
<code> hg commit -m "periodic merge of default branch into my branch" </code> | <code> hg commit -m "periodic merge of default branch into my branch" </code> <br/> | ||
<!--[[File:Hg-student-flow3.png]] <br/>--> | <!--[[File:Hg-student-flow3.png]] <br/>--> | ||
<code> hg push ssh://student@public.server.org/octave </code></li> | <code> hg push ssh://student@public.server.org/octave </code></li> | ||
Line 119: | Line 188: | ||
<ol style="list-style-type: lower-roman;"> | <ol style="list-style-type: lower-roman;"> | ||
<li> each touched file appears only once </li> | <li> each touched file appears only once </li> | ||
<li> changes that were backed out should not be mentioned (like changeset "H" in the above example) </li> | <li> changes that were backed out should not be mentioned <!--(like changeset "H" in the above example)--> </li> | ||
</ol> | </ol> | ||
The main purpose of this log is to make it easy, not only for the main mentor, but also for other developers who | The main purpose of this log is to make it easy, not only for the main mentor, but also for other developers who | ||
have not been closely following the progress of the project to quickly understand where to look at in the code to evaluate it, but it will also be used as the commit message for the merge changeset, so it should itself comply with the [[Commit message guidelines]]. | have not been closely following the progress of the project to quickly understand where to look at in the code to evaluate it, but it will also be used as the commit message for the merge changeset, so it should itself comply with the [[Commit message guidelines]]. | ||
<li> prepare a merge changeset including all the code that should be submitted for review | <li> prepare a merge changeset including all the code that should be submitted for review | ||
<ol> | <ol style="list-style-type: lower-roman;"> | ||
<code>hg pull </code> | <li> pull from the main repository<br/> | ||
<code>hg pull http://www.octave.org/hg/octave</code></li> | |||
<li> move to the top of the main line of development and merge in the feature branch<br/> | |||
<code>hg up -r @</code><br/> | |||
<code>hg merge student-bookmark-name </code><br/></li> | |||
<li> create a changeset, export it and send to the mentor for review, remember to use the log created above as a commit message<br/> | |||
<code>hg commit </code><br/> | |||
<code>hg export @ > mid-term-review.changeset </code><br/> | |||
the file mid-term-review.changeset can then be sent to the [mailto:octave-maintainers@octave.org mailing list] or posted | |||
to the [https://savannah.gnu.org/patch/?group=octave patch tracker]</li> | |||
</ol> </li> | </ol> </li> | ||
</ol> | </ol> | ||
== Mercurial Tips for SoC mentors == | == Mercurial Tips for SoC mentors == | ||
Will fill in this section after trying out the above procedure at least once with a student and actually pushing his changes to the main repo. | |||
<!--- | |||
<code> | <code> | ||
hg pull http://student.repo.url | hg pull http://student.repo.url | ||
Line 149: | Line 230: | ||
hg log --style=changelog --user student | hg log --style=changelog --user student | ||
</code> | </code> | ||
--> | |||
==External links== | |||
* [https://www.mercurial-scm.org/ Official website] | |||
[[Category:Development]] | [[Category:Development]] |