Received-SPF: pass (google.com: domain of linux-kernel+bounces-10802-linux.lists.archive=gmail.com@vger.kernel.org designates 2604:1380:45e3:2400::1 as permitted sender) client-ip=2604:1380:45e3:2400::1;
Date: Sun, 24 Dec 2023 19:44:02 +0100
From: Joel Granados <j.granados@samsung.com>
To: Thomas =?utf-8?Q?Wei=C3=9Fschuh?= <linux@weissschuh.net>
CC: Luis Chamberlain <mcgrof@kernel.org>, <linux-kernel@vger.kernel.org>
Subject: Re: [PATCH] scripts: check-sysctl-docs: adapt to new API
Message-ID: <20231224184402.of6cc2tczajmnbri@localhost>
Precedence: bulk
MIME-Version: 1.0
Content-Type: multipart/signed; micalg="pgp-sha512";
	protocol="application/pgp-signature"; boundary="jvjkiodbs7ntsrn5"
Content-Disposition: inline
In-Reply-To: <20231220-sysctl-check-v1-1-420ced4a69d7@weissschuh.net>
CMS-TYPE: 201P
References: <CGME20231220213032eucas1p2889cb35ee41ed155ce68e75b02892582@eucas1p2.samsung.com>
	<20231220-sysctl-check-v1-1-420ced4a69d7@weissschuh.net>

--jvjkiodbs7ntsrn5
Content-Type: text/plain; charset="iso-8859-1"
Content-Disposition: inline
Content-Transfer-Encoding: quoted-printable

