[v1] Doc: Obex Implement support for message listing format version 1.1

Commit Message

Amisha Jain Dec. 20, 2024, 12:59 p.m. UTC

Add the documentation for the ‘Messages-Listing Format Version 1.1’
feature for MCE.

---
 doc/org.bluez.obex.Message.rst | 39 ++++++++++++++++++++++++++++++++++
 1 file changed, 39 insertions(+)

Comments

[e-mail] Dec. 20, 2024, 2:23 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=919894

---Test result---

Test Summary:
CheckPatch                    PENDING   0.18 seconds
GitLint                       PENDING   0.38 seconds
BuildEll                      PASS      20.61 seconds
BluezMake                     FAIL      97.55 seconds
MakeCheck                     FAIL      1999.94 seconds
MakeDistcheck                 FAIL      12.30 seconds
CheckValgrind                 FAIL      70.60 seconds
CheckSmatch                   FAIL      155.16 seconds
bluezmakeextell               FAIL      73.81 seconds
IncrementalBuild              PENDING   0.24 seconds
ScanBuild                     PASS      844.68 seconds

Details
##############################
Test: CheckPatch - PENDING
Desc: Run checkpatch.pl script
Output:

##############################
Test: GitLint - PENDING
Desc: Run gitlint
Output:

##############################
Test: BluezMake - FAIL
Desc: Build BlueZ
Output:

tools/mgmt-tester.c: In function ‘main’:
tools/mgmt-tester.c:12893:5: note: variable tracking size limit exceeded with ‘-fvar-tracking-assignments’, retrying without
12893 | int main(int argc, char *argv[])
      |     ^~~~
doc/org.bluez.obex.Message.rst:159: (WARNING/2) Title underline too short.

string ConversationName [readonly]
````````````````````````````````
Exiting due to level-2 (WARNING) system message.
make[1]: *** [Makefile:13951: doc/org.bluez.obex.Message.5] Error 1
make[1]: *** Waiting for unfinished jobs....
make: *** [Makefile:4695: all] Error 2
##############################
Test: MakeCheck - FAIL
Desc: Run Bluez Make Check
Output:

unit/test-avdtp.c: In function ‘main’:
unit/test-avdtp.c:766:5: note: variable tracking size limit exceeded with ‘-fvar-tracking-assignments’, retrying without
  766 | int main(int argc, char *argv[])
      |     ^~~~
unit/test-avrcp.c: In function ‘main’:
unit/test-avrcp.c:989:5: note: variable tracking size limit exceeded with ‘-fvar-tracking-assignments’, retrying without
  989 | int main(int argc, char *argv[])
      |     ^~~~
doc/org.bluez.obex.Message.rst:159: (WARNING/2) Title underline too short.

string ConversationName [readonly]
````````````````````````````````
Exiting due to level-2 (WARNING) system message.
make[1]: *** [Makefile:13951: doc/org.bluez.obex.Message.5] Error 1
make: *** [Makefile:12363: check] Error 2
##############################
Test: MakeDistcheck - FAIL
Desc: Run Bluez Make Distcheck
Output:

doc/org.bluez.obex.Message.rst:159: (WARNING/2) Title underline too short.

string ConversationName [readonly]
````````````````````````````````
Exiting due to level-2 (WARNING) system message.
make[2]: *** [Makefile:13951: doc/org.bluez.obex.Message.5] Error 1
make[2]: *** Waiting for unfinished jobs....
make[1]: *** [Makefile:12196: distdir] Error 2
make: *** [Makefile:12272: dist] Error 2
##############################
Test: CheckValgrind - FAIL
Desc: Run Bluez Make Check with Valgrind
Output:

tools/mgmt-tester.c: In function ‘main’:
tools/mgmt-tester.c:12893:5: note: variable tracking size limit exceeded with ‘-fvar-tracking-assignments’, retrying without
12893 | int main(int argc, char *argv[])
      |     ^~~~
doc/org.bluez.obex.Message.rst:159: (WARNING/2) Title underline too short.

string ConversationName [readonly]
````````````````````````````````
Exiting due to level-2 (WARNING) system message.
make[1]: *** [Makefile:13951: doc/org.bluez.obex.Message.5] Error 1
make[1]: *** Waiting for unfinished jobs....
make: *** [Makefile:12363: check] Error 2
##############################
Test: CheckSmatch - FAIL
Desc: Run smatch tool with source
Output:

