ARMmbed
/
mbed-os
mirror of https://github.com/ARMmbed/mbed-os.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

importer: update readme

pull/12949/head
Martin Kojtal 2020-05-11 11:37:21 +01:00
parent 640e1fd896
commit 8859cb0dca
1 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
tools/importer/README.md
View File

@ -3,7 +3,8 @@
importer.py script can be used to import code base from different repositories into mbed-os.
### Pre-requisties
1. Get the required repository clone and update it to commit required. Note: Repository should be placed outside the mbed-os.
1. Get the required repository clone and update it to commit required - the recommended would be to checkout the latest release version in the repository that we are getting an update from.
Note: Repository should be placed outside the mbed-os. For instance CMSIS_5 repo would be at the same level as mbed-os repository (`update/mbed-os` and update/CMSIS_5)
2. Create json file as per template
### JSON file template
@ -13,7 +14,7 @@ New commit is created on branch `feature_+repo_name+last_sha` with commit messag
Note: Only files present in folder will be copied, directories inside the folder will not be copied.
`commit_sha` is list of commits present in mbed-os repo. These commits will be applied after copying files and folders listed above.Each commit in the commit_sha list is cherry-picked and applied with the -x option, which records the SHA of the source commit in the commit message.
`commit_sha` is list of commits present in mbed-os repo. They are used to be on top of the update - we are changing the upstream repository. To illustrate, the upstream repository does not contain Mbed OS specific change. To apply this change for every update, we add this commit SHA to the `commit_sha`. Every update we do, will use this sha and apply it on top of the latest update. Each commit in the commit_sha list is cherry-picked and applied with the -x option, which records the SHA of the source commit in the commit message.
Note: You must resolve any conflicts that arise during this cherry-pick process. Make sure that the "(cherry picked from commit ...)" statement is present in the commit message. Re-execute the python script to apply rest of the SHA commits.
```json