All of lore.kernel.org
 help / color / mirror / Atom feed
From: kernel test robot <lkp@intel.com>
To: Ira Weiny <ira.weiny@intel.com>
Cc: kbuild-all@lists.01.org, Mike Rapoport <rppt@kernel.org>,
	linux-kernel@vger.kernel.org, Mike Rapoport <rppt@linux.ibm.com>,
	Dan Williams <dan.j.williams@intel.com>,
	Dave Hansen <dave.hansen@linux.intel.com>,
	Fenghua Yu <fenghua.yu@intel.com>,
	linux-doc@vger.kernel.org
Subject: [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
Date: Sat, 13 Nov 2021 01:33:17 +0800	[thread overview]
Message-ID: <202111130107.F39UdfAH-lkp@intel.com> (raw)

[-- Attachment #1: Type: text/plain, Size: 2362 bytes --]

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@intel.com>

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@lists.01.org

[-- Attachment #2: .config.gz --]
[-- Type: application/gzip, Size: 66545 bytes --]

WARNING: multiple messages have this Message-ID (diff)
From: kernel test robot <lkp@intel.com>
To: kbuild-all@lists.01.org
Subject: [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
Date: Sat, 13 Nov 2021 01:33:17 +0800	[thread overview]
Message-ID: <202111130107.F39UdfAH-lkp@intel.com> (raw)

[-- Attachment #1: Type: text/plain, Size: 2425 bytes --]

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@intel.com>

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(a)lists.01.org

[-- Attachment #2: config.gz --]
[-- Type: application/gzip, Size: 66545 bytes --]

             reply	other threads:[~2021-11-12 17:34 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-11-12 17:33 kernel test robot [this message]
2021-11-12 17:33 ` [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

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=202111130107.F39UdfAH-lkp@intel.com \
    --to=lkp@intel.com \
    --cc=dan.j.williams@intel.com \
    --cc=dave.hansen@linux.intel.com \
    --cc=fenghua.yu@intel.com \
    --cc=ira.weiny@intel.com \
    --cc=kbuild-all@lists.01.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=rppt@kernel.org \
    --cc=rppt@linux.ibm.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.