From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mailbackend.panix.com (mailbackend.panix.com [166.84.1.89]) by sourceware.org (Postfix) with ESMTPS id E036F3851C23 for ; Sun, 14 Mar 2021 21:40:34 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.3.2 sourceware.org E036F3851C23 Authentication-Results: sourceware.org; dmarc=none (p=none dis=none) header.from=panix.com Authentication-Results: sourceware.org; spf=pass smtp.mailfrom=zackw@panix.com Received: from mail-ed1-f46.google.com (mail-ed1-f46.google.com [209.85.208.46]) by mailbackend.panix.com (Postfix) with ESMTPSA id 4DzCdt2fbgz1Dvt for ; Sun, 14 Mar 2021 17:40:34 -0400 (EDT) DKIM-Signature: v=1; a=rsa-sha256; c=simple/simple; d=panix.com; s=panix; t=1615758034; bh=VH7OWqmKP1K+3Gqx0YjUL/k/ECc59WT1KiNLy3oiNRg=; h=References:In-Reply-To:From:Date:Subject:To:Cc; b=NJzjIDN0F3vVtDg0v7ezbhQMr6iKi94ePIOcKyHK+9/3DURXitMqsR684pj5A6B4K +7B/K+ZdD84nSkMzeZMpNU1rL1OGJ29FgYtV+r5h45PIugfN8uz+3YnN1gU4QvmDrT X85Ba6CZ96EiwHKjXh8tXJEDfjo+94/XgaOtvrqc= Received: by mail-ed1-f46.google.com with SMTP id bf3so15045279edb.6 for ; Sun, 14 Mar 2021 14:40:34 -0700 (PDT) X-Gm-Message-State: AOAM531nmj1sWitA1GeRZ7ZxhesR8QSCYnAEb5Y5nVOAysaYNzAhQMOR cM1ypdgGjX6uWW57yA3Xbx3H9KYjfsx0Lo+6g1c= X-Google-Smtp-Source: ABdhPJyGc99PnGPTK9D08Ib+nUgMWPyUJMeh+YBoKHTK4EEsjqJObW5KSbhC4+YbNmWIBfpxbRuRHBGcmwhS09dbUZE= X-Received: by 2002:aa7:db01:: with SMTP id t1mr26691060eds.77.1615758033090; Sun, 14 Mar 2021 14:40:33 -0700 (PDT) MIME-Version: 1.0 References: <20210314160134.127878-1-alx.manpages@gmail.com> In-Reply-To: <20210314160134.127878-1-alx.manpages@gmail.com> From: Zack Weinberg Date: Sun, 14 Mar 2021 17:40:21 -0400 X-Gmail-Original-Message-ID: Message-ID: Subject: Re: [PATCH] Various pages: Remove unused To: Alejandro Colomar Cc: "Michael Kerrisk (man-pages)" , linux-man , GNU C Library Content-Type: text/plain; charset="UTF-8" X-Spam-Status: No, score=-1.7 required=5.0 tests=BAYES_00, DKIM_SIGNED, DKIM_VALID, DKIM_VALID_AU, DKIM_VALID_EF, JMQ_SPF_NEUTRAL, RCVD_IN_MSPIKE_H3, RCVD_IN_MSPIKE_WL, SPF_HELO_NONE, SPF_PASS, TXREP autolearn=no 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: Sun, 14 Mar 2021 21:40:36 -0000 On Sun, Mar 14, 2021 at 12:04 PM Alejandro Colomar via Libc-alpha wrote: > > The manual pages are already inconsistent in which headers need > to be included. Right now, not all of the types used by a > function have their required header included in the SYNOPSIS. > > If we were to add the headers required by all of the types used by > functions, the SYNOPSIS would grow too much. Not only it would > grow too much, but the information there would be less precise. > > Having system_data_types(7) document each type with all the > information about required includes is much more precise, and the > info is centralized so that it's much easier to maintain. > > So let's document only the include required for the function > prototype, and also the ones required for the macros needed to > call the function. I endorse this change. For glibc, if the header file containing the function prototype doesn't also provide everything you need to call the function, it's a bug (except for a few cases where the relevant standards prevent us from doing this, e.g. a function that calls vprintf will need the macros in , but the C standard specifically forbids to include ). > only defines types, not functions or constants, so > it doesn't belong to man[23] (function) pages at all. > I ignore if some old systems had headers that required you to > include *before* them (incomplete headers), Such systems did exist in the past, but they are too old to worry about nowadays. I don't think it's possible for them to be compliant with POSIX.1-1995, and the examples I know of personally (SunOS 4, for instance) were not even fully compliant with C89. zw