Mercurial: Difference between revisions
(→Submitting patches: Condense section to relevant information.) |
|||
Line 13: | Line 13: | ||
* Follow the style guides for both [[Octave style guide|Octave]] and [[C++ style guide|C++]] languages. | * Follow the style guides for both [[Octave style guide|Octave]] and [[C++ style guide|C++]] languages. | ||
== | == Creating and submitting patches (changesets) == | ||
If you want to modify Octave's source code, given at https://www.octave.org/hg/octave, you cannot just submit your changes there. You have to generate a patch (or changeset) so Octave developers with permissions can include them into Octave's source code. | |||
# 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> | # 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> | ||
Line 34: | Line 24: | ||
# Export the changes <pre>hg export -r tip -o bug42424.patch</pre> The final patch for submission will look like this<syntaxhighlight lang="patch"> | # Export the changes <pre>hg export -r tip -o bug42424.patch</pre> The final patch for submission will look like this<syntaxhighlight lang="patch"> | ||
</syntaxhighlight> | </syntaxhighlight> | ||
# Upload {{Path|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! | # Upload {{Path|bug42424.patch}} to the [https://savannah.gnu.org/bugs/?group=octave bug] or [https://savannah.gnu.org/patch/?group=octave 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 == | == Mercurial Tips for SoC students == |
Revision as of 08:49, 10 June 2020
Mercurial (sometimes referred to as hg
) is the source code management system used for Octave development.
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 and C++ languages.
Creating and submitting patches (changesets)
If you want to modify Octave's source code, given at https://www.octave.org/hg/octave, you cannot just submit your changes there. You have to generate a patch (or changeset) so Octave developers with permissions can include them into Octave's source code.
- Get the latest revision of Octave (or some Octave package)
hg clone https://www.octave.org/hg/octave
or when already clonedhg pull && hg update
- Make your changes (fix the bug) and save them.
- Commit your changes
hg commit
Mercurial 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 how to display relevant topics first.
- Export the changes
hg export -r tip -o bug42424.patch
The 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 SOCIS or GSoC students working on new Octave features.
Students should publish their work as it progresses in a public repository merging regularly the main savannah repository to facilitate merging back their code at the end of the project.
Here are some useful hg commands that can be used to do this.
Getting started
- Clone the main Octave repository at savannah:
hg clone http://www.octave.org/hg/octave
- Create a new bookmark:
hg bookmark student-bookmark-name
- Make the bookmark visible in the public repo, assuming the public repo is at
public.server.org/octave
hg push --bookmark ssh://student@public.server.org/octave
Staying up-to-date with the main savannah repository
As the students development proceeds,
the savannah repository gets updated, too.
To avoid having the two branches diverging too much, which can
lead to conflicts when the final merge is done, students should
keep their public repo up-to-date with the recent changes,
the following commands can be used for this:
- Download new changes from the main line of development
hg pull http://www.octave.org/hg/octave
- Merge the main line of development into the feature branch
hg up -r student-bookmark-name
hg merge @
- Apply the change and publish it
hg commit -m "periodic merge of default branch into my branch"
hg push ssh://student@public.server.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 development branch. To this end students should:
- 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
hg log --style=changelog --no-merges --user student-name
this message should be edited so that- each touched file appears only once
- changes that were backed out should not be mentioned
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.
- prepare a merge changeset including all the code that should be submitted for review
- pull from the main repository
hg pull http://www.octave.org/hg/octave
- move to the top of the main line of development and merge in the feature branch
hg up -r @
hg merge student-bookmark-name
- create a changeset, export it and send to the mentor for review, remember to use the log created above as a commit message
hg commit
hg export @ > mid-term-review.changeset
the file mid-term-review.changeset can then be sent to the mailing list or posted to the patch tracker
- pull from the main repository
Example Mercurial configuration
Place the following file in your home directory, e.g. /home/username/.hgrc.
[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
External links
- https://hginit.com/ -- Mercurial tutorial
- https://www.mercurial-scm.org/wiki/Tutorial -- Mercurial tutorial
- https://www.mercurial-scm.org/wiki/QuickStart -- Mercurial quick start