audit-userspace icon indicating copy to clipboard operation
audit-userspace copied to clipboard

SYNOPSIS format in man-page is not unified

Open miztake opened this issue 4 years ago • 1 comments

The SYNOPSIS format is different for each man-page. The following patterns can be seen.

pattern 1: Header file is bold. Function prototype is not bold. e.g.: audit_open(3)

pattern 2: Header file is not bold. Function prototype is only function name bold. e.g.: set_aumessage_mode(3)

pattern 3: Both header files and function prototypes are bold. e.g.: audit_log_semanage_message(3)

Other patterns also exist.

The inconsistent format does not cause bugs. Therefore, I don't consider it a serious issue. However, readability is higher when the format is unified.

For example, glibc seems to have the following format.

Header file is bold. Function prototype is bold, but its argument is not bold, it is underlined. The arguments in DESCRIPTION are also underlined

miztake avatar Apr 25 '21 16:04 miztake

This is true. They have been modified many times by other people adding italics, bold, and various other formatting.

stevegrubb avatar Apr 25 '21 20:04 stevegrubb