Services/Sync/Getting Started

Getting started with Sync development

Using Mercurial

Mozilla's development process is very much patch driven. [Mercurial Patch Queues], although a bit awkward to use at times, fit this process rather well. It is recommended you familiarize yourself with them and use them.

Configuration

Marco Bonardo has some [purpose tips] for Mozilla developers on how to format patches before uploading them to Bugzilla.

Essentially it is recommended you put the following in your ~/.hgrc:

 [ui]
 username = Your Name <you@mozilla.com>
 
 [extensions]
 hgext.mq = 
 
 [diff]
 git = 1
 unified = 8
 
 [defaults]
 diff = -pU8
 qdiff = -pU8
 qnew = -U
 qseries = -sv

Repositories

fx-sync

Sync is primarily developed in the [[1]] repository. Things that live there:

• The Services client libraries in services/crypto/ and services/sync.

• The Firefox Sync add-on in addon/*

• The Firefox 3.x and Fennec 1.x UIs for the Sync add-on in ui/*

mozilla-central

mozilla-central is the repository for Firefox and the base repository for other Mozilla-based applications. How mozilla-central is relevant to Sync:

• The client library is periodically merged from fx-sync to mozilla-central.

• The integrated UI for Firefox Sync lives in browser/base/*, along with the rest of the Firefox UI.