From patchwork Mon Jan 6 16:26:09 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Arjun Shankar X-Patchwork-Id: 104191 Return-Path: X-Original-To: patchwork@sourceware.org Delivered-To: patchwork@sourceware.org Received: from server2.sourceware.org (localhost [IPv6:::1]) by sourceware.org (Postfix) with ESMTP id 708D33858C33 for ; Mon, 6 Jan 2025 16:40:32 +0000 (GMT) DKIM-Filter: OpenDKIM Filter v2.11.0 sourceware.org 708D33858C33 Authentication-Results: sourceware.org; dkim=pass (1024-bit key, unprotected) header.d=redhat.com header.i=@redhat.com header.a=rsa-sha256 header.s=mimecast20190719 header.b=CkiVvvLD X-Original-To: libc-alpha@sourceware.org Delivered-To: libc-alpha@sourceware.org Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.133.124]) by sourceware.org (Postfix) with ESMTP id 023C73858CD1 for ; Mon, 6 Jan 2025 16:33:13 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.2 sourceware.org 023C73858CD1 Authentication-Results: sourceware.org; dmarc=pass (p=none dis=none) header.from=redhat.com Authentication-Results: sourceware.org; spf=pass smtp.mailfrom=redhat.com ARC-Filter: OpenARC Filter v1.0.0 sourceware.org 023C73858CD1 Authentication-Results: server2.sourceware.org; arc=none smtp.remote-ip=170.10.133.124 ARC-Seal: i=1; a=rsa-sha256; d=sourceware.org; s=key; t=1736181194; cv=none; b=DFfbaFK8hKo8hGNq2vHH5GwNZkygq1m+5U8uUYbVRZP0mgXOjjGavCKJZTWiGbnxpUUQIwVM2e6p1VKVdv50nsrIGyrOBMOQHBnVTUxUPcmcGgoUPCsghvrd8ruJ8EEwqjL0zGfd1oO4m4PNeMxA1j+x50YWt2wrbwDFdRzSTU4= ARC-Message-Signature: i=1; a=rsa-sha256; d=sourceware.org; s=key; t=1736181194; c=relaxed/simple; bh=2goPm42jtOvauiPeVehcqTGtkw1XylskrHeMum0nEa0=; h=DKIM-Signature:From:To:Subject:Date:Message-ID:MIME-Version; b=crKAyNSj9m7Abz6wgg0gDXzmcBLJfR4XOfsYJTX9baLXMzTgUqO2jAK8dC4BlEswtPepjB96cqDGdv5tl5ji/t2riRKRZseWoXpqYaYLL63uVN4/QuJvpd5BAu27PcEJkoqPbRklaYm3HdhiC0+8WyjjZEY5p/Q8TU2MExUAvWM= ARC-Authentication-Results: i=1; server2.sourceware.org DKIM-Filter: OpenDKIM Filter v2.11.0 sourceware.org 023C73858CD1 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1736181193; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=Hd0+9XDydE8QvG6z+1BY2GCfuu/dfbbhehLmk38GUGY=; b=CkiVvvLDrJH6AeBOe2awDotPz8f8hf7wMdct43tjdcRw6Mjx9+n/XR6eS6VZJyqgVewCOj 9Bx1IJeMPvNXJ8/B3abbWoBM99G/Iv3sFr5SxbGQHfTVf11UEiGVWcbEjcIlihRdYRX8zN EANKTZMsoX8kQ6LIhh44RRDO07SmhDQ= Received: from mail-qt1-f200.google.com (mail-qt1-f200.google.com [209.85.160.200]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-584-3UpJifDsMPiLLsMTzhJRwg-1; Mon, 06 Jan 2025 11:33:12 -0500 X-MC-Unique: 3UpJifDsMPiLLsMTzhJRwg-1 X-Mimecast-MFC-AGG-ID: 3UpJifDsMPiLLsMTzhJRwg Received: by mail-qt1-f200.google.com with SMTP id d75a77b69052e-467b5861766so297792711cf.2 for ; Mon, 06 Jan 2025 08:33:12 -0800 (PST) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1736181192; x=1736785992; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=Hd0+9XDydE8QvG6z+1BY2GCfuu/dfbbhehLmk38GUGY=; b=dNkEZri3BDg4r0kUvG7hit7LaeDCNMw5MgIIIT7SsbPbp2/Nxz8ulKw6ZtfvPC2Uu8 /oajymcVWzwM5AEWT7ivuqu4pwuSQUQvlZuiCWLAlfhT6lv8UWPf2OnQkCGz10P6896a NwblRD/gZgnklZwymtGysSJ9SJZ8bSD4x53kMc7YHdNNIv7A+ZEGTdtxGrCRaOkCwhh0 e5vQ22ZVe0HYo6Sp6eTvp+WPVlQj/G74/fXSxyDKluYThbqhBOwrCk+LviTJknH3Cz3t K4meurWPy932at4GSh3wa21K9DbpWSJ8aZ7398xp1X+LhqV4+dY8MPKqVcD8phaF98/i K5QQ== X-Gm-Message-State: AOJu0YzItYSNIoDO7UaK7ZzEqk2IC+NL5YVpXsSnfoh5lv46tR2hq8AD wzG4K8AJB0qfyg4+MW8yaVkEEJps3WG2B3rADlzrDuF0DPr/9LYP4POwfYHzZxAzwpAdK8BHTVQ 25oh5NTwQwW2WrRg8qwugjIquMw4dxAejUYp8ZlwyTMgHW829bKD2HO/lPlATpjGpVStIdkqk/e Fh/o+0KFPNI4ia8fGjdCRvVcc9YKXfCs8NRHb8wA== X-Gm-Gg: ASbGncsyE937L0vcNiBSD39aEtOzDF1eMtaCCwlUrCpCDxG5B8WBDhZTM61N249gxbL a5VJT3wOVkBfjK75ot+FkAOG2Wp7Rsgxe8KlAPFj6nP04DCrF4l5+ezPT9yuSzmFGKSNk1ghuKq RESf/o0v95Q2Gwk3S109EyU57pKSFvKS/MOaS/rC2AotLHW7abOQYZJQ5b1a//YzqCs/K/JefYA o8H4EYxf2RBTUBr0c8yCsS6AuTY4ECiVqzlSvDT8Tc932ppPD0Bdtzxif8Je6H7c5FNupXQBVSd GBaXi08nl5WAyuV/6a+rtN7O X-Received: by 2002:ac8:7f8e:0:b0:467:7441:270e with SMTP id d75a77b69052e-46a4a8b2aeemr816706621cf.6.1736181191878; Mon, 06 Jan 2025 08:33:11 -0800 (PST) X-Google-Smtp-Source: AGHT+IFUo2UKktRmlHOLd9RSc4ryXYaTFjcuIPo9SOMnqGFFx/FHJH7KxVP9YmS1zKftIROxPuB8Mw== X-Received: by 2002:ac8:7f8e:0:b0:467:7441:270e with SMTP id d75a77b69052e-46a4a8b2aeemr816706331cf.6.1736181191516; Mon, 06 Jan 2025 08:33:11 -0800 (PST) Received: from x1carbon9g.redhat.com (ip-94-112-226-240.bb.vodafone.cz. [94.112.226.240]) by smtp.gmail.com with ESMTPSA id d75a77b69052e-46a3e67e361sm176664841cf.31.2025.01.06.08.33.10 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 06 Jan 2025 08:33:11 -0800 (PST) From: Arjun Shankar To: libc-alpha@sourceware.org Cc: Arjun Shankar Subject: [PATCH v2 4/5] manual: Document unlinkat Date: Mon, 6 Jan 2025 17:26:09 +0100 Message-ID: <20250106163257.705106-5-arjun@redhat.com> X-Mailer: git-send-email 2.47.1 In-Reply-To: <20250106163257.705106-1-arjun@redhat.com> References: <20250106163257.705106-1-arjun@redhat.com> MIME-Version: 1.0 X-Mimecast-Spam-Score: 0 X-Mimecast-MFC-PROC-ID: BV6ndg61XSYVWWVqi5wMHJmTOJdH0lrBfKG8YMkL9nM_1736181192 X-Mimecast-Originator: redhat.com content-type: text/plain; charset="US-ASCII"; x-default=true X-Spam-Status: No, score=-11.4 required=5.0 tests=BAYES_00, DKIMWL_WL_HIGH, DKIM_SIGNED, DKIM_VALID, DKIM_VALID_AU, DKIM_VALID_EF, GIT_PATCH_0, RCVD_IN_BARRACUDACENTRAL, RCVD_IN_DNSWL_NONE, RCVD_IN_MSPIKE_H2, SPF_HELO_NONE, SPF_NONE, TXREP autolearn=ham autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on server2.sourceware.org X-BeenThere: libc-alpha@sourceware.org X-Mailman-Version: 2.1.30 Precedence: list List-Id: Libc-alpha mailing list List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: libc-alpha-bounces~patchwork=sourceware.org@sourceware.org --- manual/filesys.texi | 35 ++++++++++++++++++++++++++++++++++- 1 file changed, 34 insertions(+), 1 deletion(-) diff --git a/manual/filesys.texi b/manual/filesys.texi index 776b98fe7f..ba2f13ef96 100644 --- a/manual/filesys.texi +++ b/manual/filesys.texi @@ -1695,6 +1695,40 @@ file system and can't be modified. @end table @end deftypefun +@deftypefun int unlinkat (int @var{filedes}, const char *@var{filename}, int @var{flags}) +@standards{POSIX.1-2008, unistd.h} +@comment Unaudited and therefore marked AC-Unsafe and AS-Unsafe by default +@safety{@mtsafe{}@asunsafe{@asucorrupt{}}@acunsafe{@acucorrupt{}}} +This function is a descriptor-relative version of the @code{unlink} +function above. @xref{Descriptor-Relative Access}. The @var{flags} +argument may either be @code{0} or contain the flag @code{AT_REMOVEDIR}: + +@table @code +@item AT_REMOVEDIR +This flag causes @code{unlinkat} to perform an @code{rmdir} operation on +@code{filename} instead of performing the equivalent of @code{unlink}. +@end table + +Compared to @code{unlink}, the following additional error conditions can +occur: + +@table @code +@item EBADF +The @var{filedes} argument is not a valid file descriptor. + +@item EINVAL +The @var{flags} argument is not valid for this function. + +@item EISDIR +@var{filename} is a directory but the @var{AT_REMOVEDIR} was not passed in +@code{flags}. + +@item ENOTDIR +The descriptor @var{filedes} is not associated with a directory, and +@var{filename} is a relative file name. +@end table +@end deftypefun + @deftypefun int rmdir (const char *@var{filename}) @standards{POSIX.1, unistd.h} @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}} @@ -3855,6 +3889,5 @@ The @code{mkdtemp} function comes from OpenBSD. @c renameat2 @c scandirat @c symlinkat -@c unlinkat @c utimensat @c mknodat