On Wed, Dec 20, 2023 at 10:30:26PM +0100, Thomas Wei=DFschuh wrote:
> The script expects the old sysctl_register_paths() API which was removed
> some time ago. Adapt it to work with the new
> sysctl_register()/sysctl_register_sz()/sysctl_register_init() APIs.
>=20
> In its reference invocation the script won't be able to parse the tables
> from ipc/ipc_sysctl.c as they are using dynamically built tables which
> are to complex to parse.
>=20
> Note that the script is already prepared for a potential constification
> of the ctl_table structs.
>=20
> Signed-off-by: Thomas Wei=DFschuh <linux@weissschuh.net>
> ---
>  scripts/check-sysctl-docs | 42 ++++++++++++------------------------------
>  1 file changed, 12 insertions(+), 30 deletions(-)
>=20
> diff --git a/scripts/check-sysctl-docs b/scripts/check-sysctl-docs
> index 4f163e0bf6a4..bd18ab4b950b 100755
> --- a/scripts/check-sysctl-docs
> +++ b/scripts/check-sysctl-docs
> @@ -8,7 +8,7 @@
>  # Example invocation:
>  #	scripts/check-sysctl-docs -vtable=3D"kernel" \
>  #		Documentation/admin-guide/sysctl/kernel.rst \
> -#		$(git grep -l register_sysctl_)
> +#		$(git grep -l register_sysctl)
>  #
>  # Specify -vdebug=3D1 to see debugging information
> =20
> @@ -20,14 +20,12 @@ BEGIN {
>  }
> =20
>  # The following globals are used:
> -# children: maps ctl_table names and procnames to child ctl_table names
>  # documented: maps documented entries (each key is an entry)
>  # entries: maps ctl_table names and procnames to counts (so
>  #          enumerating the subkeys for a given ctl_table lists its
>  #          procnames)
>  # files: maps procnames to source file names
>  # paths: maps ctl_path names to paths
> -# curpath: the name of the current ctl_path struct
>  # curtable: the name of the current ctl_table struct
>  # curentry: the name of the current proc entry (procname when parsing
>  #           a ctl_table, constructed path when parsing a ctl_path)
> @@ -94,44 +92,24 @@ FNR =3D=3D NR {
> =20
>  # Stage 2: process each file and find all sysctl tables
>  BEGINFILE {
> -    delete children
>      delete entries
>      delete paths
Why did you leave paths? As I read it you remove the use of paths and
now this is not needed any longer.

> -    curpath =3D ""
>      curtable =3D ""
>      curentry =3D ""
>      if (debug) print "Processing file " FILENAME
>  }
> =20
> -/^static struct ctl_path/ {
> -    match($0, /static struct ctl_path ([^][]+)/, tables)
> -    curpath =3D tables[1]
> -    if (debug) print "Processing path " curpath
> -}
> -
> -/^static struct ctl_table/ {
> -    match($0, /static struct ctl_table ([^][]+)/, tables)
> -    curtable =3D tables[1]
> +/^static( const)? struct ctl_table/ {
> +    match($0, /static( const)? struct ctl_table ([^][]+)/, tables)
Would these regular expressions match lines that have more than one
spaces before const?

> +    curtable =3D tables[2]
>      if (debug) print "Processing table " curtable
>  }
> =20
>  /^};$/ {
> -    curpath =3D ""
>      curtable =3D ""
>      curentry =3D ""
>  }
> =20
> -curpath && /\.procname[\t ]*=3D[\t ]*".+"/ {
> -    match($0, /.procname[\t ]*=3D[\t ]*"([^"]+)"/, names)
> -    if (curentry) {
> -	curentry =3D curentry "/" names[1]
> -    } else {
> -	curentry =3D names[1]
> -    }
> -    if (debug) print "Setting path " curpath " to " curentry
> -    paths[curpath] =3D curentry
> -}
> -
>  curtable && /\.procname[\t ]*=3D[\t ]*".+"/ {
>      match($0, /.procname[\t ]*=3D[\t ]*"([^"]+)"/, names)
>      curentry =3D names[1]
> @@ -140,10 +118,14 @@ curtable && /\.procname[\t ]*=3D[\t ]*".+"/ {
>      file[curentry] =3D FILENAME
>  }
> =20
> -/\.child[\t ]*=3D/ {
> -    child =3D trimpunct($NF)
> -    if (debug) print "Linking child " child " to table " curtable " entr=
y " curentry
> -    children[curtable][curentry] =3D child
> +/register_sysctl.*/ {
> +    match($0, /register_sysctl(|_init|_sz)\("([^"]+)" *, *([^,)]+)/, tab=
les)
> +    if (debug) print "Registering table " tables[3] " at " tables[2]
> +    if (tables[2] =3D=3D table) {
> +        for (entry in entries[tables[3]]) {
> +            printentry(entry)
> +        }
> +    }
>  }
> =20
>  END {
>=20
> ---
> base-commit: 1a44b0073b9235521280e19d963b6dfef7888f18
> change-id: 20231220-sysctl-check-8802651d945d
>=20
> Best regards,
> --=20
> Thomas Wei=DFschuh <linux@weissschuh.net>
>=20

--=20

Joel Granados

--jvjkiodbs7ntsrn5
Content-Type: application/pgp-signature; name="signature.asc"

-----BEGIN PGP SIGNATURE-----

iQGzBAABCgAdFiEErkcJVyXmMSXOyyeQupfNUreWQU8FAmWIe+MACgkQupfNUreW
QU+nAgv8CxhzHsN++0uY7h36mOFVhZN/c1cDkKd4EnQ0qMdB0g8/POd7J8oyjG70
v8aVx/NUmaM5hOGHlyp3oyosGYhB5RfYDMvaJuMGr+ilU6ViXz8l7H6hkZXX6vaj
OkCwPS/uBHLLRh4TmarACmFngnL/qZE6YFIJY0Qw1BCMuYNtjgLfABVyOaDflVLk
fnZ/+6mou3bSfFXDKW4oWfOtS8LTg82wUfqCPweh0o9gVt73eCZ3iwHphfz5fhtF
nEpocfvBJN1kl04uDoc4oGFH6zJkB5yrSsIDOTmqdBL+UpcfE4/DRbMbMCXPriU1
wCB1kv7bqYNf85Pr7d/e1cvZcC0gll19pRo92DjUKwwRHL/bVNk154S2tzOnjhqG
DEk2eze69U+sXw4yrPCptzsloph4at2z8MmfVl22A0h1CpDOWVuswqHbJANbCAYj
rn1fulPptsaEALMD0tStcIrivhPZzpngMgrLzhZp8eetN7c0rcZQyApjbYC6FHGV
gXTMzI22
=eqMn
-----END PGP SIGNATURE-----

--jvjkiodbs7ntsrn5--