[PATCH RFC 3/4] [media] subdev-formats.rst: don't use adjustbox on a longtable

[Mauro Carvalho Chehab]

adjustbox doesn't work on longtables. Also, this
causes an error on LaTeX in interactive mode.

So, use, instead, a tiny font.

Signed-off-by: Mauro Carvalho Chehab 
---
 Documentation/media/uapi/v4l/subdev-formats.rst | 11 +--
 1 file changed, 9 insertions(+), 2 deletions(-)

diff --git a/Documentation/media/uapi/v4l/subdev-formats.rst 
b/Documentation/media/uapi/v4l/subdev-formats.rst
index 489a685945e2..cfffcfbe98fa 100644
--- a/Documentation/media/uapi/v4l/subdev-formats.rst
+++ b/Documentation/media/uapi/v4l/subdev-formats.rst
@@ -1524,9 +1524,16 @@ The following table lists existing packed Bayer formats. 
The data
 organization is given as an example for the first pixel only.
 
 
+.. HACK: ideally, we would be using adjustbox here. However, Sphinx
+.. is a very bad behaviored guy: if the table has more than 30 cols,
+.. it switches to long table, and there's no way to override it.
+
+
 .. raw:: latex
 
-\newline\newline\begin{adjustbox}{width=\columnwidth}
+\begingroup
+\tiny
+\setlength{\tabcolsep}{2pt}
 
 .. tabularcolumns:: 
|p{7.6cm}|p{1.6cm}|p{0.7cm}|p{0.5cm}|p{0.5cm}|p{0.5cm}|p{0.5cm}|p{0.5cm}|p{0.5cm}|p{0.5cm}|p{0.5cm}|p{0.5cm}|p{0.5cm}|p{0.5cm}|p{0.5cm}|
 
@@ -2312,7 +2319,7 @@ organization is given as an example for the first pixel 
only.
 
 .. raw:: latex
 
-\end{adjustbox}\newline\newline
+\endgroup
 
 
 Packed YUV Formats
-- 
2.7.4


--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majord...@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

[PATCH RFC 2/4] [media] subdev-formats.rst: we need a pdf picture for bayer

[Mauro Carvalho Chehab]

The png picture is not ok on Sphinx 1.4.8.

Signed-off-by: Mauro Carvalho Chehab 
---
 Documentation/media/uapi/v4l/subdev-formats.rst |   4 +---
 .../media/uapi/v4l/subdev-formats_files/bayer.pdf   | Bin 0 -> 11131 bytes
 2 files changed, 1 insertion(+), 3 deletions(-)
 create mode 100644 Documentation/media/uapi/v4l/subdev-formats_files/bayer.pdf

diff --git a/Documentation/media/uapi/v4l/subdev-formats.rst 
b/Documentation/media/uapi/v4l/subdev-formats.rst
index e144370f62a0..489a685945e2 100644
--- a/Documentation/media/uapi/v4l/subdev-formats.rst
+++ b/Documentation/media/uapi/v4l/subdev-formats.rst
@@ -1515,13 +1515,11 @@ be named ``MEDIA_BUS_FMT_SRGGB10_2X8_PADHI_LE``.
 .. _bayer-patterns:
 
 .. figure::  subdev-formats_files/bayer.*
-:alt:bayer.png
+:alt:bayer.pdf / bayer.png
 :align:  center
 
 **Figure 4.8 Bayer Patterns**
 
-
-
 The following table lists existing packed Bayer formats. The data
 organization is given as an example for the first pixel only.
 
