blob: ddf3673eb1992fb3fbc633e7c10c88be09423296 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
|
#!/usr/bin/env python3
# Wireshark - Network traffic analyzer
# By Gerald Combs <gerald@wireshark.org>
# Copyright 1998 Gerald Combs
#
# SPDX-License-Identifier: GPL-2.0-or-later
'''
Go through all user guide help URLs listed in the program
and confirm these are present in the User's Guide source files.
'''
from re import search
from glob import glob
from sys import exit
found = {}
with open("ui/help_url.c") as f:
for line in f:
if url := search(r"user_guide_url\(\"(.*).html\"\);", line):
chapter = url.group(1)
found[chapter] = False
adoc_files = glob("docbook/wsug_src/*.adoc")
for adoc_file in adoc_files:
with open(adoc_file) as f:
for line in f:
# Fail on legacy block anchor syntax (double square brackets)
if tag := search(r"^\[\#(.*)]", line):
chapter = tag.group(1)
if chapter in found:
found[chapter] = True
missing = False
for chapter in found:
if not found[chapter]:
if not missing:
print("The following chapters are missing in the User's Guide:")
missing = True
print(chapter)
if missing:
exit(-1)
|
