From 549b8ce8f8271f86bdd5cbc7698513cfae91bc58 Mon Sep 17 00:00:00 2001
From: Isaac IY Saito <130s@lateeye.net>
Date: Sun, 31 Aug 2014 09:36:19 +0900
Subject: [PATCH] (README.rst) Add maintainer section (moved from
 http://wiki.ros.org/action/info/hrpsys_ros_bridge?action=diff&rev2=3&rev1=1).

---
 README.md | 60 +++++++++++++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 58 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 04531d01a..8e7d01a74 100644
--- a/README.md
+++ b/README.md
@@ -1,14 +1,18 @@
+================================================================================================================================================================
 rtmros_common  [![Build Status](https://travis-ci.org/start-jsk/rtmros_common.png)](https://travis-ci.org/start-jsk/rtmros_common)
--------------
+================================================================================================================================================================
 
 A package suite that provides all the capabilities for the ROS users to connect to the robots that run on RT Middleware or RTM-based controllers.
 
+.. contents::
 
---------------
+Install
+========
 
 This document explains how to use and how to contribute to rtm-ros-robotics softwares ([openrtm_aist_core](https://github.com/start-jsk/openrtm_aist_core), [openhrp3](https://github.com/start-jsk/openhrp3), [hrpsys](https://github.com/start-jsk/hrpsys), [rtshell_core](https://github.com/start-jsk/rtshell_core), [rtmros_common](https://github.com/start-jsk/rtmros_common), [rtmros_hironx](https://github.com/start-jsk/rtmros_hironx), [rtmros_tutorial](https://github.com/start-jsk/rtmros_turorial), [rtmros_gazebo](https://github.com/start-jsk/rtmros_gazebo)). The instruction uses `rtmros_common` repository as an example, but also works for other rtm-ros-robotics repositories.
 
 1. Install software
+
  rtm-ros-robotics software is distributed as ros-debian packages, if you already uses ROS system, install the software as follows:
  - `sudo apt-get install ros-$ROS_DISTRO-rtmros-common`
  
@@ -22,6 +26,7 @@ This document explains how to use and how to contribute to rtm-ros-robotics soft
  - `source /opt/ros/hydro/setup.bash` # it is better to source ROS environment everytime terminal starts (`echo "source /opt/ros/hydro/setup.bash" >> ~/.bashrc`)
 
 2. Compile from source code
+
  You may have two choice, one is to compile all rtm-ros-robotics source code, other is to compile target repository.
  First, create catkin workspace
  - `mkdir -p ~/catkin_ws/src`
@@ -43,6 +48,7 @@ This document explains how to use and how to contribute to rtm-ros-robotics soft
  - `catkin_make`
 
 3. Contributes to rtm-ros-robotics projects.
+
  - First fork the target repository on GitHub
  - Move to the package direcotry
  - `source ~/catkin_ws/devel/setup.bash`
@@ -62,6 +68,7 @@ This document explains how to use and how to contribute to rtm-ros-robotics soft
 
 You don't need to wait for the maintainers to merge some pull requests by others
 before you use them.
+
  - Adding other's remote repository to your git remote
  - `git remote add <awesome-fork> https://github.com/<user>/rtmros_common`
  - Fetch branches from the remote.
@@ -69,4 +76,53 @@ before you use them.
  - Merge those remote branch into your current branch
  - `git merge <awesome-fork>/<branch-name>`
 
+For maintainers
+===============
+
+Tweak to release into Groovy
+--------------------------------
+
+While in current design the package depends on `pr2_controllers_msgs <http://wiki.ros.org/pr2_controllers_msgs>`_ that's catkinized from ROS hydro onward and not available in ROS groovy, some hacks allow the package not to separate `branches` (regardless it's good or not, doing so is the decision as of March 2014). This requires another hack during release process using `bloom` as follows:
+
+ 1. Run `bloom <http://wiki.ros.org/bloom>`_ as normal. E.g. `$ bloom-release --rosdistro groovy --track groovy rtmros_common`.
+ 2. Once `bloom` halts and its command prompt starts waiting on the same terminal (the output might look as following), edit `package.xml` to comment out lines for declaring build and run depend on `pr2-controllers`.
+
+  ::
+
+    $ bloom-release --rosdistro groovy --track groovy rtmros_common
+    :
+    >>> Resolve any conflicts and when you have resolved this problem run 'git am --resolved' and then exit the shell using 'exit 0'. <<<
+        To abort use 'exit 1'
+    (bloom)emacs package.xml 
+
+  Modify `package.xml` as:
+
+  ::
+
+    :  
+    <!-- <build_depend>pr2_controllers</build_depend> -->
+    :
+    <!-- <run_depend>pr2_controllers</run_depend> -->
+    :
+
+ 3. Run `git add`, `$ git am --skip`, `git commit` like below, and `exit 0` respectively. If all succeeds then `bloom` resumes.
+
+  ::
 
+    (bloom)git add package.xml
+    (bloom)git am --skip
+    Resolve operation not in progress, we are not resuming.
+    (bloom)git commit -m "3rd trial commentout pr2 pkg" -a
+    [release/groovy/hrpsys_ros_bridge 1c05bbc] 3rd trial commentout pr2 pkg
+     1 file changed, 1 insertion(+), 1 deletion(-)
+    (bloom)git status
+    # On branch release/groovy/hrpsys_ros_bridge
+    # Your branch is ahead of 'origin/release/groovy/hrpsys_ros_bridge' by 8 commits.
+    #
+    nothing to commit (working directory clean)
+    (bloom)exit 0
+    exit
+     [git-bloom-patch import]: User reports that conflicts have been resolved, continuing.
+     [git-bloom-patch import]: Applied 2 patches
+    :
+    (bloom continues)