diff --git a/Documentation/media/uapi/v4l/subdev-formats_files/bayer.pdf 
b/Documentation/media/uapi/v4l/subdev-formats_files/bayer.pdf
new file mode 100644
index 
..8ccef608cabd2cfdd6cfb3e80a5055d5cb05d814
GIT binary patch
literal 11131
zcmaKScUV(P_ijKC4I)iIdZhQ>dq+W#9*_W1BE2Ml^dbmI?Y{Z
zMvh)CP!N}mwI3AD4HQ&`L#@3W-QCozy>O_SjEIo1gs_mPu!xAbw1^PSK*!zge{Iu)
zyW4r}Mp(gQKmdjE8Gg4{p_1t8ST?kZ7{e;%^gAFWfA;0%1U0
z7y)4kX*WNbG9rg+R8hz(0AaxdZjDIR4AwFSf7ZT!j{u{+s`+?5_}WkRa|M
z0tp(misSwPj>W(Hu15WLN=AQ3|BDx(prN;o*B|7M4^U9o+7
zxJL#TTEhkR(5XRf-R+=PQv-IiyBd@b(cS?!O_I3(s_riCa6=DkTPR5QYAgmo
zK@~?YPdzAH)!o&@-R)|Uq=15dadI{GKeYWdMBnj^T;f2ZuBM&=dG{C<-g
z>fD~KUJl_A^EkrrY3MKU5>ow-byhzUza%zy*gLFer+~?u{B$<6AI!l|zfSB=vkx9t
zL<{l_{{T~#d*f}JUT+AhJHvEPnE7;_A(?Z=Lgpfb8+%+~cTQ4K6%ll~CH(?!?~c#Xg)W
z(

Re: Proposing help for documentation

[Luis de Bethencourt]

On 01/11/16 21:52, Patrice wrote:
> On Tue, Nov 1, 2016 at 5:40 PM, Luis de Bethencourt
>  wrote:
>> On 01/11/16 19:35, Patrice wrote:
>>> Following on Jonathan Corbet article on LWN, I'd like to propose my
>>> help for the documentation.
>>>
>>> I'm a software developer, not much of a kernel or system dev though,
>>> even if I've done a bit, but I know my way around the kernel and
>>> source, I have studied it for a pretty long time, out of personal
>>> interest.
>>>
>>> I can help anywhere you see fit.
>>>
>>> Patrice
>>
>> Which article on LWN is this? I feel like I missed it.
>>
>> Luis
>>
> 
> https://lwn.net/Articles/704613/
> 
> It's this week edition so for subscribers, but it will be online in a
> few days I think for non-subscribers.
> 

I missed it!

"Documentation/ is a long name, and is the only top-level directory in
the kernel starting with a capital letter. One can joke that this
distinction highlights the importance of documentation"
Hahahaaa

Great read. Thanks Patrice.

Jonathan,
I also offer my help, let me know if you see anything I can do.

I will follow this mailing list more closely now.

Thanks,
Luis
--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majord...@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Re: [PATCH RFC 0/4] Fix PDF build errors

[Mauro Carvalho Chehab]

Em Tue,  1 Nov 2016 16:44:09 -0600
Mauro Carvalho Chehab  escreveu:

> This series address a series of errors during PDF generation from
> media documentation.
> 
> Please notice that patch 2 carries on a PDF conversion from a PNG
> image, because Sphinx is not smart enough to do the convertion.
> 
> This is a temporary solution (That's why I'm marking this series
> as RFC).
> 
> I'm working on a more permanent access where the image format

In time:
"more permanent solution"

> required by Sphinx for PDF output will be met.
> 
> Mauro Carvalho Chehab (4):
>   docs-rst: fix PDF build errors
>   [media] subdev-formats.rst: we need a pdf picture for bayer
>   [media] subdev-formats.rst: don't use adjustbox on a longtable
>   [media] subdev-formats.rst: add missing columns to tabularcolumns
> 
>  Documentation/conf.py  |   4 
>  Documentation/media/index.rst  |   5 -
>  Documentation/media/uapi/v4l/subdev-formats.rst|  17 
> +++--
>  .../media/uapi/v4l/subdev-formats_files/bayer.pdf  | Bin 0 -> 11131 bytes
>  4 files changed, 15 insertions(+), 11 deletions(-)
>  create mode 100644 
> Documentation/media/uapi/v4l/subdev-formats_files/bayer.pdf
> 




Cheers,
Mauro
--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majord...@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Re: make pdfdocs fails with v4.9-rc3

[Mauro Carvalho Chehab]

Em Tue, 1 Nov 2016 15:11:55 -0700
Jim Davis  escreveu:

> On Mon, Oct 31, 2016 at 3:41 PM, Mauro Carvalho Chehab
>  wrote:
> > Em Mon, 31 Oct 2016 16:40:02 -0600
> > Mauro Carvalho Chehab  escreveu:
> >  
> >> Em Mon, 31 Oct 2016 15:04:42 -0700
> >> Jim Davis  escreveu:
> >>  
> >> > On Mon, Oct 31, 2016 at 1:58 PM, Mauro Carvalho Chehab
> >> >  wrote:  
> >> > > Em Mon, 31 Oct 2016 14:17:59 -0600
> >> > > Mauro Carvalho Chehab  escreveu:
> >> > >  
> >> > >> Em Mon, 31 Oct 2016 13:15:24 -0600
> >> > >> Jonathan Corbet  escreveu:
> >> > >>  
> >> > >> > On Mon, 31 Oct 2016 11:51:20 -0700
> >> > >> > Jim Davis  wrote:
> >> > >> >  
> >> > >> > > Running make pdfdocs on a Ubuntu 16.04 system fails with
> >> > >> > >
> >> > >> > > Makefile:58: recipe for target 'media.pdf' failed
> >> > >> > > make[2]: *** [media.pdf] Error 1
> >> > >> > > Documentation/Makefile.sphinx:79: recipe for target 'pdfdocs' 
> >> > >> > > failed
> >> > >> > > make[1]: *** [pdfdocs] Error 2
> >> > >> > > Makefile:1442: recipe for target 'pdfdocs' failed
> >> > >> > > make: *** [pdfdocs] Error 2
> >> > >> > >
> >> > >> > > It's not clear from the voluminous (>5MB) output from make pdfdocs
> >> > >> > > exactly which stage is failing, and there are some pdf files 
> >> > >> > > produced
> >> > >> > > in output/latex.  
> >> > >> >
> >> > >> > Hmm, so it does.  It comes down to this:
> >> > >> >
> >> > >> > ! LaTeX Error: \DUrole undefined.
> >> > >> >
> >> > >> > See the LaTeX manual or LaTeX Companion for explanation.
> >> > >> > Type  H   for immediate help.
> >> > >> >  ...
> >> > >> >
> >> > >> > l.195 \renewcommand*{\DUrole}
> >> > >> >  [2]{ #2 }
> >> > >> >
> >> > >> > Where the offending command is in Documentation/media/index.rst.  
> >> > >> > Mauro,
> >> > >> > got an idea for what's going on there?  
> >> > >>
> >> > >> Sphinx is really a poor solution when it comes to PDF output. In this
> >> > >> specific case, this is meant to fix a problem with cross-references.
> >> > >>
> >> > >> What happens is that Sphinx 1.4.6 (and later?) define reference names 
> >> > >> without
> >> > >> being properly escaped. So, for some references, it causes the PDF 
> >> > >> output
> >> > >> to crash. That happens at one of the DVB header files, if I remember 
> >> > >> well.
> >> > >>
> >> > >> This commit restores the sphinx 1.2.x behavior:
> >> > >>
> >> > >> commit e61a39baf74dddb6cd236147bd19b55c10188d78
> >> > >> Author: Mauro Carvalho Chehab 
> >> > >> Date:   Sun Aug 21 15:14:57 2016 -0300
> >> > >>
> >> > >> [media] index.rst: Fix LaTeX error in interactive mode on Sphinx 
> >> > >> 1.4.x
> >> > >>
> >> > >> The Sphinx 1.4.x definition for \DUrole is:
> >> > >>
> >> > >> \providecommand*{\DUrole}[2]{%
> >> > >>   \ifcsname DUrole#1\endcsname%
> >> > >> \csname DUrole#1\endcsname{#2}%
> >> > >>   \else% backwards compatibility: try \docutilsrole#1{#2}
> >> > >> \ifcsname docutilsrole#1\endcsname%
> >> > >>   \csname docutilsrole#1\endcsname{#2}%
> >> > >> \else%
> >> > >>   #2%
> >> > >> \fi%
> >> > >>   \fi%
> >> > >> }
> >> > >>
> >> > >> This is broken when it is used inside a \begin{alltt} block.
> >> > >> So, replace it by just "#2", as this won't cause troubles, and
> >> > >> it is one of the fallback methods for it.
> >> > >>
> >> > >> Signed-off-by: Mauro Carvalho Chehab 
> >> > >>
> >> > >> At the time I tested, it worked fine, but maybe it is redefining the
> >> > >> \DUrole too late.
> >> > >>
> >> > >> Maybe we could move it to LaTeX preamble instead. Please check if this
> >> > >> untested patch fixes the issue.  
> >> > >
> >> > > Yes, this seems to be the case. The patch below should fix it.
> >> > >
> >> > > [PATCH] docs-rst: fix PDF build errors
> >> > >
> >> > > PDF build on Kernel 4.9-rc? returns an error. This is
> >> > > because we're re-defining a command too late. Move
> >> > > such redefinition to LaTeX preamble.
> >> > >
> >> > > Tested by building the documentation on interactive mode:
> >> > > make PDFLATEX=xelatex -C Documentation/output/./latex
> >> > >
> >> > > Fixes: e61a39baf74d ("[media] index.rst: Fix LaTeX error in 
> >> > > interactive mode on Sphinx 1.4.x")
> >> > >
> >> > > Signed-off-by: Mauro Carvalho Chehab 
> >> > >
> >> > > diff --git a/Documentation/conf.py b/Documentation/conf.py
> >> > > index d9bad21dd427..d9ebfeb431a9 100644
> >> > > --- a/Documentation/conf.py
> >> > > +++ b/Documentation/conf.py
> >> > > @@ -329,6 +329,9 @@ latex_elements = {
> >> > > % To allow adjusting table sizes
> >> > > \\usepackage{adjustbox}
> >> > >
> >> > > +   % Fix reference escape troubles with Sphinx 

[PATCH RFC 4/4] [media] subdev-formats.rst: add missing columns to tabularcolumns

[Mauro Carvalho Chehab]

There are several missing columns on the size specification,
causing LaTeX to complain on interactive mode.

Signed-off-by: Mauro Carvalho Chehab 
---
 Documentation/media/uapi/v4l/subdev-formats.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/media/uapi/v4l/subdev-formats.rst 
b/Documentation/media/uapi/v4l/subdev-formats.rst
index cfffcfbe98fa..ac9e96049d04 100644
--- a/Documentation/media/uapi/v4l/subdev-formats.rst
+++ b/Documentation/media/uapi/v4l/subdev-formats.rst
@@ -1535,7 +1535,7 @@ organization is given as an example for the first pixel 
only.
 \tiny
 \setlength{\tabcolsep}{2pt}
 
-.. tabularcolumns:: 
|p{7.6cm}|p{1.6cm}|p{0.7cm}|p{0.5cm}|p{0.5cm}|p{0.5cm}|p{0.5cm}|p{0.5cm}|p{0.5cm}|p{0.5cm}|p{0.5cm}|p{0.5cm}|p{0.5cm}|p{0.5cm}|p{0.5cm}|
+.. tabularcolumns:: 
|p{4.0cm}|p{0.7cm}|p{0.3cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|
 
 .. _v4l2-mbus-pixelcode-bayer:
 
-- 
2.7.4


--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majord...@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

[PATCH] [TRIVIAL] Remove last traces of ikconfig.h

[Paul Bolle]

The build system stopped generating ikconfig.h in v2.6.8. Remove an entry
for it in dontdiff. There's also a reference to it in a small comment.
Remove that comment too, as it is of little help in any case.

Signed-off-by: Paul Bolle 
---
 Documentation/dontdiff | 1 -
 kernel/Makefile| 2 --
 2 files changed, 3 deletions(-)

diff --git a/Documentation/dontdiff b/Documentation/dontdiff
index 5385cba941d2..a23edccd2059 100644
--- a/Documentation/dontdiff
+++ b/Documentation/dontdiff
@@ -139,7 +139,6 @@ hpet_example
 hugepage-mmap
 hugepage-shm
 ihex2fw
-ikconfig.h*
 inat-tables.c
 initramfs_list
 int16.c
diff --git a/kernel/Makefile b/kernel/Makefile
index eb26e12c6c2a..eaee9de224bd 100644
--- a/kernel/Makefile
+++ b/kernel/Makefile
@@ -115,8 +115,6 @@ obj-$(CONFIG_HAS_IOMEM) += memremap.o
 
 $(obj)/configs.o: $(obj)/config_data.h
 
-# config_data.h contains the same information as ikconfig.h but gzipped.
-# Info from config_data can be extracted from /proc/config*
 targets += config_data.gz
 $(obj)/config_data.gz: $(KCONFIG_CONFIG) FORCE
$(call if_changed,gzip)
-- 
2.7.4

--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majord...@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Re: make pdfdocs fails with v4.9-rc3

[Jim Davis]

On Mon, Oct 31, 2016 at 3:41 PM, Mauro Carvalho Chehab
 wrote:
> Em Mon, 31 Oct 2016 16:40:02 -0600
> Mauro Carvalho Chehab  escreveu:
>
>> Em Mon, 31 Oct 2016 15:04:42 -0700
>> Jim Davis  escreveu:
>>
>> > On Mon, Oct 31, 2016 at 1:58 PM, Mauro Carvalho Chehab
>> >  wrote:
>> > > Em Mon, 31 Oct 2016 14:17:59 -0600
>> > > Mauro Carvalho Chehab  escreveu:
>> > >
>> > >> Em Mon, 31 Oct 2016 13:15:24 -0600
>> > >> Jonathan Corbet  escreveu:
>> > >>
>> > >> > On Mon, 31 Oct 2016 11:51:20 -0700
>> > >> > Jim Davis  wrote:
>> > >> >
>> > >> > > Running make pdfdocs on a Ubuntu 16.04 system fails with
>> > >> > >
>> > >> > > Makefile:58: recipe for target 'media.pdf' failed
>> > >> > > make[2]: *** [media.pdf] Error 1
>> > >> > > Documentation/Makefile.sphinx:79: recipe for target 'pdfdocs' failed
>> > >> > > make[1]: *** [pdfdocs] Error 2
>> > >> > > Makefile:1442: recipe for target 'pdfdocs' failed
>> > >> > > make: *** [pdfdocs] Error 2
>> > >> > >
>> > >> > > It's not clear from the voluminous (>5MB) output from make pdfdocs
>> > >> > > exactly which stage is failing, and there are some pdf files 
>> > >> > > produced
>> > >> > > in output/latex.
>> > >> >
>> > >> > Hmm, so it does.  It comes down to this:
>> > >> >
>> > >> > ! LaTeX Error: \DUrole undefined.
>> > >> >
>> > >> > See the LaTeX manual or LaTeX Companion for explanation.
>> > >> > Type  H   for immediate help.
>> > >> >  ...
>> > >> >
>> > >> > l.195 \renewcommand*{\DUrole}
>> > >> >  [2]{ #2 }
>> > >> >
>> > >> > Where the offending command is in Documentation/media/index.rst.  
>> > >> > Mauro,
>> > >> > got an idea for what's going on there?
>> > >>
>> > >> Sphinx is really a poor solution when it comes to PDF output. In this
>> > >> specific case, this is meant to fix a problem with cross-references.
>> > >>
>> > >> What happens is that Sphinx 1.4.6 (and later?) define reference names 
>> > >> without
>> > >> being properly escaped. So, for some references, it causes the PDF 
>> > >> output
>> > >> to crash. That happens at one of the DVB header files, if I remember 
>> > >> well.
>> > >>
>> > >> This commit restores the sphinx 1.2.x behavior:
>> > >>
>> > >> commit e61a39baf74dddb6cd236147bd19b55c10188d78
>> > >> Author: Mauro Carvalho Chehab 
>> > >> Date:   Sun Aug 21 15:14:57 2016 -0300
>> > >>
>> > >> [media] index.rst: Fix LaTeX error in interactive mode on Sphinx 
>> > >> 1.4.x
>> > >>
>> > >> The Sphinx 1.4.x definition for \DUrole is:
>> > >>
>> > >> \providecommand*{\DUrole}[2]{%
>> > >>   \ifcsname DUrole#1\endcsname%
>> > >> \csname DUrole#1\endcsname{#2}%
>> > >>   \else% backwards compatibility: try \docutilsrole#1{#2}
>> > >> \ifcsname docutilsrole#1\endcsname%
>> > >>   \csname docutilsrole#1\endcsname{#2}%
>> > >> \else%
>> > >>   #2%
>> > >> \fi%
>> > >>   \fi%
>> > >> }
>> > >>
>> > >> This is broken when it is used inside a \begin{alltt} block.
>> > >> So, replace it by just "#2", as this won't cause troubles, and
>> > >> it is one of the fallback methods for it.
>> > >>
>> > >> Signed-off-by: Mauro Carvalho Chehab 
>> > >>
>> > >> At the time I tested, it worked fine, but maybe it is redefining the
>> > >> \DUrole too late.
>> > >>
>> > >> Maybe we could move it to LaTeX preamble instead. Please check if this
>> > >> untested patch fixes the issue.
>> > >
>> > > Yes, this seems to be the case. The patch below should fix it.
>> > >
>> > > [PATCH] docs-rst: fix PDF build errors
>> > >
>> > > PDF build on Kernel 4.9-rc? returns an error. This is
>> > > because we're re-defining a command too late. Move
>> > > such redefinition to LaTeX preamble.
>> > >
>> > > Tested by building the documentation on interactive mode:
>> > > make PDFLATEX=xelatex -C Documentation/output/./latex
>> > >
>> > > Fixes: e61a39baf74d ("[media] index.rst: Fix LaTeX error in interactive 
>> > > mode on Sphinx 1.4.x")
>> > >
>> > > Signed-off-by: Mauro Carvalho Chehab 
>> > >
>> > > diff --git a/Documentation/conf.py b/Documentation/conf.py
>> > > index d9bad21dd427..d9ebfeb431a9 100644
>> > > --- a/Documentation/conf.py
>> > > +++ b/Documentation/conf.py
>> > > @@ -329,6 +329,9 @@ latex_elements = {
>> > > % To allow adjusting table sizes
>> > > \\usepackage{adjustbox}
>> > >
>> > > +   % Fix reference escape troubles with Sphinx 1.4.x
>> > > +   \\renewcommand*{\\DUrole}[2]{ #2 }
>> > > +
>> > >   '''
>> > >  }
>> > >
>> > > diff --git a/Documentation/media/index.rst 
>> > > b/Documentation/media/index.rst
>> > > index e347a3e7bdef..7f8f0af620ce 100644
>> > > --- a/Documentation/media/index.rst
>> > > +++ b/Documentation/media/index.rst
>> > > @@ -1,11 +1,6 @@

Re: Proposing help for documentation

[Luis de Bethencourt]

On 01/11/16 19:35, Patrice wrote:
> Following on Jonathan Corbet article on LWN, I'd like to propose my
> help for the documentation.
> 
> I'm a software developer, not much of a kernel or system dev though,
> even if I've done a bit, but I know my way around the kernel and
> source, I have studied it for a pretty long time, out of personal
> interest.
> 
> I can help anywhere you see fit.
> 
> Patrice

Which article on LWN is this? I feel like I missed it.

Luis

--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majord...@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Proposing help for documentation

[Patrice]

Following on Jonathan Corbet article on LWN, I'd like to propose my
help for the documentation.

I'm a software developer, not much of a kernel or system dev though,
even if I've done a bit, but I know my way around the kernel and
source, I have studied it for a pretty long time, out of personal
interest.

I can help anywhere you see fit.

Patrice
--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majord...@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Re: [PATCH 2/2] ABI: ibm_rtl: the "What:" fields are incomplete

[Darren Hart]

On Sat, Oct 29, 2016 at 08:10:03AM -0200, Mauro Carvalho Chehab wrote:
> The "What:" field at the ABI should describe the location of
> the ABI, e. g. the position under a mounted sysfs. However,
> this file has only the basename without the path.
> 
> Fix it.
> 
> Cc: Vernon Mauery 
> Cc: Darren Hart 
> Cc: platform-driver-...@vger.kernel.org
> Signed-off-by: Mauro Carvalho Chehab 

Jon,

Is it OK with you if I push this through my platform driver x86 tree?

Thanks,

Darren

> ---
>  Documentation/ABI/testing/sysfs-devices-system-ibm-rtl | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/Documentation/ABI/testing/sysfs-devices-system-ibm-rtl 
> b/Documentation/ABI/testing/sysfs-devices-system-ibm-rtl
> index b82deeaec314..470def06ab0a 100644
> --- a/Documentation/ABI/testing/sysfs-devices-system-ibm-rtl
> +++ b/Documentation/ABI/testing/sysfs-devices-system-ibm-rtl
> @@ -1,4 +1,4 @@
> -What:   state
> +What:   /sys/devices/system/ibm_rtl/state
>  Date:   Sep 2010
>  KernelVersion:  2.6.37
>  Contact:Vernon Mauery 
> @@ -10,7 +10,7 @@ Description:The state file allows a means by which to 
> change in and
>  Users:  The ibm-prtm userspace daemon uses this interface.
>  
>  
> -What:   version
> +What:   /sys/devices/system/ibm_rtl/version
>  Date:   Sep 2010
>  KernelVersion:  2.6.37
>  Contact:Vernon Mauery 
> -- 
> 2.7.4
> 
> 

-- 
Darren Hart
Intel Open Source Technology Center
--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majord...@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Re: [PATCH 2/2] ABI: ibm_rtl: the "What:" fields are incomplete

[Darren Hart]

On Sat, Oct 29, 2016 at 08:10:03AM -0200, Mauro Carvalho Chehab wrote:
> The "What:" field at the ABI should describe the location of
> the ABI, e. g. the position under a mounted sysfs. However,
> this file has only the basename without the path.
> 
> Fix it.
> 
> Cc: Vernon Mauery 
> Cc: Darren Hart 
> Cc: platform-driver-...@vger.kernel.org
> Signed-off-by: Mauro Carvalho Chehab 

Thanks, applied.

-- 
Darren Hart
Intel Open Source Technology Center
--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majord...@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

[PATCH] USB: fix typo in documentation

[Luis de Bethencourt]

A typo sneaked in the latest change on the USB documentation. Fixing it
and also a trailing whitespace since it is also in the "USB Host-Side API
Model" chapter.

Signed-off-by: Luis de Bethencourt 
---
 Documentation/DocBook/usb.tmpl | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/Documentation/DocBook/usb.tmpl b/Documentation/DocBook/usb.tmpl
index 8ec4d59..e322691 100644
--- a/Documentation/DocBook/usb.tmpl
+++ b/Documentation/DocBook/usb.tmpl
@@ -160,7 +160,7 @@
 In theory, all HCDs provide the same functionality through the same
 API.  In practice, that's becoming mostly true,
 but there are still differences that crop up especially with
-fault handling on the less common controllers.
+fault handling on the less common controllers.
 Different controllers don't necessarily report
 the same aspects of failures, and recovery from faults (including
 software-induced ones like unlinking an URB) isn't yet fully
@@ -168,7 +168,7 @@
 Device driver authors should make a point of doing disconnect
 testing (while the device is active) with each different host
 controller driver, to make sure drivers don't have bugs of
-thei1r own as well as to make sure they aren't relying on some
+their own as well as to make sure they aren't relying on some
 HCD-specific behavior.
 

--
2.8.1
--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majord...@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

[PATCH v2] doc-rst: make cleandocs misses a fair number of files

[Markus Heiser]

Removes intermediate 'Documentation/DocBook/.*.xml.cmd' files

Changes since v1:
- Reduce the patch to DocBook cleandocs

References: 
http://lkml.kernel.org/r/CA+r1Zhjr5SCVAroREBv84t9bxDVu5jVJ_Fu=bbvdgnnabdq...@mail.gmail.com
Reported-by: Jim Davis 
Signed-off-by: Markus Heiser 
---
 Documentation/DocBook/Makefile | 1 +
 1 file changed, 1 insertion(+)

diff --git a/Documentation/DocBook/Makefile b/Documentation/DocBook/Makefile
index fdf8232..263e657 100644
--- a/Documentation/DocBook/Makefile
+++ b/Documentation/DocBook/Makefile
@@ -264,6 +264,7 @@ clean-files := $(DOCBOOKS) \
$(patsubst %.xml, %.aux.xml, $(DOCBOOKS)) \
$(patsubst %.xml, %.xml.db,  $(DOCBOOKS)) \
$(patsubst %.xml, %.xml, $(DOCBOOKS)) \
+   $(patsubst %.xml, .%.xml.cmd, $(DOCBOOKS)) \
$(index)
 
 clean-dirs := $(patsubst %.xml,%,$(DOCBOOKS)) man
-- 
2.7.4

--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majord...@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Re: [PATCH] doc-rst: make cleandocs misses a fair number of files

[Jani Nikula]

On Tue, 01 Nov 2016, Markus Heiser  wrote:
> Am 01.11.2016 um 08:39 schrieb Jani Nikula :
>
>> On Tue, 01 Nov 2016, Markus Heiser  wrote:
>>> Removes intermediate files:
>>> 
>>> - Documentation/DocBook/.*.xml.cmd
>>> - Documentation/.../*.pyc
>>> - Documentation/.../*.pyo
>>> - Documentation/.../__pycache__
>>> 
>>> To be more future-proof, this covers more than we need today. I guess
>>> there comes the day we assemble a python package structure under
>>> Documentation/sphinx.
>>> 
>>> References: 
>>> http://lkml.kernel.org/r/camuhmdvxqph7-9xj+ye_pgoa+-fe0969cskoehyh3uubycr...@mail.gmail.com
>>> Reported-by: Geert Uytterhoeven 
>> 
>> Geert reports about writing files to the source tree to begin with, and
>> the fix is to stop doing that instead of cleaning up afterwards! The fix
>> for that is [1].
>> 
>> So please take out the parts touching the source tree. And ITYM:
>> 
>> References: 
>> http://lkml.kernel.org/r/CA+r1Zhjr5SCVAroREBv84t9bxDVu5jVJ_Fu=bbvdgnnabdq...@mail.gmail.com
>> Reported-by: Jim Davis 
>
> Aargh .. you are right, I've messed it up.
>
> @jon, @geert: ignore this patch / sorry

We do want this part to address Jim's report though:

> + $(patsubst %.xml, .%.xml.cmd, $(DOCBOOKS)) \

BR,
Jani.


-- 
Jani Nikula, Intel Open Source Technology Center
--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majord...@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Re: [PATCH 2/2] swiotlb: Add swiotlb=nobounce debug option

[Robin Murphy]

On 31/10/16 18:20, Geert Uytterhoeven wrote:
> Hi Robin,
> 
> On Mon, Oct 31, 2016 at 6:41 PM, Robin Murphy  wrote:
>> On 31/10/16 15:45, Geert Uytterhoeven wrote:
>>> On architectures like arm64, swiotlb is tied intimately to the core
>>> architecture DMA support. In addition, ZONE_DMA cannot be disabled.
>>
>> To be fair, that only takes a single-character change in
>> arch/arm64/Kconfig - in fact, I'm amused to see my stupid patch to fix
>> the build if you do just that (86a5906e4d1d) has just had its birthday ;)
> 
> Unfortunately it's not that simple. Using a small patch (based on Mark 
> Salter's
> "arm64: make CONFIG_ZONE_DMA user settable"), it appears to work. However:
>   - With CONFIG_ZONE_DMA=n and memory present over 4G, swiotlb_init() is
> not called.
> This will lead to a NULL pointer dereference later, when
> dma_map_single() calls into an unitialized SWIOTLB subsystem through
> swiotlb_tbl_map_single().
>   - With CONFIG_ZONE_DMA=n and no memory present over 4G, swiotlb_init()
> is also not called, but RAVB works fine.
> Disabling CONFIG_SWIOTLB is non-trivial, as the arm64 DMA core always
> uses swiotlb_dma_ops, and its operations depend a lot on SWIOTLB
> helpers.
> 
> So that's why I went for this option.

OK, that's new to me - I guess this behaviour was introduced by
b67a8b29df7e ("arm64: mm: only initialize swiotlb when necessary").
Regardless of this patch, that check probably wants fixing to still do
the appropriate thing if arm64_dma_phys_limit is above 4GB (or just
depend on ZONE_DMA). Disabling ZONE_DMA for development doesn't seem
that unreasonable a thing to do, especially if there are ready-made
patches floating around already, so having it crash the kernel in ways
it didn't before isn't ideal.

>>> To aid debugging and catch devices not supporting DMA to memory outside
>>> the 32-bit address space, add a kernel command line option
>>> "swiotlb=nobounce", which disables the use of bounce buffers.
>>> If specified, trying to map memory that cannot be used with DMA will
>>> fail, and a warning will be printed (rate-limited).
>>
>> This rationale seems questionable - how useful is non-deterministic
>> behaviour for debugging really? What you end up with is DMA sometimes
>> working or sometimes not depending on whether allocations happen to
>> naturally fall below 4GB or not. In my experience, that in itself can be
>> a pain in the arse to debug.
> 
> It immediately triggered for me, though:
> 
> rcar-dmac e730.dma-controller: Cannot do DMA to address
> 0x00067a9b7000
> ravb e680.ethernet: Cannot do DMA to address 0x00067aa07780
> 
>> Most of the things you might then do to make things more deterministic
>> again (like making the default DMA mask tiny or hacking out all the
>> system's 32-bit addressable RAM) are also generally sufficient to make
>> DMA fail earlier and make this option moot anyway. What's the specific
>> use case motivating this?
> 
> My use case is finding which drivers and DMA engines do not support 64-bit
> memory. There's more info in my series "[PATCH/RFC 0/5] arm64: r8a7796: 64-bit
> Memory and Ethernet Prototype"
> (https://www.mail-archive.com/linux-renesas-soc@vger.kernel.org/msg08393.html)

Thanks for the context. I've done very similar things in the past, and
my first instinct would be to change the default DMA mask in
of_dma_configure() to something which can't reach RAM (e.g. <30 bits),
then instrument dma_set_mask() to catch cleverer drivers. That's a
straightforward way to get 100% coverage - the problem with simply
disabling bounce buffering is that whilst statistically it almost
certainly will catch >95% of cases, there will always be some that it
won't; if some driver only ever does a single dma_alloc_coherent() early
enough that allocations are still fairly deterministic, and always
happens to get a 32-bit address on that platform, it's likely to slip
through the net.

I'm not against the idea of SWIOTLB growing a runtime-disable option,
I'm just not sure what situation it's actually the best solution for.

Robin.

> 
> Gr{oetje,eeting}s,
> 
> Geert
> 
> --
> Geert Uytterhoeven -- There's lots of Linux beyond ia32 -- 
> ge...@linux-m68k.org
> 
> In personal conversations with technical people, I call myself a hacker. But
> when I'm talking to journalists I just say "programmer" or something like 
> that.
> -- Linus Torvalds
> 

--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majord...@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Re: [PATCH] doc-rst: make cleandocs misses a fair number of files

[Markus Heiser]

Am 01.11.2016 um 08:39 schrieb Jani Nikula :

> On Tue, 01 Nov 2016, Markus Heiser  wrote:
>> Removes intermediate files:
>> 
>> - Documentation/DocBook/.*.xml.cmd
>> - Documentation/.../*.pyc
>> - Documentation/.../*.pyo
>> - Documentation/.../__pycache__
>> 
>> To be more future-proof, this covers more than we need today. I guess
>> there comes the day we assemble a python package structure under
>> Documentation/sphinx.
>> 
>> References: 
>> http://lkml.kernel.org/r/camuhmdvxqph7-9xj+ye_pgoa+-fe0969cskoehyh3uubycr...@mail.gmail.com
>> Reported-by: Geert Uytterhoeven 
> 
> Geert reports about writing files to the source tree to begin with, and
> the fix is to stop doing that instead of cleaning up afterwards! The fix
> for that is [1].
> 
> So please take out the parts touching the source tree. And ITYM:
> 
> References: 
> http://lkml.kernel.org/r/CA+r1Zhjr5SCVAroREBv84t9bxDVu5jVJ_Fu=bbvdgnnabdq...@mail.gmail.com
> Reported-by: Jim Davis 

Aargh .. you are right, I've messed it up.

@jon, @geert: ignore this patch / sorry

Thanks!

-- Markus 
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majord...@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Re: [PATCH] doc-rst: make cleandocs misses a fair number of files

[Jani Nikula]

On Tue, 01 Nov 2016, Markus Heiser  wrote:
> Removes intermediate files:
>
> - Documentation/DocBook/.*.xml.cmd
> - Documentation/.../*.pyc
> - Documentation/.../*.pyo
> - Documentation/.../__pycache__
>
> To be more future-proof, this covers more than we need today. I guess
> there comes the day we assemble a python package structure under
> Documentation/sphinx.
>
> References: 
> http://lkml.kernel.org/r/camuhmdvxqph7-9xj+ye_pgoa+-fe0969cskoehyh3uubycr...@mail.gmail.com
> Reported-by: Geert Uytterhoeven 

Geert reports about writing files to the source tree to begin with, and
the fix is to stop doing that instead of cleaning up afterwards! The fix
for that is [1].

So please take out the parts touching the source tree. And ITYM:

References: 
http://lkml.kernel.org/r/CA+r1Zhjr5SCVAroREBv84t9bxDVu5jVJ_Fu=bbvdgnnabdq...@mail.gmail.com
Reported-by: Jim Davis 


BR,
Jani.


[1] 
http://lkml.kernel.org/r/1477945781-8354-1-git-send-email-jani.nik...@intel.com




> Signed-off-by: Markus Heiser 
> ---
>  Documentation/DocBook/Makefile | 1 +
>  Documentation/Makefile.sphinx  | 4 +++-
>  2 files changed, 4 insertions(+), 1 deletion(-)
>
> diff --git a/Documentation/DocBook/Makefile b/Documentation/DocBook/Makefile
> index fdf8232..263e657 100644
> --- a/Documentation/DocBook/Makefile
> +++ b/Documentation/DocBook/Makefile
> @@ -264,6 +264,7 @@ clean-files := $(DOCBOOKS) \
>   $(patsubst %.xml, %.aux.xml, $(DOCBOOKS)) \
>   $(patsubst %.xml, %.xml.db,  $(DOCBOOKS)) \
>   $(patsubst %.xml, %.xml, $(DOCBOOKS)) \
> + $(patsubst %.xml, .%.xml.cmd, $(DOCBOOKS)) \
>   $(index)
>  
>  clean-dirs := $(patsubst %.xml,%,$(DOCBOOKS)) man
> diff --git a/Documentation/Makefile.sphinx b/Documentation/Makefile.sphinx
> index 92deea3..3e8a7d7 100644
> --- a/Documentation/Makefile.sphinx
> +++ b/Documentation/Makefile.sphinx
> @@ -92,7 +92,9 @@ mandocs:
>  installmandocs:
>  
>  cleandocs:
> - $(Q)rm -rf $(BUILDDIR)
> + $(Q)rm -rf $(obj)/output
> + $(Q)find $(srctree)/$(src) -type d -name '__pycache__' | xargs rm -rf
> + $(Q)find $(srctree)/$(src) -name '*.pyc' -o -name '*.pyo' | xargs rm -f
>  
>  endif # HAVE_SPHINX

-- 
Jani Nikula, Intel Open Source Technology Center
--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majord...@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

[PATCH] doc-rst: make cleandocs misses a fair number of files

[Markus Heiser]

Removes intermediate files:

- Documentation/DocBook/.*.xml.cmd
- Documentation/.../*.pyc
- Documentation/.../*.pyo
- Documentation/.../__pycache__

To be more future-proof, this covers more than we need today. I guess
there comes the day we assemble a python package structure under
Documentation/sphinx.

References: 
http://lkml.kernel.org/r/camuhmdvxqph7-9xj+ye_pgoa+-fe0969cskoehyh3uubycr...@mail.gmail.com
Reported-by: Geert Uytterhoeven 
Signed-off-by: Markus Heiser 
---
 Documentation/DocBook/Makefile | 1 +
 Documentation/Makefile.sphinx  | 4 +++-
 2 files changed, 4 insertions(+), 1 deletion(-)

diff --git a/Documentation/DocBook/Makefile b/Documentation/DocBook/Makefile
index fdf8232..263e657 100644
--- a/Documentation/DocBook/Makefile
+++ b/Documentation/DocBook/Makefile
@@ -264,6 +264,7 @@ clean-files := $(DOCBOOKS) \
$(patsubst %.xml, %.aux.xml, $(DOCBOOKS)) \
$(patsubst %.xml, %.xml.db,  $(DOCBOOKS)) \
$(patsubst %.xml, %.xml, $(DOCBOOKS)) \
+   $(patsubst %.xml, .%.xml.cmd, $(DOCBOOKS)) \
$(index)
 
 clean-dirs := $(patsubst %.xml,%,$(DOCBOOKS)) man
diff --git a/Documentation/Makefile.sphinx b/Documentation/Makefile.sphinx
index 92deea3..3e8a7d7 100644
--- a/Documentation/Makefile.sphinx
+++ b/Documentation/Makefile.sphinx
@@ -92,7 +92,9 @@ mandocs:
 installmandocs:
 
 cleandocs:
-   $(Q)rm -rf $(BUILDDIR)
+   $(Q)rm -rf $(obj)/output
+   $(Q)find $(srctree)/$(src) -type d -name '__pycache__' | xargs rm -rf
+   $(Q)find $(srctree)/$(src) -name '*.pyc' -o -name '*.pyo' | xargs rm -f
 
 endif # HAVE_SPHINX
 
-- 
2.7.4

--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majord...@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html