Date: Thu, 14 Nov 2013 21:31:58 +0000 (UTC) From: John Baldwin <jhb@FreeBSD.org> To: src-committers@freebsd.org, svn-src-all@freebsd.org, svn-src-stable@freebsd.org, svn-src-stable-9@freebsd.org Subject: svn commit: r258146 - stable/9/share/man/man9 Message-ID: <201311142131.rAELVwhj098453@svn.freebsd.org>
next in thread | raw e-mail | index | archive | help
Author: jhb Date: Thu Nov 14 21:31:58 2013 New Revision: 258146 URL: http://svnweb.freebsd.org/changeset/base/258146 Log: MFC 255498: - Document the UQUAD sysctl variants. - Clarify that exactly one of the "access" flags is required and list the optional flags in a separate list. Prefer bundling CTLFLAG_TUN into the access flag by not documenting it as an optional flag to set. Modified: stable/9/share/man/man9/Makefile stable/9/share/man/man9/sysctl.9 stable/9/share/man/man9/sysctl_add_oid.9 Directory Properties: stable/9/share/man/man9/ (props changed) Modified: stable/9/share/man/man9/Makefile ============================================================================== --- stable/9/share/man/man9/Makefile Thu Nov 14 21:27:19 2013 (r258145) +++ stable/9/share/man/man9/Makefile Thu Nov 14 21:31:58 2013 (r258146) @@ -1273,22 +1273,24 @@ MLINKS+=sysctl.9 SYSCTL_DECL.9 \ sysctl.9 SYSCTL_NODE.9 \ sysctl.9 SYSCTL_OPAQUE.9 \ sysctl.9 SYSCTL_PROC.9 \ + sysctl.9 SYSCTL_QUAD.9 \ sysctl.9 SYSCTL_STRING.9 \ sysctl.9 SYSCTL_STRUCT.9 \ sysctl.9 SYSCTL_UINT.9 \ sysctl.9 SYSCTL_ULONG.9 \ - sysctl.9 SYSCTL_QUAD.9 + sysctl.9 SYSCTL_UQUAD.9 MLINKS+=sysctl_add_oid.9 SYSCTL_ADD_INT.9 \ sysctl_add_oid.9 SYSCTL_ADD_LONG.9 \ sysctl_add_oid.9 SYSCTL_ADD_NODE.9 \ sysctl_add_oid.9 SYSCTL_ADD_OID.9 \ sysctl_add_oid.9 SYSCTL_ADD_OPAQUE.9 \ sysctl_add_oid.9 SYSCTL_ADD_PROC.9 \ + sysctl_add_oid.9 SYSCTL_ADD_QUAD.9 \ sysctl_add_oid.9 SYSCTL_ADD_STRING.9 \ sysctl_add_oid.9 SYSCTL_ADD_STRUCT.9 \ sysctl_add_oid.9 SYSCTL_ADD_UINT.9 \ sysctl_add_oid.9 SYSCTL_ADD_ULONG.9 \ - sysctl_add_oid.9 SYSCTL_ADD_QUAD.9 \ + sysctl_add_oid.9 SYSCTL_ADD_UQUAD.9 \ sysctl_add_oid.9 SYSCTL_CHILDREN.9 \ sysctl_add_oid.9 sysctl_move_oid.9 \ sysctl_add_oid.9 sysctl_remove_oid.9 \ Modified: stable/9/share/man/man9/sysctl.9 ============================================================================== --- stable/9/share/man/man9/sysctl.9 Thu Nov 14 21:27:19 2013 (r258145) +++ stable/9/share/man/man9/sysctl.9 Thu Nov 14 21:31:58 2013 (r258146) @@ -25,7 +25,7 @@ .\" .\" $FreeBSD$ .\" -.Dd January 16, 2010 +.Dd September 12, 2013 .Dt SYSCTL 9 .Os .Sh NAME @@ -35,11 +35,12 @@ .Nm SYSCTL_NODE , .Nm SYSCTL_OPAQUE , .Nm SYSCTL_PROC , +.Nm SYSCTL_QUAD , .Nm SYSCTL_STRING , .Nm SYSCTL_STRUCT , .Nm SYSCTL_UINT , .Nm SYSCTL_ULONG , -.Nm SYSCTL_QUAD +.Nm SYSCTL_UQUAD .Nd Static sysctl declaration functions .Sh SYNOPSIS .In sys/types.h @@ -50,11 +51,12 @@ .Fn SYSCTL_NODE parent nbr name access handler descr .Fn SYSCTL_OPAQUE parent nbr name access ptr len fmt descr .Fn SYSCTL_PROC parent nbr name access ptr arg handler fmt descr +.Fn SYSCTL_QUAD parent nbr name access ptr val descr .Fn SYSCTL_STRING parent nbr name access arg len descr .Fn SYSCTL_STRUCT parent nbr name access ptr type descr .Fn SYSCTL_UINT parent nbr name access ptr val descr .Fn SYSCTL_ULONG parent nbr name access ptr val descr -.Fn SYSCTL_QUAD parent nbr name access ptr val descr +.Fn SYSCTL_UQUAD parent nbr name access ptr val descr .Sh DESCRIPTION The .Nm SYSCTL @@ -76,12 +78,13 @@ New nodes are declared using one of .Fn SYSCTL_NODE , .Fn SYSCTL_OPAQUE , .Fn SYSCTL_PROC , +.Fn SYSCTL_QUAD , .Fn SYSCTL_STRING , .Fn SYSCTL_STRUCT , .Fn SYSCTL_UINT , .Fn SYSCTL_ULONG , and -.Fn SYSCTL_QUAD . +.Fn SYSCTL_UQUAD . Each macro accepts a parent name, as declared using .Fn SYSCTL_DECL , an OID number, typically @@ -118,15 +121,23 @@ This is an unsigned long. This is a 64-bit unsigned integer. .El .Pp -All sysctl types except for new node declarations require one or more flags -to be set indicating the read and write disposition of the sysctl: +All sysctl types except for new node declarations require one of the following +flags to be set indicating the read and write disposition of the sysctl: .Bl -tag -width ".Dv CTLFLAG_ANYBODY" .It Dv CTLFLAG_RD This is a read-only sysctl. +.It Dv CTLFLAG_RDTUN +This is a read-only sysctl which can be set by a system tunable. .It Dv CTLFLAG_WR This is a writable sysctl. .It Dv CTLFLAG_RW This sysctl is readable and writable. +.It Dv CTLFLAG_RWTUN +This sysctl is readable and writable and can also be set by a system tunable. +.El +.Pp +Additionally, any of the following optional flags may also be specified: +.Bl -tag -width ".Dv CTLFLAG_ANYBODY" .It Dv CTLFLAG_ANYBODY Any user or process can write to this sysctl. .It Dv CTLFLAG_SECURE @@ -139,9 +150,6 @@ This sysctl can be written to by process When iterating the sysctl name space, do not list this sysctl. .It Dv CTLFLAG_TUN Advisory flag that a system tunable also exists for this variable. -.It Dv CTLFLAG_RDTUN -Advisory flag that a system tunable also exists for this variable; -however, the run-time variable is read-only. .El .Pp When creating new sysctls, careful attention should be paid to the security Modified: stable/9/share/man/man9/sysctl_add_oid.9 ============================================================================== --- stable/9/share/man/man9/sysctl_add_oid.9 Thu Nov 14 21:27:19 2013 (r258145) +++ stable/9/share/man/man9/sysctl_add_oid.9 Thu Nov 14 21:31:58 2013 (r258146) @@ -27,7 +27,7 @@ .\" .\" $FreeBSD$ .\" -.Dd July 15, 2000 +.Dd September 12, 2013 .Dt SYSCTL_ADD_OID 9 .Os .Sh NAME @@ -157,6 +157,16 @@ .Fa "const char *descr" .Fc .Ft struct sysctl_oid * +.Fo SYSCTL_ADD_UQUAD +.Fa "struct sysctl_ctx_list *ctx" +.Fa "struct sysctl_oid_list *parent" +.Fa "int number" +.Fa "const char *name" +.Fa "int access" +.Fa "uint64_t *arg" +.Fa "const char *descr" +.Fc +.Ft struct sysctl_oid * .Fo SYSCTL_ADD_OPAQUE .Fa "struct sysctl_ctx_list *ctx" .Fa "struct sysctl_oid_list *parent"
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?201311142131.rAELVwhj098453>