sbuf(9): clarify kernel-only APIs

- move sbuf_bcopyin(9) and sbuf_copyin(9) near sbuf_new_for_sysctl(9), as
  all three functions are kernel-only APIs.
- add #ifdef _KERNEL around sbuf_*copyin and sbuf_new_for_sysctl(9) to
  make it visually clear that they are kernel-only APIs.

MFC after:	2 months
Sponsored by:	Dell EMC Isilon
This commit is contained in:
Enji Cooper 2017-04-06 02:46:09 +00:00
parent a6848fd560
commit e90ede1cc8
Notes: svn2git 2020-12-20 02:59:44 +00:00
svn path=/head/; revision=316551

View file

@ -106,12 +106,6 @@
.Fa "size_t len"
.Fc
.Ft int
.Fo sbuf_bcopyin
.Fa "struct sbuf *s"
.Fa "const void *uaddr"
.Fa "size_t len"
.Fc
.Ft int
.Fo sbuf_bcpy
.Fa "struct sbuf *s"
.Fa "const void *buf"
@ -128,12 +122,6 @@
.Fa "const char *str"
.Fc
.Ft int
.Fo sbuf_copyin
.Fa "struct sbuf *s"
.Fa "const void *uaddr"
.Fa "size_t len"
.Fc
.Ft int
.Fo sbuf_printf
.Fa "struct sbuf *s"
.Fa "const char *fmt" "..."
@ -207,6 +195,21 @@
.Fo sbuf_putbuf
.Fa "struct sbuf *s"
.Fc
.Fd #ifdef _KERNEL
.In sys/types.h
.In sys/sbuf.h
.Ft int
.Fo sbuf_bcopyin
.Fa "struct sbuf *s"
.Fa "const void *uaddr"
.Fa "size_t len"
.Fc
.Ft int
.Fo sbuf_copyin
.Fa "struct sbuf *s"
.Fa "const void *uaddr"
.Fa "size_t len"
.Fc
.In sys/sysctl.h
.Ft struct sbuf *
.Fo sbuf_new_for_sysctl
@ -215,6 +218,7 @@
.Fa "int length"
.Fa "struct sysctl_req *req"
.Fc
.Fd #endif /* _KERNEL */
.Sh DESCRIPTION
The
.Nm