External/libvirt
1
0
Fork 0
mirror of https://gitlab.com/libvirt/libvirt.git synced 2024-12-22 13:45:38 +00:00
Code Issues Packages Projects Releases Wiki Activity
b099aa88e9
libvirt/docs
History
Michal Privoznik 38df47c9af docs: Teach apibuild to deal with (1U << 31) too 
The apibuild script is a terrifying beast that parses some source
files of ours and produces an XML representation of them. When it
comes to parsing enums we have in some header files, it tries to
be clever and detect a value that an enum member has (or if it is
an alias for a different member). Whilst doing that it has to
deal with values we give to the members in many formats. At some
places we just pass the value in decimal:

    VIR_DOMAIN_BLOCK_JOB_TYPE_PULL = 1,

in other places, we use the aliasing:

    VIR_CONNECT_GET_ALL_DOMAINS_STATS_ACTIVE = VIR_CONNECT_LIST_DOMAINS_ACTIVE,

and in other places bitwise shifts are used:

    VIR_CONNECT_GET_ALL_DOMAINS_STATS_ENFORCE_STATS = 1 << 31, /* enforce requested stats */

The script tries to parse all of these resulting in the following
tokens: "1", "VIR_CONNECT_LIST_DOMAINS_ACTIVE", "1<<31"; Then, the
script tries to turn these into integers using python's eval()
function. This function succeeds on the first and the last
tokens. But, if we were to modify the last example so that it's
of the following form:

    VIR_CONNECT_GET_ALL_DOMAINS_STATS_ENFORCE_STATS = 1U << 31, /* enforce requested stats */

the token representing enum's member value will then be "1U<<31".
So our parsing is good. Unfortunately, python is not aware of the
difference between signed and unsigned C types, therefore eval()
fails over this token and the parser falls back thinking it's an
alias to another enum member. Well it's not.

The solution is to transform [0-9]U into [0-9] as for our
purposes here it's the same thing.

