* [PATCH] CODING_STYLE.rst: Be less strict about 80 character limit
@ 2020-11-06 11:29 ` Peter Maydell
0 siblings, 0 replies; 8+ messages in thread
From: Peter Maydell @ 2020-11-06 11:29 UTC (permalink / raw)
To: qemu-devel
Cc: Daniel P. Berrange, zhanghailiang, Michael S. Tsirkin,
qemu-trivial, Gan Qixin, Chenqun (kuhn), Paolo Bonzini,
Philippe Mathieu-Daudé
Relax the wording about line lengths a little bit; this goes with the
checkpatch changes to warn at 100 characters rather than 80.
(Compare the Linux kernel commit bdc48fa11e46f8; our coding style is
not theirs, but the rationale is good and applies to us too.)
Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
---
CODING_STYLE.rst | 9 +++++++--
1 file changed, 7 insertions(+), 2 deletions(-)
diff --git a/CODING_STYLE.rst b/CODING_STYLE.rst
index 8b13ef0669e..7bf4e39d487 100644
--- a/CODING_STYLE.rst
+++ b/CODING_STYLE.rst
@@ -85,8 +85,13 @@ Line width
Lines should be 80 characters; try not to make them longer.
Sometimes it is hard to do, especially when dealing with QEMU subsystems
-that use long function or symbol names. Even in that case, do not make
-lines much longer than 80 characters.
+that use long function or symbol names. If wrapping the line at 80 columns
+is obviously less readable and more awkward, prefer not to wrap it; better
+to have an 85 character line than one which is awkwardly wrapped.
+
+Even in that case, try not to make lines much longer than 80 characters.
+(The checkpatch script will warn at 100 characters, but this is intended
+as a guard against obviously-overlength lines, not a target.)
Rationale:
--
2.20.1
^ permalink raw reply related [flat|nested] 8+ messages in thread
* Re: [PATCH] CODING_STYLE.rst: Be less strict about 80 character limit
2020-11-06 11:29 ` Peter Maydell
@ 2020-11-06 13:10 ` Markus Armbruster
-1 siblings, 0 replies; 8+ messages in thread
From: Markus Armbruster @ 2020-11-06 13:10 UTC (permalink / raw)
To: Peter Maydell
Cc: qemu-devel, Daniel P. Berrange, zhanghailiang, Michael S. Tsirkin,
qemu-trivial, Gan Qixin, Chenqun (kuhn), Paolo Bonzini,
Philippe Mathieu-Daudé
Peter Maydell <peter.maydell@linaro.org> writes:
> Relax the wording about line lengths a little bit; this goes with the
> checkpatch changes to warn at 100 characters rather than 80.
>
> (Compare the Linux kernel commit bdc48fa11e46f8; our coding style is
> not theirs, but the rationale is good and applies to us too.)
>
> Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
> ---
> CODING_STYLE.rst | 9 +++++++--
> 1 file changed, 7 insertions(+), 2 deletions(-)
>
> diff --git a/CODING_STYLE.rst b/CODING_STYLE.rst
> index 8b13ef0669e..7bf4e39d487 100644
> --- a/CODING_STYLE.rst
> +++ b/CODING_STYLE.rst
> @@ -85,8 +85,13 @@ Line width
> Lines should be 80 characters; try not to make them longer.
>
> Sometimes it is hard to do, especially when dealing with QEMU subsystems
> -that use long function or symbol names. Even in that case, do not make
> -lines much longer than 80 characters.
> +that use long function or symbol names. If wrapping the line at 80 columns
> +is obviously less readable and more awkward, prefer not to wrap it; better
> +to have an 85 character line than one which is awkwardly wrapped.
> +
> +Even in that case, try not to make lines much longer than 80 characters.
> +(The checkpatch script will warn at 100 characters, but this is intended
> +as a guard against obviously-overlength lines, not a target.)
>
> Rationale:
Alright, that's much more reasobale than I expected.
Reviewed-by: Markus Armbruster <armbru@redhat.com>
One more thing that might be worth explaining: the width of the text
matters, i.e. line length less indentation.
^ permalink raw reply [flat|nested] 8+ messages in thread
* Re: [PATCH] CODING_STYLE.rst: Be less strict about 80 character limit
@ 2020-11-06 13:10 ` Markus Armbruster
0 siblings, 0 replies; 8+ messages in thread
From: Markus Armbruster @ 2020-11-06 13:10 UTC (permalink / raw)
To: Peter Maydell
Cc: Daniel P. Berrange, zhanghailiang, Michael S. Tsirkin,
qemu-trivial, qemu-devel, Gan Qixin, Paolo Bonzini,
Chenqun (kuhn), Philippe Mathieu-Daudé
Peter Maydell <peter.maydell@linaro.org> writes:
> Relax the wording about line lengths a little bit; this goes with the
> checkpatch changes to warn at 100 characters rather than 80.
>
> (Compare the Linux kernel commit bdc48fa11e46f8; our coding style is
> not theirs, but the rationale is good and applies to us too.)
>
> Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
> ---
> CODING_STYLE.rst | 9 +++++++--
> 1 file changed, 7 insertions(+), 2 deletions(-)
>
> diff --git a/CODING_STYLE.rst b/CODING_STYLE.rst
> index 8b13ef0669e..7bf4e39d487 100644
> --- a/CODING_STYLE.rst
> +++ b/CODING_STYLE.rst
> @@ -85,8 +85,13 @@ Line width
> Lines should be 80 characters; try not to make them longer.
>
> Sometimes it is hard to do, especially when dealing with QEMU subsystems
> -that use long function or symbol names. Even in that case, do not make
> -lines much longer than 80 characters.
> +that use long function or symbol names. If wrapping the line at 80 columns
> +is obviously less readable and more awkward, prefer not to wrap it; better
> +to have an 85 character line than one which is awkwardly wrapped.
> +
> +Even in that case, try not to make lines much longer than 80 characters.
> +(The checkpatch script will warn at 100 characters, but this is intended
> +as a guard against obviously-overlength lines, not a target.)
>
> Rationale:
Alright, that's much more reasobale than I expected.
Reviewed-by: Markus Armbruster <armbru@redhat.com>
One more thing that might be worth explaining: the width of the text
matters, i.e. line length less indentation.
^ permalink raw reply [flat|nested] 8+ messages in thread
* Re: [PATCH] CODING_STYLE.rst: Be less strict about 80 character limit
2020-11-06 11:29 ` Peter Maydell
@ 2020-11-06 16:48 ` Michael S. Tsirkin
-1 siblings, 0 replies; 8+ messages in thread
From: Michael S. Tsirkin @ 2020-11-06 16:48 UTC (permalink / raw)
To: Peter Maydell
Cc: qemu-devel, qemu-trivial, Daniel P. Berrange, Paolo Bonzini,
Philippe Mathieu-Daudé, Chenqun (kuhn), zhanghailiang,
Gan Qixin
On Fri, Nov 06, 2020 at 11:29:40AM +0000, Peter Maydell wrote:
> Relax the wording about line lengths a little bit; this goes with the
> checkpatch changes to warn at 100 characters rather than 80.
>
> (Compare the Linux kernel commit bdc48fa11e46f8; our coding style is
> not theirs, but the rationale is good and applies to us too.)
>
> Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
Reviewed-by: Michael S. Tsirkin <mst@redhat.com>
> ---
> CODING_STYLE.rst | 9 +++++++--
> 1 file changed, 7 insertions(+), 2 deletions(-)
>
> diff --git a/CODING_STYLE.rst b/CODING_STYLE.rst
> index 8b13ef0669e..7bf4e39d487 100644
> --- a/CODING_STYLE.rst
> +++ b/CODING_STYLE.rst
> @@ -85,8 +85,13 @@ Line width
> Lines should be 80 characters; try not to make them longer.
>
> Sometimes it is hard to do, especially when dealing with QEMU subsystems
> -that use long function or symbol names. Even in that case, do not make
> -lines much longer than 80 characters.
> +that use long function or symbol names. If wrapping the line at 80 columns
> +is obviously less readable and more awkward, prefer not to wrap it; better
> +to have an 85 character line than one which is awkwardly wrapped.
> +
> +Even in that case, try not to make lines much longer than 80 characters.
> +(The checkpatch script will warn at 100 characters, but this is intended
> +as a guard against obviously-overlength lines, not a target.)
>
> Rationale:
>
> --
> 2.20.1
^ permalink raw reply [flat|nested] 8+ messages in thread
* Re: [PATCH] CODING_STYLE.rst: Be less strict about 80 character limit
@ 2020-11-06 16:48 ` Michael S. Tsirkin
0 siblings, 0 replies; 8+ messages in thread
From: Michael S. Tsirkin @ 2020-11-06 16:48 UTC (permalink / raw)
To: Peter Maydell
Cc: Daniel P. Berrange, zhanghailiang, qemu-trivial, qemu-devel,
Gan Qixin, Chenqun (kuhn), Paolo Bonzini,
Philippe Mathieu-Daudé
On Fri, Nov 06, 2020 at 11:29:40AM +0000, Peter Maydell wrote:
> Relax the wording about line lengths a little bit; this goes with the
> checkpatch changes to warn at 100 characters rather than 80.
>
> (Compare the Linux kernel commit bdc48fa11e46f8; our coding style is
> not theirs, but the rationale is good and applies to us too.)
>
> Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
Reviewed-by: Michael S. Tsirkin <mst@redhat.com>
> ---
> CODING_STYLE.rst | 9 +++++++--
> 1 file changed, 7 insertions(+), 2 deletions(-)
>
> diff --git a/CODING_STYLE.rst b/CODING_STYLE.rst
> index 8b13ef0669e..7bf4e39d487 100644
> --- a/CODING_STYLE.rst
> +++ b/CODING_STYLE.rst
> @@ -85,8 +85,13 @@ Line width
> Lines should be 80 characters; try not to make them longer.
>
> Sometimes it is hard to do, especially when dealing with QEMU subsystems
> -that use long function or symbol names. Even in that case, do not make
> -lines much longer than 80 characters.
> +that use long function or symbol names. If wrapping the line at 80 columns
> +is obviously less readable and more awkward, prefer not to wrap it; better
> +to have an 85 character line than one which is awkwardly wrapped.
> +
> +Even in that case, try not to make lines much longer than 80 characters.
> +(The checkpatch script will warn at 100 characters, but this is intended
> +as a guard against obviously-overlength lines, not a target.)
>
> Rationale:
>
> --
> 2.20.1
^ permalink raw reply [flat|nested] 8+ messages in thread
* Re: [PATCH] CODING_STYLE.rst: Be less strict about 80 character limit
2020-11-06 11:29 ` Peter Maydell
@ 2020-12-13 16:51 ` Laurent Vivier
-1 siblings, 0 replies; 8+ messages in thread
From: Laurent Vivier @ 2020-12-13 16:51 UTC (permalink / raw)
To: Peter Maydell, qemu-devel
Cc: Daniel P. Berrange, zhanghailiang, Michael S. Tsirkin,
qemu-trivial, Gan Qixin, Chenqun (kuhn), Paolo Bonzini,
Philippe Mathieu-Daudé
Le 06/11/2020 à 12:29, Peter Maydell a écrit :
> Relax the wording about line lengths a little bit; this goes with the
> checkpatch changes to warn at 100 characters rather than 80.
>
> (Compare the Linux kernel commit bdc48fa11e46f8; our coding style is
> not theirs, but the rationale is good and applies to us too.)
>
> Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
> ---
> CODING_STYLE.rst | 9 +++++++--
> 1 file changed, 7 insertions(+), 2 deletions(-)
>
> diff --git a/CODING_STYLE.rst b/CODING_STYLE.rst
> index 8b13ef0669e..7bf4e39d487 100644
> --- a/CODING_STYLE.rst
> +++ b/CODING_STYLE.rst
> @@ -85,8 +85,13 @@ Line width
> Lines should be 80 characters; try not to make them longer.
>
> Sometimes it is hard to do, especially when dealing with QEMU subsystems
> -that use long function or symbol names. Even in that case, do not make
> -lines much longer than 80 characters.
> +that use long function or symbol names. If wrapping the line at 80 columns
> +is obviously less readable and more awkward, prefer not to wrap it; better
> +to have an 85 character line than one which is awkwardly wrapped.
> +
> +Even in that case, try not to make lines much longer than 80 characters.
> +(The checkpatch script will warn at 100 characters, but this is intended
> +as a guard against obviously-overlength lines, not a target.)
>
> Rationale:
>
>
Applied to my trivial-patches branch.
Thanks,
Laurent
^ permalink raw reply [flat|nested] 8+ messages in thread
* Re: [PATCH] CODING_STYLE.rst: Be less strict about 80 character limit
@ 2020-12-13 16:51 ` Laurent Vivier
0 siblings, 0 replies; 8+ messages in thread
From: Laurent Vivier @ 2020-12-13 16:51 UTC (permalink / raw)
To: Peter Maydell, qemu-devel
Cc: Daniel P. Berrange, zhanghailiang, Michael S. Tsirkin,
qemu-trivial, Gan Qixin, Paolo Bonzini, Chenqun (kuhn),
Philippe Mathieu-Daudé
Le 06/11/2020 à 12:29, Peter Maydell a écrit :
> Relax the wording about line lengths a little bit; this goes with the
> checkpatch changes to warn at 100 characters rather than 80.
>
> (Compare the Linux kernel commit bdc48fa11e46f8; our coding style is
> not theirs, but the rationale is good and applies to us too.)
>
> Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
> ---
> CODING_STYLE.rst | 9 +++++++--
> 1 file changed, 7 insertions(+), 2 deletions(-)
>
> diff --git a/CODING_STYLE.rst b/CODING_STYLE.rst
> index 8b13ef0669e..7bf4e39d487 100644
> --- a/CODING_STYLE.rst
> +++ b/CODING_STYLE.rst
> @@ -85,8 +85,13 @@ Line width
> Lines should be 80 characters; try not to make them longer.
>
> Sometimes it is hard to do, especially when dealing with QEMU subsystems
> -that use long function or symbol names. Even in that case, do not make
> -lines much longer than 80 characters.
> +that use long function or symbol names. If wrapping the line at 80 columns
> +is obviously less readable and more awkward, prefer not to wrap it; better
> +to have an 85 character line than one which is awkwardly wrapped.
> +
> +Even in that case, try not to make lines much longer than 80 characters.
> +(The checkpatch script will warn at 100 characters, but this is intended
> +as a guard against obviously-overlength lines, not a target.)
>
> Rationale:
>
>
Applied to my trivial-patches branch.
Thanks,
Laurent
^ permalink raw reply [flat|nested] 8+ messages in thread