[PATCH] Documentation: kgdb: Replace deprecated remotebaud

[PATCH] Documentation: kgdb: Replace deprecated remotebaud

[Christian Löhle]

The gdb remotebaud to set baudrate has been replaced in favor of
set serial baud many years ago.

Signed-off-by: Christian Loehle <cloehle@hyperstone.com>
---
 Documentation/dev-tools/kgdb.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/dev-tools/kgdb.rst b/Documentation/dev-tools/kgdb.rst
index 43456244651a..7c90e111b364 100644
--- a/Documentation/dev-tools/kgdb.rst
+++ b/Documentation/dev-tools/kgdb.rst
@@ -557,7 +557,7 @@ Connecting with gdb to a serial port
    Example (using a directly connected port)::
 
            % gdb ./vmlinux
-           (gdb) set remotebaud 115200
+           (gdb) set serial baud 115200
            (gdb) target remote /dev/ttyS0
 
 
-- 
2.34.1
Hyperstone GmbH | Reichenaustr. 39a  | 78467 Konstanz
Managing Director: Dr. Jan Peter Berns.
Commercial register of local courts: Freiburg HRB381782

Re: [PATCH] Documentation: kgdb: Replace deprecated remotebaud

[Daniel Thompson]

On Tue, Jan 04, 2022 at 04:56:51PM +0000, Christian Löhle wrote:
> The gdb remotebaud to set baudrate has been replaced in favor of
> set serial baud many years ago.

I'd prefer to have a little more historical info in the patch header
so that anyone still running gdb-7.6 has a better shot at finding out
what is going on (some folks in the embedded world end up relying on
surprisingly old cross-toolsets).

In other words something more like:

  Using set remotebaud to set the baud rate was deprecated in
  gdb-7.7 and completely removed from the command parser in gdb-7.8
  (released in 2014). Adopt set serial baud instead.

Other than that the change looks good to me so with an improved
description containing the above versions and dates this can be:
Reviewed-by: Daniel Thompson <daniel.thompson@linaro.org>


Thanks

Daniel.


> 
> Signed-off-by: Christian Loehle <cloehle@hyperstone.com>
> ---
>  Documentation/dev-tools/kgdb.rst | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/Documentation/dev-tools/kgdb.rst b/Documentation/dev-tools/kgdb.rst
> index 43456244651a..7c90e111b364 100644
> --- a/Documentation/dev-tools/kgdb.rst
> +++ b/Documentation/dev-tools/kgdb.rst
> @@ -557,7 +557,7 @@ Connecting with gdb to a serial port
>     Example (using a directly connected port)::
> 
>             % gdb ./vmlinux
> -           (gdb) set remotebaud 115200
> +           (gdb) set serial baud 115200
>             (gdb) target remote /dev/ttyS0
> 
> 
> --
> 2.34.1
> Hyperstone GmbH | Reichenaustr. 39a  | 78467 Konstanz
> Managing Director: Dr. Jan Peter Berns.
> Commercial register of local courts: Freiburg HRB381782
> 

[PATCHv2] Documentation: kgdb: Replace deprecated remotebaud

[Christian Löhle]

Using set remotebaud to set the baud rate was deprecated in
gdb-7.7 and completely removed from the command parser in gdb-7.8
(released in 2014). Adopt set serial baud instead.

Signed-off-by: Christian Loehle <cloehle@hyperstone.com>
---
 Documentation/dev-tools/kgdb.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/dev-tools/kgdb.rst b/Documentation/dev-tools/kgdb.rst
index 43456244651a..7c90e111b364 100644
--- a/Documentation/dev-tools/kgdb.rst
+++ b/Documentation/dev-tools/kgdb.rst
@@ -557,7 +557,7 @@ Connecting with gdb to a serial port
    Example (using a directly connected port)::
 
            % gdb ./vmlinux
-           (gdb) set remotebaud 115200
+           (gdb) set serial baud 115200
            (gdb) target remote /dev/ttyS0
 
 
-- 
2.34.1
Hyperstone GmbH | Reichenaustr. 39a  | 78467 Konstanz
Managing Director: Dr. Jan Peter Berns.
Commercial register of local courts: Freiburg HRB381782

Re: [PATCHv2] Documentation: kgdb: Replace deprecated remotebaud

[Daniel Thompson]

