From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 36871 invoked by alias); 26 May 2017 16:17:24 -0000 Mailing-List: contact libc-alpha-help@sourceware.org; run by ezmlm Precedence: bulk List-Id: List-Subscribe: List-Archive: List-Post: List-Help: , Sender: libc-alpha-owner@sourceware.org Received: (qmail 36163 invoked by uid 89); 26 May 2017 16:17:22 -0000 Authentication-Results: sourceware.org; auth=none X-Virus-Found: No X-Spam-SWARE-Status: No, score=-1.9 required=5.0 tests=AWL,BAYES_00,RCVD_IN_DNSWL_NONE,SPF_PASS,URIBL_RED autolearn=ham version=3.3.2 spammy= X-HELO: relay1.mentorg.com Date: Fri, 26 May 2017 16:17:00 -0000 From: Joseph Myers To: "Gabriel F. T. Gomes" CC: Subject: Re: [PATCH 5/6] float128: Add strfromf128, strtof128, and wcstof128 to the manual In-Reply-To: <1495803396-14558-6-git-send-email-gftg@linux.vnet.ibm.com> Message-ID: References: <1495803396-14558-1-git-send-email-gftg@linux.vnet.ibm.com> <1495803396-14558-6-git-send-email-gftg@linux.vnet.ibm.com> User-Agent: Alpine 2.20 (DEB 67 2015-01-07) MIME-Version: 1.0 Content-Type: text/plain; charset="US-ASCII" X-ClientProxiedBy: svr-ies-mbx-01.mgc.mentorg.com (139.181.222.1) To SVR-ORW-MBX-06.mgc.mentorg.com (147.34.90.206) X-SW-Source: 2017-05/txt/msg00809.txt.bz2 On Fri, 26 May 2017, Gabriel F. T. Gomes wrote: > 2016-11-14 Gabriel F. T. Gomes > > * manual/arith.texi: Add descriptions for strfromf128, strtof128, > and wcstof128. The documentation needs to be clear about what systems the functions are supported on. Rather than repeating that for every _Float128 function, I think an appropriate structure would be to have a section of arith.texi that discusses the C floating-point types, including explaining _Float@var{n} and _Float@var{n}x and that such types are supported by glibc on only some systems (currently the empty set, powerpc64le patch would change that section to say that _Float128 is supported on powerpc64le). Then the documentation of each function would be written in a type-generic way, say documenting @deftypefun _Float@var{n} strtof@var{n} (const char *@var{string}, char **@var{tailptr}) @deftypefunx _Float@var{n}x strtof@var{n}x (const char *@var{string}, char **@var{tailptr}) (documenting the _FloatNx functions optional since your patches aren't adding any such functions), so that it would apply automatically to all _FloatN types for which support is added to glibc (likewise, use @var{n} instead of literal 128 in the documentation text, ideally avoiding text that would need additional duplication when there are _FloatNx functions as well). (I'm assuming here that such uses of @var in function names and return / argument types work properly.) E.g. the text might say simply: These functions are like @code{strtod}, except for the return type. They were introduced in @w{ISO/IEC TS 18661-3}. which avoids the text needing changing when more such types are supported. -- Joseph S. Myers joseph@codesourcery.com