Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
miztake opened this issue Apr 25, 2021 · 2 comments

Comments

@miztake
Copy link
Contributor

miztake commented Apr 25, 2021

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.

  • auparse.h
    auparse_get_record_interpretations

  • libaudit.h
    audit_close
    audit_determine_machine
    audit_format_signal_info
    audit_name_to_field
    audit_field_to_name
    audit_name_to_syscall
    audit_syscall_to_name
    audit_name_to_flag
    audit_flag_to_name
    audit_name_to_action
    audit_action_to_name
    audit_name_to_msg_type
    audit_msg_type_to_name
    audit_name_to_machine
    audit_machine_to_name
    audit_machine_to_elf
    audit_elf_to_machine
    audit_operator_to_symbol
    audit_name_to_errno
    audit_errno_to_name
    audit_name_to_ftype
    audit_ftype_to_name
    audit_name_to_fstype
    audit_fstype_to_name
    audit_number_to_errmsg
    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_add_dir
    audit_add_watch_dir
    audit_trim_subtrees
    audit_make_equivalent
    audit_value_needs_encoding
    audit_encode_value
    audit_rule_create_data
    audit_rule_init_data
    audit_rule_syscall_data
    audit_rule_syscallbyname_data
    audit_rule_fieldpair_data
    audit_rule_interfield_comp_data
    audit_rule_free_data
    audit_can_control
    audit_can_write
    audit_can_read

@stevegrubb
Copy link
Member

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
Copy link
Contributor Author

miztake commented Apr 26, 2021

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,

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants