linux-kernel - Re: [PATCH v2 2/5] docs: automarkup.py: Fix regexes to solve sphinx 3 warnings

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] [day] [month] [year] [list]

Date:   Thu, 15 Oct 2020 08:31:47 +0200
From:   Mauro Carvalho Chehab <mchehab+huawei@...nel.org>
To:     Jonathan Corbet <corbet@....net>
Cc:     "Nícolas F. R. A. Prado" <nfraprado@...tonmail.com>,
        linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org,
        lkcamp@...ts.libreplanetbr.org, andrealmeid@...labora.com
Subject: Re: [PATCH v2 2/5] docs: automarkup.py: Fix regexes to solve sphinx
 3 warnings

Em Wed, 14 Oct 2020 14:16:16 -0600
Jonathan Corbet <corbet@....net> escreveu:

> On Wed, 14 Oct 2020 20:09:10 +0000
> Nícolas F. R. A. Prado <nfraprado@...tonmail.com> wrote:
> 
> > One I had noted down was:
> > 
> > WARNING: Unparseable C cross-reference: '调用debugfs_rename'
> > 
> > which I believe occurred in the chinese translation.
> > 
> > I think the problem is that in chinese there normally isn't space between the
> > words, so even if I had made the regexes only match the beginning of the word
> > (which I didn't, but I fixed this in this patch with the \b), it would still try
> > to cross-reference to that symbol containing chinese characters, which is
> > unparsable to sphinx.
> > 
> > So since valid identifiers in C are only in ASCII anyway, I used the ASCII flag
> > to make \w, and \d only match ASCII characters, otherwise they match any unicode
> > character.  
> 
> OK, this all makes sense, as does your fix.  The one thing I would ask
> would be to put that warning into the changelog for future reference.

I added yesterday patches 1 to 4 from Nícolas series on my -next tree:

	https://git.linuxtv.org/mchehab/media-next.git/log/

Today, I changed the changelog in order to better describe the ASCII issue:

	https://git.linuxtv.org/mchehab/media-next.git/commit/?id=f66e47f98c1e827a85654a8cfa1ba539bb381a1b

If this is enough, I'll likely send the PR to Linus later today or tomorrow,
depending on next- merge results.

Patch 5 can be added later, after we find a way to keep it safe for
parallel reading.

Thanks,
Mauro