From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-7.1 required=3.0 tests=DKIMWL_WL_HIGH,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,INCLUDES_PATCH,MAILING_LIST_MULTI,SIGNED_OFF_BY, SPF_HELO_NONE,SPF_PASS autolearn=unavailable autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 5CAEDC433DF for ; Wed, 10 Jun 2020 15:50:21 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 342F7206F4 for ; Wed, 10 Jun 2020 15:50:21 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=default; t=1591804221; bh=gjNi9v8mH0UE14YlBjV9C7FAXJQuACnUBQ+1HxXujq8=; h=Date:From:To:Cc:Subject:References:In-Reply-To:List-ID:From; b=gMhFgjvxsPYzA0+QIK9wDLiSdGitBHqQTHoHi46D4SfLploU2Wya/GNdXfxMZ8W6n YxVR1btFo9s/17CeuC0fiB85Pg7EwkhwTDbEA1SjxuEQ6Kz0YlDjCXN6RBbNATDWGD bYyYGdmrSl1N1EtbCxztOWvsX757Vuj1XDi9usaE= Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1730426AbgFJPuP (ORCPT ); Wed, 10 Jun 2020 11:50:15 -0400 Received: from mail.kernel.org ([198.145.29.99]:47966 "EHLO mail.kernel.org" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1730336AbgFJPuP (ORCPT ); Wed, 10 Jun 2020 11:50:15 -0400 Received: from sol.localdomain (c-107-3-166-239.hsd1.ca.comcast.net [107.3.166.239]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPSA id CA0A8206C3; Wed, 10 Jun 2020 15:50:14 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=default; t=1591804215; bh=gjNi9v8mH0UE14YlBjV9C7FAXJQuACnUBQ+1HxXujq8=; h=Date:From:To:Cc:Subject:References:In-Reply-To:From; b=pxYTFTM6+6hKI5D1epsl48SmXcRjOBEt8sQ+0GCnrbjo8tOx0zkNan2Gb4mVS/sSU 2UdnoVKqsVgEVtc4oBDq7DD/NZDEs+OKexSEFRWEu0YRL7DzURB54rbwpLDawaDR7R qNk4xmtA4yXe/MrtTSxASUbeUpQBoDSgYht6S/u0= Date: Wed, 10 Jun 2020 08:50:13 -0700 From: Eric Biggers To: Jeff Layton Cc: mtk.manpages@gmail.com, linux-man@vger.kernel.org, linux-fsdevel@vger.kernel.org, linux-kernel@vger.kernel.org Subject: Re: [PATCH][man-pages] sync.2: syncfs() now returns errors if writeback fails Message-ID: <20200610155013.GA1339@sol.localdomain> References: <20200610103347.14395-1-jlayton@kernel.org> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <20200610103347.14395-1-jlayton@kernel.org> Sender: linux-man-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-man@vger.kernel.org On Wed, Jun 10, 2020 at 06:33:47AM -0400, Jeff Layton wrote: > A patch has been merged for v5.8 that changes how syncfs() reports > errors. Change the sync() manpage accordingly. > > Signed-off-by: Jeff Layton > --- > man2/sync.2 | 24 +++++++++++++++++++++++- > 1 file changed, 23 insertions(+), 1 deletion(-) > > diff --git a/man2/sync.2 b/man2/sync.2 > index 7198f3311b05..27e04cff5845 100644 > --- a/man2/sync.2 > +++ b/man2/sync.2 > @@ -86,11 +86,26 @@ to indicate the error. > is always successful. > .PP > .BR syncfs () > -can fail for at least the following reason: > +can fail for at least the following reasons: > .TP > .B EBADF > .I fd > is not a valid file descriptor. > +.TP > +.B EIO > +An error occurred during synchronization. > +This error may relate to data written to any file on the filesystem, or on > +metadata related to the filesytem itself. > +.TP > +.B ENOSPC > +Disk space was exhausted while synchronizing. > +.TP > +.BR ENOSPC ", " EDQUOT > +Data was written to a files on NFS or another filesystem which does not > +allocate space at the time of a > +.BR write (2) > +system call, and some previous write failed due to insufficient > +storage space. > .SH VERSIONS > .BR syncfs () > first appeared in Linux 2.6.39; > @@ -121,6 +136,13 @@ or > .BR syncfs () > provide the same guarantees as fsync called on every file in > the system or filesystem respectively. > +.PP > +In mainline kernel versions prior to 5.8, > +.\" commit 735e4ae5ba28c886d249ad04d3c8cc097dad6336 > +.BR syncfs () > +will only fail with EBADF when passed a bad file descriptor. In 5.8 > +and later kernels, it will also report an error if one or more inodes failed > +to be written back since the last syncfs call. The sentence "In mainline kernel versions prior to 5.8, syncfs() will only fail with EBADF when passed a bad file descriptor" is ambiguous. It could mean that EBADF can now mean other things too. Maybe write: "In mainline kernel versions prior to 5.8, syncfs() will only fail when passed a bad file descriptor (EBADF)." - Eric