From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mail-wm1-x32c.google.com (mail-wm1-x32c.google.com [IPv6:2a00:1450:4864:20::32c]) by sourceware.org (Postfix) with ESMTPS id 7DF133987C33 for ; Wed, 10 Mar 2021 18:32:19 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.3.2 sourceware.org 7DF133987C33 Received: by mail-wm1-x32c.google.com with SMTP id u187so7730883wmg.4 for ; Wed, 10 Mar 2021 10:32:19 -0800 (PST) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=SbBJw7oZUCrdT15Cge/YxGfwbb0E/66cTP2LTmVSnRY=; b=R3BFaKWJxo51s6QDAAJ3wHoy7Uyp76+cox93la+nwn72fenMKNE165jLy9gShJIuSZ RAomt1/XsJZv0TrqyLwhZ2ie8Af2PSIkGB6dPmGCLARaxhCX0A+k7RyirnvDFha+UTv6 3v+bjBQOKNhueUYB6PNPB11+M0ncv8kO5l+5tep/4gfnu8qJBYUWvh5UxtviJPxKKhBL cZT9PoJnmP69sMIauPBvdqRKQEaAO8/vlYzpLttGkJn4ca991HhdiSatwtFc37yomsnt ha5FktHAnU9oQmGeokqFlzyNrgsIP7h4AYA/8WevwW1AtcmlcAhZTgoJvACeGkAdPfSt jAUw== X-Gm-Message-State: AOAM532uYqnzZUHjt7a+fqKWzImeFGo1mpZy5/PPxni5BsNRH7erHiuZ t0yH9fBy5bXv+Tia1jm4o5A= X-Google-Smtp-Source: ABdhPJxq34au83jDv0d8RqnRgJJjOhgBrUwWWkmj0dT5LrDKozFY0E246553+aJrWe/KygcAKJG29A== X-Received: by 2002:a05:600c:2102:: with SMTP id u2mr4691389wml.22.1615401138646; Wed, 10 Mar 2021 10:32:18 -0800 (PST) Received: from localhost.localdomain ([170.253.51.130]) by smtp.googlemail.com with ESMTPSA id k11sm325374wmj.1.2021.03.10.10.32.17 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 10 Mar 2021 10:32:18 -0800 (PST) From: Alejandro Colomar To: mtk.manpages@gmail.com Cc: Alejandro Colomar , linux-man@vger.kernel.org, libc-alpha@sourceware.org Subject: [PATCH 15/24] string.3: SYNOPSIS: Use 'restrict' in prototypes Date: Wed, 10 Mar 2021 19:31:41 +0100 Message-Id: <20210310183149.194717-16-alx.manpages@gmail.com> X-Mailer: git-send-email 2.30.1.721.g45526154a5 In-Reply-To: <20210310183149.194717-1-alx.manpages@gmail.com> References: <20210310183149.194717-1-alx.manpages@gmail.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Spam-Status: No, score=-12.4 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: Wed, 10 Mar 2021 18:32:20 -0000 Both POSIX and glibc use 'restrict' in stpcpy(), strcat(), strcpy(), strncat(), strncpy(), strtok(), strxfrm(). Let's use it here too. .../glibc$ grep_glibc_prototype stpcpy string/string.h:475: extern char *stpcpy (char *__restrict __dest, const char *__restrict __src) __THROW __nonnull ((1, 2)); .../glibc$ grep_glibc_prototype strcat string/string.h:133: extern char *strcat (char *__restrict __dest, const char *__restrict __src) __THROW __nonnull ((1, 2)); .../glibc$ grep_glibc_prototype strcpy string/string.h:125: extern char *strcpy (char *__restrict __dest, const char *__restrict __src) __THROW __nonnull ((1, 2)); .../glibc$ grep_glibc_prototype strncat string/string.h:136: extern char *strncat (char *__restrict __dest, const char *__restrict __src, size_t __n) __THROW __nonnull ((1, 2)); .../glibc$ grep_glibc_prototype strncpy string/string.h:128: extern char *strncpy (char *__restrict __dest, const char *__restrict __src, size_t __n) __THROW __nonnull ((1, 2)); .../glibc$ grep_glibc_prototype strtok string/string.h:340: extern char *strtok (char *__restrict __s, const char *__restrict __delim) __THROW __nonnull ((2)); .../glibc$ grep_glibc_prototype strxfrm string/string.h:150: extern size_t strxfrm (char *__restrict __dest, const char *__restrict __src, size_t __n) __THROW __nonnull ((2)) __attr_access ((__write_only__, 1, 3)); .../glibc$ Signed-off-by: Alejandro Colomar --- man3/string.3 | 19 +++++++++++-------- 1 file changed, 11 insertions(+), 8 deletions(-) diff --git a/man3/string.3 b/man3/string.3 index ab4cc3ce7..06da21c28 100644 --- a/man3/string.3 +++ b/man3/string.3 @@ -66,7 +66,7 @@ in the string .TP .B #include .TP -.BI "char *stpcpy(char *" dest ", const char *" src ); +.BI "char *stpcpy(char *restrict " dest ", const char *restrict " src ); Copy a string from .I src to @@ -74,7 +74,7 @@ to returning a pointer to the end of the resulting string at .IR dest . .TP -.BI "char *strcat(char *" dest ", const char *" src ); +.BI "char *strcat(char *restrict " dest ", const char *restrict " src ); Append the string .I src to the string @@ -101,7 +101,7 @@ with .I s2 using the current locale. .TP -.BI "char *strcpy(char *" dest ", const char *" src ); +.BI "char *strcpy(char *restrict " dest ", const char *restrict " src ); Copy the string .I src to @@ -129,7 +129,8 @@ Randomly swap the characters in Return the length of the string .IR s . .TP -.BI "char *strncat(char *" dest ", const char *" src ", size_t " n ); +.BI "char *strncat(char *restrict " dest ", const char *restrict " src \ +", size_t " n ); Append at most .I n bytes from the string @@ -147,7 +148,8 @@ bytes of the strings and .IR s2 . .TP -.BI "char *strncpy(char *" dest ", const char *" src ", size_t " n ); +.BI "char *strncpy(char *restrict " dest ", const char *restrict " src \ +", size_t " n ); Copy at most .I n bytes from string @@ -188,19 +190,20 @@ in the string .IR haystack , returning a pointer to the found substring. .TP -.BI "char *strtok(char *" s ", const char *" delim ); +.BI "char *strtok(char *restrict " s ", const char *restrict " delim ); Extract tokens from the string .I s that are delimited by one of the bytes in .IR delim . .TP -.BI "size_t strxfrm(char *" dest ", const char *" src ", size_t " n ); +.BI "size_t strxfrm(char *restrict " dst ", const char *restrict " src \ +", size_t " n ); Transforms .I src to the current locale and copies the first .I n bytes to -.IR dest . +.IR dst . .SH DESCRIPTION The string functions perform operations on null-terminated strings. -- 2.30.1.721.g45526154a5