[BlueZ 0/2] Documentation fixups

[BlueZ 0/2] Documentation fixups

[Bastien Nocera]

Some documentation fixups after "Port text docs to RST and move man
pages" got merged.

Bastien Nocera (2):
  doc: Add "C" code-block markers for coding-style doc
  doc: Update .gitignore for new daemon man page locations

 .gitignore           |  4 ++--
 doc/coding-style.rst | 46 ++++++++++++++++++++++----------------------
 2 files changed, 25 insertions(+), 25 deletions(-)

-- 
2.52.0

[BlueZ 1/2] doc: Add "C" code-block markers for coding-style doc

[Bastien Nocera]

The file isn't processed by rst2man, so this doesn't add a new
dependency as was the case in 0ea4e4d52c55 ("doc: Remove Pygments
dependency from manpage").
---
 doc/coding-style.rst | 46 ++++++++++++++++++++++----------------------
 1 file changed, 23 insertions(+), 23 deletions(-)

diff --git a/doc/coding-style.rst b/doc/coding-style.rst
index 585d14fd86d9..91250e867f09 100644
--- a/doc/coding-style.rst
+++ b/doc/coding-style.rst
@@ -30,14 +30,14 @@ not preceded by an expression or variable declaration.
 Example:
 1)
 
-.. code-block::
+.. code-block:: C
 
         a = 1;
         if (b) {  // wrong
 
 2)
 
-.. code-block::
+.. code-block:: C
 
         a = 1
 
@@ -47,14 +47,14 @@ Example:
 
 3)
 
-.. code-block::
+.. code-block:: C
 
         if (a) {
 	        if (b)  // correct
 
 4)
 
-.. code-block::
+.. code-block:: C
 
         b = 2;
 
@@ -67,7 +67,7 @@ Example:
 The only exception to this rule applies when a variable is being checked for
 errors as such:
 
-.. code-block::
+.. code-block:: C
 
         err = stat(filename, &st);
         if (err || !S_ISDIR(st.st_mode))
@@ -80,7 +80,7 @@ If your comment has more than one line, please start it from the second line.
 
 Example:
 
