[BlueZ] doc/advmon-api: Clarify Patterns property

Commit Message

David Lechner May 10, 2021, 7:47 p.m. UTC

The Patterns property description was not as clear as it could be. This
expands the text a bit, replaces the C enum value 0x01 with the D-Bus
property string value "or_patterns" and improves the grammar in a few
places.
---

Related question: How can we create an advertisement monitor with no filter?
Currently, "or_patterns" is the only Type and therefore a pattern is required.


 doc/advertisement-monitor-api.txt | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)

Comments

[e-mail] May 10, 2021, 8:39 p.m. UTC | #1

This is automated email and please do not reply to this email!

Dear submitter,

Thank you for submitting the patches to the linux bluetooth mailing list.
This is a CI test results with your patch series:
PW Link:https://patchwork.kernel.org/project/bluetooth/list/?series=479785

---Test result---

Test Summary:
CheckPatch                    PASS      0.46 seconds
GitLint                       PASS      0.12 seconds
Prep - Setup ELL              PASS      41.25 seconds
Build - Prep                  PASS      0.10 seconds
Build - Configure             PASS      7.20 seconds
Build - Make                  PASS      175.64 seconds
Make Check                    PASS      8.46 seconds
Make Dist                     PASS      11.50 seconds
Make Dist - Configure         PASS      4.49 seconds
Make Dist - Make              PASS      70.64 seconds
Build w/ext ELL - Configure   PASS      7.21 seconds
Build w/ext ELL - Make        PASS      165.05 seconds

Details
##############################
Test: CheckPatch - PASS
Desc: Run checkpatch.pl script with rule in .checkpatch.conf

##############################
Test: GitLint - PASS
Desc: Run gitlint with rule in .gitlint

##############################
Test: Prep - Setup ELL - PASS
Desc: Clone, build, and install ELL

##############################
Test: Build - Prep - PASS
Desc: Prepare environment for build

##############################
Test: Build - Configure - PASS
Desc: Configure the BlueZ source tree

##############################
Test: Build - Make - PASS
Desc: Build the BlueZ source tree

##############################
Test: Make Check - PASS
Desc: Run 'make check'

##############################
Test: Make Dist - PASS
Desc: Run 'make dist' and build the distribution tarball

##############################
Test: Make Dist - Configure - PASS
Desc: Configure the source from distribution tarball

##############################
Test: Make Dist - Make - PASS
Desc: Build the source from distribution tarball

##############################
Test: Build w/ext ELL - Configure - PASS
Desc: Configure BlueZ source with '--enable-external-ell' configuration

##############################
Test: Build w/ext ELL - Make - PASS
Desc: Build BlueZ source with '--enable-external-ell' configuration



---
Regards,
Linux Bluetooth

Patch

diff --git a/doc/advertisement-monitor-api.txt b/doc/advertisement-monitor-api.txt
index 8100717c0..9189f2cce 100644
--- a/doc/advertisement-monitor-api.txt
+++ b/doc/advertisement-monitor-api.txt
@@ -105,10 +105,11 @@  Properties	string Type [read-only]
 
 		array{(uint8, uint8, array{byte})} Patterns [read-only, optional]
 
-			If Type is set to 0x01, this must exist and has at least
-			one entry in the array.
+			If the Type property is set to "or_patterns", then this
+			property must exist and have at least one entry in the
+			array.
 
-			The structure of a pattern contains the following.
+			The structure of a pattern contains the following:
 			uint8 start_position
 				The index in an AD data field where the search
 				should start. The beginning of an AD data field