From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mail-wm1-x32d.google.com (mail-wm1-x32d.google.com [IPv6:2a00:1450:4864:20::32d]) by sourceware.org (Postfix) with ESMTPS id C9AE83857027 for ; Sat, 12 Jun 2021 08:35:31 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.1 sourceware.org C9AE83857027 Received: by mail-wm1-x32d.google.com with SMTP id 3-20020a05600c0243b029019f2f9b2b8aso9924991wmj.2 for ; Sat, 12 Jun 2021 01:35:31 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:subject:to:cc:references:from:message-id:date :user-agent:mime-version:in-reply-to:content-language :content-transfer-encoding; bh=E1OmEWyTxSwx53cZyOS6ar3gXCWnYLccMSf/+1B185c=; b=qt2TeY7SsMO4BS7oWXfLxe0mxlZRaiOGneaxBgmJnzrbOzP+k5scSoyZv1tqL3r5gl waGmvUR8N/41y06GwcO970x3R2n19bqzPI8nUYWbZxTBb9JfH+xdPG/G52r2TIvS0Bvd Tc64l9vkZyLcIAY3r0+HKdiHvF/iu349bIs4j8MfpJUKZB1G5d4F2dzoqT5n+zpcsWts um31W32A/R07epr/AHMzyHCWHyETcIF0OMlLJJ07BzP64DM2aJqpI/ezaH8fSQDV2ZbF uTIcXdBNAqV/hh5Xb0EqyLHMAApwUkYjm6EzMjQ9GuX3dhK/NodYVTAxSuy0zqfhCeIB TsDw== X-Gm-Message-State: AOAM532HngxwlgPOPCLYulr8Ufmmch6cvRlXTd+zj6RxKfXVB4Se57ef 6Kfp5FTvs/oNSg2hsbxeuojHkaozZQU= X-Google-Smtp-Source: ABdhPJy/bFHlxVzh/1n9uhNV/7CgcmCcQTS1zndUCvVrKZxkNxXbCVfdYYQbyEejYrBPED/TB3JC/w== X-Received: by 2002:a05:600c:3795:: with SMTP id o21mr7442074wmr.99.1623486930733; Sat, 12 Jun 2021 01:35:30 -0700 (PDT) Received: from [192.168.0.160] ([170.253.36.171]) by smtp.gmail.com with ESMTPSA id a10sm8009512wrr.48.2021.06.12.01.35.30 (version=TLS1_3 cipher=TLS_AES_128_GCM_SHA256 bits=128/128); Sat, 12 Jun 2021 01:35:30 -0700 (PDT) Subject: Ping: [PATCH v3] MAX.3, MIN.3: New pages to document MAX() and MIN() To: mtk.manpages@gmail.com Cc: linux-man@vger.kernel.org, libc-alpha@sourceware.org, Paul Eggert References: <688adf87-e108-b4dd-66dd-ae9c4d7afdf8@cs.ucla.edu> <20210512225130.43044-1-alx.manpages@gmail.com> From: "Alejandro Colomar (man-pages)" Message-ID: <4a253e9e-06dd-7c20-a6c1-b0a684ad741d@gmail.com> Date: Sat, 12 Jun 2021 10:35:29 +0200 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:78.0) Gecko/20100101 Thunderbird/78.11.0 MIME-Version: 1.0 In-Reply-To: <20210512225130.43044-1-alx.manpages@gmail.com> Content-Type: text/plain; charset=utf-8 Content-Language: en-US Content-Transfer-Encoding: 7bit X-Spam-Status: No, score=-12.0 required=5.0 tests=BAYES_00, DKIM_SIGNED, DKIM_VALID, DKIM_VALID_AU, DKIM_VALID_EF, FREEMAIL_FROM, GIT_PATCH_0, RCVD_IN_DNSWL_NONE, SPF_HELO_NONE, SPF_PASS, TXREP autolearn=ham autolearn_force=no version=3.4.2 X-Spam-Checker-Version: SpamAssassin 3.4.2 (2018-09-13) on server2.sourceware.org X-BeenThere: libc-alpha@sourceware.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: Libc-alpha mailing list List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Sat, 12 Jun 2021 08:35:33 -0000 Ping On 5/13/21 12:51 AM, Alejandro Colomar wrote: > Signed-off-by: Alejandro Colomar > Cc: Paul Eggert > --- > > v2: > wfix > v3: > Adress Paul's review (rewrote most sections, and added BUGS and NOTES). > > > man3/MAX.3 | 90 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ > man3/MIN.3 | 1 + > 2 files changed, 91 insertions(+) > create mode 100644 man3/MAX.3 > create mode 100644 man3/MIN.3 > > diff --git a/man3/MAX.3 b/man3/MAX.3 > new file mode 100644 > index 000000000..38d019a2d > --- /dev/null > +++ b/man3/MAX.3 > @@ -0,0 +1,90 @@ > +.\" Copyright (C) 2021 Alejandro Colomar > +.\" > +.\" %%%LICENSE_START(VERBATIM) > +.\" Permission is granted to make and distribute verbatim copies of this > +.\" manual provided the copyright notice and this permission notice are > +.\" preserved on all copies. > +.\" > +.\" Permission is granted to copy and distribute modified versions of this > +.\" manual under the conditions for verbatim copying, provided that the > +.\" entire resulting derived work is distributed under the terms of a > +.\" permission notice identical to this one. > +.\" > +.\" Since the Linux kernel and libraries are constantly changing, this > +.\" manual page may be incorrect or out-of-date. The author(s) assume no > +.\" responsibility for errors or omissions, or for damages resulting from > +.\" the use of the information contained herein. The author(s) may not > +.\" have taken the same level of care in the production of this manual, > +.\" which is licensed free of charge, as they might when working > +.\" professionally. > +.\" > +.\" Formatted or processed versions of this manual, if unaccompanied by > +.\" the source, must acknowledge the copyright and authors of this work. > +.\" %%%LICENSE_END > +.\" > +.TH MAX 3 2020-11-01 "Linux" "Linux Programmer's Manual" > +.SH NAME > +MAX, MIN \- maximum or minimum of two values > +.SH SYNOPSIS > +.nf > +.B #include > +.PP > +.BI MAX( a ", " b ); > +.BI MIN( a ", " b ); > +.fi > +.SH DESCRIPTION > +These macros return the maximum or minimum of > +.I a > +and > +.IR b . > +.SH RETURN VALUE > +These macros return the value of one of their arguments, > +possibly converted to a different type (see BUGS). > +.SH ERRORS > +These macros may raise the "invalid" floating-point exception > +when any of the arguments is NaN. > +.SH CONFORMING TO > +These nonstandard macros are present in glibc and the BSDs. > +.SH NOTES > +If either of the arguments is of a floating-point type, > +you might prefer to use > +.BR fmax (3) > +or > +.BR fmin (3), > +which can handle NaN. > +.PP > +The arguments may be evaluated more than once, or not at all. > +.PP > +Some UNIX systems might provide these macros in a different header, > +or not at all. > +.SH BUGS > +Due to the usual arithmetic conversions, > +the result of these macros may be very different from either of the arguments. > +To avoid this, ensure that both arguments have the same type. > +.SH EXAMPLES > +.EX > +#include > +#include > +#include > + > +int > +main(int argc, char *argv[]) > +{ > + int a, b, x; > + > + if (argc != 3) { > + fprintf(stderr, "Usage: %s \en", argv[0]); > + exit(EXIT_FAILURE); > + } > + > + a = atoi(argv[1]); > + b = atoi(argv[2]); > + x = MAX(a, b); > + printf("MAX(%d, %d) is %d\en", a, b, x); > + > + exit(EXIT_SUCCESS); > +} > +.EE > +.SH SEE ALSO > +.BR fmax (3), > +.BR fmin (3) > diff --git a/man3/MIN.3 b/man3/MIN.3 > new file mode 100644 > index 000000000..9938abda2 > --- /dev/null > +++ b/man3/MIN.3 > @@ -0,0 +1 @@ > +.so man3/MAX.3 > -- Alejandro Colomar Linux man-pages comaintainer; https://www.kernel.org/doc/man-pages/ http://www.alejandro-colomar.es/