On Wed, Jan 05, 2022 at 09:58:38AM +0000, Christian Löhle wrote:
> Using set remotebaud to set the baud rate was deprecated in
> gdb-7.7 and completely removed from the command parser in gdb-7.8
> (released in 2014). Adopt set serial baud instead.
> 
> Signed-off-by: Christian Loehle <cloehle@hyperstone.com>

Thanks for the update.

Reviewed-by: Daniel Thompson <daniel.thompson@linaro.org>


Daniel.

PS No need to worry about it this time around but, for future
   reference, if someone provides you one of the tags
   (Reviewed-By, Acked-By, etc) during a review cycle then you are
   normally expected to collect this and add them to tags section when
   you share the next version of the patch or, if there are big
   technical changes that make you choose to view the tag as
   out-of-date then drop the tag but mention why in the patch
   changelog.


> ---
>  Documentation/dev-tools/kgdb.rst | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/Documentation/dev-tools/kgdb.rst b/Documentation/dev-tools/kgdb.rst
> index 43456244651a..7c90e111b364 100644
> --- a/Documentation/dev-tools/kgdb.rst
> +++ b/Documentation/dev-tools/kgdb.rst
> @@ -557,7 +557,7 @@ Connecting with gdb to a serial port
>     Example (using a directly connected port)::
> 
>             % gdb ./vmlinux
> -           (gdb) set remotebaud 115200
> +           (gdb) set serial baud 115200
>             (gdb) target remote /dev/ttyS0
> 
> 
> --
> 2.34.1
> Hyperstone GmbH | Reichenaustr. 39a  | 78467 Konstanz
> Managing Director: Dr. Jan Peter Berns.
> Commercial register of local courts: Freiburg HRB381782
> 

Re: [PATCHv2] Documentation: kgdb: Replace deprecated remotebaud

[Jonathan Corbet]

Christian Löhle <CLoehle@hyperstone.com> writes:

> Using set remotebaud to set the baud rate was deprecated in
> gdb-7.7 and completely removed from the command parser in gdb-7.8
> (released in 2014). Adopt set serial baud instead.
>
> Signed-off-by: Christian Loehle <cloehle@hyperstone.com>
> ---
>  Documentation/dev-tools/kgdb.rst | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/Documentation/dev-tools/kgdb.rst b/Documentation/dev-tools/kgdb.rst
> index 43456244651a..7c90e111b364 100644
> --- a/Documentation/dev-tools/kgdb.rst
> +++ b/Documentation/dev-tools/kgdb.rst
> @@ -557,7 +557,7 @@ Connecting with gdb to a serial port
>     Example (using a directly connected port)::
>  
>             % gdb ./vmlinux
> -           (gdb) set remotebaud 115200
> +           (gdb) set serial baud 115200
>             (gdb) target remote /dev/ttyS0

I've applied this, thanks.

I can help but wonder, though, whether the historical information in the
changelog actually belongs in the document itself.  A user on some
ancient system who can't make the example work is probably unlikely to
consult the git history when looking for a solution.

jon

[PATCHv3] Documentation: kgdb: Replace deprecated remotebaud

[Christian Löhle]

Using set remotebaud to set the baud rate was deprecated in
gdb-7.7 and completely removed from the command parser in gdb-7.8
(released in 2014). Adopt set serial baud instead.

Change since v2:
  - Add historical example in the documentation

Signed-off-by: Christian Loehle <cloehle@hyperstone.com>
---
 Documentation/dev-tools/kgdb.rst | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)

diff --git a/Documentation/dev-tools/kgdb.rst b/Documentation/dev-tools/kgdb.rst
index 43456244651a..d7acb2bdb0ba 100644
--- a/Documentation/dev-tools/kgdb.rst
+++ b/Documentation/dev-tools/kgdb.rst
@@ -557,9 +557,14 @@ Connecting with gdb to a serial port
    Example (using a directly connected port)::
 
            % gdb ./vmlinux
-           (gdb) set remotebaud 115200
+           (gdb) set serial baud 115200
            (gdb) target remote /dev/ttyS0
 
+   Example (using a directly connected port with gdb version < 7.8)::
+
+           % gdb ./vmlinux
+           (gdb) set remotebaud 115200
+           (gdb) target remote /dev/ttyS0
 
    Example (kgdb to a terminal server on TCP port 2012)::
 
-- 
2.34.1
Hyperstone GmbH | Reichenaustr. 39a  | 78467 Konstanz
Managing Director: Dr. Jan Peter Berns.
Commercial register of local courts: Freiburg HRB381782