check_update_docs Namespace Reference

Functions
str	read_text (str path)
None	write_text (str path, str content)
str	generate_updated_list ()
int	main (Sequence[str] argv)

Variables
Final	EXTRA_DIR = os.path.join(os.path.dirname(__file__), "../..")
Final	CLANG_TIDY_DIR = os.path.join(EXTRA_DIR, "clang-tidy")
Final	DOCS_DIR = os.path.join(EXTRA_DIR, "docs")
Final	LIST_DOC = os.path.join(DOCS_DIR, "clang-tidy", "checks", "list.rst")

Detailed Description

Clang-Tidy Check List Checker
=============================

This wrapper script runs `add_new_check.py --update-docs` on
a temporary copy of clang-tools-extra/{clang-tidy,docs} and
writes the generated docs/clang-tidy/checks/list.rst to the
requested output path.

Function Documentation

generate_updated_list()

str check_update_docs.generate_updated_list

(

)

Definition at line 48 of file check_update_docs.py.

References read_text().

Referenced by main().

main()

int check_update_docs.main

(

Sequence[str]

argv

)

Definition at line 75 of file check_update_docs.py.

References generate_updated_list(), main(), read_text(), and write_text().

Referenced by main().

read_text()

str check_update_docs.read_text

(

str

path

)

Definition at line 38 of file check_update_docs.py.

Referenced by generate_updated_list(), and main().

write_text()

None check_update_docs.write_text	(	str	path,
		str	content )

Definition at line 43 of file check_update_docs.py.

Referenced by main().

Variable Documentation

CLANG_TIDY_DIR

Final check_update_docs.CLANG_TIDY_DIR = os.path.join(EXTRA_DIR, "clang-tidy")

Definition at line 33 of file check_update_docs.py.

DOCS_DIR

Final check_update_docs.DOCS_DIR = os.path.join(EXTRA_DIR, "docs")

Definition at line 34 of file check_update_docs.py.

EXTRA_DIR

Final check_update_docs.EXTRA_DIR = os.path.join(os.path.dirname(__file__), "../..")

Definition at line 32 of file check_update_docs.py.

LIST_DOC

Final check_update_docs.LIST_DOC = os.path.join(DOCS_DIR, "clang-tidy", "checks", "list.rst")

Definition at line 35 of file check_update_docs.py.