kernel/power/swap.c:1570: warning: Function parameter or member 'snapshot_test' not described in 'swsusp_close'

kernel/power/swap.c:1570: warning: Function parameter or member 'snapshot_test' not described in 'swsusp_close'

[kernel test robot]

tree:   https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git master
head:   4853c74bd7ab7fdb83f319bd9ace8a08c031e9b6
commit: 2736e8eeb0ccdc71d1f4256c9c9a28f58cc43307 block: use the holder as indication for exclusive opens
date:   9 weeks ago
config: powerpc-randconfig-r023-20230817 (https://download.01.org/0day-ci/archive/20230817/202308171645.cgBSXD7v-lkp@intel.com/config)
compiler: powerpc-linux-gcc (GCC) 12.3.0
reproduce: (https://download.01.org/0day-ci/archive/20230817/202308171645.cgBSXD7v-lkp@intel.com/reproduce)

If you fix the issue in a separate patch/commit (i.e. not just a new version of
the same patch/commit), kindly add following tags
| Reported-by: kernel test robot <lkp@intel.com>
| Closes: https://lore.kernel.org/oe-kbuild-all/202308171645.cgBSXD7v-lkp@intel.com/

All warnings (new ones prefixed by >>):

   kernel/power/swap.c:543: warning: Function parameter or member 'handle' not described in 'save_image'
   kernel/power/swap.c:543: warning: Function parameter or member 'snapshot' not described in 'save_image'
   kernel/power/swap.c:543: warning: Function parameter or member 'nr_to_write' not described in 'save_image'
   kernel/power/swap.c:890: warning: Function parameter or member 'nr_pages' not described in 'enough_swap'
   kernel/power/swap.c:1061: warning: Function parameter or member 'handle' not described in 'load_image'
   kernel/power/swap.c:1061: warning: Function parameter or member 'snapshot' not described in 'load_image'
   kernel/power/swap.c:1061: warning: Function parameter or member 'nr_to_read' not described in 'load_image'
   kernel/power/swap.c:1520: warning: Function parameter or member 'snapshot_test' not described in 'swsusp_check'
>> kernel/power/swap.c:1570: warning: Function parameter or member 'snapshot_test' not described in 'swsusp_close'

Kconfig warnings: (for reference only)
   WARNING: unmet direct dependencies detected for HOTPLUG_CPU
   Depends on [n]: SMP [=y] && (PPC_PSERIES [=n] || PPC_PMAC [=n] || PPC_POWERNV [=n] || FSL_SOC_BOOKE [=n])
   Selected by [y]:
   - PM_SLEEP_SMP [=y] && SMP [=y] && (ARCH_SUSPEND_POSSIBLE [=y] || ARCH_HIBERNATION_POSSIBLE [=y]) && PM_SLEEP [=y]


vim +1570 kernel/power/swap.c

61159a314bca640 Rafael J. Wysocki 2006-03-23  1564  
61159a314bca640 Rafael J. Wysocki 2006-03-23  1565  /**
61159a314bca640 Rafael J. Wysocki 2006-03-23  1566   *	swsusp_close - close swap device.
61159a314bca640 Rafael J. Wysocki 2006-03-23  1567   */
61159a314bca640 Rafael J. Wysocki 2006-03-23  1568  
2736e8eeb0ccdc7 Christoph Hellwig 2023-06-08  1569  void swsusp_close(bool snapshot_test)
61159a314bca640 Rafael J. Wysocki 2006-03-23 @1570  {
8a0d613fa12e1b7 Jiri Slaby        2010-05-01  1571  	if (IS_ERR(hib_resume_bdev)) {
64ec72a1ece37d9 Joe Perches       2017-09-27  1572  		pr_debug("Image device not initialised\n");
61159a314bca640 Rafael J. Wysocki 2006-03-23  1573  		return;
61159a314bca640 Rafael J. Wysocki 2006-03-23  1574  	}
61159a314bca640 Rafael J. Wysocki 2006-03-23  1575  
2736e8eeb0ccdc7 Christoph Hellwig 2023-06-08  1576  	blkdev_put(hib_resume_bdev, snapshot_test ? &swsusp_holder : NULL);
61159a314bca640 Rafael J. Wysocki 2006-03-23  1577  }
1b29c1643c0d825 Vivek Goyal       2007-05-02  1578  

:::::: The code at line 1570 was first introduced by commit
:::::: 61159a314bca6408320c3173c1282c64f5cdaa76 [PATCH] swsusp: separate swap-writing/reading code

:::::: TO: Rafael J. Wysocki <rjw@sisk.pl>
:::::: CC: Linus Torvalds <torvalds@g5.osdl.org>

-- 
0-DAY CI Kernel Test Service
https://github.com/intel/lkp-tests/wiki

kernel/power/swap.c:1570: warning: Function parameter or member 'snapshot_test' not described in 'swsusp_close'

[kernel test robot]

Hi Christoph,

FYI, the error/warning still remains.

tree:   https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git master
head:   0bb80ecc33a8fb5a682236443c1e740d5c917d1d
commit: 2736e8eeb0ccdc71d1f4256c9c9a28f58cc43307 block: use the holder as indication for exclusive opens
date:   3 months ago
config: arm64-defconfig (https://download.01.org/0day-ci/archive/20230911/202309112011.MJzjBMxT-lkp@intel.com/config)
compiler: aarch64-linux-gcc (GCC) 13.2.0
reproduce (this is a W=1 build): (https://download.01.org/0day-ci/archive/20230911/202309112011.MJzjBMxT-lkp@intel.com/reproduce)

If you fix the issue in a separate patch/commit (i.e. not just a new version of
the same patch/commit), kindly add following tags
| Reported-by: kernel test robot <lkp@intel.com>
| Closes: https://lore.kernel.org/oe-kbuild-all/202309112011.MJzjBMxT-lkp@intel.com/

All warnings (new ones prefixed by >>):

   kernel/power/swap.c:543: warning: Function parameter or member 'handle' not described in 'save_image'
   kernel/power/swap.c:543: warning: Function parameter or member 'snapshot' not described in 'save_image'
   kernel/power/swap.c:543: warning: Function parameter or member 'nr_to_write' not described in 'save_image'
   kernel/power/swap.c:890: warning: Function parameter or member 'nr_pages' not described in 'enough_swap'
   kernel/power/swap.c:1061: warning: Function parameter or member 'handle' not described in 'load_image'
   kernel/power/swap.c:1061: warning: Function parameter or member 'snapshot' not described in 'load_image'
   kernel/power/swap.c:1061: warning: Function parameter or member 'nr_to_read' not described in 'load_image'
   kernel/power/swap.c:1520: warning: Function parameter or member 'snapshot_test' not described in 'swsusp_check'
>> kernel/power/swap.c:1570: warning: Function parameter or member 'snapshot_test' not described in 'swsusp_close'


vim +1570 kernel/power/swap.c

61159a314bca64 Rafael J. Wysocki 2006-03-23  1564  
61159a314bca64 Rafael J. Wysocki 2006-03-23  1565  /**
61159a314bca64 Rafael J. Wysocki 2006-03-23  1566   *	swsusp_close - close swap device.
61159a314bca64 Rafael J. Wysocki 2006-03-23  1567   */
61159a314bca64 Rafael J. Wysocki 2006-03-23  1568  
2736e8eeb0ccdc Christoph Hellwig 2023-06-08  1569  void swsusp_close(bool snapshot_test)
61159a314bca64 Rafael J. Wysocki 2006-03-23 @1570  {
8a0d613fa12e1b Jiri Slaby        2010-05-01  1571  	if (IS_ERR(hib_resume_bdev)) {
64ec72a1ece37d Joe Perches       2017-09-27  1572  		pr_debug("Image device not initialised\n");
61159a314bca64 Rafael J. Wysocki 2006-03-23  1573  		return;
61159a314bca64 Rafael J. Wysocki 2006-03-23  1574  	}
61159a314bca64 Rafael J. Wysocki 2006-03-23  1575  
2736e8eeb0ccdc Christoph Hellwig 2023-06-08  1576  	blkdev_put(hib_resume_bdev, snapshot_test ? &swsusp_holder : NULL);
61159a314bca64 Rafael J. Wysocki 2006-03-23  1577  }
1b29c1643c0d82 Vivek Goyal       2007-05-02  1578  

:::::: The code at line 1570 was first introduced by commit
:::::: 61159a314bca6408320c3173c1282c64f5cdaa76 [PATCH] swsusp: separate swap-writing/reading code

:::::: TO: Rafael J. Wysocki <rjw@sisk.pl>
:::::: CC: Linus Torvalds <torvalds@g5.osdl.org>

-- 
0-DAY CI Kernel Test Service
https://github.com/intel/lkp-tests/wiki