add comments and documentation
ClosedPublic

Authored by garretraziel on Jul 30 2015, 2:46 PM.

Details

Summary

Add comments to tests, document code,
explain for what use what baseclass etc.

Test Plan

Run whole testsuite

Diff Detail

Repository
rOPENQATESTS os-autoinst-distri-fedora
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.
garretraziel retitled this revision from to add comments and documentation.Jul 30 2015, 2:46 PM
garretraziel updated this object.
garretraziel edited the test plan for this revision. (Show Details)
garretraziel added reviewers: jskladan, adamwill.

Note that this isn't final DR, I will continue on it tomorrow.

so far so good, only few nitpicks

lib/fedorabase.pm
6

...using other base class...

10

... logging in as root/specified...

11

...by the root_console() method ...

lib/fedoradistribution.pm
6

Distro-specific functions, that are actually part of the API (....) should be here

9

..that can be...

main.pm
65

UPGRADE can be set to ...

76

this comment sounds like the _boot_to_anaconda takes care of the reboot phase

Aside from my inline comments, can I suggest we hold off merging this until D475 is merged? I think it should be easier to rebase the comments on top of the storage changes than vice versa, plus the changes in D475 will require some of the comments in this request to be changed.

main.pm
79

'anacodna' -> 'anaconda'

tests/_boot_to_anaconda.pm
14

it's -> its

59

wat -> wait

In D481#9049, @adamwill wrote:

Aside from my inline comments, can I suggest we hold off merging this until D475 is merged?

Yes, that's what I was planning to do.

changes in README.md, merged with develop

adamwill accepted this revision.Jul 31 2015, 8:54 PM

This all looks fine to me now, thanks!

This revision is now accepted and ready to land.Jul 31 2015, 8:54 PM
This revision was automatically updated to reflect the committed changes.