The Mer Wiki now uses your Mer user account and password (create account on https://bugs.merproject.org/)

Nemo/GettingStartedInFixingBugs

From Mer Wiki
< Nemo(Difference between revisions)
Jump to: navigation, search
(→‎Take a bug)
(→‎Getting Started in Fixing Bugs)
 
(13 intermediate revisions by 8 users not shown)
Line 1: Line 1:
 
= Getting Started in Fixing Bugs =
 
= Getting Started in Fixing Bugs =
 
'''Prerequisites'''
 
'''Prerequisites'''
−
* Tools on your computer:
+
* [[Platform SDK|Mer SDK installed]]
−
** osc
+
−
** spectacle
+
 
* User accounts
 
* User accounts
−
** Community OBS account
+
** [https://build.merproject.org/ Community OBS] same account as bugzilla below, https://wiki.merproject.org/wiki/Nemo/OBS#Getting_started_with_the_build_system
−
** Nemo Bugzilla account
+
** [https://bugs.nemomobile.org/ Nemo Bugzilla] account (same account works on both mer and nemo bugzilla, register here: https://bugs.merproject.org/createaccount.cgi)
 
* For running on device: Nemo Mobile device
 
* For running on device: Nemo Mobile device
 
* Optionally
 
* Optionally
Line 13: Line 11:
 
== Take a bug ==
 
== Take a bug ==
 
# Go to https://bugs.nemomobile.org
 
# Go to https://bugs.nemomobile.org
−
# Chooce a bug, preferably one from [https://bugs.nemomobile.org/buglist.cgi?emailassigned_to1=1&query_format=advanced&bug_status=UNCONFIRMED&bug_status=NEW&bug_status=NEEDINFO&bug_status=ASSIGNED&bug_status=TRIAGEDUPSTREAM&bug_status=REOPENED&email1=not-taken%40nemomobile.org&product=Applications&product=Hardware%20adaptation&product=Middleware&product=MTF%20UX&known_name=all_bugs&query_based_on=all_bugs&emailtype1=substring not-assigned bugs].
+
# Choose a bug: [https://bugs.nemomobile.org/buglist.cgi?chfieldto=Now&query_format=advanced&chfieldfrom=2013-11-18&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED]
 
# Change the assignee to yourself
 
# Change the assignee to yourself
 
# Change the bug status to assigned
 
# Change the bug status to assigned
  
 
== Create a patch ==
 
== Create a patch ==
−
Ideally, we would fix the upstream pacakge and would release a new version of the package. However, many times we want fix quicker than this allows and thus end up temporarily patching the package. This gives a brief instructions on how.
+
Ideally, we would fix the upstream package and would release a new version of the package. However, many times we want fix quicker than this allows and thus end up temporarily patching the package. This gives a brief instructions on how.
  
 
Once you know which package needs to be fixed
 
Once you know which package needs to be fixed
Line 31: Line 29:
 
# Once the fix works commit your fix to your local branch
 
# Once the fix works commit your fix to your local branch
 
# create patch with <pre>git format-patch</pre>
 
# create patch with <pre>git format-patch</pre>
−
+
 
 +
== Submit the patch upstream ==
 +
 
 +
Nemo contains software from a variety of sources, so there isn't always a clear guideline for how to do this, but generally speaking:
 +
 
 +
* For anything we maintain (generally speaking, anything on https://github.com/nemomobile), please submit a pull request on github. The right people should get a mail notification automatically, but feel free to ping us in #nemomobile too.
 +
* For software from Maemo (or MeeGo), or other sources where there may not be an active upstream, please ask (in #nemomobile) to get a repository created in the nemomobile project on github.
 +
* For anything else, please follow upstream proceedures. If you can't find them, please ping in #nemomobile and we'll try help you out.
 +
 
 +
If you're unsure, or need help, please just ask.
 +
 
 
== Building package with the patch in OBS ==
 
== Building package with the patch in OBS ==
−
# Log into [https://build.pub.meego.com/ community OBS]
+
Please note that you don't need to patch packages that we maintain (see github). Instead, we should be making releases of those packages. Generally, the maintainer(s) of the packages will take care of this in a reasonable amount of time after your patch is merged, but please ping someone on #nemomobile if this process takes too long. (TODO: write a page on release guidelines)
 +
 
 +
# Log into [https://build.merproject.org/ community OBS]
 
# Search for the package needing the fix
 
# Search for the package needing the fix
 
# Branch the package
 
# Branch the package
 
# Go to your computers command line
 
# Go to your computers command line
−
# Check out your branched package with <pre>osc -A https://api.pub.meego.com/ co <your_branched_project>/<package-name></pre>
+
# Check out your branched package with <pre>osc -A https://api.merproject.org/ co <your_branched_project>/<package-name></pre>
 
# Change into dir that was checked out above
 
# Change into dir that was checked out above
 
# Copy the patch to working dir
 
# Copy the patch to working dir
Line 45: Line 55:
 
# Update .changes file. See details of changelog format [http://www.mail-archive.com/mer-general@lists.merproject.org/msg00055.html here]
 
# Update .changes file. See details of changelog format [http://www.mail-archive.com/mer-general@lists.merproject.org/msg00055.html here]
 
# Check in your changes with <pre>osc ci -m "fixes NEMO#xx"</pre> where xx is bug number
 
# Check in your changes with <pre>osc ci -m "fixes NEMO#xx"</pre> where xx is bug number
−
# Go back to community OBS Web UI. Check that your pacakge builds.
+
# Go back to community OBS Web UI. Check that your package builds.
−
# Once OBS has succesfully built a pacakge for your architecture, install it on your device to check that it works.
+
# Once OBS has succesfully built a package for your architecture, install it on your device to check that it works.
  
 
== Submit your fixed package to Nemo ==
 
== Submit your fixed package to Nemo ==
Line 55: Line 65:
 
# Submit
 
# Submit
 
# Mark the bug in bugzilla as fixed and add link to submit request to comments of the bug
 
# Mark the bug in bugzilla as fixed and add link to submit request to comments of the bug
−
# Be prepared to do (typically minor) fixes to your submit request based on automated feedback by build infrastructure or by review of maintainer (sage)
+
# Be prepared to do (typically minor) fixes based on automated feedback by build infrastructure or by review of maintainer (sage). Create a new submit request with the fix, if you will try to reopen the old declined one, then the same old non-fixed revision will be used.
 
# Once the fix has been accepted maintainer (Sage) will mark the bug as released in bugzilla
 
# Once the fix has been accepted maintainer (Sage) will mark the bug as released in bugzilla
−
 
  
 
== More information ==
 
== More information ==
 
* There is an example with images of a bug's life in [http://veskuh.blogspot.com/2012/01/bugs-life.html Vesku's blog]
 
* There is an example with images of a bug's life in [http://veskuh.blogspot.com/2012/01/bugs-life.html Vesku's blog]

Latest revision as of 19:47, 11 February 2014

Contents

[edit] Getting Started in Fixing Bugs

Prerequisites

[edit] Take a bug

  1. Go to https://bugs.nemomobile.org
  2. Choose a bug: [1]
  3. Change the assignee to yourself
  4. Change the bug status to assigned

[edit] Create a patch

Ideally, we would fix the upstream package and would release a new version of the package. However, many times we want fix quicker than this allows and thus end up temporarily patching the package. This gives a brief instructions on how.

Once you know which package needs to be fixed

  1. Find where the upstream git repository is
  2. Clone the sources 
    git clone <url>
  3. Check out the release tag that matches the version in Nemo
  4. Create local branch for you fix
  5. Fix the sources.
    • In fixing your package the QtSDK may help you if you work on N900 or N950. See hello world -tutorial for details
    • Second option is to use local builds using osc. (TODO tutorial)
    • Third option is let OBS build the package. (In practice in this point ignoring if the fix works and executing the remaining steps and steps in the next section)
  6. Once the fix works commit your fix to your local branch
  7. create patch with 
    git format-patch

[edit] Submit the patch upstream

Nemo contains software from a variety of sources, so there isn't always a clear guideline for how to do this, but generally speaking:

  • For anything we maintain (generally speaking, anything on https://github.com/nemomobile), please submit a pull request on github. The right people should get a mail notification automatically, but feel free to ping us in #nemomobile too.
  • For software from Maemo (or MeeGo), or other sources where there may not be an active upstream, please ask (in #nemomobile) to get a repository created in the nemomobile project on github.
  • For anything else, please follow upstream proceedures. If you can't find them, please ping in #nemomobile and we'll try help you out.

If you're unsure, or need help, please just ask.

[edit] Building package with the patch in OBS

Please note that you don't need to patch packages that we maintain (see github). Instead, we should be making releases of those packages. Generally, the maintainer(s) of the packages will take care of this in a reasonable amount of time after your patch is merged, but please ping someone on #nemomobile if this process takes too long. (TODO: write a page on release guidelines)

  1. Log into community OBS
  2. Search for the package needing the fix
  3. Branch the package
  4. Go to your computers command line
  5. Check out your branched package with 
    osc -A https://api.merproject.org/ co <your_branched_project>/<package-name>
  6. Change into dir that was checked out above
  7. Copy the patch to working dir
  8. Add the patch to package's source files with 
    osc add <patch>
  9. Add the patch in .yaml file in the patches-section
  10. Run specify to update .spec file
  11. Update .changes file. See details of changelog format here
  12. Check in your changes with 
    osc ci -m "fixes NEMO#xx"
    where xx is bug number
  13. Go back to community OBS Web UI. Check that your package builds.
  14. Once OBS has succesfully built a package for your architecture, install it on your device to check that it works.

[edit] Submit your fixed package to Nemo

  1. Go to community OBS Web UI
  2. Enable publish for all architectures (under your branched project -> repositories)
  3. In case you have not done this before it would be good to say in irc channel #nemomobile that you are planning to submit bug fix
  4. Go to overview page of the package
  5. Submit
  6. Mark the bug in bugzilla as fixed and add link to submit request to comments of the bug
  7. Be prepared to do (typically minor) fixes based on automated feedback by build infrastructure or by review of maintainer (sage). Create a new submit request with the fix, if you will try to reopen the old declined one, then the same old non-fixed revision will be used.
  8. Once the fix has been accepted maintainer (Sage) will mark the bug as released in bugzilla

[edit] More information

  • There is an example with images of a bug's life in Vesku's blog
Retrieved from "https://wiki.merproject.org/wiki/index.php?title=Nemo/GettingStartedInFixingBugs&oldid=4359"
Personal tools