NuKVM/libvirt
3
0
Fork 0
mirror of https://github.com/libvirt/libvirt.git synced 2025-02-25 18:55:26 -06:00
Code Issues Packages Projects Releases Wiki Activity
6efdd94dbc
libvirt/docs
History
Michal Privoznik 6efdd94dbc apibuild.py: Handle enum comments properly 
After f4cb85c6af we only have two options for placing enum
values descriptions. It's either:

    typedef enum {
        /* Some long description. Therefore it's placed before
         * the value. */
        VIR_ENUM_A_VAL = 1,
    } virEnumA;

or:

    typedef enum {
        VIR_ENUM_B_VAL = 1, /* Some short description */
    } virEnumB;

However, our apibuild.py script is not able to deal with the
former one. It messes up comments. To fix this couple of things
needs to be done:

a) DO NOT reset self.comment in parseEnumBlock(). This is a
result from our tokenizer. Upon calling token() if it finds a
comment block it stores it in self.comment and returns the next
token (which is not comment). Therefore, if we reset self.comment
we might lose the first comment in the enum block.

b) we need a variable to track if the current enum block uses
value descriptions before or after values. That is if it's type
virEnumA or virEnumB. Depending on that, it we're dealing with
virEnumA type and the current token is a comma ',' we can add the
value into the list as we already have everything needed:
comment, name and value.

