New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Cordio Documentation: Explain how to tests and what tools are available. #7417

Merged
merged 9 commits into from Aug 24, 2018

Conversation

@pan-
Member

pan- commented Jul 4, 2018

Description

Improve the cordio porting documentation by explaining how tests can be run and describe the tooling available.

Pull request type

[ ] Fix
[ ] Refactor
[ ] New target
[X] Feature
[ ] Breaking change

@pan- pan- requested a review from donatieng Jul 4, 2018

@0xc0170 0xc0170 requested a review from ARMmbed/mbed-docs Jul 4, 2018

@0xc0170

This comment has been minimized.

Member

0xc0170 commented Jul 4, 2018

@ARMmbed/mbed-docs As @AnotherButler is OoO this week, can anyone else review this please

@iriark01

This comment has been minimized.

Contributor

iriark01 commented Jul 4, 2018

@MelindaWeed wanna meet something that isn't Mbed Cloud?

@melwee01

This comment has been minimized.

Contributor

melwee01 commented Jul 4, 2018

So long as it doesn't bite. Anything I should know before review, or is this standard procedure?

@iriark01

This comment has been minimized.

Contributor

iriark01 commented Jul 4, 2018

Take no prisoners?

@pan- pan- force-pushed the pan-:improve-cordio-hci-doc branch from a02b666 to 7a8cc02 Jul 4, 2018

@melwee01

This comment has been minimized.

Contributor

melwee01 commented Jul 4, 2018

I don't have push access. Could I be granted it temporarily, or should I fork?

@donatieng

This comment has been minimized.

Member

donatieng commented Jul 4, 2018

What do you need push access for @MelindaWeed ? Do you have reviewing rights?

@pan-

This comment has been minimized.

Member

pan- commented Jul 4, 2018

@MelindaWeed I made sure you can push on my fork this pr branch.

@melwee01

This comment has been minimized.

Contributor

melwee01 commented Jul 4, 2018

Please do not merge until docs gives the thumbs-up. Working on it now.

@donatieng, I'm standing in for Amanda for docs review since she's OoO.

@melwee01

I'd like to take a look at the whole file, if I may.

@@ -489,6 +489,26 @@ ble::vendor::cordio::CordioHCIDriver& ble_cordio_get_hci_driver() {
}
```
### Tests
Greentea tests are bundled with the cordio port of BLE API to ensure that the transport driver works as expected as well as validate the cordio stack initialization. You can run them with the following command:

This comment has been minimized.

@melwee01

melwee01 Jul 4, 2018

Contributor

Greentea tests are bundled with the Cordio port of the BLE API to make sure the transport driver works as expected, as well as to validate Cordio stack initialization. You can run them with the following command:

We don't typically use language that implies things might not work (as per the style guide). I'm not crazy about "works as expected."

This comment has been minimized.

@melwee01

melwee01 Jul 4, 2018

Contributor

Also, if the bundling is something Arm does, Arm should be the active subject of the sentence. Or "we."

This comment has been minimized.

@melwee01

melwee01 Jul 4, 2018

Contributor

Cordio capitalized throughout.

mbed test -t <toolchain> -m <target> -n mbed-os-features-feature_ble-targets-target_cordio-tests-cordio_hci-driver,mbed-os-features-feature_ble-targets-target_cordio-tests-cordio_hci-transport
```
* mbed-os-features-feature_ble-targets-target_cordio-tests-cordio_hci-transport: Ensure that the transport is able to send an HCI reset command and receive the corresponding HCI status event.

This comment has been minimized.

@melwee01

melwee01 Jul 4, 2018

Contributor

Rather than ensure, I'd suggest check. Or make sure.

This comment has been minimized.

@melwee01

melwee01 Jul 4, 2018

Contributor

Rather than is able to, can. Reduces wordiness.

This comment has been minimized.

@AnotherButler

AnotherButler Jul 9, 2018

Contributor

Query: Why don't you like "ensure"? I usually prefer it to "make sure" because it's shorter.

The application [mbed-os-cordio-hci-passthrough](https://github.com/ARMmbed/mbed-os-cordio-hci-passthrough) can be used to _proxify_ a Bluetooth controller connected to an mbed board.
Bytes sent by the host over the board serial are forwarded to the controller with the help of the `HCITransportDriver` while bytes sent by the controller are sent back to the host through the board serial.

This comment has been minimized.

@melwee01

melwee01 Jul 4, 2018

Contributor

Subject-verb disagreement in Runs the whole initialization process then ensure the cordio stack has been properly initialized by the HCI driver.

Is this a statement about what the driver does, or a command that the user must follow?

Passive -> active. Every sentence here could be streamlined by changing from passive to active.

@0xc0170

This comment has been minimized.

Member

0xc0170 commented Jul 4, 2018

Please do not merge until docs gives the thumbs-up. Working on it now.

We always do 👍

@melwee01

This comment has been minimized.

Contributor

melwee01 commented Jul 4, 2018

I was about to thumbs-up your thumbs-up, but was afraid that might be misinterpreted. :)

