[PATCH] can: Explain PDU in CAN_ISOTP help text

[PATCH] can: Explain PDU in CAN_ISOTP help text

[Geert Uytterhoeven]

The help text for the CAN_ISOTP config symbol uses the acronym "PDU".
However, this acronym is not explained here, nor in
Documentation/networking/can.rst.
Expand the acronym to make it easier for users to decide if they need to
enable the CAN_ISOTP option or not.

Signed-off-by: Geert Uytterhoeven <geert+renesas@glider.be>
---
 net/can/Kconfig | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/net/can/Kconfig b/net/can/Kconfig
index 224e5e0283a986d9..7c9958df91d353c8 100644
--- a/net/can/Kconfig
+++ b/net/can/Kconfig
@@ -62,8 +62,9 @@ config CAN_ISOTP
 	  communication between CAN nodes via two defined CAN Identifiers.
 	  As CAN frames can only transport a small amount of data bytes
 	  (max. 8 bytes for 'classic' CAN and max. 64 bytes for CAN FD) this
-	  segmentation is needed to transport longer PDUs as needed e.g. for
-	  vehicle diagnosis (UDS, ISO 14229) or IP-over-CAN traffic.
+	  segmentation is needed to transport longer Protocol Data Units (PDU)
+	  as needed e.g. for vehicle diagnosis (UDS, ISO 14229) or IP-over-CAN
+	  traffic.
 	  This protocol driver implements data transfers according to
 	  ISO 15765-2:2016 for 'classic' CAN and CAN FD frame types.
 	  If you want to perform automotive vehicle diagnostic services (UDS),
-- 
2.17.1

Re: [PATCH] can: Explain PDU in CAN_ISOTP help text

[Oliver Hartkopp]

On 13.10.20 16:13, Geert Uytterhoeven wrote:
> The help text for the CAN_ISOTP config symbol uses the acronym "PDU".
> However, this acronym is not explained here, nor in
> Documentation/networking/can.rst.
> Expand the acronym to make it easier for users to decide if they need to
> enable the CAN_ISOTP option or not.
> 
> Signed-off-by: Geert Uytterhoeven <geert+renesas@glider.be>

Acked-by: Oliver Hartkopp <socketcan@hartkopp.net>

Yes, when you are so deep into it that PDU becomes a word like dog or 
cat ;-)

Thanks,
Oliver

> ---
>   net/can/Kconfig | 5 +++--
>   1 file changed, 3 insertions(+), 2 deletions(-)
> 
> diff --git a/net/can/Kconfig b/net/can/Kconfig
> index 224e5e0283a986d9..7c9958df91d353c8 100644
> --- a/net/can/Kconfig
> +++ b/net/can/Kconfig
> @@ -62,8 +62,9 @@ config CAN_ISOTP
>   	  communication between CAN nodes via two defined CAN Identifiers.
>   	  As CAN frames can only transport a small amount of data bytes
>   	  (max. 8 bytes for 'classic' CAN and max. 64 bytes for CAN FD) this
> -	  segmentation is needed to transport longer PDUs as needed e.g. for
> -	  vehicle diagnosis (UDS, ISO 14229) or IP-over-CAN traffic.
> +	  segmentation is needed to transport longer Protocol Data Units (PDU)
> +	  as needed e.g. for vehicle diagnosis (UDS, ISO 14229) or IP-over-CAN
> +	  traffic.
>   	  This protocol driver implements data transfers according to
>   	  ISO 15765-2:2016 for 'classic' CAN and CAN FD frame types.
>   	  If you want to perform automotive vehicle diagnostic services (UDS),
> 

Re: [PATCH] can: Explain PDU in CAN_ISOTP help text

[Marc Kleine-Budde]

[-- Attachment #1.1: Type: text/plain, Size: 971 bytes --]

On 10/13/20 6:43 PM, Oliver Hartkopp wrote:
> On 13.10.20 16:13, Geert Uytterhoeven wrote:
>> The help text for the CAN_ISOTP config symbol uses the acronym "PDU".
>> However, this acronym is not explained here, nor in
>> Documentation/networking/can.rst.
>> Expand the acronym to make it easier for users to decide if they need to
>> enable the CAN_ISOTP option or not.
>>
>> Signed-off-by: Geert Uytterhoeven <geert+renesas@glider.be>
> 
> Acked-by: Oliver Hartkopp <socketcan@hartkopp.net>
> 
> Yes, when you are so deep into it that PDU becomes a word like dog or 
> cat ;-)

As v5.9 is out and isotp will hit mainline quite soon, I'll queue this via
can/master.

Tnx,
Marc

-- 
Pengutronix e.K.                 | Marc Kleine-Budde           |
Embedded Linux                   | https://www.pengutronix.de  |
Vertretung West/Dortmund         | Phone: +49-231-2826-924     |
Amtsgericht Hildesheim, HRA 2686 | Fax:   +49-5121-206917-5555 |


[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 488 bytes --]