How to download nuttx for a Feature Branched Workflow

This is a series of blogs (my self documentation) on using Nuttx in a branched workflow.
Hopefully its of use to others.
This assumes you already have a viable build environment on your local machine.
This assumes you have already forked the nuttx repo's on bitbucket
Ideally your fork is sycned to a release tag - but that is advanced code management for another discussion.
Now you need to download the repos to a local machine  before they can be build.
There are many workpractises that can accomplish this - so I'm sharing the one I've evolved.
The target is to be eventually do a "polished" Pull Request back into the  main nuttx. There is a fierce guardian of the repo - so while a users main effort might be creating the code, possibly if like me quite messily, the activity of submitting back to the nuttx repos of working code can be a process in itself.
So as per the Feature Branched Workflow guidelines I consider creating one local instance of nuttx for working on - with a branch usually starting with "work..."  and then when submitting it creating another local nuttx instance got staging and polishing the code ... with a branch possibly beginning "pr.."
Nuttx can be built for a number of processors or starting configurations, I find it useful to create my local nuttx instance with a defined naming scheme

I use a postfix nxZZ for each directory,  as I found a need for different instances of Nuttx as the development progress

nxtipXXX - direct bitbucket/nuttx with target build

nxoh4wk - nuttx Olimex-STM32-h407 Work tree 

nxoh4sg - ditto stage tree

nxnkl25<xx> - nuttx  NXP FRDM-KL25 work/stage

nxnk64<xx>  - nuttx NXP FRDM-K64 work/stage

So assuming the target environment is Olimx-STM32-h407 I create two directories 

$ cd git

mkdir nxtipoh4   #my top level directory for pure nuttx code from tip built for Olimex-STM32-h407

mkdir nxoh4wk

cd nxoh4wk

#I've forked to the specific repos below

git clone git@bitbucket.org:<user>/anuttx.git nuttx

git clone git@bitbucket.org:<user>/nuttapps.git apps

#if first time on machine using make menuconfig - need to set up Kconfigs)

git clone https://bitbucket.org/nuttx/tools.git tools

#end first time Kconfigs

cd nuttx

  

$ tools/version.sh -b 160405_1103 -v 7.15 .version

make distclean

cd  tools

#use a starting config

./configure.sh olimex-stm32-h407/nsh

cd ..

source setenv_xx.sh (if first time)

make menuconfig #ensure host is correct, save and then exit to use latest format

make #test build, should work and be tested before continuing

(cable to serial port, teraTerm 19200 to serial port)

#next create the working feature branched workflow environment of your choice

git checkout -b work_featurebranchAA

cd ../apps

git checkout -b work_featurebranchAA

# now can edit in either nuttx or apps and it will be tracked.

#Optionally an instance can be created for the tip - and differences between the forked branch can be seen using meld or something similar.

cd ../nxtipoh4

git clone git@bitbucket.org:nuttx/nuttx.git nuttx

git clone git@bitbucket.org:nuttx/apps.git apps

# then build - see above

tutorial: bitbucket setup Feature Branched Workflow for nuttx (single git repository)

This is a series of blogs (my self documentation) on using Nuttx in a branched workflow.
Hopefully its of some use to others.

"Nuttx OS" on bitbucket for the beginner has a two git module configuration - bitbucket.org/nuttx/nttuxt and bitbucket.org/nuttx/apps The "apps" may be replaced by a custom configuration later.

My development environment is Ubuntu 15.10, with Meld to do differencing. 

Meld required Ubunutu 15.10

The editing is done in Eclipse Mars on Windows10 over the network to Ubuntu. I login in remotely to the Ubuntu machine to compile.

Some references

atlassian.com/git/tutorials/comparing-workflows

git.wiki.kernel.org/index.php/GitSubmoduleTutorial - definitions, complex

stackoverflowchanging-remote-repository-for-a-git-submodule options

To start, sign-in to bitbucket.org with your own account , then clone the following into your <userSpace> on bitbucket

I use a prefix ZZ as you might want to experiment with different instances of Nuttx as the development progress

bitbucket.org/patacongo/nuttx  to ZZNuttX   Description: <your plans for the fork>

bitbucket.org/nuttx/apps             ZZnuttapps Description: <your plans for an apps>

Next article:  how to download the code to your local machine.

Previous posts superseded

The previous posts on multiple repositories for Nuttx have superseded, as three core repos have been made one.
For a nuttx apps writer it is now effectively two repositories
https://groups.yahoo.com/neo/groups/nuttx/conversations/messages/11665

I'll provide updates as I redo my repositories

branched development merge for Nuttx 15.7

With a recent update of Nuttx 15.7
https://groups.yahoo.com/neo/groups/nuttx/conversations/messages/11496
https://sourceforge.net/projects/nuttx/files/nuttx/nuttx-7.15/