Signed-off-by: Michal Privoznik <mprivozn@redhat.com>
2016-05-28 13:21:43 +02:00
..
api_extension xen_xs: name xendConfigVersion magic numbers 2012-02-01 16:28:17 -07:00
devhelp maint: consolidate several .gitignore files 2012-02-03 15:27:16 -07:00
html maint: consolidate several .gitignore files 2012-02-03 15:27:16 -07:00
internals Minor typo fixes in documentation 2015-09-15 11:27:35 +02:00
schemas conf: permit auto-assignment of controller indexes 2016-05-25 15:00:25 -04:00
32favicon.png * docs/site.xsl docs/*.png docs/*.html: update the images from Diana, 2006-01-23 22:55:41 +00:00
404.html.in Fix multiple formatting problems in HTML docs 2013-05-03 15:56:15 +01:00
acl.html.in docs: Correct invalid hyperlinks 2014-12-02 07:30:10 +01:00
aclpolkit.html.in examples: Add example polkit ACL rules 2015-09-04 17:26:04 +02:00
api_extension.html.in maint: improve VIR_ERR_INVALID_CONN usage 2014-01-06 21:41:02 -07:00
api.html.in docs: Rename 'parallels' to 'vz' 2015-08-25 07:21:33 -04:00
apibuild.py docs: Teach apibuild to deal with (1U << 31) too 2016-05-28 13:21:43 +02:00
apps.html.in docs: Don't use <strong> in headers 2016-03-31 16:26:18 +02:00
archdomain.html.in Fix multiple formatting problems in HTML docs 2013-05-03 15:56:15 +01:00
architecture.fig Remove trailing whitespace from all xfig files 2011-10-28 10:11:16 +01:00
architecture.gif * docs/architecture.* docs/*: added a section on the architecture 2005-12-21 16:59:34 +00:00
architecture.html.in Fix multiple formatting problems in HTML docs 2013-05-03 15:56:15 +01:00
archnetwork.html.in Fix multiple formatting problems in HTML docs 2013-05-03 15:56:15 +01:00
archnode.html.in Fix multiple formatting problems in HTML docs 2013-05-03 15:56:15 +01:00
archstorage.html.in Fix multiple formatting problems in HTML docs 2013-05-03 15:56:15 +01:00
auditlog.html.in docs: Use <code> inside <dt> for symbols 2016-04-22 10:36:14 +02:00
auth.html.in Add documentation for access control system 2013-08-09 17:13:02 +01:00
bindings.html.in docs: Fix docs about python bindings package 2015-01-19 14:50:52 +01:00
bugs.html.in Fix common misspellings 2015-03-23 09:01:30 +01:00
cgroups.html.in docs: cgroups: fix typo about LXC cgroups 2014-03-27 06:52:20 -06:00
compiling.html.in build: honor autogen.sh --no-git 2013-07-09 16:15:29 -06:00
contact.html.in Fix common misspellings 2015-03-23 09:01:30 +01:00
csharp.html.in Fix multiple formatting problems in HTML docs 2013-05-03 15:56:15 +01:00
deployment.html.in Fix multiple formatting problems in HTML docs 2013-05-03 15:56:15 +01:00
devguide.html.in docs: Update devguide.html to point to the new Python dev guide 2015-09-10 12:15:45 +01:00
docs.html.in Fix multiple formatting problems in HTML docs 2013-05-03 15:56:15 +01:00
downloads.html.in docs: update github project name 2015-05-26 15:07:18 +01:00
drivers.html.in docs: Rename 'parallels' to 'vz' 2015-08-25 07:21:33 -04:00
drvbhyve.html.in docs: bhyve: document clock configuration 2015-07-22 19:30:56 +03:00
drvesx.html.in typos: fix s/it/is/ where applicable 2014-05-05 11:49:36 +02:00
drvhyperv.html.in Fix multiple formatting problems in HTML docs 2013-05-03 15:56:15 +01:00
drvlxc.html.in docs: Use <code> inside <dt> for symbols 2016-04-22 10:36:14 +02:00
drvopenvz.html.in Fix multiple formatting problems in HTML docs 2013-05-03 15:56:15 +01:00
drvphyp.html.in Fix multiple formatting problems in HTML docs 2013-05-03 15:56:15 +01:00
drvqemu.html.in qemu: really remove last traces of Xenner support 2015-11-10 10:38:15 +00:00
drvremote.html.in Fix multiple formatting problems in HTML docs 2013-05-03 15:56:15 +01:00
drvtest.html.in Fix multiple formatting problems in HTML docs 2013-05-03 15:56:15 +01:00
drvuml.html.in docs: typo fix 2014-03-03 17:41:26 +04:00
drvvbox.html.in Move VirtualBox driver into libvirtd 2013-05-16 16:28:53 +01:00
drvvirtuozzo.html.in Rename page about vz driver 2015-08-25 07:36:37 -04:00
drvvmware.html.in VMware: Initial VMware Fusion support 2013-09-29 18:40:36 +08:00
drvxen.html.in Fix multiple formatting problems in HTML docs 2013-05-03 15:56:15 +01:00
errors.html.in docs: Correct invalid hyperlinks 2014-12-02 07:30:10 +01:00
firewall.html.in Fix typos in various docs 2013-12-02 10:21:26 +08:00
format.html.in Fix multiple formatting problems in HTML docs 2013-05-03 15:56:15 +01:00
formatcaps.html.in docs: Use <code> inside <dt> for symbols 2016-04-22 10:36:14 +02:00
formatdomain.html.in conf: permit auto-assignment of controller indexes 2016-05-25 15:00:25 -04:00
formatdomaincaps.html.in domaincaps: Report video modelType 2016-05-09 16:05:31 -04:00
formatnetwork.html.in docs: fix version number in vlan tagging documentation 2016-05-10 15:23:55 -04:00
formatnode.html.in nodedev: Expose PCI header type 2016-03-18 17:35:06 +01:00
formatnwfilter.html.in docs: remove *other* reference to igmp for IPv6 2016-04-22 12:45:59 -04:00
formatsecret.html.in docs: remove <auth> from secret XML format 2014-02-14 16:47:14 +01:00
formatsnapshot.html.in syntax-check: Enforce <code> inside <dt> elements 2016-04-25 12:09:34 +02:00
formatstorage.html.in storage: Fix algorithm generating path names for devmapper 2016-05-11 09:23:31 -04:00
formatstorageencryption.html.in docs: fix encryption format attribute in example 2014-09-10 09:25:40 +02:00
genaclperms.pl Add documentation for access control system 2013-08-09 17:13:02 +01:00
generic.css docs: Add bold style for <dt><code> elements 2016-04-22 08:14:17 -04:00
goals.html.in Fix multiple formatting problems in HTML docs 2013-05-03 15:56:15 +01:00
governance.html.in Fix minor typo in governance doc 2014-02-04 10:43:15 -07:00
hacking1.xsl maint: tweak use of <a> in HACKING 2013-07-09 11:49:20 -06:00
hacking2.xsl maint: tweak use of <a> in HACKING 2013-07-09 11:49:20 -06:00
hacking.html.in virtestmock: Print invalid file accesses into a file 2016-05-14 09:46:23 +02:00
hooks.html.in qemu: hook: Provide hook when restoring a domain save image 2014-09-22 17:11:56 +02:00
hvsupport.pl docs: Correct invalid hyperlinks 2014-12-02 07:30:10 +01:00
index.html.in Fix link to page for Virtuozzo driver 2015-08-26 09:05:59 -04:00
index.py Test for object identity when checking for None in Python 2013-08-23 08:12:26 +02:00
internals.html.in Move daemon-related parts of virNetServer to virNetDaemon 2015-06-16 13:46:19 +02:00
intro.html.in Fix multiple formatting problems in HTML docs 2013-05-03 15:56:15 +01:00
java.html.in docs: Correct invalid hyperlinks 2014-12-02 07:30:10 +01:00
library.xen remove all trailing blank lines 2009-07-16 15:06:42 +02:00
libvirt-daemon-arch.fig Remove trailing whitespace from all xfig files 2011-10-28 10:11:16 +01:00
libvirt-daemon-arch.png build: regenerate .png files 2012-07-23 16:07:13 -06:00
libvirt-driver-arch.fig Remove trailing whitespace from all xfig files 2011-10-28 10:11:16 +01:00
libvirt-driver-arch.png build: regenerate .png files 2012-07-23 16:07:13 -06:00
libvirt-header-bg.png Split website out into one file per page. APply new layout and styling 2008-04-23 17:08:31 +00:00
libvirt-header-logo.png Split website out into one file per page. APply new layout and styling 2008-04-23 17:08:31 +00:00
libvirt-net-logical.fig Remove trailing whitespace from all xfig files 2011-10-28 10:11:16 +01:00
libvirt-net-logical.png build: regenerate .png files 2012-07-23 16:07:13 -06:00
libvirt-net-physical.fig Remove trailing whitespace from all xfig files 2011-10-28 10:11:16 +01:00
libvirt-net-physical.png build: regenerate .png files 2012-07-23 16:07:13 -06:00
libvirt-object-model.fig Remove trailing whitespace from all xfig files 2011-10-28 10:11:16 +01:00
libvirt-object-model.png build: regenerate .png files 2012-07-23 16:07:13 -06:00
libvirt-virConnect-example.fig internals: Update to include RPC and Lock links and add new data 2013-03-04 17:36:03 -05:00
libvirt-virConnect-example.png internals: Update to include RPC and Lock links and add new data 2013-03-04 17:36:03 -05:00
libvirt.css docs: Remove unused #sponsor CSS rule 2016-04-01 13:28:03 +02:00
libvirtLogo404.png Add a custom 404 error page for the website 2012-06-18 20:10:29 +01:00
libvirtLogo.png * //* : renamed the project libvirt , this affects all makefiles, 2006-02-09 17:45:11 +00:00
locking-lockd.html.in docs: add page about virtlockd setup 2015-02-17 13:59:54 +00:00
locking-sanlock.html.in docs: split out sanlock setup docs 2015-02-17 13:59:19 +00:00
locking.html.in docs: Use <code> inside <dt> for symbols 2016-04-22 10:36:14 +02:00
logging.html.in docs: update to properly reflect meaning of fields in log filter 2016-01-04 15:19:38 -05:00
madeWith.png * //* : renamed the project libvirt , this affects all makefiles, 2006-02-09 17:45:11 +00:00
main.css Split website out into one file per page. APply new layout and styling 2008-04-23 17:08:31 +00:00
Makefile.am docs: Pass relative paths to apibuild.py 2016-04-26 09:20:11 +02:00
migration-managed-direct.fig Remove trailing whitespace from all xfig files 2011-10-28 10:11:16 +01:00
migration-managed-direct.png Add documentation about migration. 2011-10-28 10:07:45 +01:00
migration-managed-p2p.fig Remove trailing whitespace from all xfig files 2011-10-28 10:11:16 +01:00
migration-managed-p2p.png Add documentation about migration. 2011-10-28 10:07:45 +01:00
migration-native.fig Remove trailing whitespace from all xfig files 2011-10-28 10:11:16 +01:00
migration-native.png Add documentation about migration. 2011-10-28 10:07:45 +01:00
migration-tunnel.fig Remove trailing whitespace from all xfig files 2011-10-28 10:11:16 +01:00
migration-tunnel.png Add documentation about migration. 2011-10-28 10:07:45 +01:00
migration-unmanaged-direct.fig Remove trailing whitespace from all xfig files 2011-10-28 10:11:16 +01:00
migration-unmanaged-direct.png Add documentation about migration. 2011-10-28 10:07:45 +01:00
migration.html.in Spell VMware with a lowercase w 2016-02-15 15:35:48 +01:00
newapi.xsl docs: generate links from plain text documentation 2013-10-30 17:30:12 +01:00
news-2005.html.in NEWS: Split releases by year 2015-10-20 17:29:03 +02:00
news-2006.html.in NEWS: Split releases by year 2015-10-20 17:29:03 +02:00
news-2007.html.in NEWS: Split releases by year 2015-10-20 17:29:03 +02:00
news-2008.html.in NEWS: Split releases by year 2015-10-20 17:29:03 +02:00
news-2009.html.in NEWS: Split releases by year 2015-10-20 17:29:03 +02:00
news-2010.html.in NEWS: Split releases by year 2015-10-20 17:29:03 +02:00
news-2011.html.in NEWS: Split releases by year 2015-10-20 17:29:03 +02:00
news-2012.html.in NEWS: Split releases by year 2015-10-20 17:29:03 +02:00
news-2013.html.in NEWS: Split releases by year 2015-10-20 17:29:03 +02:00
news-2014.html.in NEWS: Split releases by year 2015-10-20 17:29:03 +02:00
news-2015.html.in NEWS: Don't prefix version numbers with 'v' 2016-01-18 10:53:22 +01:00
news.html.in Release of libvirt-1.3.4 2016-05-01 09:50:21 +08:00
news.xsl NEWS: Fix XSLT stylesheet 2015-10-20 17:30:34 +02:00
node.fig Remove trailing whitespace from all xfig files 2011-10-28 10:11:16 +01:00
node.gif * doc/*: augment and try to complete the doc in its current state 2006-01-23 13:24:07 +00:00
nss.html.in docs: Document NSS module 2016-03-29 13:45:33 +02:00
page.xsl docs: website: Remove the et.redhat.com footer 2016-03-10 11:06:25 -05:00
pending.html.in Fix multiple formatting problems in HTML docs 2013-05-03 15:56:15 +01:00
php.html.in docs: php: remove reference to Red Hat 2015-06-04 10:00:59 +02:00
python.html.in docs: Correct invalid hyperlinks 2014-12-02 07:30:10 +01:00
relatedlinks.html.in Fix multiple formatting problems in HTML docs 2013-05-03 15:56:15 +01:00
remote.html.in syntax-check: Enforce <code> inside <dt> elements 2016-04-25 12:09:34 +02:00
search.php.code.in better patch for the XSS search issue 2015-07-03 21:04:24 +08:00
search.php.in Repair the search on libvirt.org 2013-09-12 17:18:32 +08:00
secureusage.html.in Add some notes about secure usage of libvirt 2013-10-15 11:33:01 +01:00
securityprocess.html.in Fix common misspellings 2015-03-23 09:01:30 +01:00
site.xsl Fix docs generator regression in previous commit 2013-05-03 16:58:46 +01:00
sitemap.html.in api: Generate docs for libvirt-common.h 2016-04-21 15:39:08 +02:00
storage.html.in docs: mention ZFS on Linux support 2016-02-27 05:39:50 +03:00
structures.fig Remove trailing whitespace from all xfig files 2011-10-28 10:11:16 +01:00
subsite.xsl virCommand: docs for usage of new command APIs 2010-12-02 16:00:47 -07:00
testapi.html.in Fix multiple formatting problems in HTML docs 2013-05-03 15:56:15 +01:00
testsuites.html.in Fix multiple formatting problems in HTML docs 2013-05-03 15:56:15 +01:00
testtck.html.in Fix multiple formatting problems in HTML docs 2013-05-03 15:56:15 +01:00
todo.cfg-example Add automatic generation of a todo item page 2010-10-12 11:26:52 +01:00
todo.pl Fix namespace bugs in API docs, todo page & hv support page 2013-05-07 11:19:04 +01:00
uri.html.in docs: Correct invalid hyperlinks 2014-12-02 07:30:10 +01:00
virshcmdref.html.in Fix multiple formatting problems in HTML docs 2013-05-03 15:56:15 +01:00
windows.html.in Point users to Virt-Viewer MSI installers for Windows builds 2013-05-07 15:29:37 +01:00
wrapstring.xsl Generate HACKING from docs/hacking.html.in 2010-11-12 19:47:20 +01:00