bcfg2-reports: Sparse documentation

[m4z <[email protected]…>]

bcfg2-reports is missing a manual page. Also, the output of bcfg2-reports -h is unclear:

• What is meant by "current interaction"? The last run of the client?
• What does expiring a host mean/do? Just "delete the client from the list"?
• What is KIND, what is NAME? (seems KIND is not Package, ConfigFile etc.)
• What are fields?
• Examples please.

(I have not read the code (yet) and users should not need to.)

[solj]

Replying to m4z <[email protected]…>:

bcfg2-reports is missing a manual page. Also, the output of bcfg2-reports -h is unclear:

The bcfg2-reports man page exists and is located at http://trac.mcs.anl.gov/projects/bcfg2/browser/man/bcfg2-reports.8.

• What is meant by "current interaction"? The last run of the client?

Yes.

• What does expiring a host mean/do? Just "delete the client from the list"?

It basically means the host is expired (no longer deployed). You can completely purge a host using bcfg2-admin reports purge.

• What is KIND, what is NAME? (seems KIND is not Package, ConfigFile etc.)

KIND is the type of entry (Package, Path, Service, etc). NAME is the name of the entry.

• What are fields?

I'm not sure. Where are you seeing this?

• Examples please.

(I have not read the code (yet) and users should not need to.)

Most of this functionality has been migrated over to bcfg2-admin reports. I think the best way to move forward from here is by updating the bcfg2-admin man pages to reflect the new options. Once bcfg2-admin reports has all of this functionality, we will likely deprecate bcfg2-reports.