From 1f29f3da065ef12d3ec39c3c673186f8ea6d764e Mon Sep 17 00:00:00 2001 From: Andrea Bolognani Date: Fri, 22 Apr 2016 11:12:10 +0200 Subject: [PATCH] syntax-check: Enforce inside
elements Commit 61b070cf20b5 cleaned up a number of cases where the
element was used to document symbols, but the symbol itself was not inside a element. To make sure we don't end up having to clean up again a few months from now, introduce a syntax-check rule that can spot such mistakes. All existing exceptions are marked as such, with either file or line granularity depending on the case. --- cfg.mk | 14 ++++++++++++++ docs/formatsnapshot.html.in | 6 +++--- docs/remote.html.in | 2 +- 3 files changed, 18 insertions(+), 4 deletions(-) diff --git a/cfg.mk b/cfg.mk index cc5ea9ee1d..b277db184a 100644 --- a/cfg.mk +++ b/cfg.mk @@ -1046,6 +1046,17 @@ sc_gettext_init: halt='the above files do not call virGettextInitialize' \ $(_sc_search_regexp) +#
is mostly used to document symbols, in which case it should contain +# a element. The regular expression below trades speed and readability +# for accuracy, and won't catch someone trying to stick a inside a +#
, but that's what code reviews are for :) +sc_prohibit_dt_without_code: + @prohibit='
([^<]|<[^c])' \ + exclude='exempt from syntax-check' \ + in_vc_files='docs/.*$$' \ + halt='Use inside
when documenting symbols' \ + $(_sc_search_regexp) + # We don't use this feature of maint.mk. prev_version_file = /dev/null @@ -1282,3 +1293,6 @@ exclude_file_name_regexp--sc_prohibit_not_streq = \ exclude_file_name_regexp--sc_prohibit_not_strneq = \ ^tests/.*\.[ch]$$ + +exclude_file_name_regexp--sc_prohibit_dt_without_code = \ + ^docs/(newapi\.xsl|(apps|contact)\.html\.in)$$ diff --git a/docs/formatsnapshot.html.in b/docs/formatsnapshot.html.in index c3ab516fa4..8c66a9cb4f 100644 --- a/docs/formatsnapshot.html.in +++ b/docs/formatsnapshot.html.in @@ -12,7 +12,7 @@ There are several types of snapshots:

-
disk snapshot
+
disk snapshot
Contents of disks (whether a subset or all disks associated with the domain) are saved at a given point of time, and can be restored back to that state. On a running guest, a disk @@ -26,14 +26,14 @@ since the snapshot in a single file) and external (the snapshot is one file, and the changes since the snapshot are in another file).
-
memory state (or VM state)
+
memory state (or VM state)
Tracks only the state of RAM and all other resources in use by the VM. If the disks are unmodified between the time a VM state snapshot is taken and restored, then the guest will resume in a consistent state; but if the disks are modified externally in the meantime, this is likely to lead to data corruption.
-
system checkpoint
+
system checkpoint
A combination of disk snapshots for all disks as well as VM memory state, which can be used to resume the guest from where it left off with symptoms similar to hibernation (that is, TCP diff --git a/docs/remote.html.in b/docs/remote.html.in index ace157721f..638fdae6d0 100644 --- a/docs/remote.html.in +++ b/docs/remote.html.in @@ -712,7 +712,7 @@ cp clientcert.pem /etc/pki/libvirt/clientcert.pem Troubleshooting TLS certificate problems
-
failed to verify client's certificate
+
failed to verify client's certificate

On the server side, run the libvirtd server with