[PATCH 0/3] Documentation fixes for MT6370 RGB

[PATCH 0/3] Documentation fixes for MT6370 RGB

[Bagas Sanjaya]

kernel test robot recently reported htmldocs warnings on documentation
for MT6370 RGB LED. So here are the fixes.

Bagas Sanjaya (3):
  Documentation: leds: Add MT6370 doc to the toctree
  Documentation: leds: MT6370: Properly wrap hw_pattern chart
  Documentation: leds: MT6370: Use bullet lists for timing variables

 Documentation/leds/index.rst           |  1 +
 Documentation/leds/leds-mt6370-rgb.rst | 42 +++++++++++++-------------
 2 files changed, 22 insertions(+), 21 deletions(-)


base-commit: 4ba9df04b7ac66d2d000ed7ae2d8136302d99a57
-- 
An old man doll... just what I always wanted! - Clara

[PATCH 1/3] Documentation: leds: Add MT6370 doc to the toctree

[Bagas Sanjaya]

Commit 4ba9df04b7ac66 ("docs: leds: Add MT6370 RGB LED pattern document")
adds documentation for Mediatek MT6370 RGB LED device, but forgets to
include it to leds toctree index.

Add the missing entry.

Link: https://lore.kernel.org/oe-kbuild-all/202303182310.tB1mUzU7-lkp@intel.com/
Fixes: 4ba9df04b7ac66 ("docs: leds: Add MT6370 RGB LED pattern document")
Reported-by: kernel test robot <lkp@intel.com>
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
 Documentation/leds/index.rst | 1 +
 1 file changed, 1 insertion(+)

diff --git a/Documentation/leds/index.rst b/Documentation/leds/index.rst
index b9ca081fac71f4..ce57254cb871f4 100644
--- a/Documentation/leds/index.rst
+++ b/Documentation/leds/index.rst
@@ -25,5 +25,6 @@ LEDs
    leds-lp5562
    leds-lp55xx
    leds-mlxcpld
+   leds-mt6370-rgb
    leds-sc27xx
    leds-qcom-lpg
-- 
An old man doll... just what I always wanted! - Clara

[PATCH 2/3] Documentation: leds: MT6370: Properly wrap hw_pattern chart

[Bagas Sanjaya]

The pattern diagram (chart) of /sys/class/leds/<led>/hw_pattern is
wrapped in literal code block. However, the block indentation is
interrupted by Icurr axis label, hence below warnings:

Documentation/leds/leds-mt6370-rgb.rst:39: WARNING: Literal block ends without a blank line; unexpected unindent.
Documentation/leds/leds-mt6370-rgb.rst:41: WARNING: Line block ends without a blank line.
Documentation/leds/leds-mt6370-rgb.rst:46: WARNING: Unexpected indentation.
Documentation/leds/leds-mt6370-rgb.rst:44: WARNING: Inline substitution_reference start-string without end-string.

Fix the chart indentation by adding 4 more spaces so that the axis label
is in the code block.

Link: https://lore.kernel.org/oe-kbuild-all/202303182310.tB1mUzU7-lkp@intel.com/
Fixes: 4ba9df04b7ac66 ("docs: leds: Add MT6370 RGB LED pattern document")
Reported-by: kernel test robot <lkp@intel.com>
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
 Documentation/leds/leds-mt6370-rgb.rst | 24 ++++++++++++------------
 1 file changed, 12 insertions(+), 12 deletions(-)

diff --git a/Documentation/leds/leds-mt6370-rgb.rst b/Documentation/leds/leds-mt6370-rgb.rst
index abf739e448428e..ea782797a06df0 100644
--- a/Documentation/leds/leds-mt6370-rgb.rst
+++ b/Documentation/leds/leds-mt6370-rgb.rst
@@ -31,19 +31,19 @@ depending on the current brightness setting.
 
 Pattern diagram::
 
