From df9e6a2cb96561188deab752b0612cbf9e9e23f6 Mon Sep 17 00:00:00 2001 From: kpetersn Date: Tue, 16 Apr 2019 14:10:06 -0500 Subject: [PATCH] Added instructions on how to update existing clones, as well as create new ones. --- README.md | 39 +++++++++++++++++++++++++++++++++++---- 1 file changed, 35 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 423ecef2..137f0bdc 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,42 @@ # motor -APS BCDA synApps module: motor - [![Build Status](https://travis-ci.org/epics-modules/motor.png)](https://travis-ci.org/epics-modules/motor) -**Note**: Current discussion on future of the *motor* module repository: https://github.com/epics-modules/motor/issues/55 +This module contains motor support for the Experimental Physics and Industrial Control System (EPICS). +The core motor functionality resides in this respository. Starting with R7-0 the drivers have been moved from motor to standalone github repositories, which have been added to motor as submodules. The driver repositories can be found here: https://github.com/epics-motor + +## Updating clones created before 2019-04-02 +Use the following procedure to update clones that were created before the beginning of the motor split: +```bash +$ cd motor +$ make distclean +$ git fetch origin +$ git status + +$ git stash +$ git rebase origin/master +$ git stash apply +$ git submodule init +$ git submodule update +``` +Failure to 'make distclean' before rebasing will result in many driver source directories in motorApp with "O.*" directories that need to be removed manually. + +## Cloning motor with support for all motor controllers +The following command results in a motor directory that contains all of the driver submodules: +```bash +$ git clone --recursive https://github.com/epics-modules/motor.git +``` + +## Cloning motor with support for a single motor controller +The following procedure allows only required drivers to be built, which can significantly reduce build times: +```bash +$ git clone https://github.com/epics-modules/motor.git +$ cd motor +$ git submodule init +$ git submodule update modules/motorMotorSim +``` + +## Additional Info For more information, see: * [main page](https://epics-modules.github.io/motor) * [release notes](https://github.com/epics-modules/motor/blob/master/docs/RELEASE.md) @@ -15,4 +47,3 @@ For more information, see: [Report an issue with Motor](https://github.com/epics-modules/motor/issues/new?title=%20ISSUE%20NAME%20HERE&body=**Describe%20the%20issue**%0A%0A**Steps%20to%20reproduce**%0A1.%20Step%20one%0A2.%20Step%20two%0A3.%20Step%20three%0A%0A**Expected%20behaivour**%0A%0A**Actual%20behaviour**%0A%0A**Build%20Environment**%0AArchitecture:%0AEpics%20Base%20Version:%0ADependent%20Module%20Versions:&labels=bug) [Request a feature](https://github.com/epics-modules/motor/issues/new?title=%20FEATURE%20SHORT%20DESCRIPTION&body=**Feature%20Long%20Description**%0A%0A**Why%20should%20this%20be%20added?**%0A&labels=enhancement) -converted from APS SVN repository: Fri Oct 16 12:31:41 CDT 2015