diff mbox series

[BlueZ,v3,1/2] doc/ccpTest: Add document support for CCP test interface

Message ID 20240509125855.2585411-1-ajay.k.v@intel.com (mailing list archive)
State Superseded
Headers show
Series [BlueZ,v3,1/2] doc/ccpTest: Add document support for CCP test interface | expand

Checks

Context Check Description
tedd_an/pre-ci_am success Success
tedd_an/CheckPatch success CheckPatch PASS
tedd_an/GitLint success Gitlint PASS
tedd_an/BuildEll success Build ELL PASS
tedd_an/BluezMake success Bluez Make PASS
tedd_an/MakeCheck success Bluez Make Check PASS
tedd_an/MakeDistcheck fail Make Distcheck FAIL: Package cups was not found in the pkg-config search path. Perhaps you should add the directory containing `cups.pc' to the PKG_CONFIG_PATH environment variable No package 'cups' found make[2]: *** No rule to make target 'doc/org.bluez.CcpTest.5', needed by 'all-am'. Stop. make[2]: *** Waiting for unfinished jobs.... make[1]: *** [Makefile:4657: all] Error 2 make: *** [Makefile:12116: distcheck] Error 1
tedd_an/CheckValgrind success Check Valgrind PASS
tedd_an/CheckSmatch success CheckSparse PASS
tedd_an/bluezmakeextell success Make External ELL PASS
tedd_an/ScanBuild fail Setup failed

Commit Message

Ajay KV May 9, 2024, 12:58 p.m. UTC 
call control profile interface has been documented with
man page added.
---
 Makefile.am               |  3 +-
 doc/org.bluez.CcpTest.5   | 82 +++++++++++++++++++++++++++++++++++++++
 doc/org.bluez.CcpTest.rst | 50 ++++++++++++++++++++++++
 3 files changed, 134 insertions(+), 1 deletion(-)
 create mode 100644 doc/org.bluez.CcpTest.5
 create mode 100644 doc/org.bluez.CcpTest.rst

Comments

bluez.test.bot@gmail.com May 9, 2024, 8:59 a.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=851799

---Test result---

Test Summary:
CheckPatch                    PASS      1.13 seconds
GitLint                       PASS      0.66 seconds
BuildEll                      PASS      24.45 seconds
BluezMake                     PASS      1666.92 seconds
MakeCheck                     PASS      13.89 seconds
MakeDistcheck                 FAIL      73.95 seconds
CheckValgrind                 PASS      245.74 seconds
CheckSmatch                   PASS      349.71 seconds
bluezmakeextell               PASS      118.98 seconds
IncrementalBuild              FAIL      0.07 seconds
ScanBuild                     FAIL      0.20 seconds

Details
##############################
Test: MakeDistcheck - FAIL
Desc: Run Bluez Make Distcheck
Output:

Package cups was not found in the pkg-config search path.
Perhaps you should add the directory containing `cups.pc'
to the PKG_CONFIG_PATH environment variable
No package 'cups' found
make[2]: *** No rule to make target 'doc/org.bluez.CcpTest.5', needed by 'all-am'.  Stop.
make[2]: *** Waiting for unfinished jobs....
make[1]: *** [Makefile:4657: all] Error 2
make: *** [Makefile:12116: distcheck] Error 1
##############################
Test: IncrementalBuild - FAIL
Desc: Incremental build with the patches in the series
Output:

error: Your local changes to the following files would be overwritten by checkout:
	doc/org.bluez.CcpTest.5
Please commit your changes or stash them before you switch branches.
Aborting
##############################
Test: ScanBuild - FAIL
Desc: Run Scan Build
Output:
Setup failed


---
Regards,
Linux Bluetooth
diff mbox series

Patch

diff --git a/Makefile.am b/Makefile.am
index 05d02932f205..2c44fb52c78b 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -377,7 +377,8 @@  man_MANS += doc/org.bluez.obex.Client.5 doc/org.bluez.obex.Session.5 \
 		doc/org.bluez.obex.PhonebookAccess.5 \
 		doc/org.bluez.obex.MessageAccess.5 \
 		doc/org.bluez.obex.Message.5 \