Signed-off-by: Michal Privoznik <mprivozn@redhat.com>
Reviewed-by: Martin Kletzander <mkletzan@redhat.com>
2017-07-24 12:03:33 +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
fonts docs: Add monospaced Overpass fonts 2016-11-21 13:15:12 +01:00
html maint: consolidate several .gitignore files 2012-02-03 15:27:16 -07:00
internals Fix minor typos 2016-12-02 09:25:13 +01:00
js docs: rewrite content on front page to be more useful 2016-11-11 12:15:05 +00:00
logos docs: add master SVG for libvirt logo 2016-11-11 09:31:10 +00:00
schemas docs: schema: make disk driver name attribute optional 2017-07-18 11:39:52 -06: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 docs: redo style of front page 2016-11-11 12:15:03 +00:00
acl.html.in docs: Correct invalid hyperlinks 2014-12-02 07:30:10 +01:00
aclpolkit.html.in aclpolkit.html.in: Kill useless spaces in <pre/> 2016-11-14 11:03:34 +01: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 apibuild.py: Handle enum comments properly 2017-07-24 12:03:33 +02:00
apps.html.in docs: add entry for Ravada to apps page 2017-07-10 16:22:36 +02: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
auditlog.html.in audit: Audit information about shmem devices 2016-09-12 19:41:43 +02:00
auth.html.in Switch to GSSAPI (kerberos) instead of the insecure DIGEST-MD5 2017-03-15 18:14:51 +00:00
bindings.html.in Point to the new libvirt-go bindings 2016-12-19 10:26:22 +00:00
bugs.html.in Fix common misspellings 2015-03-23 09:01:30 +01:00
cgroups.html.in cgroups.html.in: Kill useless spaces in <pre/> 2016-11-14 11:03:34 +01:00
compiling.html.in compiling.html.in: Kill useless spaces in <pre/> 2016-11-14 11:03:34 +01:00
contact.html.in docs: add some improved styling to contact page 2016-11-11 12:15:06 +00:00
contribute.html.in docs: Point to hacking.html from contribute.html 2017-06-26 14:19:12 +02:00
csharp.html.in Fix multiple formatting problems in HTML docs 2013-05-03 15:56:15 +01:00
devguide.html.in devguide.html.in: Kill useless spaces in <pre/> 2016-11-14 11:03:34 +01:00
docs.html.in Point to the new libvirt-go bindings 2016-12-19 10:26:22 +00:00
downloads.html.in docs: add entry to download table listing the Rust language binding 2017-07-05 13:12:22 +01:00
drivers.html.in docs: Provide a nodedev driver stub documentation 2017-04-26 15:56:11 +02:00
drvbhyve.html.in docs: Document bhyve's vgaconf support 2017-06-29 16:43:37 +04:00
drvesx.html.in drvesx.html.in: Kill useless spaces in <pre/> 2016-11-14 11:03:34 +01:00
drvhyperv.html.in hyperv: update driver documentation. 2017-04-08 15:55:07 +02:00
drvlxc.html.in drvlxc.html.in: Kill useless spaces in <pre/> 2016-11-14 11:03:34 +01:00
drvnodedev.html.in docs: Document the mediated devices within the nodedev driver 2017-05-18 12:21:55 +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 format.html.in: Kill useless spaces in <pre/> 2016-11-14 11:03:34 +01:00
formatcaps.html.in Fix minor typos 2017-04-24 14:40:00 +02:00
formatdomain.html.in qemu: Enable NUMA node tag in pci-root for PPC64 2017-07-21 15:46:29 +02:00
formatdomaincaps.html.in domain_capabilities: Don't report machine type for bhyve 2017-03-22 09:40:17 +01:00
formatnetwork.html.in docs: Update pointer to networking information 2017-05-22 13:22:32 +02:00
formatnode.html.in virsh: nodedev: ability to filter CCW capabilities 2017-05-26 10:44:05 -04:00
formatnwfilter.html.in doc: fix writing of QEMU 2017-03-08 17:33:07 +01:00
formatsecret.html.in formatsecret.html.in: Kill useless spaces in <pre/> 2016-11-14 11:03:34 +01:00
formatsnapshot.html.in qemu: Store save cookie in save images and snapshots 2017-06-07 13:36:02 +02:00
formatstorage.html.in storage: use 0711 as the default perms for dirs 2017-05-15 12:09:24 +01:00
formatstorageencryption.html.in formatstorageencryption.html.in: Kill useless spaces in <pre/> 2016-11-14 11:03:34 +01:00
genaclperms.pl Add documentation for access control system 2013-08-09 17:13:02 +01:00
generic.css docs: Use Overpass Mono as the monospace font 2016-11-21 14:04:05 +01: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
hacking.html.in hacking: Improve 'git send-email' documentation 2017-06-26 07:12:43 +02:00
hooks.html.in libxl: add hooks support 2016-08-02 14:20:31 +02:00
hvsupport.pl docs: remove navigation sidebar from pages 2016-11-11 12:15:06 +00:00
index.html.in docs: link to news file and other resources 2016-12-19 10:58:55 +00:00
index.py Test for object identity when checking for None in Python 2013-08-23 08:12:26 +02:00
internals.html.in docs: Document our event loop 2016-06-06 17:35:44 +02:00
java.html.in docs: Correct invalid hyperlinks 2014-12-02 07:30:10 +01: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-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 navigation sidebar from pages 2016-11-11 12:15:06 +00:00
locking-lockd.html.in locking-lockd.html.in: Kill useless spaces in <pre/> 2016-11-14 11:03:34 +01:00
locking-sanlock.html.in locking-sanlock.html.in: Kill useless spaces in <pre/> 2016-11-14 11:03:34 +01:00
locking.html.in docs: Use <code> inside <dt> for symbols 2016-04-22 10:36:14 +02:00
logging.html.in logging.html.in: Kill useless spaces in <pre/> 2016-11-14 11:03:34 +01:00
main.css docs: use overpass font for website 2016-11-11 09:31:10 +00:00
Makefile.am HACKING: Drop from the git repository 2017-06-26 14:25:54 +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 migration.html.in: Kill useless spaces in <pre/> 2016-11-14 11:03:34 +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-2016.html.in NEWS: Archive 2016 releases 2016-11-22 14:05:24 +01:00
news-ascii.xsl NEWS: Improve building pipeline 2017-01-10 19:37:53 +01:00
news-html.xsl news: Allow empty <section> elements 2017-04-03 10:49:42 +02:00
news.rng docs: Move news.rng out of docs/schemas 2017-04-05 09:51:51 +02:00
news.xml news: Update for hostdev isolation 2017-07-18 09:00:13 +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: Fix libvirt_guest nss module name 2017-01-13 11:41:11 +01:00
page.xsl docs: Use href_base in absolute links 2017-01-04 15:10:06 +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
reformat-news.py NEWS: Reformat at generation time 2017-01-10 19:37:55 +01:00
remote.html.in docs: Utilize our XSLT list generating template more 2017-04-24 12:37:37 +02:00
search.php.code.in docs: Properly quote self uri in search.php 2017-07-10 13:44:00 +02:00
search.php.in docs: redo style of front page 2016-11-11 12:15:03 +00: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
storage.html.in docs: Utilize our XSLT list generating template more 2017-04-24 12:37:37 +02: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
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