Editing C&I Wiki Portal/ToolsDevelopmentGuideline (section)

=== Bazaar ===
==== About Bazaar ====
Bazaar is a version control system that helps you track project history over time and to collaborate easily with others. Whether you're a single developer, a co-located team or a community of developers scattered across the world, Bazaar scales and adapts to meet your needs. Part of the GNU Project, Bazaar is free software sponsored by Canonical

You can learn more at http://bazaar.canonical.com/en/

==== Obtaining Bazaar ====
To install Bazaar on a debian or ubuntu system:
<code>sudo apt-get install bazaar</code>

For other Operating Systems, including Windows, Red Hat, SuSE, OSX and more, please see http://wiki.bazaar.canonical.com/Download

==== Learning Bazaar ====
Bazaar is easy to learn.  There is an excellent [http://doc.bazaar.canonical.com/latest/en/mini-tutorial/ 5 Minute Tutorial] that should get you started.  Beyond that, bzr has a fairly well developed man page and in-program help system.  

Please read and do the 5 Minute Tutorial now, which will teach you the basics like creating branches, logging into LP, pushing and merging.

===== Trees, Branches, Trunks? =====
The basic top level of a codebase is called the Trunk.  The Trunk is the mainline code that all branches are a part of.  Branches are localized copies of Trunk.  Branches are where you make changes for submission and merge consideration.  Once accepted, Branches are merged into Trunk and become part of the mainline codebase.  

===== Basic Commands =====
* The most basic command is: <code>bzr</code>
* To get a local copy of a project: <code>bzr branch lp:opencompute/opencompute-testing</code>
* To review a change summary: <code>bzr status</code>
* To add new files that are not yet managed: <code>bzr add path/to/filename</code>
** Note that /path/to/filename needs to be a path INSIDE your branch.  When adding files not in the branch, you need to copy those files into the branch before adding them.
* To see a diff of changes: <code>bzr diff path/to/filename</code>
* To commit your changes to a new revision <code>bzr commit -m "Some descriptive summary of your changes"</code>
* To push your changes to launchpad in preparation for a Merge Request: <code>bzr push lp:~<Your Launchpad Username>/opencompute/<Your Branch Name></code>
** for example: <code>bzr push lp:~bladernr/opencompute/ocp-testing-job-updates</code>

There are many MANY more commands but those are the ones you'll likely use most frequently.

===== Learning More =====
* http://doc.bazaar.canonical.com/en/
* http://wiki.bazaar.canonical.com/Tutorials
* https://yade-dem.org/wiki/Quick_Bazaar_tutorial
* http://wiki.bazaar.canonical.com/Tutorials