Skip site navigation (1)Skip section navigation (2)
Date:      Thu, 6 Apr 2017 02:46:09 +0000 (UTC)
From:      Ngie Cooper <ngie@FreeBSD.org>
To:        src-committers@freebsd.org, svn-src-all@freebsd.org, svn-src-head@freebsd.org
Subject:   svn commit: r316551 - head/share/man/man9
Message-ID:  <201704060246.v362k926010756@repo.freebsd.org>

next in thread | raw e-mail | index | archive | help
Author: ngie
Date: Thu Apr  6 02:46:09 2017
New Revision: 316551
URL: https://svnweb.freebsd.org/changeset/base/316551

Log:
  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

Modified:
  head/share/man/man9/sbuf.9

Modified: head/share/man/man9/sbuf.9
==============================================================================
--- head/share/man/man9/sbuf.9	Thu Apr  6 02:40:52 2017	(r316550)
+++ head/share/man/man9/sbuf.9	Thu Apr  6 02:46:09 2017	(r316551)
@@ -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



Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?201704060246.v362k926010756>