Magnificent7 / Hackathon

Includes library modifications to allow access to AIN_4 (AIN_0 / 5)

mbd_os/features/net/FEATURE_IPV6/CONTRIBUTING.md@0:eafc3fd41f75, 2016-09-20 (annotated)

Committer:
bryantaylor
Date:
Tue Sep 20 21:26:12 2016 +0000
Revision:
0:eafc3fd41f75
hackathon

Who changed what in which revision?

UserRevisionLine numberNew contents of line
bryantaylor 0:eafc3fd41f75 1 # How to contribute
bryantaylor 0:eafc3fd41f75 2
bryantaylor 0:eafc3fd41f75 3 This directory structure is entirely generated or copied from other repositories. Do not send patches against it, they cannot be accepted because all code will be entirely overwritten on next release.
bryantaylor 0:eafc3fd41f75 4
bryantaylor 0:eafc3fd41f75 5 Instead, follow these instructions to send and test your contributions against master repositories.
bryantaylor 0:eafc3fd41f75 6
bryantaylor 0:eafc3fd41f75 7 ## Directory structure
bryantaylor 0:eafc3fd41f75 8
bryantaylor 0:eafc3fd41f75 9 This directory consists of following modules
bryantaylor 0:eafc3fd41f75 10
bryantaylor 0:eafc3fd41f75 11 * [mbed-mesh-api](#mbed-mesh-api)
bryantaylor 0:eafc3fd41f75 12 * [mbed-trace](#mbed-trace)
bryantaylor 0:eafc3fd41f75 13 * [nanostack-hal-mbed-cmsis-rtos](#nanostack-hal-mbed-cmsis-rtos)
bryantaylor 0:eafc3fd41f75 14 * [nanostack-libservice](#nanostack-libservice)
bryantaylor 0:eafc3fd41f75 15 * [sal-stack-nanostack-eventloop](#sal-stack-nanostack-eventloop)
bryantaylor 0:eafc3fd41f75 16 * [sal-stack-nanostack-private](#sal-stack-nanostack-private)
bryantaylor 0:eafc3fd41f75 17
bryantaylor 0:eafc3fd41f75 18
bryantaylor 0:eafc3fd41f75 19 ## mbed-mesh-api
bryantaylor 0:eafc3fd41f75 20
bryantaylor 0:eafc3fd41f75 21 mbed Mesh API is copied from master repository https://github.com/ARMmbed/mbed-mesh-api
bryantaylor 0:eafc3fd41f75 22
bryantaylor 0:eafc3fd41f75 23 To replace the copied version with the master repository, follow these steps:
bryantaylor 0:eafc3fd41f75 24
bryantaylor 0:eafc3fd41f75 25 * Remove the mbed-mesh-api directory: `rm -rf mbed-mesh-api`
bryantaylor 0:eafc3fd41f75 26 * Clone from the master: `git clone git@github.com:ARMmbed/mbed-mesh-api.git`
bryantaylor 0:eafc3fd41f75 27
bryantaylor 0:eafc3fd41f75 28 Now you have the mbed-mesh-api directory replaced with the Git repository cloned from the original. You can build and test your changes against it and send patches normally to Github as a pull requests.
bryantaylor 0:eafc3fd41f75 29
bryantaylor 0:eafc3fd41f75 30 ## mbed-trace
bryantaylor 0:eafc3fd41f75 31
bryantaylor 0:eafc3fd41f75 32 mbed-trace library is copied from master repository https://github.com/ARMmbed/mbed-trace
bryantaylor 0:eafc3fd41f75 33
bryantaylor 0:eafc3fd41f75 34 To replace the copied version with the master repository, follow these steps:
bryantaylor 0:eafc3fd41f75 35
bryantaylor 0:eafc3fd41f75 36 * Remove the mbed-mesh-api directory: `rm -rf mbed-trace`
bryantaylor 0:eafc3fd41f75 37 * Clone from the master: `git clone git@github.com:ARMmbed/mbed-trace.git`
bryantaylor 0:eafc3fd41f75 38
bryantaylor 0:eafc3fd41f75 39 ## nanostack-hal-mbed-cmsis-rtos
bryantaylor 0:eafc3fd41f75 40
bryantaylor 0:eafc3fd41f75 41 nanostack-hal-mbed-cmsis-rtos library is copied from master repository https://github.com/ARMmbed/nanostack-hal-mbed-cmsis-rtos
bryantaylor 0:eafc3fd41f75 42
bryantaylor 0:eafc3fd41f75 43 To replace the copied version with the master repository, follow these steps:
bryantaylor 0:eafc3fd41f75 44
bryantaylor 0:eafc3fd41f75 45 * Remove the mbed-mesh-api directory: `rm -rf nanostack-hal-mbed-cmsis-rtos`
bryantaylor 0:eafc3fd41f75 46 * Clone from the master: `git clone git@github.com:ARMmbed/nanostack-hal-mbed-cmsis-rtos.git`
bryantaylor 0:eafc3fd41f75 47
bryantaylor 0:eafc3fd41f75 48 ## nanostack-libservice
bryantaylor 0:eafc3fd41f75 49
bryantaylor 0:eafc3fd41f75 50 nanostack-libservice library is copied from master repository https://github.com/ARMmbed/nanostack-libservice
bryantaylor 0:eafc3fd41f75 51
bryantaylor 0:eafc3fd41f75 52 To replace the copied version with the master repository, follow these steps:
bryantaylor 0:eafc3fd41f75 53
bryantaylor 0:eafc3fd41f75 54 * Remove the mbed-mesh-api directory: `rm -rf nanostack-libservice`
bryantaylor 0:eafc3fd41f75 55 * Clone from the master: `git clone git@github.com:ARMmbed/nanostack-libservice.git`
bryantaylor 0:eafc3fd41f75 56
bryantaylor 0:eafc3fd41f75 57 ## sal-stack-nanostack-eventloop
bryantaylor 0:eafc3fd41f75 58
bryantaylor 0:eafc3fd41f75 59 sal-stack-nanostack-eventloop library is copied from master repository https://github.com/ARMmbed/sal-stack-nanostack-eventloop
bryantaylor 0:eafc3fd41f75 60
bryantaylor 0:eafc3fd41f75 61 To replace the copied version with the master repository, follow these steps:
bryantaylor 0:eafc3fd41f75 62
bryantaylor 0:eafc3fd41f75 63 * Remove the mbed-mesh-api directory: `rm -rf sal-stack-nanostack-eventloop`
bryantaylor 0:eafc3fd41f75 64 * Clone from the master: `git clone git@github.com:ARMmbed/sal-stack-nanostack-eventloop.git`
bryantaylor 0:eafc3fd41f75 65
bryantaylor 0:eafc3fd41f75 66 ## sal-stack-nanostack-private
bryantaylor 0:eafc3fd41f75 67
bryantaylor 0:eafc3fd41f75 68 This directory holds binary libraries generated from the Nanostack networking library.
bryantaylor 0:eafc3fd41f75 69
bryantaylor 0:eafc3fd41f75 70 **Only mbed Partners have access to the source code.**
bryantaylor 0:eafc3fd41f75 71
bryantaylor 0:eafc3fd41f75 72 If you have access, the source directory is available in https://github.com/ARMmbed/sal-stack-nanostack-private
bryantaylor 0:eafc3fd41f75 73
bryantaylor 0:eafc3fd41f75 74 You can replace the binary libraries with the source tree as follows:
bryantaylor 0:eafc3fd41f75 75
bryantaylor 0:eafc3fd41f75 76 * Remove the sal-stack-nanostack directory: `rm -rf sal-stack-nanostack`
bryantaylor 0:eafc3fd41f75 77 * Clone the original source repository: `git@github.com:ARMmbed/sal-stack-nanostack-private.git`
bryantaylor 0:eafc3fd41f75 78
bryantaylor 0:eafc3fd41f75 79 Now you can modify, build and test your changes with the mbed OS build.
bryantaylor 0:eafc3fd41f75 80
bryantaylor 0:eafc3fd41f75 81 ### Instructions for generating the binary modules
bryantaylor 0:eafc3fd41f75 82
bryantaylor 0:eafc3fd41f75 83 Check `Releasing.md` from the Nanostack source repository.