Skip to content

Commit bdfa22a

Browse files
author
Seppo Takalo
committed
Update CONTRIBUTING.md
1 parent 6ba8068 commit bdfa22a

File tree

1 file changed

+25
-48
lines changed

1 file changed

+25
-48
lines changed
Lines changed: 25 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -1,69 +1,43 @@
11
# How to contribute
22

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.
3+
This directory structure contains some repositories that are copied from external sources.
44

5-
Instead, follow these instructions to send and test your contributions against master repositories.
5+
Please follow these instructions to send contributions to master repositories.
66

77
## Directory structure
88

99
This directory consists of following modules
1010

11+
* [coap-service](#coap-service)
1112
* [mbed-mesh-api](#mbed-mesh-api)
12-
* [mbed-trace](#mbed-trace)
13-
* [nanostack-hal-mbed-cmsis-rtos](#nanostack-hal-mbed-cmsis-rtos)
14-
* [nanostack-libservice](#nanostack-libservice)
15-
* [sal-stack-nanostack-eventloop](#sal-stack-nanostack-eventloop)
16-
* [sal-stack-nanostack-private](#sal-stack-nanostack-private)
13+
* [nanostack-interface](#nanostack-interface)
14+
* [sal-stack-nanostack](#sal-stack-nanostack)
1715

16+
## coap-service
1817

19-
## mbed-mesh-api
20-
21-
mbed Mesh API is copied from master repository https://github.com/ARMmbed/mbed-mesh-api
22-
23-
To replace the copied version with the master repository, follow these steps:
24-
25-
* Remove the mbed-mesh-api directory: `rm -rf mbed-mesh-api`
26-
* Clone from the master: `git clone [email protected]:ARMmbed/mbed-mesh-api.git`
27-
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.
29-
30-
## mbed-trace
31-
32-
mbed-trace library is copied from master repository https://github.com/ARMmbed/mbed-trace
33-
34-
To replace the copied version with the master repository, follow these steps:
18+
Master repository is located in the https://github.com/ARMmbed/coap-service
3519

36-
* Remove the mbed-mesh-api directory: `rm -rf mbed-trace`
37-
* Clone from the master: `git clone [email protected]:ARMmbed/mbed-trace.git`
20+
Please send contributions against that repository.
3821

39-
## nanostack-hal-mbed-cmsis-rtos
22+
To test changes, remove the `coap-service` repository and replace with Git clone
23+
of the master repository.
4024

41-
nanostack-hal-mbed-cmsis-rtos library is copied from master repository https://github.com/ARMmbed/nanostack-hal-mbed-cmsis-rtos
25+
```
26+
rm -rf coap-service
27+
git clone [email protected]:ARMmbed/coap-service.git
28+
```
4229

43-
To replace the copied version with the master repository, follow these steps:
44-
45-
* Remove the mbed-mesh-api directory: `rm -rf nanostack-hal-mbed-cmsis-rtos`
46-
* Clone from the master: `git clone [email protected]:ARMmbed/nanostack-hal-mbed-cmsis-rtos.git`
47-
48-
## nanostack-libservice
49-
50-
nanostack-libservice library is copied from master repository https://github.com/ARMmbed/nanostack-libservice
51-
52-
To replace the copied version with the master repository, follow these steps:
53-
54-
* Remove the mbed-mesh-api directory: `rm -rf nanostack-libservice`
55-
* Clone from the master: `git clone [email protected]:ARMmbed/nanostack-libservice.git`
56-
57-
## sal-stack-nanostack-eventloop
30+
## mbed-mesh-api
5831

59-
sal-stack-nanostack-eventloop library is copied from master repository https://github.com/ARMmbed/sal-stack-nanostack-eventloop
32+
This is the master source of mbed-mesh-api.
33+
Send contributions directly to this repository.
6034

61-
To replace the copied version with the master repository, follow these steps:
35+
## nanostack-interface
6236

63-
* Remove the mbed-mesh-api directory: `rm -rf sal-stack-nanostack-eventloop`
64-
* Clone from the master: `git clone [email protected]:ARMmbed/sal-stack-nanostack-eventloop.git`
37+
This is the master source of nanostack-interface.
38+
Send contributions directly to this repository.
6539

66-
## sal-stack-nanostack-private
40+
## sal-stack-nanostack
6741

6842
This directory holds binary libraries generated from the Nanostack networking library.
6943

@@ -74,10 +48,13 @@ If you have access, the source directory is available in https://github.com/ARMm
7448
You can replace the binary libraries with the source tree as follows:
7549

7650
* Remove the sal-stack-nanostack directory: `rm -rf sal-stack-nanostack`
77-
* Clone the original source repository: `[email protected]:ARMmbed/sal-stack-nanostack-private.git`
51+
* Remove the binaries located one directory up: `rm -rf ../nanostack-binaries`
52+
* Clone the original source repository to root folder of your application: `[email protected]:ARMmbed/sal-stack-nanostack-private.git`
7853

7954
Now you can modify, build and test your changes with the mbed OS build.
8055

56+
**NOTE:** You do not need to clone the Nanostack to exactly same location in the build tree. This may even cause build problems.
57+
8158
### Instructions for generating the binary modules
8259

8360
Check `Releasing.md` from the Nanostack source repository.

0 commit comments

Comments
 (0)