[1/2] doc: install: document bootstrap-ubsan

Message ID 8b554f975768a30672c6b37819f004881c4c3bb9.1730409074.git.sam@gentoo.org
State Committed
Commit 8f791fac1419a5dc663abd5091cf4db409539b33
Headers
Series [1/2] doc: install: document bootstrap-ubsan |

Checks

Context Check Description
linaro-tcwg-bot/tcwg_gcc_build--master-arm success Build passed
linaro-tcwg-bot/tcwg_gcc_build--master-aarch64 success Build passed
linaro-tcwg-bot/tcwg_gcc_check--master-aarch64 pending Patch applied

Commit Message

Sam James Oct. 31, 2024, 9:11 p.m. UTC
  gcc/ChangeLog:
	PR other/116948

	* doc/install.texi (Building a native compiler): Mention bootstrap-ubsan.
---
 gcc/doc/install.texi | 4 ++++
 1 file changed, 4 insertions(+)
  

Comments

Filip Kastl Nov. 6, 2024, 9:20 a.m. UTC | #1
Hi,

I'm not a maintainer but I think we certainly want to have bootstrap-ubsan
documented and the patch looks good to me.

Cheers,
Filip

On Thu 2024-10-31 21:11:13, Sam James wrote:
> gcc/ChangeLog:
> 	PR other/116948
> 
> 	* doc/install.texi (Building a native compiler): Mention bootstrap-ubsan.
> ---
>  gcc/doc/install.texi | 4 ++++
>  1 file changed, 4 insertions(+)
> 
> diff --git a/gcc/doc/install.texi b/gcc/doc/install.texi
> index f19d55f76c3d..85896721a0ac 100644
> --- a/gcc/doc/install.texi
> +++ b/gcc/doc/install.texi
> @@ -3151,6 +3151,10 @@ Compiles GCC itself using HWAddress Sanitization in order to catch invalid
>  memory accesses within the GCC code.  This option is only available on AArch64
>  systems that are running Linux kernel version 5.4 or later.
>  
> +@item @samp{bootstrap-ubsan}
> +Compiles GCC itself using Undefined Behavior Sanitization in order to catch
> +undefined behavior within the GCC code.
> +
>  @end table
>  
>  @section Building a cross compiler
> -- 
> 2.47.0
>
  

Patch

diff --git a/gcc/doc/install.texi b/gcc/doc/install.texi
index f19d55f76c3d..85896721a0ac 100644
--- a/gcc/doc/install.texi
+++ b/gcc/doc/install.texi
@@ -3151,6 +3151,10 @@  Compiles GCC itself using HWAddress Sanitization in order to catch invalid
 memory accesses within the GCC code.  This option is only available on AArch64
 systems that are running Linux kernel version 5.4 or later.
 
+@item @samp{bootstrap-ubsan}
+Compiles GCC itself using Undefined Behavior Sanitization in order to catch
+undefined behavior within the GCC code.
+
 @end table
 
 @section Building a cross compiler