Skip site navigation (1)Skip section navigation (2)
Date:      Sat, 22 Apr 2017 19:32:23 +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: r317289 - head/lib/libgeom
Message-ID:  <201704221932.v3MJWNpj051636@repo.freebsd.org>

next in thread | raw e-mail | index | archive | help
Author: ngie
Date: Sat Apr 22 19:32:23 2017
New Revision: 317289
URL: https://svnweb.freebsd.org/changeset/base/317289

Log:
  libgeom(3): note that stdio.h is required when referencing gctl_dump(3)
  
  gctl_dump(3) is only exposed when stdio.h is #include'd first, per its
  addition in r112510. The reasoning noted for the conditional "exposure"
  of the function was to "limit #include pollution".
  
  This addresses an issue I found with the documentation when looking at
  bug 218809, which in turn addresses a -Wimplicit-function-declaration
  compiler warning in `tools/regression/geom_gpt/test.c` (it uses
  gctl_dump(3)).
  
  MFC after:	5 weeks
  Sponsored by:	Dell EMC Isilon

Modified:
  head/lib/libgeom/libgeom.3

Modified: head/lib/libgeom/libgeom.3
==============================================================================
--- head/lib/libgeom/libgeom.3	Sat Apr 22 19:11:37 2017	(r317288)
+++ head/lib/libgeom/libgeom.3	Sat Apr 22 19:32:23 2017	(r317289)
@@ -63,6 +63,10 @@
 .Sh LIBRARY
 .Lb libgeom
 .Sh SYNOPSIS
+.Bd -literal
+/* stdio.h is only required for `gctl_dump` */
+.Ed
+.In stdio.h
 .In libgeom.h
 .Ss "Statistics Functions"
 .Ft void



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