This isn't really meant for inclusion as it's a bit of a hackjob, but I
figured it would be best to share it in some form or another to serve as
a basis for a kind of meta-review of the crossreferenceification series.
This script is designed to convert 'name', "name", name, and @name
instances in qapi/*.json files to `name` for the purposes of
cross-referencing commands, events, and data types in the generated HTML
documentation. It is specifically tuned for our QAPI files and is not
suitable for running on generic rST source files. It can likely be made
to operate on QEMU guest agent or other qapi JSON files with some edits
to which files its opening.
Navigate to your qemu/qapi/ directory and run this script with "python
insert_crossrefs.py" and it'll handle the rest. Definitely don't run it
in a non-git-controlled folder, it edits your source files.
(Yes, in polishing this script, I found a few instances of
cross-references I missed in my v1 series. I figure I'll let us discuss
the conversion a bit before I send out a v2 patchbomb.)
Signed-off-by: John Snow <js...@redhat.com>
---
contrib/autoxref/insert_crossrefs.py | 69 ++++++++++++++++++++++++++++
1 file changed, 69 insertions(+)
create mode 100644 contrib/autoxref/insert_crossrefs.py
diff --git a/contrib/autoxref/insert_crossrefs.py
b/contrib/autoxref/insert_crossrefs.py
new file mode 100644
index 00000000000..399dd7524c2
--- /dev/null
+++ b/contrib/autoxref/insert_crossrefs.py
@@ -0,0 +1,69 @@
+# SPDX-License-Identifier: GPL-2.0-or-later
+
+import os
+import re
+import sys
+
+if not os.path.exists("qapi-schema.json"):
+ raise Exception(
+ "This script was meant to be run from the qemu.git/qapi directory."
+ )
+sys.path.append("../scripts/")
+
+from qapi.schema import QAPISchema, QAPISchemaDefinition
+
+# Adjust this global to exclude certain tokens from being xreffed.
+SKIP_TOKENS = ('String', 'stop', 'transaction', 'eject', 'migrate', 'quit')
+
+print("Compiling schema to build list of reference-able entities ...", end='')
+tokens = []
+schema = QAPISchema("qapi-schema.json")
+for ent in schema._entity_list:
+ if isinstance(ent, QAPISchemaDefinition) and not ent.is_implicit():
+ if ent.name not in SKIP_TOKENS:
+ tokens.append(ent.name)
+print("OK")
+
+patt_names = r'(' + '|'.join(tokens) + r')'
+
+# catch 'token' and "token" specifically
+patt = re.compile(r'([\'"]|``)' + patt_names + r'\1')
+# catch naked instances of token, excluding those where prefixed or
+# suffixed by a quote, dash, or word character. Exclude "@" references
+# specifically to handle them elsewhere. Exclude <name> matches, as
+# these are explicit cross-reference targets.
+patt2 = r"(?<![-@`'\"\w<])" + patt_names + r"(?![-`'\"\w>])"
+# catch @references. prohibit when followed by ":" to exclude members
+# whose names happen to match xreffable entities.
+patt3 = r"@" + patt_names + r"(?![-\w:])"
+
+
+
+
+for file in os.scandir():
+ outlines = []
+ if not file.name.endswith(".json"):
+ continue
+ print(f"Scanning {file.name} ...")
+ with open(file.name) as searchfile:
+ block_start = False
+ for line in searchfile:
+ # Don't mess with the start of doc blocks.
+ # We don't want to convert "# @name:" to a reference!
+ if block_start and line.startswith('# @'):
+ outlines.append(line)
+ continue
+ block_start = bool(line.startswith('##'))
+
+ # Don't mess with anything outside of comment blocks,
+ # and don't mess with example blocks. We use five spaces
+ # as a heuristic for detecting example blocks. It's not perfect,
+ # but it seemingly does the job well.
+ if line.startswith('# ') and not line.startswith('# '):
+ line = re.sub(patt, r'`\2`', line)
+ line = re.sub(patt2, r'`\1`', line)
+ line = re.sub(patt3, r'`\1`', line)
+ outlines.append(line)
+ with open(file.name, "w") as outfile:
+ for line in outlines:
+ outfile.write(line)
--
2.48.1
