linux.git/Documentation/sphinx/parse-headers.pl, branch v4.8

doc-rst: parse-headers: remove trailing spaces

2016-07-09T12:42:31+00:00

The function that replace references add a "\ " at the end of
references, to avoid the ReST markup parser to not identify
them as references. That works fine except for the end of lines,
as a sequence of { '\', ' ', '\n' } characters makes Sphinx
to ignore the end of line. So, strip those escape/spaces at the
end of lines.

Signed-off-by: Mauro Carvalho Chehab

doc-rst: parse-headers: don't do substituition references

2016-07-07T18:13:17+00:00

Add one extra escape character to avoid those warnings:
	Documentation/linux_tv/videodev2.h.rst:6: WARNING: Inline substitution_reference start-string without end-string.

Signed-off-by: Mauro Carvalho Chehab

doc-rst: parse-headers: add an option to ignore enum symbols

2016-07-07T18:13:07+00:00

At videodev2.h, we have hundreds of symbols that don't
currently have a reference yet. Let's ignore for how, while
we don't improve those cross-refs.

Signed-off-by: Mauro Carvalho Chehab

doc-rst: parse-headers: better handle comments at the source code

2016-07-07T18:12:48+00:00

We should not let comments to mangle with the symbols
parsing. Unfortunately, videodev2.h has lots of those
in the middle of enums and structs. So, we need to improve
our parser to discard them.

Signed-off-by: Mauro Carvalho Chehab

doc-rst: parse-headers: fix multiline typedef handler

2016-07-07T11:12:57+00:00

The typedef handler should do two things to be generic:
  1) parse typedef enums;
  2) accept both possible syntaxes:
	 typedef struct foo { .. } foo_t;
	 typedef struct { .. } foo_t;

Unfortunately, this is needed to parse some legacy DVB
files, like dvb/audio.h.

Signed-off-by: Mauro Carvalho Chehab

doc-rst: parse-headers: better handle typedefs

2016-07-07T10:22:20+00:00

When typedef is used on its multiline format, we need to
also parse enum and struct in the same line.

Signed-off-by: Mauro Carvalho Chehab

doc-rst: parse-headers: be more formal about the valid symbols

2016-07-07T10:08:32+00:00

Be more formal about the valid symbols that are expected by
the parser, to match what c language expects.

Signed-off-by: Mauro Carvalho Chehab

doc-rst: fix parsing comments and '{' on a separate line

2016-07-07T09:54:00+00:00

The dmx.h header has two things that causes the parser to
break while handling enums:
 per-header enums and the '{' starts on a new line

Both makes the parser to get lexical marks to be detected
as if they were symbols.

Fix it.

Signed-off-by: Mauro Carvalho Chehab

doc-dst: parse-headers: highlight deprecated comments

2016-07-07T09:36:46+00:00

When something is deprecated, highlight it, as we want it
to be clearer to the reader.

Signed-off-by: Mauro Carvalho Chehab

doc-rst: parse-headers: improve delimiters to detect symbols

2016-07-07T09:36:46+00:00

As we had to escape the symbols for the ReST markup to not do
the wrong thing, the logic to discover start/end of strings
are not trivial. Improve the end delimiter detection, in order
to highlight more occurrences of the strings.

Signed-off-by: Mauro Carvalho Chehab