@melwee01

This comment has been minimized.

Contributor

melwee01 commented Jul 4, 2018

So I'll need to do some pretty heavy restructuring/rewording to the rest of the file so it's compliant with our stylistic guidelines. What's the timeframe on this?

@cmonr

This comment has been minimized.

Contributor

cmonr commented Jul 5, 2018

@pan- Ping. ^^^

@0xc0170

This comment has been minimized.

Member

0xc0170 commented Jul 25, 2018

@MelindaWeed Please update this pull request. Is it ready or still to be done?

@melwee01

This comment has been minimized.

Contributor

melwee01 commented Jul 25, 2018

Partially done. Update has jumped to the top of my list this sprint, sorry.

@cmonr cmonr added needs: work and removed needs: review labels Jul 25, 2018

@cmonr

This comment has been minimized.

Contributor

cmonr commented Aug 9, 2018

@MelindaWeed Your timeframe question was never answered.
The sooner the better, but by the end of the month/by the 5.10 code freeze would be prefereable.

@cmonr cmonr added the needs: review label Aug 13, 2018

@adbridge adbridge added needs: work and removed needs: review labels Aug 15, 2018

@melwee01

This comment has been minimized.

Contributor

melwee01 commented Aug 17, 2018

@pan- How do you feel about the signature line now?

@cmonr cmonr added needs: review and removed needs: work labels Aug 18, 2018

@0xc0170

This comment has been minimized.

Member

0xc0170 commented Aug 20, 2018

@pan- Please review (add those tags back in) and we should be good to go ?

@pan-

This comment has been minimized.

Member

pan- commented Aug 23, 2018

@0xc0170 That's my PR so I github forbid me to approve it. I do approve @MelindaWeed changes.

@0xc0170

This comment has been minimized.

Member

0xc0170 commented Aug 23, 2018

/morph build

@mbed-ci

This comment has been minimized.

mbed-ci commented Aug 23, 2018

Build : SUCCESS

Build number : 2883
Build artifacts/logs : http://mbed-os.s3-website-eu-west-1.amazonaws.com/?prefix=builds/7417/

Triggering tests

/morph test
/morph uvisor-test
/morph export-build
/morph mbed2-build

@cmonr

This comment has been minimized.

Contributor

cmonr commented Aug 23, 2018

Pausing Test CI until 5.9.6 PR is merged.
Will restart CI shortly after.

@mbed-ci

This comment has been minimized.

@cmonr

This comment has been minimized.

Contributor

cmonr commented Aug 24, 2018

@MelindaWeed For reference, since I didn't see anyone clarify what happened with your picture.

You tried to directly push changes to an Mbed OS branch, in which most people don't have access to do (by design, and to the irritation of some).

You then pushed your changes to @pan-'s branch, which you did have access to, and because that branch has an active PR (this PR), your changes magically appeared!

@cmonr

This comment has been minimized.

Contributor

cmonr commented Aug 24, 2018

/morph test

@melwee01

This comment has been minimized.

Contributor

melwee01 commented Aug 24, 2018

Ahhhh, got it. Thanks! Still learning the ins and outs of git, and it finds constant ways to be surprising/frustrating.

@cmonr

This comment has been minimized.

Contributor

cmonr commented Aug 24, 2018

Still learning the ins and outs of git, and it finds constant ways to be surprising/frustrating.

Don't worry. I don't think that ever goes away.

@mbed-ci

This comment has been minimized.

@0xc0170 0xc0170 merged commit 70814d6 into ARMmbed:master Aug 24, 2018

15 checks passed

AWS-CI uVisor Build & Test Success
Details
ci-morph-build build completed
Details
ci-morph-exporter build completed
Details
ci-morph-mbed2-build build completed
Details
ci-morph-test test completed , RTOS ROM(+0.0%) RAM(+0.0%)
Details
continuous-integration/jenkins/pr-head This commit looks good
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
jenkins-ci/cloud_client_smoke_test Test job was successful
Details
travis-ci/astyle Passed, 584 files
Details
travis-ci/docs Local docs testing has passed
Details
travis-ci/events Passed, runtime is 10406 cycles (+116 cycles)
Details
travis-ci/gitattributestest Local gitattributestest testing has passed
Details
travis-ci/licence_check Local licence_check testing has passed
Details
travis-ci/littlefs Passed, code size is 8372B (+0.00%)
Details
travis-ci/tools-py2.7 Local tools-py2.7 testing has passed
Details

pan- pushed a commit to pan-/mbed that referenced this pull request Aug 29, 2018

Merge pull request ARMmbed#7417 from pan-/improve-cordio-hci-doc
Cordio Documentation: Explain how to tests and what tools are available.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment