Lee Kai Xuan / mbed-os

mbed-os

Fork of mbed-os by erkin yucel

features/nanostack/CONTRIBUTING.md@0:f269e3021894, 2016-10-23 (annotated)

Committer:
elessair
Date:
Sun Oct 23 15:10:02 2016 +0000
Revision:
0:f269e3021894
Initial commit

Who changed what in which revision?

UserRevisionLine numberNew contents of line
elessair 0:f269e3021894 1 # How to contribute
elessair 0:f269e3021894 2
elessair 0:f269e3021894 3 This directory structure contains some repositories that are copied from external sources.
elessair 0:f269e3021894 4
elessair 0:f269e3021894 5 Please follow these instructions to send contributions to master repositories.
elessair 0:f269e3021894 6
elessair 0:f269e3021894 7 ## Directory structure
elessair 0:f269e3021894 8
elessair 0:f269e3021894 9 This directory consists of following modules
elessair 0:f269e3021894 10
elessair 0:f269e3021894 11 * [coap-service](#coap-service)
elessair 0:f269e3021894 12 * [mbed-mesh-api](#mbed-mesh-api)
elessair 0:f269e3021894 13 * [nanostack-interface](#nanostack-interface)
elessair 0:f269e3021894 14 * [sal-stack-nanostack](#sal-stack-nanostack)
elessair 0:f269e3021894 15
elessair 0:f269e3021894 16 ## coap-service
elessair 0:f269e3021894 17
elessair 0:f269e3021894 18 Master repository is located in the https://github.com/ARMmbed/coap-service
elessair 0:f269e3021894 19
elessair 0:f269e3021894 20 Please send contributions against that repository.
elessair 0:f269e3021894 21
elessair 0:f269e3021894 22 To test changes, remove the `coap-service` repository and replace with Git clone
elessair 0:f269e3021894 23 of the master repository.
elessair 0:f269e3021894 24
elessair 0:f269e3021894 25 ```
elessair 0:f269e3021894 26 rm -rf coap-service
elessair 0:f269e3021894 27 git clone git@github.com:ARMmbed/coap-service.git
elessair 0:f269e3021894 28 ```
elessair 0:f269e3021894 29
elessair 0:f269e3021894 30 ## mbed-mesh-api
elessair 0:f269e3021894 31
elessair 0:f269e3021894 32 This is the master source of mbed-mesh-api.
elessair 0:f269e3021894 33 Send contributions directly to this repository.
elessair 0:f269e3021894 34
elessair 0:f269e3021894 35 ## nanostack-interface
elessair 0:f269e3021894 36
elessair 0:f269e3021894 37 This is the master source of nanostack-interface.
elessair 0:f269e3021894 38 Send contributions directly to this repository.
elessair 0:f269e3021894 39
elessair 0:f269e3021894 40 ## sal-stack-nanostack
elessair 0:f269e3021894 41
elessair 0:f269e3021894 42 This directory holds binary libraries generated from the Nanostack networking library.
elessair 0:f269e3021894 43
elessair 0:f269e3021894 44 **Only mbed Partners have access to the source code.**
elessair 0:f269e3021894 45
elessair 0:f269e3021894 46 If you have access, the source directory is available in https://github.com/ARMmbed/sal-stack-nanostack-private
elessair 0:f269e3021894 47
elessair 0:f269e3021894 48 You can replace the binary libraries with the source tree as follows:
elessair 0:f269e3021894 49
elessair 0:f269e3021894 50 * Remove the sal-stack-nanostack directory: `rm -rf sal-stack-nanostack`
elessair 0:f269e3021894 51 * Remove the binaries located one directory up: `rm -rf ../nanostack-binaries`
elessair 0:f269e3021894 52 * Clone the original source repository to root folder of your application: `git@github.com:ARMmbed/sal-stack-nanostack-private.git`
elessair 0:f269e3021894 53
elessair 0:f269e3021894 54 Now you can modify, build and test your changes with the mbed OS build.
elessair 0:f269e3021894 55
elessair 0:f269e3021894 56 **NOTE:** You do not need to clone the Nanostack to exactly same location in the build tree. This may even cause build problems.
elessair 0:f269e3021894 57
elessair 0:f269e3021894 58 ### Instructions for generating the binary modules
elessair 0:f269e3021894 59
elessair 0:f269e3021894 60 Check `Releasing.md` from the Nanostack source repository.