git: c6ec13c12901 - stable/13 - bitset: __BIT_FFS_AT(): Fix herald comment, take 2

From: Olivier Certner <olce_at_FreeBSD.org>
Date: Fri, 04 Oct 2024 08:45:23 UTC
The branch stable/13 has been updated by olce:

URL: https://cgit.FreeBSD.org/src/commit/?id=c6ec13c12901ca3eab0f610742df7b0292e9b830

commit c6ec13c12901ca3eab0f610742df7b0292e9b830
Author:     Olivier Certner <olce@FreeBSD.org>
AuthorDate: 2024-09-03 10:08:49 +0000
Commit:     Olivier Certner <olce@FreeBSD.org>
CommitDate: 2024-10-04 08:44:23 +0000

    bitset: __BIT_FFS_AT(): Fix herald comment, take 2
    
    Remove the reference to the nonexistent 'end' parameter.  While here,
    rephrase a bit.
    
    I did the initial comment fix (commit "bitset: Fix __BIT_FFS_AT()'s
    herald comment", f3ab0d86e8070c73) as part of an experiment introducing
    macros to operate on ranges of bits in a bitset and subject to
    a predicate (a generalization of some code used in some pending
    modifications of the ULE scheduler), which was finally ditched as being
    too verbose and impractical to use.  I however then forgot to remove the
    reference to 'end'.
    
    No functional change.
    
    Noted by:       emaste
    Approved by:    emaste (mentor)
    MFC after:      3 days
    MFC with:       f3ab0d86e807
    Sponsored by:   The FreeBSD Foundation
    
    (cherry picked from commit ad4cf76ec4d4524381350e77b02b9abe24eb4b02)
    
    Approved by:    emaste (mentor)
---
 sys/sys/bitset.h | 5 ++---
 1 file changed, 2 insertions(+), 3 deletions(-)

diff --git a/sys/sys/bitset.h b/sys/sys/bitset.h
index 2e15df7de4dd..16bccbdcaf0b 100644
--- a/sys/sys/bitset.h
+++ b/sys/sys/bitset.h
@@ -220,9 +220,8 @@
 } while (0)
 
 /*
- * 'start' and 'end' are 0-based bit (runtime) indices. Note that, as for ffs(),
- * the returned index is 1-based, 0 being reserved to indicate that no bits are
- * set.
+ * 'start' is a 0-based bit index.  By contrast, and as for ffs(), the returned
+ * index is 1-based, 0 being reserved to indicate that no bits are set.
  */
 #define	__BIT_FFS_AT(_s, p, start) __extension__ ({			\
 	__size_t __i;							\