Re: [Libvirt-cim] [PATCH] [TEST] Add CodyingSystem and SubmittingPatches files
Deepti B Kalakeri wrote:
Very Good write up. I have few ideas along with some comments on this
patch(Please see inline for comments).
We can improve it further including the information for "How to write a
test case?"
I think most of the things you have listed here can be inferred by
reading the existing test cases. I know the style has changed some, so
a lot of the test cases aren't in the best shape they could be. But a
lot of these issues are being fixed as tests are being updated.
This would include information like:
1) What kind of function should be included in the libraries present in
the XenKVMLib directory.
2) What should not be included in libraries present in the cimtest/lib.
This will change over time, so I worry that the statements will become
out of date and the file will not be updated accordingly.
3) What type of logger statements to be used for giving different
messages, for ex: use logger.info("Some information") or else use
logger.error("To print error")
The name of the functions here should make it obvious which to use.
4) Also, License information to be included in the test cases.
5) Including small description about what the test case does at the
beginning will help in maintenance in the long run.
These are good points. I can update the style guide to include this info.
6) Commands to submit a Single patch, commands to submit a Patch Set
using *"hg".
T*his will make things easy for someone who is using *hg* for the first
time and might encourage more new people to contribute.
It's good to encourage people to contribute, but there are plenty of hg
references out there that people can use.
The SubmittingPatches file already mentioned that patches should be
submitted using the patchbomb feature. From there, someone can
reference mercurial's how to documents for more information.
We can rename the CodingStyle file to "Cimtest_Howto_Doc"
and then
Include all the above information along with the CodingStyle in one file.
I would like to keep the name as is since it parallels the
format/structure of what's in libvirt-cim.
We can advertise the presence of these documents at the
http://wiki.libvirt.org/page/Cimtest_todo page.
Not sure what you mean here.. the todo page is for keeping track of
improvements/enhancements to the testsuite, as well as test cases that
need to be written.
--
Kaitlin Rupert
IBM Linux Technology Center
kaitlin(a)linux.vnet.ibm.com