src/shared/crypto.c:271:21: warning: Variable length array is used.
src/shared/crypto.c:272:23: warning: Variable length array is used.
src/shared/gatt-helpers.c:768:31: warning: Variable length array is used.
src/shared/gatt-helpers.c:830:31: warning: Variable length array is used.
src/shared/gatt-helpers.c:1323:31: warning: Variable length array is used.
src/shared/gatt-helpers.c:1354:23: warning: Variable length array is used.
src/shared/gatt-server.c:278:25: warning: Variable length array is used.
src/shared/gatt-server.c:618:25: warning: Variable length array is used.
src/shared/gatt-server.c:716:25: warning: Variable length array is used.
src/shared/bap.c:296:25: warning: array of flexible structures
src/shared/bap.c: note: in included file:
./src/shared/ascs.h:88:25: warning: array of flexible structures
src/shared/shell.c: note: in included file (through /usr/include/readline/readline.h):
/usr/include/readline/rltypedefs.h:35:23: warning: non-ANSI function declaration of function 'Function'
/usr/include/readline/rltypedefs.h:36:25: warning: non-ANSI function declaration of function 'VFunction'
/usr/include/readline/rltypedefs.h:37:27: warning: non-ANSI function declaration of function 'CPFunction'
/usr/include/readline/rltypedefs.h:38:29: warning: non-ANSI function declaration of function 'CPPFunction'
src/shared/crypto.c:271:21: warning: Variable length array is used.
src/shared/crypto.c:272:23: warning: Variable length array is used.
src/shared/gatt-helpers.c:768:31: warning: Variable length array is used.
src/shared/gatt-helpers.c:830:31: warning: Variable length array is used.
src/shared/gatt-helpers.c:1323:31: warning: Variable length array is used.
src/shared/gatt-helpers.c:1354:23: warning: Variable length array is used.
src/shared/gatt-server.c:278:25: warning: Variable length array is used.
src/shared/gatt-server.c:618:25: warning: Variable length array is used.
src/shared/gatt-server.c:716:25: warning: Variable length array is used.
src/shared/bap.c:296:25: warning: array of flexible structures
src/shared/bap.c: note: in included file:
./src/shared/ascs.h:88:25: warning: array of flexible structures
src/shared/shell.c: note: in included file (through /usr/include/readline/readline.h):
/usr/include/readline/rltypedefs.h:35:23: warning: non-ANSI function declaration of function 'Function'
/usr/include/readline/rltypedefs.h:36:25: warning: non-ANSI function declaration of function 'VFunction'
/usr/include/readline/rltypedefs.h:37:27: warning: non-ANSI function declaration of function 'CPFunction'
/usr/include/readline/rltypedefs.h:38:29: warning: non-ANSI function declaration of function 'CPPFunction'
tools/mesh-cfgtest.c:1453:17: warning: unknown escape sequence: '\%'
tools/sco-tester.c: note: in included file:
./lib/bluetooth.h:232:15: warning: array of flexible structures
./lib/bluetooth.h:237:31: warning: array of flexible structures
tools/bneptest.c:634:39: warning: unknown escape sequence: '\%'
tools/seq2bseq.c:57:26: warning: Variable length array is used.
tools/obex-client-tool.c: note: in included file (through /usr/include/readline/readline.h):
/usr/include/readline/rltypedefs.h:35:23: warning: non-ANSI function declaration of function 'Function'
/usr/include/readline/rltypedefs.h:36:25: warning: non-ANSI function declaration of function 'VFunction'
/usr/include/readline/rltypedefs.h:37:27: warning: non-ANSI function declaration of function 'CPFunction'
/usr/include/readline/rltypedefs.h:38:29: warning: non-ANSI function declaration of function 'CPPFunction'
android/avctp.c:505:34: warning: Variable length array is used.
android/avctp.c:556:34: warning: Variable length array is used.
unit/test-avrcp.c:373:26: warning: Variable length array is used.
unit/test-avrcp.c:398:26: warning: Variable length array is used.
unit/test-avrcp.c:414:24: warning: Variable length array is used.
android/avrcp-lib.c:1085:34: warning: Variable length array is used.
android/avrcp-lib.c:1583:34: warning: Variable length array is used.
android/avrcp-lib.c:1612:34: warning: Variable length array is used.
android/avrcp-lib.c:1638:34: warning: Variable length array is used.
mesh/mesh-io-mgmt.c:523:67: warning: Variable length array is used.
doc/org.bluez.obex.Message.rst:159: (WARNING/2) Title underline too short.

