[PATCH] algol68: Documentation fixes

Thu Mar 20 19:02:00 GMT 2025

Hello Pietro.

Thanks for the patch.
I have pushed it on your behalf.

> I was working on adding the `-I' option to ga68 and realized I needed to run `make regenerate-opt-urls' after editing `lang.opt'. At first it didn't work so I fixed it. The only change to `ga68.texi' that is strictly necessary is the capitalization of `Option Index', but the others are nice to have IMHO ;)
>
> gcc/ChangeLog:
>
> 	* Makefile.in (OPT_URLS_HTML_DEPS): Add the Algol68 Option-Index.html
> 	file to the dependency list.
> 	* algol68/Make-lang.in ($(build_htmldir)/ga68/index.html): Use makeinfo
> 	flags from gcc/Makefile.
> 	(algol68.html): Fix the variable name for the internals dependency.
> 	* algol68/ga68.texi: Change copyright variable name to use ga68.
> 	Add short table of contents.
> 	Capitalize title of index chapters.
> 	Add @item for `fa68-nil-checking' option.
> 	* algol68/lang.opt.urls: Regenerate.
> 	* common.opt.urls: Regenerate.
> 	* regenerate-opt-urls.py (PER_LANGUAGE_OPTION_INDEXES): Add Algol68.
>
> Signed-off-by: Pietro Monteiro <pietro@sociotechnical.xyz>
> ---
>  gcc/Makefile.in            |  3 ++-
>  gcc/algol68/Make-lang.in   |  5 ++--
>  gcc/algol68/ga68.texi      | 16 ++++++------
>  gcc/algol68/lang.opt.urls  | 50 +++++++++++++++++++++-----------------
>  gcc/common.opt.urls        |  3 +++
>  gcc/regenerate-opt-urls.py |  3 ++-
>  6 files changed, 47 insertions(+), 33 deletions(-)
>
> diff --git a/gcc/Makefile.in b/gcc/Makefile.in
> index 66f8d8e7cb1..e4c3ead4efd 100644
> --- a/gcc/Makefile.in
> +++ b/gcc/Makefile.in
> @@ -3851,7 +3851,8 @@ $(build_htmldir)/gccinstall/index.html: $(TEXI_GCCINSTALL_FILES)
>  .PHONY: regenerate-opt-urls
>  OPT_URLS_HTML_DEPS = $(build_htmldir)/gcc/Option-Index.html \
>  	$(build_htmldir)/gdc/Option-Index.html \
> -	$(build_htmldir)/gfortran/Option-Index.html
> +	$(build_htmldir)/gfortran/Option-Index.html \
> +	$(build_htmldir)/ga68/Option-Index.html
>  $(OPT_URLS_HTML_DEPS): %/Option-Index.html: %/index.html
>  
>  regenerate-opt-urls: $(srcdir)/regenerate-opt-urls.py $(OPT_URLS_HTML_DEPS)
> diff --git a/gcc/algol68/Make-lang.in b/gcc/algol68/Make-lang.in
> index 5a9ba2275bf..569e94ada7d 100644
> --- a/gcc/algol68/Make-lang.in
> +++ b/gcc/algol68/Make-lang.in
> @@ -159,7 +159,8 @@ doc/ga68.pdf: $(A68_MANUAL_FILES)
>  $(build_htmldir)/ga68/index.html: $(A68_MANUAL_FILES)
>  	$(mkinstalldirs) $(@D)
>  	rm -f $(@D)/*
> -	$(TEXI2HTML) -I $(gcc_docdir)/include -I $(srcdir)/d -o $(@D) $<
> +	$(TEXI2HTML) $(MAKEINFO_TOC_INLINE_FLAG) \
> +		-I $(gcc_docdir)/include -I $(srcdir)/d -o $(@D) $<
>  
>  .INTERMEDIATE: ga68.pod
>  
> @@ -177,7 +178,7 @@ algol68.info: doc/ga68.info doc/ga68-internals.info
>  algol68.dvi: doc/ga68.dvi
>  algol68.pdf: doc/ga68.pdf
>  algol68.install-pdf:
> -algol68.html: $(build_htmldir)/ga68/index.html $(build_html)/ga68-internals/index.html
> +algol68.html: $(build_htmldir)/ga68/index.html $(build_htmldir)/ga68-internals/index.html
>  algol68.man: doc/ga68.1
>  algol68.srcinfo: doc/ga68.info doc/ga68-internals.info
>  	-cp -p $^ $(srcdir)/doc
> diff --git a/gcc/algol68/ga68.texi b/gcc/algol68/ga68.texi
> index 28df79448e9..8ed75f1d459 100644
> --- a/gcc/algol68/ga68.texi
> +++ b/gcc/algol68/ga68.texi
> @@ -36,11 +36,11 @@
>  @include gcc-common.texi
>  
>  @c Copyright years for this manual.
> -@set copyrights-d 2025
> +@set copyrights-ga68 2025
>  
>  @copying
>  @c man begin COPYRIGHT
> -Copyright @copyright{} @value{copyrights-d} Free Software Foundation, Inc.
> +Copyright @copyright{} @value{copyrights-ga68} Free Software Foundation, Inc.
>  
>  Permission is granted to copy, distribute and/or modify this document
>  under the terms of the GNU Free Documentation License, Version 1.3 or
> @@ -77,6 +77,7 @@ man page gfdl(7).
>  @sp 1
>  @insertcopying
>  @end titlepage
> +@summarycontents
>  @contents
>  @page
>  
> @@ -101,8 +102,8 @@ bibliography.
>  * Copying::                     The GNU General Public License.
>  * GNU Free Documentation License::
>                                  How you can share and copy this manual.
> -* Option index::                Index of command line options.
> -* General index::               General index.
> +* Option Index::                Index of command line options.
> +* General Index::               General index.
>  @end menu
>  
>  @node Invoking ga68
> @@ -218,6 +219,7 @@ Turn off code generation for @code{ASSERT} contracts.
>  
>  @opindex fa68-nil-checking
>  @opindex fno-a68-nil-checking
> +@item -fa68-nil-checking
>  Turn on code generation of run-time checks for NIL while
>  dereferencing.
>  
> @@ -2024,8 +2026,8 @@ pattern of the value rather than zero.  Therefore, @code{@B{bin} -
>  @include gpl_v3.texi
>  @include fdl.texi
>  
> -@node Option index
> -@unnumbered Option index
> +@node Option Index
> +@unnumbered Option Index
>  
>  @command{ga68}'s command line options are indexed here without any initial
>  @samp{-} or @samp{--}.  Where an option has both positive and negative forms
> @@ -2035,7 +2037,7 @@ sometimes be useful to look up both forms.
>  
>  @printindex op
>  
> -@node General index
> +@node General Index
>  @unnumbered Index
>  
>  @printindex cp
> diff --git a/gcc/algol68/lang.opt.urls b/gcc/algol68/lang.opt.urls
> index 3d899ae97b0..ab3296983b8 100644
> --- a/gcc/algol68/lang.opt.urls
> +++ b/gcc/algol68/lang.opt.urls
> @@ -1,32 +1,38 @@
> -; Autogenerated by regenerate-opt-urls.py from gcc/rust/lang.opt and generated HTML
> +; Autogenerated by regenerate-opt-urls.py from gcc/algol68/lang.opt and generated HTML
>  
> -I
> -UrlSuffix(gcc/Directory-Options.html#index-I) LangUrlSuffix_D(gdc/Directory-Options.html#index-I)
> +Wextensions
> +LangUrlSuffix_Algol68(ga68/Warnings-options.html#index-Wextensions)
>  
> -L
> -UrlSuffix(gcc/Directory-Options.html#index-L) LangUrlSuffix_D(gdc/Directory-Options.html#index-L)
> +Wvoiding
> +LangUrlSuffix_Algol68(ga68/Warnings-options.html#index-Wno-voiding)
>  
> -; skipping UrlSuffix for 'Wall' due to multiple URLs:
> -;   duplicate: 'gcc/Standard-Libraries.html#index-Wall-1'
> -;   duplicate: 'gcc/Warning-Options.html#index-Wall'
> -Wall
> -LangUrlSuffix_D(gdc/Warnings.html#index-Wall)
> +Wextra
> +UrlSuffix(gcc/Warning-Options.html#index-Wextra) LangUrlSuffix_D(gdc/Warnings.html#index-Wextra) LangUrlSuffix_Fortran(gfortran/Error-and-Warning-Options.html#index-Wextra)
>  
> -Wunused-variable
> -UrlSuffix(gcc/Warning-Options.html#index-Wno-unused-variable)
> +Wscope
> +LangUrlSuffix_Algol68(ga68/Warnings-options.html#index-Wno-scope)
>  
> -Wunused-const-variable
> -UrlSuffix(gcc/Warning-Options.html#index-Wno-unused-const-variable)
> +Whidden-declarations
> +LangUrlSuffix_Algol68(ga68/Warnings-options.html#index-Whidden-declarations)
>  
> -Wunused-const-variable=
> -UrlSuffix(gcc/Warning-Options.html#index-Wno-unused-const-variable)
> +fa68-assert
> +LangUrlSuffix_Algol68(ga68/Runtime-options.html#index-fa68-assert)
>  
> -Wunused-result
> -UrlSuffix(gcc/Warning-Options.html#index-Wno-unused-result)
> +fa68-nil-checking
> +LangUrlSuffix_Algol68(ga68/Runtime-options.html#index-fa68-nil-checking)
>  
> -Winfinite-recursion
> -UrlSuffix(gcc/Warning-Options.html#index-Winfinite-recursion)
> +fa68-bounds-checking
> +LangUrlSuffix_Algol68(ga68/Runtime-options.html#index-fa68-bounds-checking)
>  
> -o
> -UrlSuffix(gcc/Overall-Options.html#index-o)
> +fdump-algol68-modes
> +LangUrlSuffix_Algol68(ga68/Developer-options.html#index-fdump-algol68-modes)
> +
> +fdump-algol68-tree
> +LangUrlSuffix_Algol68(ga68/Developer-options.html#index-fdump-algol68-tree)
> +
> +static-libga68
> +LangUrlSuffix_Algol68(ga68/Linking-options.html#index-static-libga68)
> +
> +shared-libga68
> +LangUrlSuffix_Algol68(ga68/Linking-options.html#index-shared-libga68)
>  
> diff --git a/gcc/common.opt.urls b/gcc/common.opt.urls
> index 79c322bed2b..44f00f27043 100644
> --- a/gcc/common.opt.urls
> +++ b/gcc/common.opt.urls
> @@ -1867,6 +1867,9 @@ UrlSuffix(gcc/Overall-Options.html#index-specs)
>  ;   duplicate: 'gcc/Darwin-Options.html#index-static-1'
>  ;   duplicate: 'gcc/Link-Options.html#index-static'
>  
> +static-libga68
> +LangUrlSuffix_Algol68(ga68/Linking-options.html#index-static-libga68)
> +
>  static-libgcc
>  UrlSuffix(gcc/Link-Options.html#index-static-libgcc)
>  
> diff --git a/gcc/regenerate-opt-urls.py b/gcc/regenerate-opt-urls.py
> index 2daa1d603f0..bda91905ace 100755
> --- a/gcc/regenerate-opt-urls.py
> +++ b/gcc/regenerate-opt-urls.py
> @@ -361,7 +361,8 @@ def write_url_file(index, optfile, dstfile):
>  PER_LANGUAGE_OPTION_INDEXES = [
>      ('gcc/Option-Index.html', None),
>      ('gdc/Option-Index.html', 'D'),
> -    ('gfortran/Option-Index.html', 'Fortran')
> +    ('gfortran/Option-Index.html', 'Fortran'),
> +    ('ga68/Option-Index.html', 'Algol68'),
>  ]
>  
>  def main(args):