* [PATCH] doc: Fix various typos in D-Bus interface documentation
@ 2025-04-08 10:12 Arkadiusz Bokowy
2025-04-08 11:13 ` bluez.test.bot
2025-04-09 14:20 ` [PATCH] " patchwork-bot+bluetooth
0 siblings, 2 replies; 3+ messages in thread
From: Arkadiusz Bokowy @ 2025-04-08 10:12 UTC (permalink / raw)
To: linux-bluetooth; +Cc: Arkadiusz Bokowy
---
doc/org.bluez.AdvertisementMonitorManager.rst | 6 +++---
doc/org.bluez.Agent.rst | 2 +-
doc/org.bluez.AgentManager.rst | 3 +--
doc/org.bluez.GattCharacteristic.rst | 4 ++--
doc/org.bluez.GattDescriptor.rst | 2 +-
doc/org.bluez.LEAdvertisement.rst | 4 ++--
doc/org.bluez.LEAdvertisingManager.rst | 2 +-
doc/org.bluez.Media.rst | 6 +++---
doc/org.bluez.obex.Agent.rst | 2 +-
doc/org.bluez.obex.AgentManager.rst | 2 +-
doc/org.bluez.obex.FileTransfer.rst | 2 +-
11 files changed, 17 insertions(+), 18 deletions(-)
diff --git a/doc/org.bluez.AdvertisementMonitorManager.rst b/doc/org.bluez.AdvertisementMonitorManager.rst
index 3775a4835..477a0e9e2 100644
--- a/doc/org.bluez.AdvertisementMonitorManager.rst
+++ b/doc/org.bluez.AdvertisementMonitorManager.rst
@@ -14,9 +14,9 @@ BlueZ D-Bus AdvertisementMonitorManager API documentation
Interface
=========
-Service org.bluez
-Interface org.bluez.AdvertisementMonitorManager1 [experimental]
-Object path /org/bluez/{hci0,hci1,...}
+:Service: org.bluez
+:Interface: org.bluez.AdvertisementMonitorManager1 [experimental]
+:Object path: /org/bluez/{hci0,hci1,...}
Methods
-------
diff --git a/doc/org.bluez.Agent.rst b/doc/org.bluez.Agent.rst
index 11d09b94d..6b6d75edb 100644
--- a/doc/org.bluez.Agent.rst
+++ b/doc/org.bluez.Agent.rst
@@ -9,7 +9,7 @@ BlueZ D-Bus Agent API documentation
:Version: BlueZ
:Date: October 2023
:Manual section: 5
-:Manual group: Linux System Administration\x02
+:Manual group: Linux System Administration
Interface
=========
diff --git a/doc/org.bluez.AgentManager.rst b/doc/org.bluez.AgentManager.rst
index dfc0297da..fadadecb1 100644
--- a/doc/org.bluez.AgentManager.rst
+++ b/doc/org.bluez.AgentManager.rst
@@ -9,7 +9,7 @@ BlueZ D-Bus AgentManager API documentation
:Version: BlueZ
:Date: October 2023
:Manual section: 5
-:Manual group: Linux System Administration\x02
+:Manual group: Linux System Administration
Interface
=========
@@ -80,4 +80,3 @@ void RequestDefaultAgent(object agent)
Possible errors:
:org.bluez.Error.DoesNotExist:
-
diff --git a/doc/org.bluez.GattCharacteristic.rst b/doc/org.bluez.GattCharacteristic.rst
index 7b1b3fbb5..bdb3476fb 100644
--- a/doc/org.bluez.GattCharacteristic.rst
+++ b/doc/org.bluez.GattCharacteristic.rst
@@ -50,11 +50,11 @@ array{byte} ReadValue(dict options)
Possible options:
- :uint16_t offset:
+ :uint16 offset:
Read start offset in bytes.
- :uint16_t mtu (server only):
+ :uint16 mtu (server only):
Exchange MTU in bytes.
diff --git a/doc/org.bluez.GattDescriptor.rst b/doc/org.bluez.GattDescriptor.rst
index f4497c6d5..536ef0ca7 100644
--- a/doc/org.bluez.GattDescriptor.rst
+++ b/doc/org.bluez.GattDescriptor.rst
@@ -50,7 +50,7 @@ array{byte} ReadValue(dict flags)
Possible options:
- :uint16_t offset:
+ :uint16 offset:
Read start offset in bytes.
diff --git a/doc/org.bluez.LEAdvertisement.rst b/doc/org.bluez.LEAdvertisement.rst
index bab507439..b998f40a2 100644
--- a/doc/org.bluez.LEAdvertisement.rst
+++ b/doc/org.bluez.LEAdvertisement.rst
@@ -177,13 +177,13 @@ uint16 Appearance [readonly, optional]
Possible values: as found on GAP Service.
-uint16_t Duration [readonly, optional]
+uint16 Duration [readonly, optional]
``````````````````````````````````````
Rotation duration of the advertisement in seconds. If there are other
applications advertising no duration is set the default is 2 seconds.
-uint16_t Timeout [readonly, optional]
+uint16 Timeout [readonly, optional]
`````````````````````````````````````
Timeout of the advertisement in seconds. This defines the lifetime of
diff --git a/doc/org.bluez.LEAdvertisingManager.rst b/doc/org.bluez.LEAdvertisingManager.rst
index 7f6359dff..93eac411a 100644
--- a/doc/org.bluez.LEAdvertisingManager.rst
+++ b/doc/org.bluez.LEAdvertisingManager.rst
@@ -117,7 +117,7 @@ dict SupportedCapabilities [readonly]
Max advertising scan response length
- ;int16 MinTxPower:
+ :int16 MinTxPower:
Min advertising tx power (dBm)
diff --git a/doc/org.bluez.Media.rst b/doc/org.bluez.Media.rst
index 678e6090c..ecd982652 100644
--- a/doc/org.bluez.Media.rst
+++ b/doc/org.bluez.Media.rst
@@ -14,9 +14,9 @@ BlueZ D-Bus Media API documentation
Interface
=========
-:Service: org.bluez
-:Interface: org.bluez.Media1
-:Object path: [variable prefix]/{hci0,hci1,...}
+:Service: org.bluez
+:Interface: org.bluez.Media1
+:Object path: [variable prefix]/{hci0,hci1,...}
Methods
-------
diff --git a/doc/org.bluez.obex.Agent.rst b/doc/org.bluez.obex.Agent.rst
index b832e278c..74e014570 100644
--- a/doc/org.bluez.obex.Agent.rst
+++ b/doc/org.bluez.obex.Agent.rst
@@ -14,7 +14,7 @@ BlueZ D-Bus OBEX Agent API documentation
Interface
=========
-;Service: unique name
+:Service: unique name
:Interface: org.bluez.obex.Agent1
:Object path: freely definable
diff --git a/doc/org.bluez.obex.AgentManager.rst b/doc/org.bluez.obex.AgentManager.rst
index f18f227bc..cdacd4d2f 100644
--- a/doc/org.bluez.obex.AgentManager.rst
+++ b/doc/org.bluez.obex.AgentManager.rst
@@ -19,7 +19,7 @@ Interface
:Object path: /org/bluez/obex
Methods
-```````
+-------
void RegisterAgent(object agent)
````````````````````````````````
diff --git a/doc/org.bluez.obex.FileTransfer.rst b/doc/org.bluez.obex.FileTransfer.rst
index 6dce7e59d..b0a2f8495 100644
--- a/doc/org.bluez.obex.FileTransfer.rst
+++ b/doc/org.bluez.obex.FileTransfer.rst
@@ -141,7 +141,7 @@ void MoveFile(string sourcefile, string targetfile)
Possible errors:
- ;org.bluez.obex.Error.InvalidArguments:
+ :org.bluez.obex.Error.InvalidArguments:
:org.bluez.obex.Error.Failed:
void Delete(string file)
--
2.43.0
^ permalink raw reply related [flat|nested] 3+ messages in thread
* RE: doc: Fix various typos in D-Bus interface documentation
2025-04-08 10:12 [PATCH] doc: Fix various typos in D-Bus interface documentation Arkadiusz Bokowy
@ 2025-04-08 11:13 ` bluez.test.bot
2025-04-09 14:20 ` [PATCH] " patchwork-bot+bluetooth
1 sibling, 0 replies; 3+ messages in thread
From: bluez.test.bot @ 2025-04-08 11:13 UTC (permalink / raw)
To: linux-bluetooth, arkadiusz.bokowy
[-- Attachment #1: Type: text/plain, Size: 1260 bytes --]
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=951032
---Test result---
Test Summary:
CheckPatch PENDING 0.23 seconds
GitLint PENDING 0.20 seconds
BuildEll PASS 20.65 seconds
BluezMake PASS 1522.88 seconds
MakeCheck PASS 13.65 seconds
MakeDistcheck PASS 159.12 seconds
CheckValgrind PASS 215.80 seconds
CheckSmatch PASS 285.45 seconds
bluezmakeextell PASS 98.95 seconds
IncrementalBuild PENDING 0.28 seconds
ScanBuild PASS 881.84 seconds
Details
##############################
Test: CheckPatch - PENDING
Desc: Run checkpatch.pl script
Output:
##############################
Test: GitLint - PENDING
Desc: Run gitlint
Output:
##############################
Test: IncrementalBuild - PENDING
Desc: Incremental build with the patches in the series
Output:
---
Regards,
Linux Bluetooth
^ permalink raw reply [flat|nested] 3+ messages in thread
* Re: [PATCH] doc: Fix various typos in D-Bus interface documentation
2025-04-08 10:12 [PATCH] doc: Fix various typos in D-Bus interface documentation Arkadiusz Bokowy
2025-04-08 11:13 ` bluez.test.bot
@ 2025-04-09 14:20 ` patchwork-bot+bluetooth
1 sibling, 0 replies; 3+ messages in thread
From: patchwork-bot+bluetooth @ 2025-04-09 14:20 UTC (permalink / raw)
To: Arkadiusz Bokowy; +Cc: linux-bluetooth
Hello:
This patch was applied to bluetooth/bluez.git (master)
by Luiz Augusto von Dentz <luiz.von.dentz@intel.com>:
On Tue, 8 Apr 2025 12:12:43 +0200 you wrote:
> ---
> doc/org.bluez.AdvertisementMonitorManager.rst | 6 +++---
> doc/org.bluez.Agent.rst | 2 +-
> doc/org.bluez.AgentManager.rst | 3 +--
> doc/org.bluez.GattCharacteristic.rst | 4 ++--
> doc/org.bluez.GattDescriptor.rst | 2 +-
> doc/org.bluez.LEAdvertisement.rst | 4 ++--
> doc/org.bluez.LEAdvertisingManager.rst | 2 +-
> doc/org.bluez.Media.rst | 6 +++---
> doc/org.bluez.obex.Agent.rst | 2 +-
> doc/org.bluez.obex.AgentManager.rst | 2 +-
> doc/org.bluez.obex.FileTransfer.rst | 2 +-
> 11 files changed, 17 insertions(+), 18 deletions(-)
Here is the summary with links:
- doc: Fix various typos in D-Bus interface documentation
https://git.kernel.org/pub/scm/bluetooth/bluez.git/?id=1288facd5548
You are awesome, thank you!
--
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/patchwork/pwbot.html
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2025-04-09 14:20 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2025-04-08 10:12 [PATCH] doc: Fix various typos in D-Bus interface documentation Arkadiusz Bokowy
2025-04-08 11:13 ` bluez.test.bot
2025-04-09 14:20 ` [PATCH] " patchwork-bot+bluetooth
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox