The patch titled add kerneldoc for clamp(), clamp_t(), clamp_val() macros has been added to the -mm tree. Its filename is add-macros-similar-to-min-max-min_t-max_t-doc.patch Before you just go and hit "reply", please: a) Consider who else should be cc'ed b) Prefer to cc a suitable mailing list as well c) Ideally: find the original patch on the mailing list and do a reply-to-all to that, adding suitable additional cc's *** Remember to use Documentation/SubmitChecklist when testing your code *** See http://www.zip.com.au/~akpm/linux/patches/stuff/added-to-mm.txt to find out what to do about this The current -mm tree may be found at http://userweb.kernel.org/~akpm/mmotm/ ------------------------------------------------------ Subject: add kerneldoc for clamp(), clamp_t(), clamp_val() macros From: Harvey Harrison <harvey.harrison@xxxxxxxxx> Signed-off-by: Harvey Harrison <harvey.harrison@xxxxxxxxx> Acked-by: Randy Dunlap <randy.dunlap@xxxxxxxxxx> Signed-off-by: Andrew Morton <akpm@xxxxxxxxxxxxxxxxxxxx> --- include/linux/kernel.h | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) diff -puN include/linux/kernel.h~add-macros-similar-to-min-max-min_t-max_t-doc include/linux/kernel.h --- a/include/linux/kernel.h~add-macros-similar-to-min-max-min_t-max_t-doc +++ a/include/linux/kernel.h @@ -351,6 +351,15 @@ extern void print_hex_dump_bytes(const c (void) (&_max1 == &_max2); \ _max1 > _max2 ? _max1 : _max2; }) +/** + * clamp - return a value clamped to a given range with strict typechecking + * @val: current value + * @min: minimum allowable value + * @max: maximum allowable value + * + * This macro does strict typechecking of min/max to make sure they are of the + * same type as val. See the unnecessary pointer comparisons. + */ #define clamp(val, min, max) ({ \ typeof(val) __val = (val); \ typeof(min) __min = (min); \ @@ -376,6 +385,16 @@ extern void print_hex_dump_bytes(const c type __max2 = (y); \ __max1 > __max2 ? __max1: __max2; }) +/** + * clamp_t - return a value clamped to a given range using a given type + * @type: the type of variable to use + * @val: current value + * @min: minimum allowable value + * @max: maximum allowable value + * + * This macro does no typechecking and uses temporary variables of type + * 'type' to make all the comparisons. + */ #define clamp_t(type, val, min, max) ({ \ type __val = (val); \ type __min = (min); \ @@ -383,6 +402,17 @@ extern void print_hex_dump_bytes(const c __val = __val < __min ? __min: __val; \ __val > __max ? __max: __val; }) +/** + * clamp_val - return a value clamped to a given range using val's type + * @val: current value + * @min: minimum allowable value + * @max: maximum allowable value + * + * This macro does no typechecking and uses temporary variables of whatever + * type the input argument 'val' is. This is useful when val is an unsigned + * type and min and max are literals that will otherwise be assigned a signed + * integer type. + */ #define clamp_val(val, min, max) ({ \ typeof(val) __val = (val); \ typeof(val) __min = (min); \ _ Patches currently in -mm which might be from harvey.harrison@xxxxxxxxx are origin.patch git-x86.patch git-acpi.patch git-alsa-tiwai.patch agp-fix-shadowed-variable-warning-in-amd-k7-agpc.patch git-cifs.patch cifs-remove-global_extern-macro.patch powerpc-replace-remaining-__function__-occurences.patch ppc-replace-remaining-__function__-occurences.patch radeon-fix-integer-as-null-pointer-warnings-in-radeon_memc.patch git-dvb.patch git-dlm.patch git-ieee1394.patch infiniband-replace-remaining-__function__-occurrences.patch input-replace-remaining-__function__-occurrences.patch git-jfs.patch git-kvm.patch pata_amd-fix-sparse-warning.patch git-async-tx.patch git-mips.patch mips-replace-remaining-__function__-occurences.patch jffs2-include-function-prototype-for-jffs2_ioctl.patch jffs2-fix-sparse-warning-in-nodemgmtc.patch jffs2-fix-sparse-warning-in-writec.patch jffs2-fix-sparse-warnings-in-gcc.patch mtd-replace-remaining-__function__-occurrences.patch blackfin-replace-remaining-__function__-occurences.patch nfs-replace-remaining-__function__-occurrences.patch git-nfsd.patch parisc-replace-remaining-__function__-occurences.patch drivers-parisc-replace-remaining-__function__-occurrences.patch pcmcia-replace-remaining-__function__-occurrences.patch git-selinux.patch drivers-s390-replace-remaining-__function__-occurrences.patch scsi-replace-remaining-__function__-occurrences.patch fusion-replace-remaining-__function__-occurrences.patch scsi-replace-__inline-with-inline.patch scsi-chc-fix-shadowed-variable-warnings.patch scsi-chc-fix-shadowed-variable-warnings-checkpatch-fixes.patch block-replace-remaining-__function__-occurrences.patch git-watchdog.patch xfs-replace-remaining-__function__-occurrences.patch xfs-replace-__inline-with-inline.patch xtensa-replace-remaining-__function__-occurences.patch remove-sparse-warning-for-mmzoneh.patch remove-sparse-warning-for-mmzoneh-checkpatch-fixes.patch smack-fix-integer-as-null-pointer-warning-in-smack_lsmc.patch alpha-remove-remaining-__function__-occurences.patch alpha-replace-__inline-with-inline.patch power-replace-remaining-__function__-occurrences.patch m68k-replace-remaining-__function__-occurences.patch uml-replace-remaining-__function__-occurences.patch adfs-work-around-bogus-sparse-warning.patch coda-add-static-to-functions-in-dirc.patch befs-fix-sparse-warning-in-linuxvfsc.patch autofs4-fix-sparse-warning-in-rootc.patch firmware-replace-remaining-__function__-occurrences.patch drivers-misc-replace-remaining-__function__-occurrences.patch ioc3c-replace-remaining-__function__-occurrences.patch ncpfs-add-prototypes-to-ncp_fsh.patch ncpfs-fix-sparse-warnings-in-ioctlc.patch ncpfs-fix-sparse-warning-in-ncpsign_kernelc.patch serial-remove-double-initializer.patch char-make-functions-static-in-synclinkmpc.patch spi-replace-remaining-__function__-occurrences.patch capi-fix-sparse-warnings-using-integer-as-null-pointer.patch avm-fix-sparse-warning-using-integer-as-null-pointer.patch eicon-fix-sparse-integer-as-null-pointer-warnings.patch isdn-replace-remaining-__function__-occurrences.patch xen-make-blkif_getgeo-static.patch ecryptfs-replace-remaining-__function__-occurrences.patch rtc-replace-remaining-__function__-occurrences.patch fbcon-replace-mono_col-macro-with-static-inline.patch fbcon-replace-mono_col-macro-with-static-inline-fix.patch video-replace-remaining-__function__-occurrences.patch md-fix-integer-as-null-pointer-warnings-in-mdc.patch md-replace-remaining-__function__-occurrences.patch ext2-replace-remaining-__function__-occurrences.patch jbd-sparse-warnings-in-revokec-journalc.patch ext3-replace-remaining-__function__-occurrences.patch jbd-replace-remaining-__function__-occurrences.patch ufs-replace-remaining-__function__-occurrences.patch ufs-replace-__inline-with-inline.patch udf-fix-sparse-warning-in-nameic.patch reiserfs-fix-sparse-warnings-in-fix_nodec.patch reiserfs-fix-sparse-warnings-in-do_balanc.patch reiserfs-fix-sparse-warning-in-nameic.patch reiserfs-fix-sparse-warnings-in-lbalancec.patch reiserfs-fix-sparse-warning-in-journalc.patch reiserfs-fix-more-sparse-warnings-in-do_balanc.patch reiserfs-replace-remaining-__function__-occurrences.patch cgroup-fix-sparse-warning-of-shadow-symbol-in-cgroupc.patch ext4-replace-remaining-__function__-occurrences.patch jdb2-replace-remaining-__function__-occurrences.patch char-fix-sparse-shadowed-variable-warnings-in-espc.patch char-espc-fix-possible-double-unlock.patch char-rocketc-fix-sparse-variable-shadowing-and-int-as-null-pointer.patch cycladesc-fix-sparse-shadowed-variable-warnings.patch epcac-static-functions-and-integer-as-null-pointer-fixes.patch epcac-static-functions-and-integer-as-null-pointer-fixes-checkpatch-fixes.patch add-macros-similar-to-min-max-min_t-max_t.patch add-macros-similar-to-min-max-min_t-max_t-doc.patch ide-eliminate-fit-macro.patch ata-remove-fit-macro.patch b43-replace-limit_value-macro-with-clamp_val.patch b43legacy-replace-limit_value-macro-with-clamp_val.patch fuse-use-clamp-rather-than-nested-min-max.patch ide-tape-use-clamp_t-rather-than-nested-min_t-max_t.patch input-ff-memlessc-use-clamp_val-macro.patch dccp-ccid2c-ccid3c-use-clamp-clamp_t.patch drivers-replace-remaining-__function__-occurrences.patch mm-remove-remaining-__function__-occurances.patch block-remove-remaining-__function__-occurances.patch kernel-replace-remaining-__function__-occurances.patch lib-replace-remaining-__function__-occurances.patch afs-replace-remaining-__function__-occurrences.patch fs-replace-remaining-__function__-occurrences.patch drivers-char-replace-remaining-__function__-occurrences.patch serial-replace-remaining-__function__-occurrences.patch -- To unsubscribe from this list: send the line "unsubscribe mm-commits" in the body of a message to majordomo@xxxxxxxxxxxxxxx More majordomo info at http://vger.kernel.org/majordomo-info.html