opensand team mailing list archive

[Didier Barvaux <didier@xxxxxxxxxxx>]

Andy,

> It looks that I finally reach a point when I can start my work with
> sources.

Great! :)

> I remember that in August Julien Bernard gaved me some suggestions
> how to become familiar with development approach for opensand
> platform. I'll refresh "developer manual" and if you agree with
> Julien ideas, I'll start my work on tasks which he proposed.
> 
> This is what he wrote:
> Your first task would help you to discover the platform as well. The
> two following points of the TODO list would be a good way to discover
> the code:
>  - Rename ATM/AAL5 into AAL5/ATM (mainly on Manager and atm plugin)
>  - Enable probes tab detaching (if you feel comfortable with GUI
> Python programming, the idea is to permit probe tab (
> http://opensand.org/images/figures/manager_probe_ping_simplified.png)
> to be detached on a new window)
> 
> My background with Python is poor but I can try to work on it if you
> agree that this is important experience for upcoming tasks.

I think it is a good way to discover the source code, and to become
familiar with the development process (Launchpad, bazaar...).

The first task (renaming ATM-related code) is an "easy" one. It is listed
in the TODO list [1]. The problem is that the naming of the AAL5/ATM
plugin is not consistent: sometimes it is named ATM/AAL5 or AAL5/ATM,
sometimes ATM only. The task is: always name it AAL5/ATM.

The steps for this task are:
 1/ Put your name in the 'Assigned to' column of the table in the wiki
    TODO page [1]. Doing so, allow everybody to see that you are working
    on the topic.
 2/ Create a new ticket in the bug tracker [2]:
     a/ Choose a good summary title that:
         - explains clearly what's going on,
         - is short.
        Example: Consistent naming for AAL5/ATM plugin
     b/ Explain the problem in the 'further information' field.
     c/ In extra options, assign the ticket to yourself.
     d/ Submit the new ticket.
 3/ Put a link toward the new ticket in the 'related bug' column of the
    table in the wiki TODO page [1].
 4/ If you are not yet familiar with the source control tool called
    Bazaar, please read its quick tutorial [3] before going further.
    Another (longer) tutorial [4] may help you if you have some
    questions afterwards.
 5/ Retrieve lastest sources with the Bazaar tool:
      $ bzr branch lp:opensand opensand-trunk
    Full OpenSAND sources are now located in the opensand-trunk/ subdir.
    Now, real work can begin! :)
 6/ The source code is organized as described in the 'source code'
    section [5] of the developer manual on the wiki. Take a some time
    to explore the code. Do not read it full yet as it is quite large ;-)
    You'll discover it part by part.
 7/ Try to identify all the parts that use the ATM and/or AAL5
    keywords. For each part, check whether renaming is required or not.
    As it is your first task (beside installing), you may send your
    search results on the mailing list, we will check if you are right
    before going to step 8.
 8/ Alter the code to rename the parts that need to. When modifying the
    code, follow the coding rules of the project [6].
 9/ Once code is updated, check that everything still builds (follow
    the configure and compile steps of the installation manual for every
    modified module). Once done, also check that running the platform with
    the AAL5/ATM plugin still works :) If everything works, go to
    step 10. If not, do not hesitate to ask for help on the mailing list.
10/ Create a patch for your modifications:
      $ cd opensand-trunk/
      $ bzr diff > fix_bug_XXXXXX.patch
11/ Send your patch on the mailing list. We'll check it, give you
    advices, help you if needed...

The steps above are performed for every change. The part about the TODO
list on the wiki may be of course skipped if the item is not on the list.

The developer manual [7] also contains some information for you. There
is a tutorial that explains you how to create a new block in
opensand-core, build it, install it, test/debug it, and submit it as a
new feature. The section "submit new functionalities" is not up to date.

If you have questions about any of the above steps, please tell me!

Regards,
Didier


[1] http://opensand.org/support/wiki/doku.php?id=todo_list#opensand
[2] https://bugs.launchpad.net/opensand/+filebug
[3] http://doc.bazaar.canonical.com/bzr.dev/en/mini-tutorial/index.html
[4] http://doc.bazaar.canonical.com/bzr.dev/en/tutorials/tutorial.html
[5] http://opensand.org/support/wiki/doku.php?id=developer_manual#source_code
[6] http://opensand.org/support/wiki/doku.php?id=coding_rules 
[7] http://opensand.org/support/wiki/doku.php?id=developer_manual

Attachment: signature.asc
Description: PGP signature