Marco Zecchini / Mbed OS Example_RTOS

Rtos API example

mbed-os/features/nanostack/CONTRIBUTING.md@0:9fca2b23d0ba, 2019-02-23 (annotated)

Committer:
marcozecchini
Date:
Sat Feb 23 12:13:36 2019 +0000
Revision:
0:9fca2b23d0ba
final commit

Who changed what in which revision?

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