linux-kernel - Re: [PATCH v1 1/1] pinctrl: Proofreading and updating the documentation accordingly

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <202301101600.5N9Yn3ok-lkp@intel.com>
Date:   Tue, 10 Jan 2023 16:19:43 +0800
From:   kernel test robot <lkp@...el.com>
To:     Andy Shevchenko <andriy.shevchenko@...ux.intel.com>,
        linux-gpio@...r.kernel.org, linux-doc@...r.kernel.org,
        linux-kernel@...r.kernel.org
Cc:     oe-kbuild-all@...ts.linux.dev,
        Linus Walleij <linus.walleij@...aro.org>,
        Jonathan Corbet <corbet@....net>,
        Niyas Sait <niyas.sait@...aro.org>
Subject: Re: [PATCH v1 1/1] pinctrl: Proofreading and updating the
 documentation accordingly

Hi Andy,

I love your patch! Perhaps something to improve:

[auto build test WARNING on linusw-pinctrl/devel]
[also build test WARNING on linusw-pinctrl/for-next linus/master v6.2-rc3 next-20230110]
[If your patch is applied to the wrong git tree, kindly drop us a note.
And when submitting patch, we suggest to use '--base' as documented in
https://git-scm.com/docs/git-format-patch#_base_tree_information]

url:    https://github.com/intel-lab-lkp/linux/commits/Andy-Shevchenko/pinctrl-Proofreading-and-updating-the-documentation-accordingly/20230110-045804
base:   https://git.kernel.org/pub/scm/linux/kernel/git/linusw/linux-pinctrl.git devel
patch link:    https://lore.kernel.org/r/20230109205456.30618-1-andriy.shevchenko%40linux.intel.com
patch subject: [PATCH v1 1/1] pinctrl: Proofreading and updating the documentation accordingly
reproduce:
        # https://github.com/intel-lab-lkp/linux/commit/b40cdd58f705c2e00a310f6f3fc828beaae6841f
        git remote add linux-review https://github.com/intel-lab-lkp/linux
        git fetch --no-tags linux-review Andy-Shevchenko/pinctrl-Proofreading-and-updating-the-documentation-accordingly/20230110-045804
        git checkout b40cdd58f705c2e00a310f6f3fc828beaae6841f
        make menuconfig
        # enable CONFIG_COMPILE_TEST, CONFIG_WARN_MISSING_DOCUMENTS, CONFIG_WARN_ABI_ERRORS
        make htmldocs

If you fix the issue, kindly add following tag where applicable
| Reported-by: kernel test robot <lkp@...el.com>

All warnings (new ones prefixed by >>):

>> Documentation/driver-api/pin-control.rst:210: WARNING: Could not lex literal_block as "c". Highlighting skipped.

vim +/c +210 Documentation/driver-api/pin-control.rst

   209	
 > 210	.. code-block:: c
   211	
   212		#include <linux/pinctrl/pinconf.h>
   213		#include <linux/pinctrl/pinctrl.h>
   214	
   215		#include "platform_x_pindefs.h"
   216	
   217		static int foo_pin_config_get(struct pinctrl_dev *pctldev,
   218					      unsigned int offset,
   219					      unsigned long *config)
   220		{
   221			struct my_conftype conf;
   222	
   223			... Find setting for pin @ offset ...
   224	
   225			*config = (unsigned long) conf;
   226		}
   227	
   228		static int foo_pin_config_set(struct pinctrl_dev *pctldev,
   229					      unsigned int offset,
   230					      unsigned long config)
   231		{
   232			struct my_conftype *conf = (struct my_conftype *) config;
   233	
   234			switch (conf) {
   235				case PLATFORM_X_PULL_UP:
   236				...
   237				break;
   238			}
   239		}
   240	
   241		static int foo_pin_config_group_get(struct pinctrl_dev *pctldev,
   242						    unsigned selector,
   243						    unsigned long *config)
   244		{
   245			...
   246		}
   247	
   248		static int foo_pin_config_group_set(struct pinctrl_dev *pctldev,
   249						    unsigned selector,
   250						    unsigned long config)
   251		{
   252			...
   253		}
   254	
   255		static struct pinconf_ops foo_pconf_ops = {
   256			.pin_config_get = foo_pin_config_get,
   257			.pin_config_set = foo_pin_config_set,
   258			.pin_config_group_get = foo_pin_config_group_get,
   259			.pin_config_group_set = foo_pin_config_group_set,
   260		};
   261	
   262		/* Pin config operations are handled by some pin controller */
   263		static struct pinctrl_desc foo_desc = {
   264			...
   265			.confops = &foo_pconf_ops,
   266		};
   267	

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

View attachment "config" of type "text/plain" (39373 bytes)