Editing Mercurial
Jump to navigation
Jump to search
The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then publish the changes below to finish undoing the edit.
Latest revision | Your text | ||
Line 1: | Line 1: | ||
[https://www.mercurial-scm.org Mercurial] (sometimes referred to as {{codeline|hg}}) is the source code management system used for Octave development. | [https://www.mercurial-scm.org Mercurial] (sometimes referred to as {{codeline|hg}}) is the source code management system used for Octave development. | ||
{{Note|[https://tortoisehg.bitbucket.io/ TortoiseHg] is a GUI for Mercurial and it is especially recommended for users doing their first steps with source code management systems. Linux, macOS, and MS Windows are supported.}} | {{Note|[https://tortoisehg.bitbucket.io/ TortoiseHg] is a GUI for Mercurial and it is especially recommended for users doing their first steps with source code management systems. Linux, macOS, and MS Windows are supported.}} | ||
Line 33: | Line 5: | ||
== Creating and submitting patches (changesets) == | == 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. | 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. 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 | # Get the latest revision of Octave (or some Octave package) <pre>hg clone https://www.octave.org/hg/octave</pre> or when already cloned <pre>hg pull && hg update</pre> | ||
# Make your changes (fix bug #42424) and save them. '''Make sure that your changes don't introduce new bugs!''' Thus it is recommended to [[Building | build Octave]] and to [[Tests | run Octave's test suite]] before proceeding.<br>{{Warning|Please follow the [[Contribution guidelines]] for C/C++ or Octave code files!}} | # Make your changes (fix bug #42424) and save them. '''Make sure that your changes don't introduce new bugs!''' Thus it is recommended to [[Building | build Octave]] and to [[Tests | run Octave's test suite]] before proceeding.<br>{{Warning|Please follow the [[Contribution guidelines]] for C/C++ or Octave code files!}} | ||
# Commit your changes <pre>hg commit</pre> Mercurial will open your default editor<ref>To set your default Mercurial editor, read https://www.mercurial-scm.org/wiki/editor .</ref> and ask you for a commit message. Please follow the [[commit message guidelines]], e.g. <syntaxhighlight lang="text">help.m: Display relevant topics first (bug #42424) | # Commit your changes <pre>hg commit</pre> Mercurial will open your default editor<ref>To set your default Mercurial editor, read https://www.mercurial-scm.org/wiki/editor .</ref> and ask you for a commit message. Please follow the [[commit message guidelines]], e.g. <syntaxhighlight lang="text">help.m: Display relevant topics first (bug #42424) | ||
Line 47: | Line 19: | ||
# Node ID 68c698c4f2fd98bf2d48234bd1da99e91763114f | # Node ID 68c698c4f2fd98bf2d48234bd1da99e91763114f | ||
# Parent f5c9bb5955e7c9fddef5c3c3f115201e11b43b79 | # Parent f5c9bb5955e7c9fddef5c3c3f115201e11b43b79 | ||
help.m: Display relevant topics first (bug #42424) | help.m: Display relevant topics first (bug #42424) | ||
Line 95: | Line 66: | ||
<syntaxhighlight lang="bash"> | <syntaxhighlight lang="bash"> | ||
hg pull https://www.octave.org/hg/octave | hg pull https://www.octave.org/hg/octave # Get latest changes from main repo, bookmark "@" | ||
hg update -r my-gsoc | hg update -r my-gsoc # Select my bookmark | ||
hg merge | hg merge @ # Merge changes of bookmark "@" to bookmark "my-gsoc" | ||
hg commit -m "maint: merge default to my-gsoc" | hg commit -m "maint: merge default to my-gsoc" | ||
hg push ssh://student@public.server.org/octave | hg push ssh://student@public.server.org/octave | ||
Line 104: | Line 75: | ||
=== Preparing for code reviews === | === 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 | 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 development branch. To this end students should: | |||
<ol> | |||
<li> prepare a full log of their changes, listing files that have been touched | |||
and including a summary of the purpose of those changes. If students have been following | |||
the [[Commit message guidelines]] the following command will give a good starting point<br> | |||
hg pull https://www.octave.org/hg/octave | <code> hg log --style=changelog --no-merges --user student-name </code><br> | ||
hg | this message should be edited so that | ||
hg merge | <ol style="list-style-type: lower-roman;"> | ||
hg commit | <li> each touched file appears only once </li> | ||
hg export | <li> changes that were backed out should not be mentioned <!--(like changeset "H" in the above example)--> </li> | ||
</ | </ol> | ||
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]]. | |||
<li> prepare a merge changeset including all the code that should be submitted for review | |||
<ol style="list-style-type: lower-roman;"> | |||
<li> pull from the main repository<br/> | |||
<code>hg pull https://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> | |||
== Example Mercurial configuration == | == Example Mercurial configuration == | ||
Line 176: | Line 163: | ||
[alias] | [alias] | ||
glog = log --graph | glog = log --graph | ||
top | top = log --graph -l | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
== Footnotes == | == Footnotes == |