Received-SPF: pass (google.com: domain of linux-bluetooth-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18;
From:   David Lechner <david@lechnology.com>
To:     linux-bluetooth@vger.kernel.org
Cc:     David Lechner <david@lechnology.com>,
        Miao-chen Chou <mcchou@chromium.org>,
        Archie Pusaka <apusaka@chromium.org>,
        Manish Mandlik <mmandlik@google.com>
Subject: [RESEND PATCH BlueZ] doc/advmon-api: Clarify Patterns property
Date:   Thu, 24 Jun 2021 12:44:01 -0500
Message-Id: <20210624174401.1881338-1-david@lechnology.com>
MIME-Version: 1.0
Content-Transfer-Encoding: 8bit
Precedence: bulk

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

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
-- 
2.25.1