-     "0 Tr1 0 Tr2 0 Tf1 0 Tf2 0 Ton 0 Toff" --> '0' for dummy brightness code
+         "0 Tr1 0 Tr2 0 Tf1 0 Tf2 0 Ton 0 Toff" --> '0' for dummy brightness code
 
-      ^
-      |           ============
-      |          /            \                                /
-Icurr |         /              \                              /
-      |        /                \                            /
-      |       /                  \                          /   .....repeat
-      |      /                    \                        /
-      |   ---                      ---                  ---
-      |---                            ---            ---
-      +----------------------------------============------------> Time
-       < Tr1><Tr2><   Ton    ><Tf1><Tf2 ><  Toff    >< Tr1><Tr2>
+          ^
+          |           ============
+          |          /            \                                /
+    Icurr |         /              \                              /
+          |        /                \                            /
+          |       /                  \                          /   .....repeat
+          |      /                    \                        /
+          |   ---                      ---                  ---
+          |---                            ---            ---
+          +----------------------------------============------------> Time
+          < Tr1><Tr2><   Ton    ><Tf1><Tf2 ><  Toff    >< Tr1><Tr2>
 
 Timing description::
 
-- 
An old man doll... just what I always wanted! - Clara

[PATCH 3/3] Documentation: leds: MT6370: Use bullet lists for timing variables

[Bagas Sanjaya]

The timing description contains list of timing pattern variables, but it
uses code block without indentation instead. Switch to bullet list as it
is better fit for this purpose.

While at it, substitute "load" for "duty" because the variables control
timing for current load into the device.

Link: https://lore.kernel.org/oe-kbuild-all/202303182310.tB1mUzU7-lkp@intel.com/
Fixes: 4ba9df04b7ac66 ("docs: leds: Add MT6370 RGB LED pattern document")
Reported-by: kernel test robot <lkp@intel.com>
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
 Documentation/leds/leds-mt6370-rgb.rst | 18 +++++++++---------
 1 file changed, 9 insertions(+), 9 deletions(-)

diff --git a/Documentation/leds/leds-mt6370-rgb.rst b/Documentation/leds/leds-mt6370-rgb.rst
index ea782797a06df0..152a2e5921724b 100644
--- a/Documentation/leds/leds-mt6370-rgb.rst
+++ b/Documentation/leds/leds-mt6370-rgb.rst
@@ -45,17 +45,17 @@ Pattern diagram::
           +----------------------------------============------------> Time
           < Tr1><Tr2><   Ton    ><Tf1><Tf2 ><  Toff    >< Tr1><Tr2>
 
-Timing description::
+Timing description:
 
-Tr1:    First rising time for duty 0 to 30%.
-Tr2:    Second rising time for duty 31% to 100%.
-Ton:    On time for duty 100%.
-Tf1:    First falling time for duty 100% to 31%.
-Tf2:    Second falling time for duty 30% to 0%.
-Toff:   Off time for duty 0%.
+  * Tr1:    First rising time for 0% - 30% load.
+  * Tr2:    Second rising time for 31% - 100% load.
+  * Ton:    On time for 100% load.
+  * Tf1:    First falling time for 100% - 31% load.
+  * Tf2:    Second falling time for 30% to 0% load.
+  * Toff:   Off time for 0% load.
 
-Tr1/Tr2/Tf1/Tf2/Ton: 125ms to 3125ms, 200ms per step.
-Toff: 250ms to 6250ms, 400ms per step.
+  * Tr1/Tr2/Tf1/Tf2/Ton: 125ms to 3125ms, 200ms per step.
+  * Toff: 250ms to 6250ms, 400ms per step.
 
 Pattern example::
 
-- 
An old man doll... just what I always wanted! - Clara

Re: [PATCH 0/3] Documentation fixes for MT6370 RGB

[Bagas Sanjaya]