-.. code-block::
+.. code-block:: C
 
         /*
          * first line comment	// correct
@@ -95,7 +95,7 @@ There should be a space before and after each operator.
 
 Example:
 
-.. code-block::
+.. code-block:: C
 
         a + b;  // correct
 
@@ -110,28 +110,28 @@ body.
 Example:
 1)
 
-.. code-block::
+.. code-block:: C
 
         if ((adapter->supported_settings & MGMT_SETTING_SSP) &&
         	!(adapter->current_settings & MGMT_SETTING_SSP)) // wrong
 
 2)
 
-.. code-block::
+.. code-block:: C
 
         if ((adapter->supported_settings & MGMT_SETTING_SSP) &&
 	        			!(adapter->current_settings & MGMT_SETTING_SSP))
 
 3)
 
-.. code-block::
+.. code-block:: C
 
         void btd_adapter_register_pin_cb(struct btd_adapter *adapter,
 	        			 btd_adapter_pin_cb_t cb) // wrong
 
 4)
 
-.. code-block::
+.. code-block:: C
 
         void btd_adapter_register_pin_cb(struct btd_adapter *adapter,
 	        						btd_adapter_pin_cb_t cb)
@@ -147,13 +147,13 @@ There should be a space between new type and variable.
 Example:
 1)
 
-.. code-block::
+.. code-block:: C
 
         a = (int *)b;  // wrong
 
 2)
 
-.. code-block::
+.. code-block:: C
 
         a = (int *) b;  // correct
 
@@ -165,7 +165,7 @@ When declaring a variable, try not to initialize it unless necessary.
 
 Example:
 
-.. code-block::
+.. code-block:: C
 
         int i = 1;  // wrong
 
@@ -200,7 +200,7 @@ prefixed by the ``enum`` type name.
 
 Example:
 
-.. code-block::
+.. code-block:: C
 
         enum animal_type {
         	ANIMAL_TYPE_FOUR_LEGS,
@@ -211,7 +211,7 @@ Example:
 If the enum contents have values (e.g. from specification) the formatting
 should be as follows:
 
-.. code-block::
+.. code-block:: C
 
         enum animal_type {
         	ANIMAL_TYPE_FOUR_LEGS =		4,
@@ -230,7 +230,7 @@ compiler will complain the new added type hasn't been handled.
 
 Example:
 
-.. code-block::
+.. code-block:: C
 
         enum animal_type {
         	ANIMAL_TYPE_FOUR_LEGS =		4,
@@ -278,13 +278,13 @@ parenthesis, too.
 Example:
 1)
 
-.. code-block::
+.. code-block:: C
 
         memset(stuff, 0, sizeof(*stuff));
 
 2)
 
-.. code-block::
+.. code-block:: C
 
         memset(stuff, 0, sizeof *stuff); // Wrong
 
@@ -296,7 +296,7 @@ A function with no parameters must use ``void`` in the parameter list.
 Example:
 1)
 
-.. code-block::
+.. code-block:: C
 
         void foo(void)
         {
@@ -304,7 +304,7 @@ Example:
 
 2)
 
-.. code-block::
+.. code-block:: C
 
         void foo()	// Wrong
         {
@@ -321,7 +321,7 @@ Example:
 
 1)
 
-.. code-block::
+.. code-block:: C
 
         if (device) {  // worse
         	memset(&eir_data, 0, sizeof(eir_data));
@@ -335,7 +335,7 @@ Example:
 
 2)
 
-.. code-block::
+.. code-block:: C
 
         if (!device) {
         	error("Unable to get device object for %s", addr);
-- 
2.52.0

Re: [BlueZ 1/2] doc: Add "C" code-block markers for coding-style doc

[Luiz Augusto von Dentz]

Hi Bastien,

On Thu, Jan 22, 2026 at 1:01 PM Bastien Nocera <hadess@hadess.net> wrote:
>
> The file isn't processed by rst2man, so this doesn't add a new
> dependency as was the case in 0ea4e4d52c55 ("doc: Remove Pygments
> dependency from manpage").

I'd leave this for later, when we actually add the dependency to deal
with language specific blocks.

> ---
>  doc/coding-style.rst | 46 ++++++++++++++++++++++----------------------
>  1 file changed, 23 insertions(+), 23 deletions(-)
>
> diff --git a/doc/coding-style.rst b/doc/coding-style.rst
> index 585d14fd86d9..91250e867f09 100644
> --- a/doc/coding-style.rst
> +++ b/doc/coding-style.rst
> @@ -30,14 +30,14 @@ not preceded by an expression or variable declaration.
>  Example:
>  1)
>
> -.. code-block::
> +.. code-block:: C
>
>          a = 1;
>          if (b) {  // wrong
>
>  2)
>
> -.. code-block::
> +.. code-block:: C
>
>          a = 1
>
> @@ -47,14 +47,14 @@ Example:
>
>  3)
>
> -.. code-block::
> +.. code-block:: C
>
>          if (a) {
>                 if (b)  // correct
>
>  4)
>
> -.. code-block::
> +.. code-block:: C
>
>          b = 2;
>
> @@ -67,7 +67,7 @@ Example:
>  The only exception to this rule applies when a variable is being checked for
>  errors as such:
>
> -.. code-block::
> +.. code-block:: C
>
>          err = stat(filename, &st);
>          if (err || !S_ISDIR(st.st_mode))
> @@ -80,7 +80,7 @@ If your comment has more than one line, please start it from the second line.
>
>  Example:
>
> -.. code-block::
> +.. code-block:: C
>
>          /*
>           * first line comment  // correct
> @@ -95,7 +95,7 @@ There should be a space before and after each operator.
>
>  Example:
>
> -.. code-block::
> +.. code-block:: C
>
>          a + b;  // correct
>
> @@ -110,28 +110,28 @@ body.
>  Example:
>  1)
>
> -.. code-block::
> +.. code-block:: C
>
>          if ((adapter->supported_settings & MGMT_SETTING_SSP) &&
>                 !(adapter->current_settings & MGMT_SETTING_SSP)) // wrong
>
>  2)
>
> -.. code-block::
> +.. code-block:: C
>
>          if ((adapter->supported_settings & MGMT_SETTING_SSP) &&
>                                         !(adapter->current_settings & MGMT_SETTING_SSP))
>
>  3)
>
> -.. code-block::
> +.. code-block:: C
>
>          void btd_adapter_register_pin_cb(struct btd_adapter *adapter,
>                                          btd_adapter_pin_cb_t cb) // wrong
>
>  4)
>
> -.. code-block::
> +.. code-block:: C
>
>          void btd_adapter_register_pin_cb(struct btd_adapter *adapter,
>                                                                 btd_adapter_pin_cb_t cb)
> @@ -147,13 +147,13 @@ There should be a space between new type and variable.
>  Example:
>  1)
>
> -.. code-block::
> +.. code-block:: C
>
>          a = (int *)b;  // wrong
>
>  2)
>
> -.. code-block::
> +.. code-block:: C
>
>          a = (int *) b;  // correct
>
> @@ -165,7 +165,7 @@ When declaring a variable, try not to initialize it unless necessary.
>
>  Example:
>
> -.. code-block::
> +.. code-block:: C
>
>          int i = 1;  // wrong
>
> @@ -200,7 +200,7 @@ prefixed by the ``enum`` type name.
>
>  Example:
>
> -.. code-block::
> +.. code-block:: C
>
>          enum animal_type {
>                 ANIMAL_TYPE_FOUR_LEGS,
> @@ -211,7 +211,7 @@ Example:
>  If the enum contents have values (e.g. from specification) the formatting
>  should be as follows:
>
> -.. code-block::
> +.. code-block:: C
>
>          enum animal_type {
>                 ANIMAL_TYPE_FOUR_LEGS =         4,
> @@ -230,7 +230,7 @@ compiler will complain the new added type hasn't been handled.
>
>  Example:
>
> -.. code-block::
> +.. code-block:: C
>
>          enum animal_type {
>                 ANIMAL_TYPE_FOUR_LEGS =         4,
> @@ -278,13 +278,13 @@ parenthesis, too.
>  Example:
>  1)
>
> -.. code-block::
> +.. code-block:: C
>
>          memset(stuff, 0, sizeof(*stuff));
>
>  2)
>
> -.. code-block::
> +.. code-block:: C
>
>          memset(stuff, 0, sizeof *stuff); // Wrong
>
> @@ -296,7 +296,7 @@ A function with no parameters must use ``void`` in the parameter list.
>  Example:
>  1)
>
> -.. code-block::
> +.. code-block:: C
>
>          void foo(void)
>          {
> @@ -304,7 +304,7 @@ Example:
>
>  2)
>
> -.. code-block::
> +.. code-block:: C
>
>          void foo()     // Wrong
>          {
> @@ -321,7 +321,7 @@ Example:
>
>  1)
>
> -.. code-block::
> +.. code-block:: C
>
>          if (device) {  // worse
>                 memset(&eir_data, 0, sizeof(eir_data));
> @@ -335,7 +335,7 @@ Example:
>
>  2)
>
> -.. code-block::
> +.. code-block:: C
>
>          if (!device) {
>                 error("Unable to get device object for %s", addr);
> --
> 2.52.0
>
>


-- 
Luiz Augusto von Dentz

RE: Documentation fixups

[bluez.test.bot]

[-- Attachment #1: Type: text/plain, Size: 1262 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=1045811

---Test result---

Test Summary:
CheckPatch                    PENDING   0.32 seconds
GitLint                       PENDING   0.36 seconds
BuildEll                      PASS      20.13 seconds
BluezMake                     PASS      650.13 seconds
MakeCheck                     PASS      18.51 seconds
MakeDistcheck                 PASS      244.13 seconds
CheckValgrind                 PASS      296.11 seconds
CheckSmatch                   PASS      350.79 seconds
bluezmakeextell               PASS      181.15 seconds
IncrementalBuild              PENDING   0.36 seconds
ScanBuild                     PASS      1021.52 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

[BlueZ 2/2] doc: Update .gitignore for new daemon man page locations

[Bastien Nocera]

bluetoothd.rst.in and bluetooth-meshd.rst.in moved, so the generated
".rst" files moved too. Update .gitignore to match the new location.
---
 .gitignore | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/.gitignore b/.gitignore
index f8e4ad686065..27c9b8b6eb65 100644
--- a/.gitignore
+++ b/.gitignore
@@ -150,9 +150,9 @@ tools/mesh-cfgclient
 tools/mesh-cfgtest
 tools/mesh-tester
 mesh/bluetooth-meshd
-mesh/bluetooth-meshd.rst
+doc/bluetooth-meshd.rst
 
-src/bluetoothd.rst
+doc/bluetoothd.rst
 src/bluetooth.service
 mesh/bluetooth-mesh.service
 
-- 
2.52.0

Re: [BlueZ 0/2] Documentation fixups

[patchwork-bot+bluetooth]

Hello:

This series was applied to bluetooth/bluez.git (master)
by Luiz Augusto von Dentz <luiz.von.dentz@intel.com>:

On Thu, 22 Jan 2026 17:58:56 +0100 you wrote:
> Some documentation fixups after "Port text docs to RST and move man
> pages" got merged.
> 
> Bastien Nocera (2):
>   doc: Add "C" code-block markers for coding-style doc
>   doc: Update .gitignore for new daemon man page locations
> 
> [...]

Here is the summary with links:
  - [BlueZ,1/2] doc: Add "C" code-block markers for coding-style doc
    (no matching commit)
  - [BlueZ,2/2] doc: Update .gitignore for new daemon man page locations
    https://git.kernel.org/pub/scm/bluetooth/bluez.git/?id=3f21f7817a40

You are awesome, thank you!
-- 
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/patchwork/pwbot.html