https://jira.whamcloud.com This file is an XML representation of an issue en-us 9.4.14 940014 05-12-2023 https://jira.whamcloud.com/browse/LU-4453 Lustre <p>It would be useful for prepare-commit-msg and/or checkpatch.pl warn about cfs_list_<b>() and cfs_atomic_</b>() and other deprecated wrappers in new patches.</p> <p>I think checkpatch.pl has a feature for reporting on deprecated function usage, or we could call the sed script to report on any changes that it finds.</p> <p>Now that we are close to finishing the cfs_* wrapper removal we don't want to introduce new users in patches that are landing. </p> LU-4453

Have prepare-commit-msg or checkpatch.pl to warn about deprecated cfs_* uses

Bug Major Resolved Fixed John Hammond Andreas Dilger RoDC checkpatch Tue, 7 Jan 2014 23:59:25 +0000 Tue, 3 Jun 2014 15:09:04 +0000 Tue, 3 Jun 2014 15:09:04 +0000 Lustre 2.6.0 Lustre 2.6.0 0 4 <p>For checkpatch.pl to warn on cfs_xxx() identifiers we would need to modify Documentation/feature-removal-schedule.txt in the kernel source. Or we could modify checkpatch.pl. Or we could use sed.</p> <p>What exactly should we warn about:</p> <ol> <li>each function defined in libcfs/include/libcfs/list.h with a cfs_ prefix</li> <li>any function matching cfs_list_*</li> <li>... cfs_hlist_*</li> <li>... cfs_atomic_*</li> <li>... cfs_timer_*</li> <li>... cfs_time_*</li> <li>... cfs_proc_*</li> </ol> <p>Other?</p> <p>We should also update the coding guidelines to say what's deprecated.</p> <ol> <li>cfs_bitmap_*</li> <li>cfs_capable</li> <li>cfs_cap_*</li> <li>cfs_duration_sec</li> <li>cfs_duration_t</li> <li>cfs_duration_usec</li> <li>cfs_fs_time_current</li> <li>cfs_fs_time_t</li> <li>cfs_init_timer</li> <li>cfs_module()</li> <li>CFS_MODULE_PARM</li> <li>CFS_O_* (CFS_O_ACCMODE, CFS_O_APPEND, ...)</li> <li>CFS_PAGE_MASK</li> <li>CFS_PAGE_SIZE</li> </ol> <p>Bad functions:</p> <ol> <li>sprintf</li> <li>strcat</li> <li>strcpy</li> </ol> <p>Including asm headers.</p> <p>Please see <a href="http://review.whamcloud.com/#/c/9585/" class="external-link" target="_blank" rel="nofollow noopener">http://review.whamcloud.com/#/c/9585/</a>.</p> <p>Do we really need to remove the checking of Documentation/feature-removal-schedule.txt? I think it might be better if we both check Documentation/feature-removal-schedule.txt and keep a special list of Lustre (e.g. cfs_*). Otherwise, it is easy to miss some deprecated functions/include files in Documentation/feature-removal-schedule.txt.</p> <p>Hi Li Xi, I see your point, but when I looked at checkpatch.pl from the 3.12 tree I saw that the deprecated function logic had been removed entirely.</p> <p>Ah, I see. That file has been removed since 9c0ece069b3. Thanks for pointing that out.</p> <p>Patch landed to Master.</p> Development Rank 1|hzwcdj: Rank (Obsolete) 12208 Severity