Received: by 2002:a05:6a10:206:0:0:0:0 with SMTP id 6csp2893001pxj; Mon, 10 May 2021 13:10:40 -0700 (PDT) X-Google-Smtp-Source: ABdhPJzK+ndv4LIw5795xaIN5ehst5no32h7q0WExGbPG+RYXiHDLEMp/1lhLF8UrZjn8G4Ilg3T X-Received: by 2002:a17:907:9620:: with SMTP id gb32mr27218577ejc.331.1620677440047; Mon, 10 May 2021 13:10:40 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1620677440; cv=none; d=google.com; s=arc-20160816; b=pYboxBbZvucLAwTQtU2x68Gc7zgKyg9I5eUgElxKk5Ipc5sEcSGg7r49Zg5j2k9/+W xLYN0HdZWZ9BgYZa78Xx7EhEjE8fYt2XYkVGuckmrMAk+2Uz2yqee2sZWBL7QgeTU3rp LcuyAFPRmoo3h4hD7ZcMaA+awn+fGb2d/dPRC/Nn7ZYTsNUZkw9wlV2GfH607YJV1+ee qzpsyevv8QD8eezdKqQNkhFNgDm0wfRTeupaBfkiQg339hNi8tHzWw6egKwm8NM6Lu58 AWuIKcrI/hY4VRuk5X9jYieTRxkmXyHAUzm2ryCGON7CUJDtGBlL1/4mdf7q58MGGG81 XPHA== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:content-transfer-encoding:mime-version :message-id:date:subject:cc:to:from:dkim-signature; bh=dvgKLP22m5dpQc/XaEo1kCfYFrQgZ0058//D3GBR13Y=; b=F/+yxw4cmQOJI8xtCSYHsr0surMHlZcheI2woFCF7oaSCueR7Ker68c/gQEKgSFaDL fOZLfla4jeHcDdILWyJTYcYlL6gfC90EtWr3swBH5VpvOOcmOBHJt36MltD3/xfF1Yu3 ui4bxMcAE+0iwBVYrNU+lgr3rc4ioo88S1+bBCzBopqErY+/QPbCr87rvVorEkkvwPZu XAqOgxWsPy2hsjvO2bnRsogbKoaCnYFSPYqA3k3evOfPTJR1r/fbchnZVmMveGxVY1Cx LS9SaGMMOwCt9J1WEDPEZCfd33s3J94oqrTPh0LiTmL7yPBn/IaN2HH/MigqOry/Bjho dxIg== ARC-Authentication-Results: i=1; mx.google.com; dkim=fail header.i=@lechnology.com header.s=default header.b=VC1kZ5nO; spf=pass (google.com: domain of linux-bluetooth-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) smtp.mailfrom=linux-bluetooth-owner@vger.kernel.org Return-Path: Received: from vger.kernel.org (vger.kernel.org. [23.128.96.18]) by mx.google.com with ESMTP id y15si13349414ede.450.2021.05.10.13.10.05; Mon, 10 May 2021 13:10:40 -0700 (PDT) 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; Authentication-Results: mx.google.com; dkim=fail header.i=@lechnology.com header.s=default header.b=VC1kZ5nO; spf=pass (google.com: domain of linux-bluetooth-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) smtp.mailfrom=linux-bluetooth-owner@vger.kernel.org Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S229946AbhEJUJ5 (ORCPT + 99 others); Mon, 10 May 2021 16:09:57 -0400 Received: from vern.gendns.com ([98.142.107.122]:40574 "EHLO vern.gendns.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229566AbhEJUJ5 (ORCPT ); Mon, 10 May 2021 16:09:57 -0400 X-Greylist: delayed 1265 seconds by postgrey-1.27 at vger.kernel.org; Mon, 10 May 2021 16:09:57 EDT DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=lechnology.com; s=default; h=Content-Transfer-Encoding:MIME-Version: Message-Id:Date:Subject:Cc:To:From:Sender:Reply-To:Content-Type:Content-ID: Content-Description:Resent-Date:Resent-From:Resent-Sender:Resent-To:Resent-Cc :Resent-Message-ID:In-Reply-To:References:List-Id:List-Help:List-Unsubscribe: List-Subscribe:List-Post:List-Owner:List-Archive; bh=dvgKLP22m5dpQc/XaEo1kCfYFrQgZ0058//D3GBR13Y=; b=VC1kZ5nOKvBFGHsVgk7G3GcyjA aWVwexgYmOjftneo+mom4qg7MYeP3vivYtiKIxwohfa5TjJY+6HOI7SGMaSWp15+WryzHxD7MsAIv SJE5CiKTBYZU4OiIBhedRzDYQ+gHnGRjg3r4PT1SNyLMIZQwRrQBfyjZIiozxbWkP7hfDBlILrjUZ NiBoNWfj2hU18Imz3aErEikIE+MOBvZwN5AjaKCdfgJlbBd+2l1UR3DL7mCGeecTdqnHK8OKdEaQJ sKIGM69gOo8Fj0iSS9zhTFr41asB0266PL3aDnOJYPbVa1k5Z55+oqy6c2YgucVjdU1+jMILr7be5 5qEssZKA==; Received: from 108-198-5-147.lightspeed.okcbok.sbcglobal.net ([108.198.5.147]:35776 helo=freyr.lechnology.com) by vern.gendns.com with esmtpsa (TLS1.2) tls TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 (Exim 4.94.2) (envelope-from ) id 1lgBsT-0007G2-F8; Mon, 10 May 2021 15:47:44 -0400 From: David Lechner To: linux-bluetooth@vger.kernel.org Cc: David Lechner , Miao-chen Chou , Archie Pusaka , Manish Mandlik Subject: [PATCH BlueZ] doc/advmon-api: Clarify Patterns property Date: Mon, 10 May 2021 14:47:07 -0500 Message-Id: <20210510194707.300130-1-david@lechnology.com> X-Mailer: git-send-email 2.25.1 MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-AntiAbuse: This header was added to track abuse, please include it with any abuse report X-AntiAbuse: Primary Hostname - vern.gendns.com X-AntiAbuse: Original Domain - vger.kernel.org X-AntiAbuse: Originator/Caller UID/GID - [47 12] / [47 12] X-AntiAbuse: Sender Address Domain - lechnology.com X-Get-Message-Sender-Via: vern.gendns.com: authenticated_id: davidmain+lechnology.com/only user confirmed/virtual account not confirmed X-Authenticated-Sender: vern.gendns.com: davidmain@lechnology.com X-Source: X-Source-Args: X-Source-Dir: Precedence: bulk List-ID: X-Mailing-List: linux-bluetooth@vger.kernel.org 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(-) 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