External/libvirt
1
0
Fork 0
mirror of https://gitlab.com/libvirt/libvirt.git synced 2025-03-07 17:28:15 +00:00
Code

syntax-check: Enforce <code> inside <dt> elements

Browse Source 
Commit 61b070cf20b5 cleaned up a number of cases where the <dt>
element was used to document symbols, but the symbol itself was
not inside a <code> 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.
This commit is contained in:
Andrea Bolognani 2016-04-22 11:12:10 +02:00
parent d195cffa2e
commit 1f29f3da06
3 changed files with 18 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
cfg.mk
View File

@ -1046,6 +1046,17 @@ sc_gettext_init:
halt='the above files do not call virGettextInitialize' \ halt='the above files do not call virGettextInitialize' \
$(_sc_search_regexp) $(_sc_search_regexp)
# <dt> is mostly used to document symbols, in which case it should contain
# a <code> element. The regular expression below trades speed and readability
# for accuracy, and won't catch someone trying to stick a <canvas> inside a
# <dt>, but that's what code reviews are for :)
sc_prohibit_dt_without_code:
@prohibit='<dt>([^<]|<[^c])' \
exclude='exempt from syntax-check' \
in_vc_files='docs/.*$$' \
halt='Use <code> inside <dt> when documenting symbols' \
$(_sc_search_regexp)
# We don't use this feature of maint.mk. # We don't use this feature of maint.mk.
prev_version_file = /dev/null 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 = \ exclude_file_name_regexp--sc_prohibit_not_strneq = \
^tests/.*\.[ch]$$ ^tests/.*\.[ch]$$
exclude_file_name_regexp--sc_prohibit_dt_without_code = \
^docs/(newapi\.xsl|(apps|contact)\.html\.in)$$

6
docs/formatsnapshot.html.in
View File

@ -12,7 +12,7 @@
There are several types of snapshots: There are several types of snapshots:
</p> </p>
<dl> <dl>
<dt>disk snapshot</dt> <dt>disk snapshot</dt> <!-- exempt from syntax-check -->
<dd>Contents of disks (whether a subset or all disks associated <dd>Contents of disks (whether a subset or all disks associated
with the domain) are saved at a given point of time, and can 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 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 since the snapshot in a single file) and external (the
snapshot is one file, and the changes since the snapshot are snapshot is one file, and the changes since the snapshot are
in another file).</dd> in another file).</dd>
<dt>memory state (or VM state)</dt> <dt>memory state (or VM state)</dt> <!-- exempt from syntax-check -->
<dd>Tracks only the state of RAM and all other resources in use <dd>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 by the VM. If the disks are unmodified between the time a VM
state snapshot is taken and restored, then the guest will state snapshot is taken and restored, then the guest will
resume in a consistent state; but if the disks are modified resume in a consistent state; but if the disks are modified
externally in the meantime, this is likely to lead to data externally in the meantime, this is likely to lead to data
corruption.</dd> corruption.</dd>
<dt>system checkpoint</dt> <dt>system checkpoint</dt> <!-- exempt from syntax-check -->
<dd>A combination of disk snapshots for all disks as well as VM <dd>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 memory state, which can be used to resume the guest from where it
left off with symptoms similar to hibernation (that is, TCP left off with symptoms similar to hibernation (that is, TCP

2
docs/remote.html.in
View File

@ -712,7 +712,7 @@ cp clientcert.pem /etc/pki/libvirt/clientcert.pem
<a name="Remote_TLS_troubleshooting">Troubleshooting TLS certificate problems</a> <a name="Remote_TLS_troubleshooting">Troubleshooting TLS certificate problems</a>
</h4> </h4>
<dl> <dl>
<dt> failed to verify client's certificate </dt> <dt>failed to verify client's certificate</dt> <!-- exempt from syntax-check -->
<dd> <dd>
<p> <p>
On the server side, run the libvirtd server with On the server side, run the libvirtd server with