On 3/19/23 14:49, Bagas Sanjaya wrote:
> kernel test robot recently reported htmldocs warnings on documentation
> for MT6370 RGB LED. So here are the fixes.
> 
> Bagas Sanjaya (3):
>   Documentation: leds: Add MT6370 doc to the toctree
>   Documentation: leds: MT6370: Properly wrap hw_pattern chart
>   Documentation: leds: MT6370: Use bullet lists for timing variables
> 
>  Documentation/leds/index.rst           |  1 +
>  Documentation/leds/leds-mt6370-rgb.rst | 42 +++++++++++++-------------
>  2 files changed, 22 insertions(+), 21 deletions(-)
> 
> 
> base-commit: 4ba9df04b7ac66d2d000ed7ae2d8136302d99a57

ping

-- 
An old man doll... just what I always wanted! - Clara

Re: [PATCH 0/3] Documentation fixes for MT6370 RGB

[Pavel Machek]

[-- Attachment #1: Type: text/plain, Size: 731 bytes --]

On Sun 2023-03-19 14:49:00, Bagas Sanjaya wrote:
> kernel test robot recently reported htmldocs warnings on documentation
> for MT6370 RGB LED. So here are the fixes.
> 
> Bagas Sanjaya (3):
>   Documentation: leds: Add MT6370 doc to the toctree
>   Documentation: leds: MT6370: Properly wrap hw_pattern chart
>   Documentation: leds: MT6370: Use bullet lists for timing variables
> 
>  Documentation/leds/index.rst           |  1 +
>  Documentation/leds/leds-mt6370-rgb.rst | 42 +++++++++++++-------------
>  2 files changed, 22 insertions(+), 21 deletions(-)

Series looks good to me.

Acked-by: Pavel Machek <pavel@ucw.cz>

								Pavel
-- 
People of Russia, stop Putin before his war on Ukraine escalates.

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 195 bytes --]

Re: [PATCH 0/3] Documentation fixes for MT6370 RGB

[Lee Jones]

On Thu, 23 Mar 2023, Bagas Sanjaya wrote:

> On 3/19/23 14:49, Bagas Sanjaya wrote:
> > kernel test robot recently reported htmldocs warnings on documentation
> > for MT6370 RGB LED. So here are the fixes.
> >
> > Bagas Sanjaya (3):
> >   Documentation: leds: Add MT6370 doc to the toctree
> >   Documentation: leds: MT6370: Properly wrap hw_pattern chart
> >   Documentation: leds: MT6370: Use bullet lists for timing variables
> >
> >  Documentation/leds/index.rst           |  1 +
> >  Documentation/leds/leds-mt6370-rgb.rst | 42 +++++++++++++-------------
> >  2 files changed, 22 insertions(+), 21 deletions(-)
> >
> >
> > base-commit: 4ba9df04b7ac66d2d000ed7ae2d8136302d99a57
>
> ping

a) Don't do that!

b) Especually don't do that 4 days after submission!

The usual expectation is 2 full weeks before submitting a [RESEND].

Mark Brown says it best:

"
Please don't send content free pings and please allow a reasonable time
for review.  People get busy, go on holiday, attend conferences and so
on so unless there is some reason for urgency (like critical bug fixes)
please allow at least a couple of weeks for review.  If there have been
review comments then people may be waiting for those to be addressed.

Sending content free pings adds to the mail volume (if they are seen at
all) which is often the problem and since they can't be reviewed
directly if something has gone wrong you'll have to resend the patches
anyway, so sending again is generally a better approach though there are
some other maintainers who like them - if in doubt look at how patches
for the subsystem are normally handled.
"

--
Lee Jones [李琼斯]

Re: [PATCH 0/3] Documentation fixes for MT6370 RGB

[Bagas Sanjaya]

