From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mail-wm1-x341.google.com (mail-wm1-x341.google.com [IPv6:2a00:1450:4864:20::341]) by sourceware.org (Postfix) with ESMTPS id C52DF385DC1A for ; Tue, 27 Oct 2020 05:49:12 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.3.2 sourceware.org C52DF385DC1A Received: by mail-wm1-x341.google.com with SMTP id k18so170325wmj.5 for ; Mon, 26 Oct 2020 22:49:12 -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=Aft1acI66pRI9Y2YbvyYheUKZJytZ44xJ+1jCA2nE4k=; b=FmHknQp6t4t+Ew4o3cRoflHVWSbe2AGar+T4gCm6WYdCwgWNPW+CaHb3u+gj5EsJH1 cx6UTpTG5aJnEFRiAg+lVbNWoo+3vL4TG3ONw9bB897zNXlCfe91jt8CjVOV892L7Lsv 8ohcCSkTQHRKsc4nhtw+sAhlS9e0ACmQIPciPJOwmOgbuarvjS/44XbpWCI2SAjUOJAl 2alBLkuYUsmt2NjAqhfCFcak3eYG1pT1PQ363nqozTcW0i/Xgej0DdC1wRYBNP1XiKwV ErgMdlCBQtJTWbrt4OtX6/EOqlA3c5rOqoE47+aOK1BGmyEhwDb1OVv1orWlByRRzs6r Yr6Q== X-Gm-Message-State: AOAM533j3Hf3mD33wPYCsVLiUQP0UF51GRx/PQVP87oopvNYxlgYA9wc suRRnrNn9Mc8tjXZgvee9NE= X-Google-Smtp-Source: ABdhPJzLBqpVDeoOryIMwHd4PwbG2LXbNR2qhloibtg3GznuYcvKeDSSb3U+Et5wO6xKIe5eL7RU0A== X-Received: by 2002:a7b:cc09:: with SMTP id f9mr726287wmh.93.1603777751734; Mon, 26 Oct 2020 22:49:11 -0700 (PDT) Received: from ?IPv6:2001:a61:245a:d801:2e74:88ad:ef9:5218? ([2001:a61:245a:d801:2e74:88ad:ef9:5218]) by smtp.gmail.com with ESMTPSA id t12sm516159wrm.25.2020.10.26.22.49.10 (version=TLS1_3 cipher=TLS_AES_128_GCM_SHA256 bits=128/128); Mon, 26 Oct 2020 22:49:11 -0700 (PDT) Cc: mtk.manpages@gmail.com, linux-man@vger.kernel.org, libc-alpha@sourceware.org, jg@jguk.org Subject: Re: [PATCH v2 1/2] system_data_types.7: Add 'error_t' To: Alejandro Colomar References: <20201026221622.24879-1-colomar.6.4.3@gmail.com> From: "Michael Kerrisk (man-pages)" Message-ID: <12701238-4167-261c-ccce-440233d01e39@gmail.com> Date: Tue, 27 Oct 2020 06:49:10 +0100 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: <20201026221622.24879-1-colomar.6.4.3@gmail.com> Content-Type: text/plain; charset=utf-8 Content-Language: en-US Content-Transfer-Encoding: 7bit X-Spam-Status: No, score=-11.4 required=5.0 tests=BAYES_00, DKIM_SIGNED, DKIM_VALID, DKIM_VALID_AU, DKIM_VALID_EF, FREEMAIL_FROM, GIT_PATCH_0, KAM_ASCII_DIVIDERS, 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: Tue, 27 Oct 2020 05:49:14 -0000 Hi Alex, On 10/26/20 11:16 PM, Alejandro Colomar wrote: > Signed-off-by: Alejandro Colomar > --- > man7/system_data_types.7 | 39 +++++++++++++++++++++++++++++++++++++++ > 1 file changed, 39 insertions(+) > > diff --git a/man7/system_data_types.7 b/man7/system_data_types.7 > index 49ca2d8e1..4930aac8b 100644 > --- a/man7/system_data_types.7 > +++ b/man7/system_data_types.7 > @@ -199,6 +199,45 @@ See also the > .I float_t > type in this page. > .RE > +.\"------------------------------------- error_t ----------------------/ > +.TP > +.I error_t > +.RS > +Include: > +.IR , > +or > +.IR . > +Alternatively, > +.IR . > +.PP > +An integer type > +used for error reporting. > +A value of 0 means success, and nonzero means failure. > +Portable programs should use > +.I int > +instead. > +.PP > +Conforming to: > +Present in glibc. > +It is not standardized by the C language standard nor POSIX. > +.PP > +Notes: > +C11 standardized a similar type as an optional extension: > +.IR errno_t . > +However, > +.I errno_t > +is not present in POSIX. > +.PP > +.I > +defines this type if the macro > +.B _GNU_SOURCE > +is defined before including the header. > +.PP > +See also: > +.BR argz_add (3), > +.BR envz_add (3), > +.BR feature_test_macros (7) > +.RE > .\"------------------------------------- fd_set -----------------------/ > .TP > .I fd_set So, I must say that I am skeptical about adding this type to the page. There is a trade-off between having useful info and creating a page that becomes so large that it becomes unwieldy. error_t is an obscure [1], nonstandard type used by two API sets (one of which is roughly a special case of the other). I'm so far unconvinced of the value of adding this typr to the page. Cheers, Michael [1] Before Jonny Grant's mail yesterday, which I presume was the inspiration for this patch, I had either neither heard of the type or at least long ago forgotten about it. -- Michael Kerrisk Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/ Linux/UNIX System Programming Training: http://man7.org/training/