Linux-Media Archive mirror
 help / color / mirror / Atom feed
From: Akira Yokosawa <akiyks@gmail.com>
To: Jean-Michel Hautbois <jeanmichel.hautbois@yoseli.org>
Cc: linux-media@vger.kernel.org, Akira Yokosawa <akiyks@gmail.com>
Subject: Re: Fwd: media: docs: build error of userspace-api.pdf as of v6.10-rc1
Date: Sun, 9 Jun 2024 00:02:40 +0900	[thread overview]
Message-ID: <83ffb1d7-fe1d-4eba-893e-f685a1addcd0@gmail.com> (raw)
In-Reply-To: <74d923bb-28b3-48f1-9da9-2311e6293ab4@yoseli.org>

On Sat, 8 Jun 2024 15:56:07 +0200, Jean-Michel Hautbois wrote:
> Hi Akira,
> 
> On 30/05/2024 03:25, Akira Yokosawa wrote:
>> Hi Jean-Michel,
>>
>> Assuming <jeanmichel.hautbois@ideasonboard.com> 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>
>>
>> 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 :-) !
> 
>>
>> 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.
> 
> 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

> Thanks,
> JM
> 
>>
>> You can ignore the extra warnings of "WARNING: undefined label:"
>> and "WARNING: unknown document:" due to the limited scope of
>> documentation.
>>
>> Regards.
>> Akira


      reply	other threads:[~2024-06-08 15:02 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-05-29 15:12 media: docs: build error of userspace-api.pdf as of v6.10-rc1 Akira Yokosawa
2024-05-30  1:25 ` Fwd: " Akira Yokosawa
2024-06-08 13:56   ` Jean-Michel Hautbois
2024-06-08 15:02     ` Akira Yokosawa [this message]

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=83ffb1d7-fe1d-4eba-893e-f685a1addcd0@gmail.com \
    --to=akiyks@gmail.com \
    --cc=jeanmichel.hautbois@yoseli.org \
    --cc=linux-media@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).