From: Paul Eggleton <bluelightning@bluelightning.org>
To: docs@lists.yoctoproject.org, michael.opdenacker@bootlin.com
Subject: Re: [docs] [PATCH 13/34] ref-manual: add pressure limit variable documentation
Date: Mon, 17 Oct 2022 09:38:25 +1300 [thread overview]
Message-ID: <4749032.GXAFRqVoOG@linc> (raw)
In-Reply-To: <936247d7-5cb0-2ec3-1a3e-15aa647d53c3@bootlin.com>
On Tuesday, 11 October 2022 23:30:50 NZDT Michael Opdenacker via
lists.yoctoproject.org wrote:
> Actually, these have recently been accepted in the BitBake manual (the
> patches from Aryaman got accepted after he left WindRiver), though
> apparently with fewer details:
> https://git.openembedded.org/bitbake/commit/?id=c014281f72f4f54ec8e681ef2b8e
> 1080de9ab5cf
>
> Shall we submit your updates to the Bitbake manual instead? This way, we
> don't have these variables documented in two different places.
Ah, oops - I missed that. I'm OK with that for now; however, and I may have
also missed if this has been discussed recently, but it's my opinion that all
variables documented in the BitBake manual should also be in the Yocto
reference manual, since they are two different contexts - the catch being that
for some variables there is information you can't reasonably include in the
bitbake manual since it relies on some definitions unique to OE so the entries
can't always be copied exactly. If on the other hand some variables only
appear in the BitBake manual, there will be people who just won't find them.
To avoid things getting out of sync, we could potentially have a script that
would check for and report on variables present in the BitBake manual that
aren't in the Yocto reference manual. I'd be happy to write such a script.
Cheers
Paul
next prev parent reply other threads:[~2022-10-16 20:38 UTC|newest]
Thread overview: 52+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-10-10 9:23 [PATCH 00/34] 4.1 release notes and related changes Paul Eggleton
2022-10-10 9:23 ` [PATCH 01/34] migration-general: add section on using buildhistory Paul Eggleton
2022-10-11 8:08 ` [docs] " Michael Opdenacker
2022-10-10 9:23 ` [PATCH 02/34] ref-manual: add DISABLE_STATIC Paul Eggleton
2022-10-10 9:23 ` [PATCH 03/34] ref-manual: expand documentation on image-buildinfo class Paul Eggleton
2022-10-10 9:23 ` [PATCH 04/34] ref-manual: add WATCHDOG_TIMEOUT to variable glossary Paul Eggleton
2022-10-10 9:23 ` [PATCH 05/34] ref-manual: correct default for BUILDHISTORY_COMMIT Paul Eggleton
2022-10-10 9:23 ` [PATCH 06/34] ref-manual: document new github-releases class Paul Eggleton
2022-10-10 9:23 ` [PATCH 07/34] ref-manual: add a note to ssh-server-dropbear feature Paul Eggleton
2022-10-10 9:23 ` [PATCH 08/34] ref-manual: sync supported distro list with code Paul Eggleton
2022-10-11 8:20 ` [docs] " Michael Opdenacker
2022-10-16 19:16 ` Paul Eggleton
2022-10-17 9:04 ` Michael Opdenacker
2022-10-10 9:23 ` [PATCH 09/34] ref-manual: update buildpaths QA check documentation Paul Eggleton
2022-10-10 9:23 ` [PATCH 10/34] ref-manual: add UBOOT_MKIMAGE_SIGN Paul Eggleton
[not found] ` <10891.1665397447952895356@lists.yoctoproject.org>
2022-10-10 19:37 ` [docs] " Paul Eggleton
2022-10-10 9:23 ` [PATCH 11/34] ref-manual: add DEV_PKG_DEPENDENCY Paul Eggleton
2022-10-10 9:23 ` [PATCH 12/34] ref-manual: add SDK_TOOLCHAIN_LANGS Paul Eggleton
2022-10-10 9:23 ` [PATCH 13/34] ref-manual: add pressure limit variable documentation Paul Eggleton
2022-10-11 10:30 ` [docs] " Michael Opdenacker
2022-10-16 20:38 ` Paul Eggleton [this message]
2022-10-17 8:15 ` Michael Opdenacker
2022-10-17 8:26 ` Quentin Schulz
2022-10-17 8:31 ` Michael Opdenacker
2022-10-10 9:24 ` [PATCH 14/34] ref-manual: add pypi class Paul Eggleton
[not found] ` <7844.1665397383974110998@lists.yoctoproject.org>
2022-10-10 19:36 ` [docs] " Paul Eggleton
2022-10-10 9:24 ` [PATCH 15/34] ref-manual: update pypi documentation for CVE_PRODUCT default in 4.1 Paul Eggleton
2022-10-10 9:24 ` [PATCH 16/34] ref-manual: add CVE_CHECK_SHOW_WARNINGS Paul Eggleton
2022-10-10 13:55 ` [docs] " Peter Kjellerstedt
2022-10-10 19:34 ` Paul Eggleton
2022-10-10 9:24 ` [PATCH 17/34] ref-manual: add info on buildtools-make-tarball Paul Eggleton
2022-10-12 9:51 ` [docs] " Michael Opdenacker
2022-10-10 9:24 ` [PATCH 18/34] ref-manual: add FIT_PAD_ALG Paul Eggleton
2022-10-10 9:24 ` [PATCH 19/34] ref-manual: add CVE_DB_UPDATE_INTERVAL Paul Eggleton
2022-10-10 9:24 ` [PATCH 20/34] ref-manual: add KERNEL_DEPLOY_DEPEND Paul Eggleton
2022-10-10 9:24 ` [PATCH 21/34] ref-manual: add MOUNT_BASE variable Paul Eggleton
2022-10-10 9:24 ` [PATCH 22/34] ref-manual: remove reference to testimage-auto class Paul Eggleton
2022-10-10 9:24 ` [PATCH 23/34] Update documentation for classes split Paul Eggleton
2022-10-10 9:24 ` [PATCH 24/34] ref-manual: complementary package installation recommends Paul Eggleton
2022-10-10 9:24 ` [PATCH 25/34] ref-manual: remove reference to largefile in DISTRO_FEATURES Paul Eggleton
2022-10-10 9:24 ` [PATCH 26/34] ref-manual: add missing features Paul Eggleton
2022-10-10 9:24 ` [PATCH 27/34] ref-manual: add serial-autologin-root to IMAGE_FEATURES documentation Paul Eggleton
2022-10-10 9:24 ` [PATCH 28/34] ref-manual: add previous overlayfs-etc variables Paul Eggleton
2022-10-10 9:24 ` [PATCH 29/34] ref-manual: add OVERLAYFS_ETC_EXPOSE_LOWER Paul Eggleton
2022-10-10 9:24 ` [PATCH 30/34] ref-manual: add WIRELESS_DAEMON Paul Eggleton
2022-10-10 9:24 ` [PATCH 31/34] ref-manual: add section for create-spdx class Paul Eggleton
2022-10-10 9:24 ` [PATCH 32/34] ref-manual: add overlayfs class variables Paul Eggleton
2022-10-10 9:24 ` [PATCH 33/34] ref-manual: add OVERLAYFS_QA_SKIP Paul Eggleton
2022-10-10 9:24 ` [PATCH 34/34] Add 4.1 migration guide & release notes Paul Eggleton
2022-10-11 19:31 ` [docs] " Michael Opdenacker
[not found] ` <171D1A9DBE3157A3.17458@lists.yoctoproject.org>
2022-10-12 8:33 ` Michael Opdenacker
[not found] ` <171D4544CA71D54E.3472@lists.yoctoproject.org>
2022-10-12 8:50 ` Michael Opdenacker
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=4749032.GXAFRqVoOG@linc \
--to=bluelightning@bluelightning.org \
--cc=docs@lists.yoctoproject.org \
--cc=michael.opdenacker@bootlin.com \
/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