Commit ce2e33ba authored by Linus Torvalds's avatar Linus Torvalds
Browse files

Merge tag 'docs-5.10-3' of git://git.lwn.net/linux 

Pull documentation fixes from Jonathan Corbet:
 "A small number of fixes, plus a build tweak to respect the desire for
  silence in V=0 builds"

* tag 'docs-5.10-3' of git://git.lwn.net/linux:
  docs: fix automarkup regression on Python 2
  documentation: arm: sunxi: add Allwinner H6 documents
  scripts: kernel-doc: split typedef complex regex
  scripts: kernel-doc: fix typedef parsing
  docs: Makefile: honor V=0 for docs building
parents 43c83418 4f3e6906

Documentation/Makefile

+4 −0
Original line number Diff line number Diff line
@@ -26,6 +26,10 @@ BUILDDIR = $(obj)/output 
PDFLATEX      = xelatex

LATEXOPTS     = -interaction=batchmode



ifeq ($(KBUILD_VERBOSE),0)

SPHINXOPTS    += "-q"

endif



# User-friendly check for sphinx-build

HAVE_SPHINX := $(shell if which $(SPHINXBUILD) >/dev/null 2>&1; then echo 1; else echo 0; fi)

Documentation/arm/sunxi.rst

+10 −0
Original line number Diff line number Diff line
@@ -148,3 +148,13 @@ SunXi family 
        * User Manual



          http://dl.linux-sunxi.org/A64/Allwinner%20A64%20User%20Manual%20v1.0.pdf



      - Allwinner H6



	* Datasheet



	  https://linux-sunxi.org/images/5/5c/Allwinner_H6_V200_Datasheet_V1.1.pdf



	* User Manual



	  https://linux-sunxi.org/images/4/46/Allwinner_H6_V200_User_Manual_V1.1.pdf

Documentation/sphinx/automarkup.py

+14 −6
Original line number Diff line number Diff line
@@ -15,6 +15,14 @@ else: 
import re

from itertools import chain



#

# Python 2 lacks re.ASCII...

#

try:

    ascii_p3 = re.ASCII

except AttributeError:

    ascii_p3 = 0



#

# Regex nastiness.  Of course.

# Try to identify "function()" that's not already marked up some
@@ -22,22 +30,22 @@ from itertools import chain 
# :c:func: block (i.e. ":c:func:`mmap()`s" flakes out), so the last

# bit tries to restrict matches to things that won't create trouble.

#

RE_function = re.compile(r'\b(([a-zA-Z_]\w+)\(\))', flags=re.ASCII)

RE_function = re.compile(r'\b(([a-zA-Z_]\w+)\(\))', flags=ascii_p3)



#

# Sphinx 2 uses the same :c:type role for struct, union, enum and typedef

#

RE_generic_type = re.compile(r'\b(struct|union|enum|typedef)\s+([a-zA-Z_]\w+)',

                             flags=re.ASCII)

                             flags=ascii_p3)



#

# Sphinx 3 uses a different C role for each one of struct, union, enum and

# typedef

#

RE_struct = re.compile(r'\b(struct)\s+([a-zA-Z_]\w+)', flags=re.ASCII)

RE_union = re.compile(r'\b(union)\s+([a-zA-Z_]\w+)', flags=re.ASCII)

RE_enum = re.compile(r'\b(enum)\s+([a-zA-Z_]\w+)', flags=re.ASCII)

RE_typedef = re.compile(r'\b(typedef)\s+([a-zA-Z_]\w+)', flags=re.ASCII)

RE_struct = re.compile(r'\b(struct)\s+([a-zA-Z_]\w+)', flags=ascii_p3)

RE_union = re.compile(r'\b(union)\s+([a-zA-Z_]\w+)', flags=ascii_p3)

RE_enum = re.compile(r'\b(enum)\s+([a-zA-Z_]\w+)', flags=ascii_p3)

RE_typedef = re.compile(r'\b(typedef)\s+([a-zA-Z_]\w+)', flags=ascii_p3)



#

# Detects a reference to a documentation page of the form Documentation/... with

scripts/kernel-doc

+10 −5
Original line number Diff line number Diff line
@@ -1427,20 +1427,25 @@ sub dump_enum($$) { 
    }

}



my $typedef_type = qr { ((?:\s+[\w\*]+){1,8})\s* }x;

my $typedef_ident = qr { \*?\s*(\w\S+)\s* }x;

my $typedef_args = qr { \s*\((.*)\); }x;



my $typedef1 = qr { typedef$typedef_type\($typedef_ident\)$typedef_args }x;

my $typedef2 = qr { typedef$typedef_type$typedef_ident$typedef_args }x;



sub dump_typedef($$) {

    my $x = shift;

    my $file = shift;



    $x =~ s@/\*.*?\*/@@gos;	# strip comments.



    # Parse function prototypes

    if ($x =~ /typedef\s+(\w+)\s*\(\*\s*(\w\S+)\s*\)\s*\((.*)\);/ ||

	$x =~ /typedef\s+(\w+)\s*(\w\S+)\s*\s*\((.*)\);/) {



	# Function typedefs

    # Parse function typedef prototypes

    if ($x =~ $typedef1 || $x =~ $typedef2) {

	$return_type = $1;

	$declaration_name = $2;

	my $args = $3;

	$return_type =~ s/^\s+//;



	create_parameterlist($args, ',', $file, $declaration_name);

CRA Git | Maintained and supported by SUSTech CRA and CCSE