I needed to merge the udpates into my bitbucket.org fork.
https://bitbucket.org/nuttx/ - previously I had forked from here, and now need to merge those updates into it.
Nuttx has 4 repositories - that all need to be individually updated.
There may be a script to do this - but right now bitbucket offers a button to sync the fork with the upstream. Its positioned on the far right and only exists if this fork is behind.



For _nuttx fork


Press the sync now - then repeat with  forks  _configs (upstream is called nuttx/boards)


_arch

 and apps.


Now on the build machine - in this case an Ubuntu I step into my development  git directory "git/nwwk2"
and then step through apps  nuttx   nuttx/configs & nuttix/arch to update all the modules.
My development branch is "work-modbus".

A little trick I learn't, that as branching is easy/quick, and to be able to easily manage (not commit if necessary) the master merge,  I create a temporary branch "work-modbus-merge" and do all the work/conflict resolution on that first.
When complete its an easy step to merge "work-modbus-merge" into "work-modbus"

git checkout master
git update   # this brings in the udpate
git checkout work-modbus
git checkout -b work-modbus-merge
git merge master   #this does the actual merging from the master

… review new code - in this case no conflicts

git checkout work-modbus

git merge work-modbus-merge

git branch -d work-modbus-merge  #deletes the -merge branch

git merge master  #should be no items

git status  #should say uptodate

git commit -m "merged with Nuttx 7.15 "

git push origin work-modbus    # final upstream update to my 

Then this step is repeated for nuttx, _configs, _arch

Enjoy the merge - when it works its very easy.!!!

tutorial: Branched workflow setup

This is a series of blogs (my self documentation) on using Nuttx in a branched workflow.
Hopefully its of some use to others.
This starts from the beginning and works through the commands to a built image

Nuttx.org  has a git submodule configuration that adds a layer of complexity to manage the submodules in  a branched workflow environment.

My development environment is Ubuntu 15.10, with Meld to do differencing. 

Meld required Ubunutu 15.10

The editing is done in Eclipse Mars on Windows8 over the network to Ubuntu. I login in remotely to the Ubuntu machine to compile.

Some references

atlassian.com/git/tutorials/comparing-workflows

git.wiki.kernel.org/index.php/GitSubmoduleTutorial - definitions, complex

stackoverflowchanging-remote-repository-for-a-git-submodule options

To start sign into bitbucket.org , then clone the following into your <userSpace> on bitbucket

I use a prefix ZZ as you might want to experiment with different instances of Nuttx as the development progress

bitbucket.org/patacongo/nuttx  to ZZ_NuttX   Description: <your plans for the fork>

bitbucket.org/nuttx/apps             ZZ_nuttapps Description: <your plans for an apps>

bitbucket.org/nuttx/arch              ZZ_nuttx-arch Description: Required as part of nuttx

bitbucket.org/nuttx/boards         ZZ_nuttx-config “Nuttx boards definitions”

Then on local machine (mine Ubuntu15.10)

(either setup SSH or use the https form instead of git@bitbucket.org:.... )

cd git

mkdir nxYY    #my top level dir - YY userdefined eg nxwkA

cd nxYY

git clone git@bitbucket.org:<user>/ZZ_nuttapps.git  apps

git clone git@bitbucket.org:<user>/ZZ_nuttx.git nuttx

cd  nuttx

git remote –v (origin should be above)

#

#first time through 

echo "/configs/*" >> .gitignore

echo "/arch/*" >> .gitignore

git add  .gitignore

git commit -m "changed submodule arch configs to directory"

git push origin master   OR if fails or first time on branch   $git push origin <branch-name>

rm -rf arch

rm -rf configs

git clone git@bitbucket.org:<user>/ZZ_nuttx-configs.git  configs

git clone git@bitbucket.org:<user>/ZZ_nuttx-arch.git  arch

git status #shows arch and configs but git ignores any action on them 

#

#optionally should be able to do the following for submodules Documentation 

#- but doesn't work, some hidden submodule meta data still lying around

git submodule init 

#(has error "no submodule mapping found in .gitmodules for path 'arch'"??)

git submodule update  #populates

make distclean

cd  tools

#one of following

$ ./configure.sh stm32f429i-disco/nsh

$ ./configure.sh olimex-stm32-h407/nsh

cd ..

make menuconfig #Step into "Build Setup: ensure host is correct, save, exit to use latest format

#optionally, specify version info

tools/version.sh -v <major.minor> 

make #test build, should work and be tested before continuing

# Do the following for changes to any one of four "projects"

# nuttx   nuttx/arch nuttx/config apps

#eg for nuttx/arch (repeat for other projects as needed)

cd apps

git branch develop  #baseline for future: only first time through

git checkout -b work-<descriptive name>  #new branch eg work-modbusm

git status

<<make changes, build and test>>

git status eg

git add .

git commit -m "sensible comment"

git push origin work-<descriptive name> 

# On Bitbucket.org/<user> check commit is as expected.