regenerate-opt-urls Namespace Reference

Data Structures
class	Index
class	OptFile
class	TestFiltering
class	TestParsingIndex

Functions
	canonicalize_option_name (option_name)
	canonicalize_url_suffix (url_suffix)
	target_specific (url_suffix)
	filter_urlsuffixes_for_optfile (optfile, url_suffixes)
	write_url_file (index, optfile, dstfile)
	main (args)

Variables
str	DESCRIPTION
dict	TARGET_SPECIFIC_PAGES
list	PER_LANGUAGE_OPTION_INDEXES
	parser
	type
	action
	args = parser.parse_args()
	INPUT_HTML_PATH = args.base_html_dir
	argv

Function Documentation

canonicalize_option_name()

regenerate-opt-urls.canonicalize_option_name

(

option_name

)

Referenced by regenerate-opt-urls.Index.add_entry(), and regenerate-opt-urls.Index.get_url_suffixes().

canonicalize_url_suffix()

regenerate-opt-urls.canonicalize_url_suffix

(

url_suffix

)

Various options have anchors for both the positive and
negative form.  For example -Wcpp has both:
  'gcc/Warning-Options.html#index-Wno-cpp'
  'gcc/Warning-Options.html#index-Wcpp'

Return a canonicalized version of the url_suffix that
strips out any "no-" prefixes, for use in deduplication.
Note that the resulting url suffix might not correspond to
an actual anchor in the HTML.

Referenced by regenerate-opt-urls.Index.add_entry().

filter_urlsuffixes_for_optfile()

regenerate-opt-urls.filter_urlsuffixes_for_optfile	(		optfile,
			url_suffixes )

Filter out target-specific options for the wrong target.

References target_specific().

Referenced by regenerate-opt-urls.TestFiltering.test_filter(), and write_url_file().

main()

regenerate-opt-urls.main

(

args

)

References write_url_file().

target_specific()

regenerate-opt-urls.target_specific

(

url_suffix

)

Referenced by filter_urlsuffixes_for_optfile(), and regenerate-opt-urls.TestFiltering.test_target_specific().

write_url_file()

regenerate-opt-urls.write_url_file	(		index,
			optfile,
			dstfile )

References filter_urlsuffixes_for_optfile().

Referenced by main().

Variable Documentation

action

regenerate-opt-urls.action

args

regenerate-opt-urls.args = parser.parse_args()

argv

regenerate-opt-urls.argv

DESCRIPTION

str regenerate-opt-urls.DESCRIPTION

Initial value:

=  """
Parses the generated HTML (from "make html") to locate anchors
for options, then parses the .opt files within the source tree,
and generates a .opt.urls in the source tree for each .opt file,
giving URLs for each option, where it can.
 
Usage (from build/gcc subdirectory):
  ../../src/gcc/regenerate-opt-urls.py HTML/gcc-14.0.0/ ../../src
 
To run unit tests:
  ../../src/gcc/regenerate-opt-urls.py HTML/gcc-14.0.0/ ../../src --unit-test
"""

INPUT_HTML_PATH

regenerate-opt-urls.INPUT_HTML_PATH = args.base_html_dir

parser

regenerate-opt-urls.parser

Initial value:

=  argparse.ArgumentParser(description=DESCRIPTION,
                                     formatter_class=argparse.RawDescriptionHelpFormatter)

PER_LANGUAGE_OPTION_INDEXES

list regenerate-opt-urls.PER_LANGUAGE_OPTION_INDEXES

Initial value:

=  [
    ('gcc/Option-Index.html', None),
    ('gdc/Option-Index.html', 'D'),
    ('gfortran/Option-Index.html', 'Fortran')
]

TARGET_SPECIFIC_PAGES

dict regenerate-opt-urls.TARGET_SPECIFIC_PAGES

type

regenerate-opt-urls.type