Differences between revisions 1 and 6 (spanning 5 versions)
⇤ ← Revision 1 as of 2012-01-10 15:55:47 →
Size: 807
Editor: mbk-50-12
Comment:
← Revision 6 as of 2015-06-27 08:35:32 → ⇥
Size: 1811
Editor: bbb
Comment:
Deletions are marked like this. Additions are marked like this.
Line 5: Line 5:
----
To clone the kernel repository (Linux + LITMUS^RT^), enter the following command:
{{{
git clone http://www.litmus-rt.org/src/litmus-rt.git		 The main development repositories are hosted on GitHub.

 * The LITMUS^RT^ GitHub account: [[https://github.com/LITMUS-RT]]

There are three main repositories:

 * The kernel repository (Linux + LITMUS^RT^): [[https://github.com/LITMUS-RT/litmus-rt]].

 * The `liblitmus` repository (the userspace library & assorted tools): [[https://github.com/LITMUS-RT/liblitmus]].

 * The Feather-Trace tools repository (the tracing tools, aka `ft_tools`): [[https://github.com/LITMUS-RT/feather-trace-tools]].


== Which branch to use? ==

Roughly the following branch structure is used:

 1. The `master` branch contains all merged patches on top of the latest release.

 1. `prop/` branches (e.g., `prop/topic-1`, `prop/topic-2`, etc.), which are topic branches containing change proposals.

 1. When the time comes, `next` will contain the rebased version that will become the next stable release of LITMUS^RT^.

To stay up-to-date, follow the `master` branch. New major changes will be staged in `prop/` branches and merged into `master` when ready. Prior to the next release, LITMUS^RT^ will be squashed and rebased in `next`. When a new release is made, `master` will be reset to `next`.

{{{#!wiki important
'''Don't develop in `master`'''

When developing your own plugin or any other changes to LITMUS^RT^, don't work in the `master` branch as it is subject to rebasing when a new release is made. Instead, use topic branches to keep track of your projects. This will make it easier to track upstream releases.
Line 11: Line 36:
Note that the litmus-rt.git repository contains a large portion of the Linux kernel repository, and will take some time to download. It is 1.1 GB in size as of February, 2011. == How to contribute? ==
Line 13: Line 38:
----
To clone the liblitmus repository (the userspace library), enter the following command:
{{{
git clone http://www.litmus-rt.org/src/liblitmus.git
}}}


----

To clone the Feather-Trace tools repository (the tracing tools), enter the following command:
{{{
git clone http://www.litmus-rt.org/src/feather-trace-tools.git
}}}		 All help is welcome! Simply send a patch series to the mailing list or create a pull request on GitHub.

Public Repositories

The LITMUSRT source code is managed using the git version control system.

The main development repositories are hosted on GitHub.

There are three main repositories:

Which branch to use?

Roughly the following branch structure is used:

  1. The master branch contains all merged patches on top of the latest release.

  2. prop/ branches (e.g., prop/topic-1, prop/topic-2, etc.), which are topic branches containing change proposals.

  3. When the time comes, next will contain the rebased version that will become the next stable release of LITMUSRT.

To stay up-to-date, follow the master branch. New major changes will be staged in prop/ branches and merged into master when ready. Prior to the next release, LITMUSRT will be squashed and rebased in next. When a new release is made, master will be reset to next.

Don't develop in master

When developing your own plugin or any other changes to LITMUSRT, don't work in the master branch as it is subject to rebasing when a new release is made. Instead, use topic branches to keep track of your projects. This will make it easier to track upstream releases.

How to contribute?

All help is welcome! Simply send a patch series to the mailing list or create a pull request on GitHub.

Repositories (last edited 2015-06-27 08:35:32 by bbb)