-		doc/org.bluez.obex.AgentManager.5 doc/org.bluez.obex.Agent.5
+		doc/org.bluez.obex.AgentManager.5 doc/org.bluez.obex.Agent.5 \
+		doc/org.bluez.CcpTest.5
 endif
 manual_pages += src/bluetoothd.8
 manual_pages += doc/org.bluez.Adapter.5 doc/org.bluez.Device.5 \
diff --git a/doc/org.bluez.CcpTest.5 b/doc/org.bluez.CcpTest.5
new file mode 100644
index 000000000000..b16097d08270
--- /dev/null
+++ b/doc/org.bluez.CcpTest.5
@@ -0,0 +1,82 @@ 
+.\" Man page generated from reStructuredText.
+.
+.
+.nr rst2man-indent-level 0
+.
+.de1 rstReportMargin
+\\$1 \\n[an-margin]
+level \\n[rst2man-indent-level]
+level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
+-
+\\n[rst2man-indent0]
+\\n[rst2man-indent1]
+\\n[rst2man-indent2]
+..
+.de1 INDENT
+.\" .rstReportMargin pre:
+. RS \\$1
+. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
+. nr rst2man-indent-level +1
+.\" .rstReportMargin post:
+..
+.de UNINDENT
+. RE
+.\" indent \\n[an-margin]
+.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.nr rst2man-indent-level -1
+.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
+..
+.TH "ORG.BLUEZ.CCPTEST" 5 "May 2024" "BlueZ" "Linux System Administration"
+.SH NAME
+org.bluez.CCPTest \- BlueZ D-Bus CCPTest API documentation
+.SH INTERFACE
+.INDENT 0.0
+.TP
+.B Service
+org.bluez
+.TP
+.B Interface
+org.bluez.CCPTest1
+.TP
+.B Object path
+[variable prefix]/{hci0,hci1,...}/dev_XX_XX_XX_XX_XX_XX/CallerX
+.UNINDENT
+.SS Methods
+.SS void Answer()
+.INDENT 0.0
+.INDENT 3.5
+This method can be called to answer an incoming call in progress.
+.sp
+Possible errors:
+.INDENT 0.0
+.TP
+.B org.bluez.Error.Failed
+.TP
+.B org.bluez.Error.NotConnected
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.SS void Reject()
+.INDENT 0.0
+.INDENT 3.5
+This Method can be called to reject a call, which can be an active call or a call on hold state.
+.sp
+Possible errors:
+.INDENT 0.0
+.TP
+.B org.bluez.Error.Failed
+.TP
+.B org.bluez.Error.NotConnected
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.SS Properties
+.SS uint32 CallState [readonly]
+.INDENT 0.0
+.INDENT 3.5
+call index defined by CCP profile to denote the active call.
+.UNINDENT
+.UNINDENT
+.\" Generated by docutils manpage writer.
+.
diff --git a/doc/org.bluez.CcpTest.rst b/doc/org.bluez.CcpTest.rst
new file mode 100644
index 000000000000..79ead19ad538
--- /dev/null
+++ b/doc/org.bluez.CcpTest.rst
@@ -0,0 +1,50 @@ 
+=================
+org.bluez.CCPTest
+=================
+
+-------------------------------------
+BlueZ D-Bus CCPTest API documentation
+-------------------------------------
+
+:Version: BlueZ
+:Date: May 2024
+:Manual section: 5
+:Manual group: Linux System Administration
+
+Interface
+=========
+
+:Service:	org.bluez
+:Interface:	org.bluez.CCPTest1
+:Object path:	[variable prefix]/{hci0,hci1,...}/dev_XX_XX_XX_XX_XX_XX/CallerX
+
+Methods
+-------
+
+void Answer()
+``````````````
+
+	This method can be called to answer an incoming call in progress.
+
+	Possible errors:
+
+	:org.bluez.Error.Failed:
+	:org.bluez.Error.NotConnected:
+
+void Reject()
+`````````````````
+
+	This Method can be called to reject a call, which can be an active call or a call on hold state.
+
+	Possible errors:
+
+	:org.bluez.Error.Failed:
+	:org.bluez.Error.NotConnected:
+
+Properties
+----------
+
+uint32 CallState [readonly]
+```````````````````````````
+
+	call index defined by CCP profile to denote the active call.