From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mail-ed1-x543.google.com (mail-ed1-x543.google.com [IPv6:2a00:1450:4864:20::543]) by sourceware.org (Postfix) with ESMTPS id 355B13887027 for ; Sat, 3 Oct 2020 11:44:16 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.3.2 sourceware.org 355B13887027 Received: by mail-ed1-x543.google.com with SMTP id j2so4604126eds.9 for ; Sat, 03 Oct 2020 04:44:16 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:cc:subject:to:references:from:message-id:date :user-agent:mime-version:in-reply-to:content-language :content-transfer-encoding; bh=rZnmq4EkXmPa94D0p2/bUPcfpqzVU4KJmwkDyUGBrGE=; b=MUJywxL5BvULtXxruJLhxzML9KvsmjMJQRiRiBlbQ4RLEPBZZJOl8N+91CA523d7yB 9chNQmc21jE8xcABnTfNnun+fg/U3dqZqz9+rwPSxmOIIthTjxQu3yiQEVQBZRqBafpk e9c2jy5WS90+9Y5Jbxcx2KZqNLHINTiIYyKaFAhZ1Rh5szRf1IfDhdBrgDKzTqflAVQm bDJLbw3QYbubTAEHS2tEDBHdJUbjOtVKrDK0YWl/NkTGu6XVnw0Ldz8/StPcIMxCr+Wb 1dvI/v62G0HwvKXIP9ea17f0BR42r6kEw+d1VTVniwRfJU5JvNzU7W01BiohfAD+PxWX IynA== X-Gm-Message-State: AOAM530+QXlFxA+ZNWSZ2PIwmLFxws/I0swbNIkWgSP4D16aKUAZhTAx 9nRuFiEqGMawD+4ApyOwVvA= X-Google-Smtp-Source: ABdhPJwsOzIYcyr0fJIEGSrt2z7pBUr1b1/9qlqF2qlaOlgxEethWd99c3Gip9psc4U8WJCT4nuqlQ== X-Received: by 2002:aa7:d6c4:: with SMTP id x4mr7808692edr.98.1601725455366; Sat, 03 Oct 2020 04:44:15 -0700 (PDT) Received: from ?IPv6:2001:a61:2479:6801:d8fe:4132:9f23:7e8f? ([2001:a61:2479:6801:d8fe:4132:9f23:7e8f]) by smtp.gmail.com with ESMTPSA id a10sm399129edu.78.2020.10.03.04.44.14 (version=TLS1_3 cipher=TLS_AES_128_GCM_SHA256 bits=128/128); Sat, 03 Oct 2020 04:44:14 -0700 (PDT) Cc: mtk.manpages@gmail.com, linux-man , GNU C Library , "gcc@gcc.gnu.org" Subject: Re: [PATCH 0/2] Document void * To: Jonathan Wakely , Alejandro Colomar References: <20201001150638.102544-1-colomar.6.4.3@gmail.com> <71c5f264-38f4-18ee-fe96-39aad08c3369@gmail.com> <41affebd-3354-9420-0048-bffd14535e95@gmail.com> From: "Michael Kerrisk (man-pages)" Message-ID: <1363a952-79d5-e41e-652c-14c67ac47a7b@gmail.com> Date: Sat, 3 Oct 2020 13:44:11 +0200 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:68.0) Gecko/20100101 Thunderbird/68.11.0 MIME-Version: 1.0 In-Reply-To: Content-Type: text/plain; charset=utf-8 Content-Language: en-US Content-Transfer-Encoding: 7bit X-Spam-Status: No, score=-5.1 required=5.0 tests=BAYES_00, DKIM_SIGNED, DKIM_VALID, DKIM_VALID_AU, DKIM_VALID_EF, FREEMAIL_FROM, KAM_SHORT, NICE_REPLY_A, 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, 03 Oct 2020 11:44:17 -0000 Hi Jonathan! On 10/2/20 3:19 PM, Jonathan Wakely wrote: > On Thu, 1 Oct 2020 at 16:51, Alejandro Colomar via Gcc wrote: >> >> Hi Michael, >> >> On 2020-10-01 17:34, Michael Kerrisk (man-pages) wrote: >>> Hello Alex, >>> >>> On 10/1/20 5:06 PM, Alejandro Colomar wrote: >>>> Hello Michael, >>>> >>>> This type is very special, >>>> so I will probably have missed some details about it. >>> >>> I do wonder if we actually need this in page at all, and given: >> >> >> I think it should be. >> I would also document 'void', even if it's a bit weird... >> They are very useful, so why not document them? > > Because the man-pages are not a tutorial for the C language. > > "The Linux man-pages project documents the Linux kernel and C library > interfaces that are employed by user-space programs." > > void and void* are not APIs. Agreed, but the rationale of the page is to document topics that are helpful when using the APIs. And, as I noted already stuff like 'void *' is borerline, but I think it's helpful to have some info summarized in one place. And, additionally, POSIX adds a detail to the C standard (casting between void * and function pointer). By the way, thanks for all of your input so far. Among other things, it made me realize that some navigational corrections were needed. Cheers, Michael -- Michael Kerrisk Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/ Linux/UNIX System Programming Training: http://man7.org/training/