Review Request 282: Added documentation for developers.

Radek Novacek reviewboard at gallagherhome.com
Mon Apr 29 13:53:51 UTC 2013


-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
http://reviewboard-openlmi.rhcloud.com/r/282/#review334
-----------------------------------------------------------


It seems that the content of many files can be generated on demand when someone wants to create the documentation. Is there any plans to write the docs into this files? If not it would be better to create them on demand.

- Radek Novacek


On April 29, 2013, 3:21 p.m., Jan Safranek wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> http://reviewboard-openlmi.rhcloud.com/r/282/
> -----------------------------------------------------------
> 
> (Updated April 29, 2013, 3:21 p.m.)
> 
> 
> Review request for OpenLMI Developers.
> 
> 
> Repository: openlmi-storage
> 
> 
> Description
> -------
> 
> Added documentation for developers.
> 
> This is generated by scripts, as side-effect it removes trailing spaces.
> Resulting documentation can be reviewed at http://jsafrane.fedorapeople.org/openlmi-storage/devel/0.5.1.test/
> (it's quite ugly, more work is needed in this area).
> 
> 
> Diffs
> -----
> 
>   doc/devel/index.rst ab8e88530a029da500c8d44c958670012b5877b4 
>   doc/devel/modules/BaseProvider.rst PRE-CREATION 
>   doc/devel/modules/BasedOnProvider.rst PRE-CREATION 
>   doc/devel/modules/CapabilitiesProvider.rst PRE-CREATION 
>   doc/devel/modules/DeviceProvider.rst PRE-CREATION 
>   doc/devel/modules/ExtentProvider.rst PRE-CREATION 
>   doc/devel/modules/FormatProvider.rst PRE-CREATION 
>   doc/devel/modules/LMI_AttachedFileSystem.rst PRE-CREATION 
>   doc/devel/modules/LMI_DataFormatProvider.rst PRE-CREATION 
>   doc/devel/modules/LMI_DiskPartition.rst PRE-CREATION 
>   doc/devel/modules/LMI_DiskPartitionConfigurationCapabilities.rst PRE-CREATION 
>   doc/devel/modules/LMI_DiskPartitionConfigurationSetting.rst PRE-CREATION 
>   doc/devel/modules/LMI_DiskPartitioningConfigurationService.rst PRE-CREATION 
>   doc/devel/modules/LMI_FileSystemConfigurationCapabilities.rst PRE-CREATION 
>   doc/devel/modules/LMI_FileSystemConfigurationService.rst PRE-CREATION 
>   doc/devel/modules/LMI_GenericDiskPartition.rst PRE-CREATION 
>   doc/devel/modules/LMI_HostedFileSystem.rst PRE-CREATION 
>   doc/devel/modules/LMI_HostedMount.rst PRE-CREATION 
>   doc/devel/modules/LMI_HostedStorageService.rst PRE-CREATION 
>   doc/devel/modules/LMI_InstalledPartitionTable.rst PRE-CREATION 
>   doc/devel/modules/LMI_LVAllocatedFromStoragePool.rst PRE-CREATION 
>   doc/devel/modules/LMI_LVBasedOn.rst PRE-CREATION 
>   doc/devel/modules/LMI_LVStorageCapabilities.rst PRE-CREATION 
>   doc/devel/modules/LMI_LVStorageExtent.rst PRE-CREATION 
>   doc/devel/modules/LMI_LocalFileSystem.rst PRE-CREATION 
>   doc/devel/modules/LMI_MDRAIDBasedOn.rst PRE-CREATION 
>   doc/devel/modules/LMI_MDRAIDFormatProvider.rst PRE-CREATION 
>   doc/devel/modules/LMI_MDRAIDStorageCapabilities.rst PRE-CREATION 
>   doc/devel/modules/LMI_MDRAIDStorageExtent.rst PRE-CREATION 
>   doc/devel/modules/LMI_MountPoint.rst PRE-CREATION 
>   doc/devel/modules/LMI_MountedFileSystem.rst PRE-CREATION 
>   doc/devel/modules/LMI_PVFormatProvider.rst PRE-CREATION 
>   doc/devel/modules/LMI_PartitionBasedOn.rst PRE-CREATION 
>   doc/devel/modules/LMI_StorageConfigurationService.rst PRE-CREATION 
>   doc/devel/modules/LMI_StorageExtent.rst PRE-CREATION 
>   doc/devel/modules/LMI_SystemStorageDevice.rst PRE-CREATION 
>   doc/devel/modules/LMI_TransientFileSystem.rst PRE-CREATION 
>   doc/devel/modules/LMI_VGAssociatedComponentExtent.rst PRE-CREATION 
>   doc/devel/modules/LMI_VGStorageCapabilities.rst PRE-CREATION 
>   doc/devel/modules/LMI_VGStoragePool.rst PRE-CREATION 
>   doc/devel/modules/LocalFileSystemProvider.rst PRE-CREATION 
>   doc/devel/modules/ProviderManager.rst PRE-CREATION 
>   doc/devel/modules/ServiceProvider.rst PRE-CREATION 
>   doc/devel/modules/SettingHelper.rst PRE-CREATION 
>   doc/devel/modules/SettingManager.rst PRE-CREATION 
>   doc/devel/modules/SettingProvider.rst PRE-CREATION 
>   doc/devel/modules/StorageConfiguration.rst PRE-CREATION 
>   doc/devel/modules/cimom_entry.rst PRE-CREATION 
>   doc/devel/modules/coverage_wrapper.rst PRE-CREATION 
>   src/openlmi/storage/BaseProvider.py c35ff362a62f2a10506201ebbe8f8a2fb8e3d423 
>   src/openlmi/storage/BasedOnProvider.py 000bbdff435c94b59a67eb3d97bcfa21a08bc085 
>   src/openlmi/storage/CapabilitiesProvider.py f28b7aff78cf18e22104ce3d529e73ab19663261 
>   src/openlmi/storage/DeviceProvider.py 8e2f0de8d0d78fc28d6a3722e8c5ad7686b9c556 
>   src/openlmi/storage/ExtentProvider.py 5eb4da8af69e2ec7aa3fbdde5fb13203b3b440d7 
>   src/openlmi/storage/FormatProvider.py dcca67d7a917be65b0c8126be4eec9dc4be1d33b 
>   src/openlmi/storage/LMI_AttachedFileSystem.py 8c7059e5f1a26dabd686053972e994474cf583c9 
>   src/openlmi/storage/LMI_DataFormatProvider.py 1096ffc078e4ec99c2e2088a2698eb6780ac5aea 
>   src/openlmi/storage/LMI_DiskPartition.py 5ef01075748b7c430853c39ccbcb1b02b6b36d63 
>   src/openlmi/storage/LMI_DiskPartitionConfigurationCapabilities.py fe9be16cdbcaee6c5f6bd39def0fb509ff6e0bcb 
>   src/openlmi/storage/LMI_DiskPartitionConfigurationSetting.py 2eeb0c6389c2270468e19a546aa4eedf03043a6b 
>   src/openlmi/storage/LMI_DiskPartitioningConfigurationService.py fc9da8523f34e49890cb500b0ae77a71223662dc 
>   src/openlmi/storage/LMI_FileSystemConfigurationCapabilities.py b5a98a2b4a47809d6ce1a037cece5efb94768afe 
>   src/openlmi/storage/LMI_FileSystemConfigurationService.py 8f7671cc850a7b0de1acab40d088b25b4714d420 
>   src/openlmi/storage/LMI_GenericDiskPartition.py 272888d355fbf2610e2c90fe87b06264d0d73d3e 
>   src/openlmi/storage/LMI_HostedFileSystem.py 4df89724a22bae0426610d5f31b987a5248bf599 
>   src/openlmi/storage/LMI_HostedMount.py 32a152209bc364457507e5e39ccd8b6d122b6219 
>   src/openlmi/storage/LMI_HostedStorageService.py fc54bc32b63ebad3978e007a9c9334ab0595e267 
>   src/openlmi/storage/LMI_InstalledPartitionTable.py 0b4c09a717fc9ef40720befce51b8d232214c7c5 
>   src/openlmi/storage/LMI_LVAllocatedFromStoragePool.py 45bb2ddcfabbce07cde813eafd5d1d675de3faa8 
>   src/openlmi/storage/LMI_LVBasedOn.py 5d4a7d8a0211d60bc4ce54e73225f2407d773e20 
>   src/openlmi/storage/LMI_LVStorageCapabilities.py 67789dda3d2516f5bc4aee3d6d2b43889b6c697b 
>   src/openlmi/storage/LMI_LVStorageExtent.py 67d0f667a0664fb6d1f92c4415f690b3e3c79d99 
>   src/openlmi/storage/LMI_LocalFileSystem.py 74740743cc3fc8f162c77945caa61a1d3aede8d2 
>   src/openlmi/storage/LMI_MDRAIDBasedOn.py 33408b8de18ac4c72f89f8a588ec323c4e84e53b 
>   src/openlmi/storage/LMI_MDRAIDFormatProvider.py 64e7f23e1fb66a849b6350251b9ef070d0ad6ff5 
>   src/openlmi/storage/LMI_MDRAIDStorageCapabilities.py 15cdbd792e9c66873e59d215cb68bb6e38ee9077 
>   src/openlmi/storage/LMI_MDRAIDStorageExtent.py 7cb98c99038c61060caa5320339bed2342e05cdf 
>   src/openlmi/storage/LMI_MountPoint.py 7eb214d2a603e80d2af9dd1ba70932df7b093f61 
>   src/openlmi/storage/LMI_MountedFileSystem.py d6899c548c4d064b466a3d6df6c831297d07292d 
>   src/openlmi/storage/LMI_PVFormatProvider.py f62be4cd232e3aedb1f605f6caadffe8ccfc14aa 
>   src/openlmi/storage/LMI_PartitionBasedOn.py 4d189bb38adcc651393c38944c0548030a1d7c1f 
>   src/openlmi/storage/LMI_StorageConfigurationService.py 47d1ee7909b4beb9311f1da63178d86f7988c9e8 
>   src/openlmi/storage/LMI_StorageExtent.py fd1da01d276a8606aeff0e743f063291ed1ada15 
>   src/openlmi/storage/LMI_SystemStorageDevice.py 1f0a32c57e7cc17c3664dcc992e108a6b7548537 
>   src/openlmi/storage/LMI_TransientFileSystem.py PRE-CREATION 
>   src/openlmi/storage/LMI_VGAssociatedComponentExtent.py 3fb112b42c7c54df8abd5ffdb69729036cc4bb37 
>   src/openlmi/storage/LMI_VGStorageCapabilities.py e95af8017859b467bc9134124a593c17f5db0961 
>   src/openlmi/storage/LMI_VGStoragePool.py 612005e987cab26a94ec516e678bbbbca32ae887 
>   src/openlmi/storage/LocalFileSystemProvider.py 42be4c5519dcd6edb4abe0614236e0b36ec6b9e5 
>   src/openlmi/storage/ProviderManager.py 63461d0654997ced0dd95e4ff1388985facb21a8 
>   src/openlmi/storage/ServiceProvider.py 0b4ed86f9b2512d863c4071d97894aec1e6af159 
>   src/openlmi/storage/SettingHelper.py aeb56e013e6e57b5bf7a02b18571a84120281777 
>   src/openlmi/storage/SettingManager.py 568ed7614e3b04e5760c653119951153eee6eed0 
>   src/openlmi/storage/SettingProvider.py 2d2284f010a1eca388e3823b98296a099c00fb24 
>   src/openlmi/storage/StorageConfiguration.py 5ff3ea7e99029180a52dd2bd96412892916d8261 
>   src/openlmi/storage/__init__.py 6edbf0bd08b1272046c22194a194b5af931275f0 
>   src/openlmi/storage/coverage_wrapper.py 8879e9a2cbecd4728844009e477dea60549746e0 
> 
> Diff: http://reviewboard-openlmi.rhcloud.com/r/282/diff/
> 
> 
> Testing
> -------
> 
> 
> Thanks,
> 
> Jan Safranek
> 
>

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.fedorahosted.org/pipermail/openlmi-devel/attachments/20130429/198029ec/attachment-0001.html>


More information about the openlmi-devel mailing list