linux-audit / audit-userspace

Linux audit userspace repository
GNU General Public License v2.0
577 stars 204 forks source link

There are no man-pages for some functions published in auparse.h and libaudit.h #193

Open miztake opened 3 years ago

miztake commented 3 years ago

Among the functions published in auparse.h and libaudit.h, there are no man-pages for the following functions. If there are any functions that shouldn't be published below, they should be removed from auparse.h and libaudit.h.

stevegrubb commented 3 years ago

This is true and intentional. Many of these functions are related to generating machine readable rules from human readable text. They are not as likely to be used by someone writing utilities for the audit logs. Of those, audit_value_needs_encoding, audit_encode_value, and audit_close might be of interest to programmers. And at a lower priority, I'd say audit_is_enabled, audit_request_features, audit_get_features, audit_reset_lost, audit_reset_backlog_wait_time_actual, audit_set_feature, audit_set_loginuid_immutable, audit_can_control, audit_can_write, and audit_can_read. The audit_can* could probably be 1 man page. I'm wondering if some of the others could also be combined or added to exist pages?

miztake commented 3 years ago

Dear @stevegrubb,

Thank you for your reply.

They are not as likely to be used by someone writing utilities for the audit logs.

Understood.

Of those, audit_value_needs_encoding, audit_encode_value, and audit_close might be of interest to programmers.

I agree with this opinion. First, I'll create these man-pages.

And at a lower priority, I'd say ...

I understand that these are low priorities.

The audit_can* could probably be 1 man page.

I agree that audit_can* could probably be 1 man page.

I'm wondering if some of the others could also be combined or added to exist pages?

I don't think it is necessary to combine or add other pages.

Regards,