summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorDaniel P. Berrange <berrange@redhat.com>2010-09-02 14:26:47 +0100
committerDaniel P. Berrange <berrange@redhat.com>2010-09-02 14:31:26 +0100
commit8eb6b71ad642006f88d35e7021764c4edccae1a7 (patch)
tree3723478b727c3388ada107ebe2289b0b5055d4e4 /docs
parent0d01d56d81ae6eabc35500f3192078b5e232f057 (diff)
Introduce a OsinfoDeployment object
The supported devices for deploying an OS on a platform are tracked as part of the main OS device list. This is not sufficiently flexible because it does not allow for tracking extra metadata against a (os, platform) pair. Introduce a new "deployment" object to track the metadata for deploying an OS on a platform. * docs/object-model.fig: Illustrate the object model * data/libosinfo-dummy-data.xml: Introduce deployment metadata * examples/demo.py, examples/demo.js: Update for new APIs * osinfo/Makefile.am, osinfo/libosinfo.syms, osinfo/osinfo.h, osinfo/osinfo_db.c, osinfo/osinfo_db.h osinfo/osinfo_db.h, osinfo/osinfo_deployment.h, osinfo/osinfo_deploymentlist.c, osinfo/osinfo_deploymentlist.h, osinfo/osinfo_devicelink.c, osinfo/osinfo_loader.c: Introduce an explicit deployment object * osinfo/osinfo_os.c, osinfo/osinfo_os.h, test/test-db.c, test/test-os.c: Remove tracking of hypervisor preferred devices * osinfo/osinfo_devicelinkfilter.c, osinfo/osinfo_devicelinkfilter.h: Allow filtering against a link and its target device at the same time.
Diffstat (limited to 'docs')
-rw-r--r--docs/object-model.fig113
-rw-r--r--docs/reference/Libosinfo-docs.xml11
-rw-r--r--docs/reference/Libosinfo-sections.txt72
-rw-r--r--docs/reference/Libosinfo.types5
4 files changed, 194 insertions, 7 deletions
diff --git a/docs/object-model.fig b/docs/object-model.fig
new file mode 100644
index 0000000..e73a104
--- /dev/null
+++ b/docs/object-model.fig
@@ -0,0 +1,113 @@
+#FIG 3.2 Produced by xfig version 3.2.5b
+Landscape
+Center
+Inches
+Letter
+100.00
+Single
+-2
+1200 2
+6 5700 900 7425 2700
+2 2 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 5
+ 5700 900 7425 900 7425 2700 5700 2700 5700 900
+2 1 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 2
+ 5700 1275 7425 1275
+4 0 0 50 -1 16 16 0.0000 4 195 825 5775 1200 Device\001
+4 0 0 50 -1 16 12 0.0000 4 150 510 5775 1500 Name\001
+4 0 0 50 -1 16 12 0.0000 4 150 615 5775 1740 Vendor\001
+4 0 0 50 -1 16 12 0.0000 4 150 675 5775 1980 Product\001
+4 0 0 50 -1 16 12 0.0000 4 150 495 5775 2220 Class\001
+4 0 0 50 -1 16 12 0.0000 4 150 345 5775 2460 Bus\001
+-6
+6 5700 5025 7425 6825
+2 2 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 5
+ 5700 5025 7425 5025 7425 6825 5700 6825 5700 5025
+2 1 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 2
+ 5700 5400 7425 5400
+4 0 0 50 -1 16 16 0.0000 4 195 930 5775 5325 Product\001
+4 0 0 50 -1 16 12 0.0000 4 150 510 5775 5625 Name\001
+4 0 0 50 -1 16 12 0.0000 4 150 615 5775 5865 Vendor\001
+4 0 0 50 -1 16 12 0.0000 4 150 660 5775 6105 Version\001
+4 0 0 50 -1 16 12 0.0000 4 150 720 5775 6345 Short ID\001
+-6
+6 7950 7875 9675 9675
+2 2 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 5
+ 7950 7875 9675 7875 9675 9675 7950 9675 7950 7875
+2 1 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 2
+ 7950 8250 9675 8250
+4 0 0 50 -1 16 16 0.0000 4 195 390 8025 8175 OS\001
+-6
+6 10050 3825 11775 5625
+2 2 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 5
+ 10050 3825 11775 3825 11775 5625 10050 5625 10050 3825
+2 1 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 2
+ 10050 4200 11775 4200
+4 0 0 50 -1 16 16 0.0000 4 195 1320 10125 4125 DeviceLink\001
+4 0 0 50 -1 16 12 0.0000 4 150 510 10125 4425 Driver\001
+-6
+6 1200 3300 2925 5100
+2 2 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 5
+ 1200 3300 2925 3300 2925 5100 1200 5100 1200 3300
+2 1 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 2
+ 1200 3675 2925 3675
+4 0 0 50 -1 16 16 0.0000 4 195 375 1275 3600 DB\001
+-6
+6 5850 10425 7575 12225
+2 2 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 5
+ 5850 10425 7575 10425 7575 12225 5850 12225 5850 10425
+2 1 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 2
+ 5850 10800 7575 10800
+4 0 0 50 -1 16 16 0.0000 4 255 1440 5925 10725 Deployment\001
+-6
+6 3600 7875 5325 9675
+2 2 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 5
+ 3600 7875 5325 7875 5325 9675 3600 9675 3600 7875
+2 1 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 2
+ 3600 8250 5325 8250
+4 0 0 50 -1 16 16 0.0000 4 195 1005 3675 8175 Platform\001
+-6
+2 1 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 3
+ 7425 1875 10875 1875 10875 3825
+2 1 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 4
+ 11250 5625 11250 12750 4275 12750 4275 9675
+2 1 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 3
+ 2925 4500 3975 4500 3975 7875
+2 1 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 3
+ 2925 4125 9300 4125 9300 7875
+2 1 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 3
+ 2925 3750 6525 3750 6525 2700
+2 1 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 3
+ 10875 5625 10875 11400 7575 11400
+2 1 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 3
+ 10500 5625 10500 8700 9675 8700
+2 1 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 3
+ 4950 9675 4950 11025 5850 11025
+2 1 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 3
+ 7575 11025 8325 11025 8325 9675
+2 1 0 1 0 7 50 -1 -1 0.000 0 0 -1 0 0 2
+ 6525 6825 6525 7275
+2 1 0 1 0 0 50 -1 20 0.000 0 0 7 0 0 4
+ 6525 7125 6375 7275 6675 7275 6525 7125
+2 1 0 1 0 0 50 -1 -1 0.000 0 0 7 0 0 4
+ 4275 7875 4275 7275 9000 7275 9000 7875
+2 1 0 1 0 0 50 -1 -1 0.000 0 0 7 0 0 5
+ 6000 5025 6000 4650 5325 4650 5325 5325 5700 5325
+4 0 0 50 -1 16 12 0.0000 4 135 105 3000 4050 1\001
+4 0 0 50 -1 16 12 0.0000 4 135 105 3000 4425 1\001
+4 0 0 50 -1 16 12 0.0000 4 135 105 3000 3675 1\001
+4 0 0 50 -1 16 12 0.0000 4 105 105 3750 7725 n\001
+4 0 0 50 -1 16 12 0.0000 4 105 105 6375 2925 n\001
+4 0 0 50 -1 16 12 0.0000 4 105 105 11025 5850 n\001
+4 0 0 50 -1 16 12 0.0000 4 105 105 10950 3675 n\001
+4 0 0 50 -1 16 12 0.0000 4 135 105 7500 1800 1\001
+4 0 0 50 -1 16 12 0.0000 4 135 105 9750 8625 1\001
+4 0 0 50 -1 16 12 0.0000 4 105 105 10725 5850 n\001
+4 0 0 50 -1 16 12 0.0000 4 135 105 4125 9900 1\001
+4 0 0 50 -1 16 12 0.0000 4 105 105 10350 5850 n\001
+4 0 0 50 -1 16 12 0.0000 4 105 105 5625 10950 n\001
+4 0 0 50 -1 16 12 0.0000 4 105 105 7650 10950 n\001
+4 0 0 50 -1 16 12 0.0000 4 135 105 4800 9900 1\001
+4 0 0 50 -1 16 12 0.0000 4 135 105 8175 9900 1\001
+4 0 0 50 -1 16 12 0.0000 4 105 105 9375 7725 n\001
+4 0 0 50 -1 16 12 0.0000 4 105 105 6075 4875 n\001
+4 0 0 50 -1 16 12 0.0000 4 105 105 5475 5550 n\001
diff --git a/docs/reference/Libosinfo-docs.xml b/docs/reference/Libosinfo-docs.xml
index fed358d..857990f 100644
--- a/docs/reference/Libosinfo-docs.xml
+++ b/docs/reference/Libosinfo-docs.xml
@@ -16,21 +16,24 @@
<chapter>
<title>Libosinfo</title>
<xi:include href="xml/osinfo_db.xml"/>
+ <xi:include href="xml/osinfo_deployment.xml"/>
+ <xi:include href="xml/osinfo_deploymentlist.xml"/>
<xi:include href="xml/osinfo_device.xml"/>
<xi:include href="xml/osinfo_devicelist.xml"/>
<xi:include href="xml/osinfo_devicelink.xml"/>
+ <xi:include href="xml/osinfo_devicelinkfilter.xml"/>
<xi:include href="xml/osinfo_devicelinklist.xml"/>
<xi:include href="xml/osinfo_entity.xml"/>
<xi:include href="xml/osinfo_filter.xml"/>
+ <xi:include href="xml/osinfo_list.xml"/>
+ <xi:include href="xml/osinfo_loader.xml"/>
+ <xi:include href="xml/osinfo_os.xml"/>
+ <xi:include href="xml/osinfo_oslist.xml"/>
<xi:include href="xml/osinfo_product.xml"/>
<xi:include href="xml/osinfo_productfilter.xml"/>
<xi:include href="xml/osinfo_productlist.xml"/>
<xi:include href="xml/osinfo_platform.xml"/>
<xi:include href="xml/osinfo_platformlist.xml"/>
- <xi:include href="xml/osinfo_list.xml"/>
- <xi:include href="xml/osinfo_loader.xml"/>
- <xi:include href="xml/osinfo_os.xml"/>
- <xi:include href="xml/osinfo_oslist.xml"/>
</chapter>
<chapter id="object-tree">
<title>Object Hierarchy</title>
diff --git a/docs/reference/Libosinfo-sections.txt b/docs/reference/Libosinfo-sections.txt
index bc20e77..6c3ce95 100644
--- a/docs/reference/Libosinfo-sections.txt
+++ b/docs/reference/Libosinfo-sections.txt
@@ -8,15 +8,20 @@ osinfo_db_new
osinfo_db_get_platform
osinfo_db_get_device
osinfo_db_get_os
+osinfo_db_get_deployment
osinfo_db_get_os_list
osinfo_db_get_platform_list
osinfo_db_get_device_list
+osinfo_db_get_deployment_list
+osinfo_db_find_deployment
osinfo_db_add_os
osinfo_db_add_platform
osinfo_db_add_device
+osinfo_db_add_deployment
osinfo_db_unique_values_for_property_in_os
osinfo_db_unique_values_for_property_in_platform
-osinfo_db_unique_values_for_property_in_dev
+osinfo_db_unique_values_for_property_in_device
+osinfo_db_unique_values_for_property_in_deployment
osinfo_db_unique_values_for_os_relationship
osinfo_db_unique_values_for_platform_relationship
<SUBSECTION Standard>
@@ -101,8 +106,6 @@ OsinfoOs
OsinfoOsClass
OsinfoOsPrivate
osinfo_os_new
-osinfo_os_get_preferred_device
-osinfo_os_get_preferred_device_link
osinfo_os_get_devices
osinfo_os_get_device_links
osinfo_os_add_device
@@ -137,6 +140,30 @@ OSINFO_PLATFORM_GET_CLASS
</SECTION>
<SECTION>
+<FILE>osinfo_deployment</FILE>
+<TITLE>OsinfoDeployment</TITLE>
+OsinfoDeployment
+OsinfoDeploymentClass
+OsinfoDeploymentPrivate
+osinfo_deployment_new
+osinfo_deployment_get_devices
+osinfo_deployment_get_device_links
+osinfo_deployment_add_device
+osinfo_deployment_get_os
+osinfo_deployment_get_platform
+osinfo_deployment_get_preferred_device
+osinfo_deployment_get_preferred_device_link
+<SUBSECTION Standard>
+OSINFO_DEPLOYMENT
+OSINFO_IS_DEPLOYMENT
+OSINFO_TYPE_DEPLOYMENT
+osinfo_deployment_get_type
+OSINFO_DEPLOYMENT_CLASS
+OSINFO_IS_DEPLOYMENT_CLASS
+OSINFO_DEPLOYMENT_GET_CLASS
+</SECTION>
+
+<SECTION>
<FILE>osinfo_filter</FILE>
<TITLE>OsinfoFilter</TITLE>
OsinfoFilter
@@ -246,6 +273,24 @@ OSINFO_PRODUCTFILTER_GET_CLASS
</SECTION>
<SECTION>
+<FILE>osinfo_devicelinkfilter</FILE>
+<TITLE>OsinfoDeviceLinkFilter</TITLE>
+OsinfoDeviceLinkFilter
+OsinfoDeviceLinkFilterClass
+OsinfoDeviceLinkFilterPrivate
+osinfo_devicelinkfilter_new
+osinfo_devicelinkfilter_get_target_filter
+<SUBSECTION Standard>
+OSINFO_DEVICELINKFILTER
+OSINFO_IS_DEVICELINKFILTER
+OSINFO_TYPE_DEVICELINKFILTER
+osinfo_devicelinkfilter_get_type
+OSINFO_DEVICELINKFILTER_CLASS
+OSINFO_IS_DEVICELINKFILTER_CLASS
+OSINFO_DEVICELINKFILTER_GET_CLASS
+</SECTION>
+
+<SECTION>
<FILE>osinfo_productlist</FILE>
<TITLE>OsinfoProductList</TITLE>
OsinfoProductList
@@ -309,6 +354,27 @@ OSINFO_PLATFORMLIST_GET_CLASS
</SECTION>
<SECTION>
+<FILE>osinfo_deploymentlist</FILE>
+<TITLE>OsinfoDeploymentList</TITLE>
+OsinfoDeploymentList
+OsinfoDeploymentListClass
+OsinfoDeploymentListPrivate
+osinfo_deploymentlist_new
+osinfo_deploymentlist_new_copy
+osinfo_deploymentlist_new_filtered
+osinfo_deploymentlist_new_intersection
+osinfo_deploymentlist_new_union
+<SUBSECTION Standard>
+OSINFO_DEPLOYMENTLIST
+OSINFO_IS_DEPLOYMENTLIST
+OSINFO_TYPE_DEPLOYMENTLIST
+osinfo_deploymentlist_get_type
+OSINFO_DEPLOYMENTLIST_CLASS
+OSINFO_IS_DEPLOYMENTLIST_CLASS
+OSINFO_DEPLOYMENTLIST_GET_CLASS
+</SECTION>
+
+<SECTION>
<FILE>osinfo_device</FILE>
<TITLE>OsinfoDevice</TITLE>
OsinfoDevice
diff --git a/docs/reference/Libosinfo.types b/docs/reference/Libosinfo.types
index 5955684..8add117 100644
--- a/docs/reference/Libosinfo.types
+++ b/docs/reference/Libosinfo.types
@@ -5,6 +5,8 @@ osinfo_entity_get_type
osinfo_filter_get_type
osinfo_platform_get_type
osinfo_platformlist_get_type
+osinfo_deployment_get_type
+osinfo_deploymentlist_get_type
osinfo_list_get_type
osinfo_loader_get_type
osinfo_product_get_type
@@ -12,3 +14,6 @@ osinfo_productfilter_get_type
osinfo_productlist_get_type
osinfo_os_get_type
osinfo_oslist_get_type
+osinfo_devicelink_get_type
+osinfo_devicelinklist_get_type
+osinfo_devicelinkfilter_get_type