From nobody Fri May 05 06:38:58 2023 X-Original-To: dev-commits-src-branches@mlmmj.nyi.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mlmmj.nyi.freebsd.org (Postfix) with ESMTP id 4QCLcg0lZXz49qHy; Fri, 5 May 2023 06:38:59 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from mxrelay.nyi.freebsd.org (mxrelay.nyi.freebsd.org [IPv6:2610:1c1:1:606c::19:3]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256 client-signature RSA-PSS (4096 bits) client-digest SHA256) (Client CN "mxrelay.nyi.freebsd.org", Issuer "R3" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 4QCLcf6Shcz47DK; Fri, 5 May 2023 06:38:58 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1683268738; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=CuHvUdTyhD5d7C6q/YTYqTW5xD5cGv/ydCNH/RP5wQM=; b=VJUxCI+YqRpye502Xf3Y3sHPCAbvKL9+BR9y6PCjYIBPy9uysfeGNqtkRdISHt+lYGmesg cULeArJsL0ZrCc4CpxKgU2miSECRo0Y+WSderzXb0RafveZPRx+h+NSqgstuXxi1Tp9Vse 6WGojs0eSD8s8cB5eNT08Nco3DhqU3nJZSRf9WzZM27raQWoQeWv5MSPhZgbvm5+UtnHGi OjeQcOPOK4wmCrrlqGInp/0GfwGq5PeMM31gl3H570Qz4LLG+TANecOVJzs6nrSeLCde81 mejE5p5LZXWilbDIheVZkOSh/q6XoMDPV1EBaRDuL8g3HA5Urn0cMlePZVi8Ig== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1683268738; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=CuHvUdTyhD5d7C6q/YTYqTW5xD5cGv/ydCNH/RP5wQM=; b=VPPp6RaX+Yv7NIV5duLF2ormXHS7YUh8+Uj2ni4VjXMTvbrC3uRpTJCAQYKFYq2g1Uo96b O5A73BeggruCHIXIoVbaSsRRM+rhC0PZjbteusXhPsAqU/FKYBrLjuogG5i0dJxIIrzSRu fbwBgZnWM5sQdBNNbVEjdmwZ19QBKXMC9HQc9Fy6imSBEzA6NfnnDbGRyJz5XxwQ6AsiR1 ewH0OXoA7vVdJiXm2a2SCkDOKzIdLiGH/MY8nZNnyEA8DJ+oe+nGKUExYEBfLmFAv+3nQ4 YDuGA/UqtYoRSZqRQlBiopB6r1vvGGJBqBvdkQYD3QoTLF3KzkoI5f81bTgLew== ARC-Authentication-Results: i=1; mx1.freebsd.org; none ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1683268738; a=rsa-sha256; cv=none; b=bdCGXoJVd8bPr3zMooHlp70JYsNkHUJjL3Y1HmOKF10TvxNlD5g0S09cMmRmUvwJY2uDsC M7qbmC0pavjppPqvqHqljAT4H4ra9RNOUEVmp/hVku62YzKSbAscyVXB8Y36TnHeHMN5A5 XT4kcXF06q5/MHw8WQFNBYCR73v+c6CH2Cmq3OkNMyBhIuJjGhj3I9k77A4VtxKFySJd91 kc9g4Weyj4qurejRVm1leOg9XlzoAoAb9eEz4w0VXHxwI0tLcPqtl/9nEEfh1yjxrP822Y 5S2dZZKF0kiBqE7w2BTXlibpzT5GXs0LFrlRb9a7IlMxHvRd1a5AfgjK7xscMg== Received: from gitrepo.freebsd.org (gitrepo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:5]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (Client did not present a certificate) by mxrelay.nyi.freebsd.org (Postfix) with ESMTPS id 4QCLcf5YWtzkRH; Fri, 5 May 2023 06:38:58 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org ([127.0.1.44]) by gitrepo.freebsd.org (8.16.1/8.16.1) with ESMTP id 3456cwPQ039538; Fri, 5 May 2023 06:38:58 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.16.1/8.16.1/Submit) id 3456cw28039535; Fri, 5 May 2023 06:38:58 GMT (envelope-from git) Date: Fri, 5 May 2023 06:38:58 GMT Message-Id: <202305050638.3456cw28039535@gitrepo.freebsd.org> To: src-committers@FreeBSD.org, dev-commits-src-all@FreeBSD.org, dev-commits-src-branches@FreeBSD.org From: Konstantin Belousov Subject: git: 21cc0c6cad65 - stable/13 - vfs: vn_dir_next_dirent(): Adapt comments to style(9) List-Id: Commits to the stable branches of the FreeBSD src repository List-Archive: https://lists.freebsd.org/archives/dev-commits-src-branches List-Help: List-Post: List-Subscribe: List-Unsubscribe: Sender: owner-dev-commits-src-branches@freebsd.org X-BeenThere: dev-commits-src-branches@freebsd.org MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: kib X-Git-Repository: src X-Git-Refname: refs/heads/stable/13 X-Git-Reftype: branch X-Git-Commit: 21cc0c6cad6597ef696e72a8ded6fc34e977ce6f Auto-Submitted: auto-generated X-ThisMailContainsUnwantedMimeParts: N The branch stable/13 has been updated by kib: URL: https://cgit.FreeBSD.org/src/commit/?id=21cc0c6cad6597ef696e72a8ded6fc34e977ce6f commit 21cc0c6cad6597ef696e72a8ded6fc34e977ce6f Author: Olivier Certner AuthorDate: 2023-04-28 09:04:16 +0000 Commit: Konstantin Belousov CommitDate: 2023-05-05 06:20:58 +0000 vfs: vn_dir_next_dirent(): Adapt comments to style(9) (cherry picked from commit c21d87a88c72804bc4fb86d7b0e8a846230e4ad0) --- sys/kern/vfs_vnops.c | 36 ++++++++++++++++++------------------ 1 file changed, 18 insertions(+), 18 deletions(-) diff --git a/sys/kern/vfs_vnops.c b/sys/kern/vfs_vnops.c index 6206c521ba48..8ad66be142b2 100644 --- a/sys/kern/vfs_vnops.c +++ b/sys/kern/vfs_vnops.c @@ -3606,33 +3606,33 @@ _Static_assert(_GENERIC_MAXDIRSIZ == sizeof(struct dirent), "(see _GENERIC_DIRLEN())"); /* - * Returns successive directory entries through some caller's provided buffer + * Returns successive directory entries through some caller's provided buffer. * * This function automatically refills the provided buffer with calls to * VOP_READDIR() (after MAC permission checks). * - * 'td' is used for credentials and passed to uiomove(). 'dirbuf' is the - * caller's buffer to fill and 'dirbuflen' its allocated size. 'dirbuf' must be - * properly aligned to access 'struct dirent' structures and 'dirbuflen' must - * be greater than GENERIC_MAXDIRSIZ to avoid VOP_READDIR() returning EINVAL - * (the latter is not a strong guarantee (yet); but EINVAL will always be - * returned if this requirement is not verified). '*dpp' points to the current - * directory entry in the buffer and '*len' contains the remaining valid bytes - * in 'dirbuf' after 'dpp' (including the pointed entry). + * 'td' is used for credentials and passed to uiomove(). 'dirbuf' is the + * caller's buffer to fill and 'dirbuflen' its allocated size. 'dirbuf' must + * be properly aligned to access 'struct dirent' structures and 'dirbuflen' + * must be greater than GENERIC_MAXDIRSIZ to avoid VOP_READDIR() returning + * EINVAL (the latter is not a strong guarantee (yet); but EINVAL will always + * be returned if this requirement is not verified). '*dpp' points to the + * current directory entry in the buffer and '*len' contains the remaining + * valid bytes in 'dirbuf' after 'dpp' (including the pointed entry). * * At first call (or when restarting the read), '*len' must have been set to 0, - * '*off' to 0 (or any valid start offset) and '*eofflag' to 0. There are no - * more entries as soon as '*len' is 0 after a call that returned 0. Calling + * '*off' to 0 (or any valid start offset) and '*eofflag' to 0. There are no + * more entries as soon as '*len' is 0 after a call that returned 0. Calling * again this function after such a condition is considered an error and EINVAL - * will be returned. Other possible error codes are those of VOP_READDIR(), + * will be returned. Other possible error codes are those of VOP_READDIR(), * EINTEGRITY if the returned entries do not pass coherency tests, or EINVAL - * (bad call). All errors are unrecoverable, i.e., the state ('*len', '*off' - * and '*eofflag') must be re-initialized before a subsequent call. On error or - * at end of directory, '*dpp' is reset to NULL. + * (bad call). All errors are unrecoverable, i.e., the state ('*len', '*off' + * and '*eofflag') must be re-initialized before a subsequent call. On error + * or at end of directory, '*dpp' is reset to NULL. * * '*len', '*off' and '*eofflag' are internal state the caller should not - * tamper with except as explained above. '*off' is the next directory offset - * to read from to refill the buffer. '*eofflag' is set to 0 or 1 by the last + * tamper with except as explained above. '*off' is the next directory offset + * to read from to refill the buffer. '*eofflag' is set to 0 or 1 by the last * internal call to VOP_READDIR() that returned without error, indicating * whether it reached the end of the directory, and to 2 by this function after * all entries have been read. @@ -3664,7 +3664,7 @@ vn_dir_next_dirent(struct vnode *vp, struct thread *td, /* * The caller continued to call us after an error (we set dp to - * NULL in a previous iteration). Bail out right now. + * NULL in a previous iteration). Bail out right now. */ if (__predict_false(dp == NULL)) return (EINVAL);