public inbox for docs@lists.yoctoproject.org
 help / color / mirror / Atom feed
From: "Antonin Godard" <antonin.godard@bootlin.com>
To: "Quentin Schulz" <quentin.schulz@cherry.de>,
	"Quentin Schulz" <foss@0leil.net>, <docs@lists.yoctoproject.org>
Subject: Re: [docs] [PATCH RFC v2 2/2] tools: add script for building documentation inside containers
Date: Fri, 24 Jan 2025 12:27:24 +0100	[thread overview]
Message-ID: <D7A9MWYP0NSW.2LQS3GNQQDYLJ@bootlin.com> (raw)
In-Reply-To: <ba64fc90-e388-4753-bc4d-baa4a1417a55@cherry.de>

Hi Quentin,

On Mon Jan 13, 2025 at 5:43 PM CET, Quentin Schulz wrote:
[...]
>>> +# relative to the location of the dockerfile
>>> +COPY --chmod=777 ${DOCS} /temp/host_packages_docs.sh
>>> +COPY --chmod=777 ${DOCS_PDF} /temp/host_packages_docs_pdf.sh
>>> +COPY --chmod=777 ${PIP3} /temp/pip3_docs.sh
>> 
>> A bit of a hacky workaround, but maybe here run
>> sed -i 's/zypper/zypper --non-interactive/ ...' on the scripts? So we don't need
>> to provide this option in the doc.
>> 
>
> Another dirty hack is to have a shell zypper wrapper that calls 
> /usr/bin/zypper --non-interactive.
>
> Up to you.

Let's go for a sed in the Containerfile.

[...]
>> 
>> Can we have a way of listing images here so a user doesn't need to read the
>> script and guess which one to use?
>> 
>
> The ones in 
> https://docs.yoctoproject.org/ref-manual/system-requirements.html#supported-linux-distributions? 
> Though I guess Rocky and CentOS are still missing. Do we want the name 
> of the distro or the name + the version? Basically we can end up with 
> two places where this information will be, in the docs and in the container.

I was thinking of just listing what the script supports, not from the docs. I
did that in my version of the script. Something like `./build-docs-container
list`. In your case, it would probably extract that information from the
Containerfiles.

Antonin

-- 
Antonin Godard, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com


      reply	other threads:[~2025-01-24 11:27 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-12-17 16:08 [PATCH RFC v2 0/2] add script for containers building the documentation Quentin Schulz
2024-12-17 16:08 ` [PATCH RFC v2 1/2] docs: use literalinclude for system requirements Quentin Schulz
2024-12-17 16:08 ` [PATCH RFC v2 2/2] tools: add script for building documentation inside containers Quentin Schulz
2024-12-26 10:41   ` [docs] " Antonin Godard
2025-01-13 16:43     ` Quentin Schulz
2025-01-24 11:27       ` Antonin Godard [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=D7A9MWYP0NSW.2LQS3GNQQDYLJ@bootlin.com \
    --to=antonin.godard@bootlin.com \
    --cc=docs@lists.yoctoproject.org \
    --cc=foss@0leil.net \
    --cc=quentin.schulz@cherry.de \
    /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