[1/2] gdb/doc: rename "x86 Architecture-specific Issues" section to "x86"

Message ID 20230908152102.32731-1-simon.marchi@efficios.com
State New
Headers
Series [1/2] gdb/doc: rename "x86 Architecture-specific Issues" section to "x86" |

Checks

Context Check Description
linaro-tcwg-bot/tcwg_gdb_build--master-aarch64 fail Patch failed to apply
linaro-tcwg-bot/tcwg_gdb_build--master-arm fail Patch failed to apply
linaro-tcwg-bot/tcwg_gdb_check--master-aarch64 fail Patch failed to apply
linaro-tcwg-bot/tcwg_gdb_check--master-arm fail Patch failed to apply

Commit Message

Simon Marchi Sept. 8, 2023, 3:20 p.m. UTC
  I'm looking to add some x86-specific information to the doc, but I find
the naming of this section odd.  It doesn't really talk about issues, it
just gives generally useful information.  Also, the sections about other
architectures don't mention "issues", just the architecture name.

Also, at least in the HTML version of the doc, the name is inconsistent
between the main table of content, where it appears as "x86
Architecture-specific Issues", and the sub-table of contents of the
"Architectures" section, where it appears as "i386".

Rename the section to just "x86".

Change-Id: I0a119ff1ab5e7b83c9afa3c3977eb085e88f52ca
---
 gdb/doc/gdb.texinfo | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)


base-commit: 9c5bc1bd1399c11427deec1f8de6c537ab249087
  

Comments

Eli Zaretskii Sept. 8, 2023, 3:37 p.m. UTC | #1
> Cc: Simon Marchi <simon.marchi@efficios.com>
> Date: Fri,  8 Sep 2023 11:20:57 -0400
> From: Simon Marchi via Gdb-patches <gdb-patches@sourceware.org>
> 
> I'm looking to add some x86-specific information to the doc, but I find
> the naming of this section odd.  It doesn't really talk about issues, it
> just gives generally useful information.  Also, the sections about other
> architectures don't mention "issues", just the architecture name.
> 
> Also, at least in the HTML version of the doc, the name is inconsistent
> between the main table of content, where it appears as "x86
> Architecture-specific Issues", and the sub-table of contents of the
> "Architectures" section, where it appears as "i386".
> 
> Rename the section to just "x86".

Assuming the information there is good for x86_64 as well, this is
fine by me.

Approved-By: Eli Zaretskii <eliz@gnu.org>
  
Simon Marchi Sept. 8, 2023, 5:17 p.m. UTC | #2
On 9/8/23 11:37, Eli Zaretskii via Gdb-patches wrote:
>> Cc: Simon Marchi <simon.marchi@efficios.com>
>> Date: Fri,  8 Sep 2023 11:20:57 -0400
>> From: Simon Marchi via Gdb-patches <gdb-patches@sourceware.org>
>>
>> I'm looking to add some x86-specific information to the doc, but I find
>> the naming of this section odd.  It doesn't really talk about issues, it
>> just gives generally useful information.  Also, the sections about other
>> architectures don't mention "issues", just the architecture name.
>>
>> Also, at least in the HTML version of the doc, the name is inconsistent
>> between the main table of content, where it appears as "x86
>> Architecture-specific Issues", and the sub-table of contents of the
>> "Architectures" section, where it appears as "i386".
>>
>> Rename the section to just "x86".
> 
> Assuming the information there is good for x86_64 as well, this is
> fine by me.

I think it is.

> Approved-By: Eli Zaretskii <eliz@gnu.org>

Thanks, pushed.

Simon
  

Patch

diff --git a/gdb/doc/gdb.texinfo b/gdb/doc/gdb.texinfo
index 8be9725d1a27..72083fc5b64f 100644
--- a/gdb/doc/gdb.texinfo
+++ b/gdb/doc/gdb.texinfo
@@ -26096,7 +26096,7 @@  all uses of @value{GDBN} with the architecture, both native and cross.
 
 @menu
 * AArch64::
-* i386::
+* x86::
 * Alpha::
 * MIPS::
 * HPPA::               HP PA architecture
@@ -26206,8 +26206,8 @@  information automatically from the core file, and will show one of the above
 messages depending on whether the synchronous or asynchronous mode is selected.
 @xref{Memory Tagging}. @xref{Memory}.
 
-@node i386
-@subsection x86 Architecture-specific Issues
+@node x86
+@subsection x86
 
 @table @code
 @item set struct-convention @var{mode}