Bug 226713 - Conflict in argument types of auditpipe(4) in man-page and audit_ioctl.h
Summary: Conflict in argument types of auditpipe(4) in man-page and audit_ioctl.h
Status: Closed FIXED
Alias: None
Product: Documentation
Classification: Unclassified
Component: Manual Pages (show other bugs)
Version: Latest
Hardware: Any Any
: --- Affects Some People
Assignee: Alan Somers
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2018-03-19 03:54 UTC by Aniket Pandey
Modified: 2018-08-03 14:24 UTC (History)
4 users (show)

See Also:

Attachments
Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.
Description Aniket Pandey 2018-03-19 03:54:24 UTC 
The ioctl(2) request arguments for auditpipe(4) have conflicting data types in the man-page and the header "security/audit/audit_ioctl.h"

Issue in Preselection Mode Ioctls:

* AUDITPIPE_GET_PRESELECT_FLAGS
* AUDITPIPE_SET_PRESELECT_FLAGS
* AUDITPIPE_GET_PRESELECT_NAFLAGS
* AUDITPIPE_SET_PRESELECT_NAFLAGS

All of the above ioctls have a defined argument type of "au_mask_t" (struct au_mask) which is incorrectly represented as "u_int" in the man page of auditpipe(4).

I have worked with the ioctls and can confirm that the source is correct. The issue is with the man-page.

**Also: A typo in the same manpage [provided->provide]
https://github.com/freebsd/freebsd/blob/master/share/man/man4/auditpipe.4#L248
Comment 1 commit-hook freebsd_committer freebsd_triage 2018-05-30 19:57:55 UTC 
A commit references this bug:

Author: asomers
Date: Wed May 30 19:57:15 UTC 2018
New revision: 334394
URL: https://svnweb.freebsd.org/changeset/base/334394

Log:
  auditpipe(4): fix some ioctl arguments in the man page

  Fix the argument types for the AUDITPIPE_[GS]ET_PRESELECT_(NA)?FLAGS ioctls.
  Also, fix some grammar.

  [skip ci]

  PR:		226713
  Submitted by:	aniketp
  MFC after:	2 weeks
  Sponsored by:	Google, Inc. (GSoC 2018)
  Differential Revision:	https://reviews.freebsd.org/D15620

Changes:
  head/share/man/man4/auditpipe.4
Comment 2 commit-hook freebsd_committer freebsd_triage 2018-07-11 19:43:24 UTC 
A commit references this bug:

Author: asomers
Date: Wed Jul 11 19:42:58 UTC 2018
New revision: 336209
URL: https://svnweb.freebsd.org/changeset/base/336209

Log:
  MFC r334394:

  auditpipe(4): fix some ioctl arguments in the man page

  Fix the argument types for the AUDITPIPE_[GS]ET_PRESELECT_(NA)?FLAGS ioctls.
  Also, fix some grammar.

  [skip ci]

  PR:		226713
  Submitted by:	aniketp
  Sponsored by:	Google, Inc. (GSoC 2018)
  Differential Revision:	https://reviews.freebsd.org/D15620

Changes:
_U  stable/11/
  stable/11/share/man/man4/auditpipe.4
Comment 3 commit-hook freebsd_committer freebsd_triage 2018-08-03 14:24:36 UTC 
A commit references this bug:

Author: asomers
Date: Fri Aug  3 14:23:52 UTC 2018
New revision: 337253
URL: https://svnweb.freebsd.org/changeset/base/337253

Log:
  MFC r334394:

  auditpipe(4): fix some ioctl arguments in the man page

  Fix the argument types for the AUDITPIPE_[GS]ET_PRESELECT_(NA)?FLAGS ioctls.
  Also, fix some grammar.

  [skip ci]

  PR:		226713
  Submitted by:	aniketp
  Sponsored by:	Google, Inc. (GSoC 2018)
  Differential Revision:	https://reviews.freebsd.org/D15620

Changes:
_U  stable/10/
  stable/10/share/man/man4/auditpipe.4