string ConversationName [readonly]
````````````````````````````````
Exiting due to level-2 (WARNING) system message.
make[1]: *** [Makefile:13951: doc/org.bluez.obex.Message.5] Error 1
make[1]: *** Waiting for unfinished jobs....
make: *** [Makefile:4695: all] Error 2
##############################
Test: bluezmakeextell - FAIL
Desc: Build Bluez with External ELL
Output:

doc/org.bluez.obex.Message.rst:159: (WARNING/2) Title underline too short.

string ConversationName [readonly]
````````````````````````````````
Exiting due to level-2 (WARNING) system message.
make[1]: *** [Makefile:13951: doc/org.bluez.obex.Message.5] Error 1
make[1]: *** Waiting for unfinished jobs....
make: *** [Makefile:4695: all] Error 2
##############################
Test: IncrementalBuild - PENDING
Desc: Incremental build with the patches in the series
Output:



---
Regards,
Linux Bluetooth

Luiz Augusto von Dentz Dec. 20, 2024, 3 p.m. UTC | #2

Hi Amisha,

On Fri, Dec 20, 2024 at 7:59 AM Amisha Jain <[e-mail]> wrote:
>
> Add the documentation for the ‘Messages-Listing Format Version 1.1’
> feature for MCE.
>
> ---
>  doc/org.bluez.obex.Message.rst | 39 ++++++++++++++++++++++++++++++++++
>  1 file changed, 39 insertions(+)
>
> diff --git a/doc/org.bluez.obex.Message.rst b/doc/org.bluez.obex.Message.rst
> index 082f87271..260445970 100644
> --- a/doc/org.bluez.obex.Message.rst
> +++ b/doc/org.bluez.obex.Message.rst
> @@ -137,3 +137,42 @@ boolean Protected [readonly]
>  ````````````````````````````
>
>         Message protected flag
> +
> +string DeliveryStatus [readonly]
> +````````````````````````````````

This probably needs to be marked as optional since not all protocols
may have a delivery status, also I don't think you have marked the
entire label with '`' so rst2man will probably fail to parse it.

> +
> +       Message delivery status
> +
> +       Possible values:
> +
> +       :"delivered":
> +       :"sent":
> +       :"unknown":
> +
> +uint64 ConversationId [readonly]
> +````````````````````````````````
> +
> +       Message conversation id
> +       Identification of the conversation

This is a server side ID, is it unique or per folder?

> +
> +string ConversationName [readonly]
> +````````````````````````````````
> +
> +       Human readable name of the conversation
> +
> +string Direction [readonly]
> +````````````````````````````````
> +
> +       Indicate the direction of the message
> +
> +       Possible values:
> +
> +       :"incoming":
> +       :"outgoing":
> +       :"outgoingdraft":
> +       :"outgoingpending":

The last 2 I would just enumerate as "draft" and "pending".

> +
> +string AttachmentMimeTypes [readonly]
> +````````````````````````````````
> +
> +       MIME type of the attachment
> \ No newline at end of file
> --
> 2.34.1
>
>

Patch

diff --git a/doc/org.bluez.obex.Message.rst b/doc/org.bluez.obex.Message.rst
index 082f87271..260445970 100644
--- a/doc/org.bluez.obex.Message.rst
+++ b/doc/org.bluez.obex.Message.rst
@@ -137,3 +137,42 @@  boolean Protected [readonly]
 ````````````````````````````
 
 	Message protected flag
+
+string DeliveryStatus [readonly]
+````````````````````````````````
+
+	Message delivery status
+
+	Possible values:
+
+	:"delivered":
+	:"sent":
+	:"unknown":
+
+uint64 ConversationId [readonly]
+````````````````````````````````
+
+	Message conversation id
+	Identification of the conversation
+
+string ConversationName [readonly]
+````````````````````````````````
+
+	Human readable name of the conversation
+
+string Direction [readonly]
+````````````````````````````````
+
+	Indicate the direction of the message
+
+	Possible values:
+
+	:"incoming":
+	:"outgoing":
+	:"outgoingdraft":
+	:"outgoingpending":
+
+string AttachmentMimeTypes [readonly]
+````````````````````````````````
+
+	MIME type of the attachment
\ No newline at end of file