BOSP Development

1–30 of 82

For those of you without a GMail ID, or willing to subscribe to this ML with an email other than google.com, just put that link on you browser:
by replacing <your_email> with one of your mail address, then follow the instruction you will receive in that account. 

The BarbequeRTRM, and the overall BOSP project, is tracked using GIT. This tool makes it easy to push a set of paches to a mailing list for peer-review.
Here is a short and simple tutorial on how to proceed for those of you which are not already expert.

Let's suppose that:
  • 1. you have a email account (examples thereafter uses GMail, any other SMTP server is just fine using the proper configuration data)
  • 2. you have a branch xyz-newFeature, branched out from the BOSP tip, and you are interested into pushing this patches for review and possible merge

All you have to do is:
  1. format a set of emails, containing your patches, which are ready for submission.
    GIT provides the right tool for that, you simply need to issue this command:

    git format-patch --cover-letter -n --subject-prefix="<SUBJECT>" -o <PATCH_DIR> <SHA1_START>

    where:
    - <SUBJECT> is a short string describing the main topic of your contribution (e.g. Monitor)
    - <PATCH_DIR> is the folder (preferable an empty dir created just for this purpose) where email should be generated
    - <SHA1_START> is the SHA1 of the commit starting from with you branched (e.g. the BOSP tip); all the patches following this commit will be sent to the mailing list.

    This command will generate an email for each patch in your branch and a cover letter (as required by the --cover-letter option).
  2. Edit the cover letter to add a brief description of the patchset, and of course update other required fields (e.g. the mail subject)
  3. send this set of email to the mailing lis.
    Again, this could be easily achieved using GIT, provided that you have already properly configured your ~/.gitconfig file to read something like this:

    [sendemail]
        smtpserver = smtp.gmail.com
        from = Your Name <your_email_address>
        bcc = your_email_address
        smtpserverport = 587
        smtpencryption = tls
        smtpuser =     your_email_address

    Than, you simply need to issue this command:

    git send-email --to <TO_MAIL> --cc <CC_MAIL>  <PATCH_DIR>

    where:
    - <TO_MAIL> it the mailing list you are targeting
    - <CC_MAIL> is an (optional) CC destination
    - <PATH_DIR> is the folder used before to host the generated patchset

These are the simple steps required to post a patchset for revision. Reviewers could comment in-line your patches to suggest updates and/or modifications.

After modifications have been done, a new submission to ML could be done. When you are done with modification requests, than a pull-request could be posted by specifying the SHA1 of your most updated branch and (of course) the remote repository hosting the code.