[rppt:pks/v0.0 10/27] lib/pks/pks_test.c:154: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst

[kernel test robot]

tree:   https://git.kernel.org/pub/scm/linux/kernel/git/rppt/linux.git pks/v0.0
head:   eed09ce6622d550ab5b10a86e7dd6c2ff6bd59d9
commit: 79a4c0d7e9449140c2ec65703a0f3b38f4d28aad [10/27] x86/pks: Add PKS test code
config: x86_64-allyesconfig (attached as .config)
compiler: gcc-9 (Debian 9.3.0-22) 9.3.0
reproduce (this is a W=1 build):
        # https://git.kernel.org/pub/scm/linux/kernel/git/rppt/linux.git/commit/?id=79a4c0d7e9449140c2ec65703a0f3b38f4d28aad
        git remote add rppt https://git.kernel.org/pub/scm/linux/kernel/git/rppt/linux.git
        git fetch --no-tags rppt pks/v0.0
        git checkout 79a4c0d7e9449140c2ec65703a0f3b38f4d28aad
        # save the attached .config to linux build tree
        make W=1 ARCH=x86_64 

If you fix the issue, kindly add following tag as appropriate
Reported-by: kernel test robot <lkp@xxxxxxxxx>

All warnings (new ones prefixed by >>):

>> lib/pks/pks_test.c:154: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
    * pks_test_callback() is exported so that the fault handler can detect


vim +154 lib/pks/pks_test.c

   152	
   153	/**
 > 154	 * pks_test_callback() is exported so that the fault handler can detect
   155	 * and report back status of intentional faults.
   156	 *
   157	 * NOTE: It clears the protection key from the page such that the fault handler
   158	 * will not re-trigger.
   159	 */
   160	bool pks_test_callback(struct pt_regs *regs)
   161	{
   162		struct extended_pt_regs *ept_regs = extended_pt_regs(regs);
   163		bool armed = (test_armed_key != 0);
   164	
   165		if (test_exception_ctx) {
   166			check_exception(ept_regs->thread_pkrs);
   167			/*
   168			 * Stop this check directly within the exception because the
   169			 * fault handler clean up code will call again while checking
   170			 * the PMD entry and there is no need to check this again.
   171			 */
   172			test_exception_ctx = NULL;
   173		}
   174	
   175		if (armed) {
   176			/* Enable read and write to stop faults */
   177			ept_regs->thread_pkrs = update_pkey_val(ept_regs->thread_pkrs,
   178								test_armed_key, 0);
   179			fault_cnt++;
   180		}
   181	
   182		return armed;
   183	}
   184	

---
0-DAY CI Kernel Test Service, Intel Corporation
https://lists.01.org/hyperkitty/list/kbuild-all@xxxxxxxxxxxx

Attachment: .config.gz
Description: application/gzip