Skip to contentSkip to conversation

media: docs: build error of userspace-api.pdf as of v6.10-rc1

DISCUSSION Akira Yokosawa 2 participants 4 messages May 29, 2024 – Jun 8, 2024 Media (V4L/DVB)

lore
Share & tools
lore
#0 lore raw

Hello Jean-Michel,

I tested "make pdfdocs" on v6.10-rc1, which ended up in a build error from xelatex:

Package tabulary Warning: No suitable columns! on input line 48770.

! Extra alignment tab has been changed to \cr. <recently read> \endtemplate

l.49179 \end{tabulary}

?

I know this won't make any sense for most kernel developers.

So, I did bisection for you.

First bad commit is:

    adb1d4655e53 ("media: v4l: Add V4L2-PIX-FMT-Y14P format")

and reverting it resolves the error.

It looks to me like said commit added two columns in the flat-table of "Luma-Only Image Formats", without updating hints to latex:

.. tabularcolumns::

above it. This results in wrong column count in the output of Sphinx's latex builder.

Please update the hint for the additional two columns.

FYI, you can test build without building the whole tree by saying:

make SPHINXDIRS=userspace-api pdfdocs

Otherwise, you will need to wait a long time.

You can ignore the extra warnings of "WARNING: undefined label:" and "WARNING: unknown document:" due to the limited scope of documentation.

Regards.
Akira

#1 lore raw

Hi Jean-Michel,

Assuming <[email protected]> is your past email account, forwarding a message bounced from
"the mail system at host perceval.ideasonboard.com" as "Undelivered".

Also, I'd suggest you to add an entry in .mailmap.

Thanks
Akira

-------- Forwarded Message --------
Subject: media: docs: build error of userspace-api.pdf as of v6.10-rc1
Date: Thu, 30 May 2024 00:12:43 +0900
From: Akira Yokosawa <[email protected]>
To: Jean-Michel Hautbois <[email protected]>
CC: Mauro Carvalho Chehab <[email protected]>, Laurent Pinchart <[email protected]>, Sakari Ailus <[email protected]>, Hans Verkuil <[email protected]>, [email protected], Jonathan Corbet <[email protected]>

Hello Jean-Michel,

I tested "make pdfdocs" on v6.10-rc1, which ended up in a build error from xelatex:

Package tabulary Warning: No suitable columns! on input line 48770.

! Extra alignment tab has been changed to \cr. <recently read> \endtemplate

l.49179 \end{tabulary}

?

I know this won't make any sense for most kernel developers.

So, I did bisection for you.

First bad commit is:

    adb1d4655e53 ("media: v4l: Add V4L2-PIX-FMT-Y14P format")

and reverting it resolves the error.

It looks to me like said commit added two columns in the flat-table of "Luma-Only Image Formats", without updating hints to latex:

.. tabularcolumns::

above it. This results in wrong column count in the output of Sphinx's latex builder.

Please update the hint for the additional two columns.

FYI, you can test build without building the whole tree by saying:

make SPHINXDIRS=userspace-api pdfdocs

Otherwise, you will need to wait a long time.

You can ignore the extra warnings of "WARNING: undefined label:" and "WARNING: unknown document:" due to the limited scope of documentation.

Regards.
Akira

#2 lore raw

Hi Akira,

Quoted 7 lines · Akira Yokosawa

Hi Jean-Michel,

Assuming <[email protected]> is your past email account, forwarding a message bounced from
"the mail system at host perceval.ideasonboard.com" as "Undelivered".

Also, I'd suggest you to add an entry in .mailmap.

Indeed, a patch just gone a few minutes ago;-)

<snip>

Quoted 6 lines

I tested "make pdfdocs" on v6.10-rc1, which ended up in a build error from xelatex:

Package tabulary Warning: No suitable columns! on input line 48770.

Quoted 8 lines

! Extra alignment tab has been changed to \cr. <recently read> \endtemplate

l.49179 \end{tabulary}

?

I know this won't make any sense for most kernel developers.

You seem to know me very well :-) !

Quoted 17 lines

So, I did bisection for you.

First bad commit is:

     adb1d4655e53 ("media: v4l: Add V4L2-PIX-FMT-Y14P format")

and reverting it resolves the error.

It looks to me like said commit added two columns in the flat-table of "Luma-Only Image Formats", without updating hints to latex:

.. tabularcolumns::

above it. This results in wrong column count in the output of Sphinx's latex builder.

Quoted 7 lines

Please update the hint for the additional two columns.

FYI, you can test build without building the whole tree by saying:

make SPHINXDIRS=userspace-api pdfdocs

Otherwise, you will need to wait a long time.

Thanks a lot for this detailed report, as I reproduced the issue quickly and easily !

Now, I would like your advice. I update the tabularcolumns to add the two new columns, but it does not fit on the page anymore [1].

What would be the best way to solve this ?

[1]: https://cryptpad.fr/file/#/2/file/C8sTCY-cv9jj-mwgzkZgjEtr/
Thanks,
JM

Quoted 7 lines

You can ignore the extra warnings of "WARNING: undefined label:" and "WARNING: unknown document:" due to the limited scope of documentation.

Regards.
Akira

#3 lore raw
Quoted 53 lines · Jean-Michel Hautbois

Hi Akira,

Quoted 7 lines · Akira Yokosawa

Hi Jean-Michel,

Assuming <[email protected]> is your past email account, forwarding a message bounced from
"the mail system at host perceval.ideasonboard.com" as "Undelivered".

Also, I'd suggest you to add an entry in .mailmap.

Indeed, a patch just gone a few minutes ago;-)

<snip>

Quoted 11 lines

I tested "make pdfdocs" on v6.10-rc1, which ended up in a build error from xelatex:

Package tabulary Warning: No suitable columns! on input line 48770.
! Extra alignment tab has been changed to \cr.
<recently read> \endtemplate
l.49179 \end{tabulary}
?

I know this won't make any sense for most kernel developers.

You seem to know me very well :-) !

Quoted 17 lines

So, I did bisection for you.

First bad commit is:

     adb1d4655e53 ("media: v4l: Add V4L2-PIX-FMT-Y14P format")

and reverting it resolves the error.

It looks to me like said commit added two columns in the flat-table of "Luma-Only Image Formats", without updating hints to latex:

.. tabularcolumns::

above it. This results in wrong column count in the output of Sphinx's latex builder.

Quoted 7 lines

Please update the hint for the additional two columns.

FYI, you can test build without building the whole tree by saying:

make SPHINXDIRS=userspace-api pdfdocs

Otherwise, you will need to wait a long time.

Quoted 7 lines

Thanks a lot for this detailed report, as I reproduced the issue quickly and easily !

Now, I would like your advice. I update the tabularcolumns to add the two new columns, but it does not fit on the page anymore [1].

What would be the best way to solve this ?

[1]: https://cryptpad.fr/file/#/2/file/C8sTCY-cv9jj-mwgzkZgjEtr/

Let me see.

It looks to me that you can reduce the width of 4th column (of "Byte 1") to 1.3cm.

If that can not make the table fit in the page width, try reduce the width of 2nd column (Of "Code").

Another option world be to reduce the font size by using \tiny instead of \scriptsize in the

    .. raw:: latex

directive above the table and reduce widths of every column.

You may need to do a couple of tries and errors.

Good luck!

Akira

Quoted 10 lines

Thanks,
JM

Quoted 7 lines

You can ignore the extra warnings of "WARNING: undefined label:" and "WARNING: unknown document:" due to the limited scope of documentation.

Regards.
Akira