Hello,

We have oe-selftest already integrated in poky but we lack in documentation: 
https://bugzilla.yoctoproject.org/show_bug.cgi?id=4740

Here is what I am thinking about what could be done and I would like opinions 
on what should be done:
1) We can do a wiki entry to describe in detail how to use oe-selftest and give 
examples. The problem here is that as oe-selftest changes this entry might 
become outdated and even if we update it then older Yocto releases users will 
not be able to use it anymore.
2) We can have a manual entry derived from the wiki entry. Scott can use the 
wiki entry as a reference, if we decide to have one, to create the manual 
entry. The advantage of this is that we will have valid and up to date 
information for each Yocto release.
3) We can introduce comments in the script to explain what and why it does what 
it does(at the moment we have some though)
4) We can introduce comments in test modules or a DESCRIPTION field to document 
the test steps, especially for more complex tests(we have no such comments at 
the moment).

I would opt for 2) and 3) as I believe they give the most value with the least 
amount of time needed for creation and maintenance.  

If anyone has any more ideas please add your thoughts. 

Regards,
Corneliu
-- 
_______________________________________________
yocto mailing list
yocto@yoctoproject.org
https://lists.yoctoproject.org/listinfo/yocto

Reply via email to