On 3/23/23 19:31, Lee Jones wrote:
>> ping
> 
> a) Don't do that!
> 
> b) Especually don't do that 4 days after submission!
> 
> The usual expectation is 2 full weeks before submitting a [RESEND].
> 
> Mark Brown says it best:
> 
> "
> Please don't send content free pings and please allow a reasonable time
> for review.  People get busy, go on holiday, attend conferences and so
> on so unless there is some reason for urgency (like critical bug fixes)
> please allow at least a couple of weeks for review.  If there have been
> review comments then people may be waiting for those to be addressed.
> 
> Sending content free pings adds to the mail volume (if they are seen at
> all) which is often the problem and since they can't be reviewed
> directly if something has gone wrong you'll have to resend the patches
> anyway, so sending again is generally a better approach though there are
> some other maintainers who like them - if in doubt look at how patches
> for the subsystem are normally handled.
> "
> 

Ah! I triggered the wrong message at the wrong time. Thanks anyway!

-- 
An old man doll... just what I always wanted! - Clara

Re: [PATCH 1/3] Documentation: leds: Add MT6370 doc to the toctree

[Lee Jones]

On Sun, 19 Mar 2023, Bagas Sanjaya wrote:

> Commit 4ba9df04b7ac66 ("docs: leds: Add MT6370 RGB LED pattern document")
> adds documentation for Mediatek MT6370 RGB LED device, but forgets to
> include it to leds toctree index.
>
> Add the missing entry.
>
> Link: https://lore.kernel.org/oe-kbuild-all/202303182310.tB1mUzU7-lkp@intel.com/
> Fixes: 4ba9df04b7ac66 ("docs: leds: Add MT6370 RGB LED pattern document")
> Reported-by: kernel test robot <lkp@intel.com>
> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
> ---
>  Documentation/leds/index.rst | 1 +
>  1 file changed, 1 insertion(+)

Applied, thanks

--
Lee Jones [李琼斯]

Re: [PATCH 2/3] Documentation: leds: MT6370: Properly wrap hw_pattern chart

[Lee Jones]

On Sun, 19 Mar 2023, Bagas Sanjaya wrote:

> The pattern diagram (chart) of /sys/class/leds/<led>/hw_pattern is
> wrapped in literal code block. However, the block indentation is
> interrupted by Icurr axis label, hence below warnings:
>
> Documentation/leds/leds-mt6370-rgb.rst:39: WARNING: Literal block ends without a blank line; unexpected unindent.
> Documentation/leds/leds-mt6370-rgb.rst:41: WARNING: Line block ends without a blank line.
> Documentation/leds/leds-mt6370-rgb.rst:46: WARNING: Unexpected indentation.
> Documentation/leds/leds-mt6370-rgb.rst:44: WARNING: Inline substitution_reference start-string without end-string.
>
> Fix the chart indentation by adding 4 more spaces so that the axis label
> is in the code block.
>
> Link: https://lore.kernel.org/oe-kbuild-all/202303182310.tB1mUzU7-lkp@intel.com/
> Fixes: 4ba9df04b7ac66 ("docs: leds: Add MT6370 RGB LED pattern document")
> Reported-by: kernel test robot <lkp@intel.com>
> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
> ---
>  Documentation/leds/leds-mt6370-rgb.rst | 24 ++++++++++++------------
>  1 file changed, 12 insertions(+), 12 deletions(-)

Applied, thanks

--
Lee Jones [李琼斯]

Re: [PATCH 3/3] Documentation: leds: MT6370: Use bullet lists for timing variables

[Lee Jones]

On Sun, 19 Mar 2023, Bagas Sanjaya wrote:

> The timing description contains list of timing pattern variables, but it
> uses code block without indentation instead. Switch to bullet list as it
> is better fit for this purpose.
>
> While at it, substitute "load" for "duty" because the variables control
> timing for current load into the device.
>
> Link: https://lore.kernel.org/oe-kbuild-all/202303182310.tB1mUzU7-lkp@intel.com/
> Fixes: 4ba9df04b7ac66 ("docs: leds: Add MT6370 RGB LED pattern document")
> Reported-by: kernel test robot <lkp@intel.com>
> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
> ---
>  Documentation/leds/leds-mt6370-rgb.rst | 18 +++++++++---------
>  1 file changed, 9 insertions(+), 9 deletions(-)

Applied, thanks

--
Lee Jones [李琼斯]