[RFAv2] Fine tune exec-file-mismatch help and documentation.

[RFAv2] Fine tune exec-file-mismatch help and documentation.

[Philippe Waroquiers]

It was deemed better to explicitly mention in help and doc that build IDs
are used for comparison, and that symbols are loaded when asking to
load the exec-file.

This is V2, fixing 2 typos and replacing 'If the user asks to load'
by 'If the user confirms loading', as suggested by Pedro.

gdb/ChangeLog
2020-07-04  Philippe Waroquiers  <philippe.waroquiers@skynet.be>

	* exec.c (_initialize_exec): Update exec-file-mismatch help.

gdb/doc/ChangeLog
2020-07-04  Philippe Waroquiers  <philippe.waroquiers@skynet.be>

	* gdb.texinfo (Attach): Update exec-file-mismatch doc.
---
 gdb/doc/gdb.texinfo | 2 ++
 gdb/exec.c          | 8 ++++++--
 2 files changed, 8 insertions(+), 2 deletions(-)

diff --git a/gdb/doc/gdb.texinfo b/gdb/doc/gdb.texinfo
index fbe9f850af..eac3a3a87e 100644
--- a/gdb/doc/gdb.texinfo
+++ b/gdb/doc/gdb.texinfo
@@ -3016,6 +3016,8 @@ by @value{GDBN} and the executable file used to start the process.  If
 @samp{ask}, the default, display a warning and ask the user whether to
 load the process executable file; if @samp{warn}, just display a
 warning; if @samp{off}, don't attempt to detect a mismatch.
+If the user confirms loading the process executable file, then its symbols
+will be loaded as well.
 
 @cindex show exec-file-mismatch
 @item show exec-file-mismatch
diff --git a/gdb/exec.c b/gdb/exec.c
index de473fbcb2..2ff5846c0e 100644
--- a/gdb/exec.c
+++ b/gdb/exec.c
@@ -305,7 +305,7 @@ validate_exec_file (int from_tty)
 	exec_file_target = TARGET_SYSROOT_PREFIX + exec_file_target;
 
       warning
-	(_("Mismatch between current exec-file %ps\n"
+	(_("Build ID mismatch between current exec-file %ps\n"
 	   "and automatically determined exec-file %ps\n"
 	   "exec-file-mismatch handling is currently \"%s\""),
 	 styled_string (file_name_style.style (), current_exec_file),
@@ -1269,7 +1269,11 @@ loaded by GDB and the exec-file automatically determined when attaching\n\
 to a process:\n\n\
  ask  - warn the user and ask whether to load the determined exec-file.\n\
  warn - warn the user, but do not change the exec-file.\n\
- off  - do not check for mismatch."),
+ off  - do not check for mismatch.\n\
+\n\
+GDB detects a mismatch by comparing the build IDs of the files.\n\
+If the user confirms loading the determined exec-file, then its symbols\n\
+will be loaded as well."),
 			set_exec_file_mismatch_command,
 			show_exec_file_mismatch_command,
 			&setlist, &showlist);
-- 
2.20.1

Re: [RFAv2] Fine tune exec-file-mismatch help and documentation.

[Philippe Waroquiers]

Ping.
Thanks
Philippe


On Sat, 2020-07-04 at 16:23 +0200, Philippe Waroquiers wrote:
> It was deemed better to explicitly mention in help and doc that build IDs
> are used for comparison, and that symbols are loaded when asking to
> load the exec-file.
> 
> This is V2, fixing 2 typos and replacing 'If the user asks to load'
> by 'If the user confirms loading', as suggested by Pedro.
> 
> gdb/ChangeLog
> 2020-07-04  Philippe Waroquiers  <philippe.waroquiers@skynet.be>
> 
> 	* exec.c (_initialize_exec): Update exec-file-mismatch help.
> 
> gdb/doc/ChangeLog
> 2020-07-04  Philippe Waroquiers  <philippe.waroquiers@skynet.be>
> 
> 	* gdb.texinfo (Attach): Update exec-file-mismatch doc.
> ---
>  gdb/doc/gdb.texinfo | 2 ++
>  gdb/exec.c          | 8 ++++++--
>  2 files changed, 8 insertions(+), 2 deletions(-)
> 
> diff --git a/gdb/doc/gdb.texinfo b/gdb/doc/gdb.texinfo
> index fbe9f850af..eac3a3a87e 100644
> --- a/gdb/doc/gdb.texinfo
> +++ b/gdb/doc/gdb.texinfo
> @@ -3016,6 +3016,8 @@ by @value{GDBN} and the executable file used to start the process.  If
>  @samp{ask}, the default, display a warning and ask the user whether to
>  load the process executable file; if @samp{warn}, just display a
>  warning; if @samp{off}, don't attempt to detect a mismatch.
> +If the user confirms loading the process executable file, then its symbols
> +will be loaded as well.
>  
>  @cindex show exec-file-mismatch
>  @item show exec-file-mismatch
> diff --git a/gdb/exec.c b/gdb/exec.c
> index de473fbcb2..2ff5846c0e 100644
> --- a/gdb/exec.c
> +++ b/gdb/exec.c
> @@ -305,7 +305,7 @@ validate_exec_file (int from_tty)
>  	exec_file_target = TARGET_SYSROOT_PREFIX + exec_file_target;
>  
>        warning
> -	(_("Mismatch between current exec-file %ps\n"
> +	(_("Build ID mismatch between current exec-file %ps\n"
>  	   "and automatically determined exec-file %ps\n"
>  	   "exec-file-mismatch handling is currently \"%s\""),
>  	 styled_string (file_name_style.style (), current_exec_file),
> @@ -1269,7 +1269,11 @@ loaded by GDB and the exec-file automatically determined when attaching\n\
>  to a process:\n\n\
>   ask  - warn the user and ask whether to load the determined exec-file.\n\
>   warn - warn the user, but do not change the exec-file.\n\
> - off  - do not check for mismatch."),
> + off  - do not check for mismatch.\n\
> +\n\
> +GDB detects a mismatch by comparing the build IDs of the files.\n\
> +If the user confirms loading the determined exec-file, then its symbols\n\
> +will be loaded as well."),
>  			set_exec_file_mismatch_command,
>  			show_exec_file_mismatch_command,
>  			&setlist, &showlist);

Re: [RFAv2] Fine tune exec-file-mismatch help and documentation.

[Pedro Alves]

On 7/4/20 3:23 PM, Philippe Waroquiers via Gdb-patches wrote:
> It was deemed better to explicitly mention in help and doc that build IDs
> are used for comparison, and that symbols are loaded when asking to
> load the exec-file.
> 
> This is V2, fixing 2 typos and replacing 'If the user asks to load'
> by 'If the user confirms loading', as suggested by Pedro.
> 
> gdb/ChangeLog
> 2020-07-04  Philippe Waroquiers  <philippe.waroquiers@skynet.be>
> 
> 	* exec.c (_initialize_exec): Update exec-file-mismatch help.
> 
> gdb/doc/ChangeLog
> 2020-07-04  Philippe Waroquiers  <philippe.waroquiers@skynet.be>
> 
> 	* gdb.texinfo (Attach): Update exec-file-mismatch doc.

This version LGTM.  I think Eli approved the previous version
so this should be good to go.

Thanks,
Pedro Alves