Re: [docs] [master] Pull request

Re: [docs] [master] Pull request

[Michael Opdenacker]

Hi Richard,

On 4/15/21 5:02 PM, Michael Opdenacker wrote:
> Hi Richard,
>
> The following changes since commit 4f7f451df266a307b34bf145b29291ca85eb882f:
>
>   docs: add a top level page for bitbake documentation (2021-04-09
> 09:00:53 +0200)
>
> are available in the Git repository at:
>
>   git://git.yoctoproject.org/yocto-docs master-next

Thanks for having merged this pull request!

Cheers,

Michael.

-- 
Michael Opdenacker, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com

Re: [docs] [master] Pull request

[Michael Opdenacker]

Hi Bruce,

On 2/24/24 at 04:35, Bruce Ashfield wrote:
> On Fri, Feb 23, 2024 at 1:47 PM Michael Opdenacker via
> lists.yoctoproject.org
> <michael.opdenacker=bootlin.com@lists.yoctoproject.org> wrote:
>> Hi Richard,
>>
>> The following changes since commit 79530aeb97976b9a63bf04ed247f98061fc9d737:
>>
>>     release-notes-4.3: fix spacing (2024-02-05 15:22:33 +0100)
>>
>> are available in the Git repository at:
>>
>>     git://git.yoctoproject.org/yocto-docs master-next
>>
>> for you to fetch changes up to b63e6a5ac71b347961037b7ee496c2e958ad22c5:
>>
>>     dev-manual: packages: need enough free space (2024-02-23 09:50:37 +0100)
>>
>> ----------------------------------------------------------------
>> Adrian Freihofer (1):
>>         sdk-manual: extensible.rst: cover devtool ide-sdk
>>
>> Khem Raj (1):
>>         ref-manual: variables: remove PYTHON_PN
>>
>> Lee Chee Yang (1):
>>         migration-guide: add release notes for 4.3.3
>>
>> Michael Opdenacker (5):
>>         ref-manual: system-requirements: update packages to build docs
>>         ref-manual: release-process: grammar fix
>>         manuals: suppress excess use of "following" word
>>         dev-manual: packages: clarify shared PR service constraint
>>         dev-manual: packages: need enough free space
>>
>> Simone Weiß (1):
>>         dev-manual: Rephrase spdx creation
>>
>> Vyacheslav Yurkov (1):
>>         manuals: kernel-dev: Fix BSP in recipe space
> As I commented on the patch itself, the above documentation tweak
> isn't correct and should be dropped.


Oops, thanks for highlighting this.
I removed this commit from my branch.
Cheers
Michael.

-- 
Michael Opdenacker, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com

Re: [docs] [master] Pull request

[Bruce Ashfield]

On Fri, Feb 23, 2024 at 1:47 PM Michael Opdenacker via
lists.yoctoproject.org
<michael.opdenacker=bootlin.com@lists.yoctoproject.org> wrote:
>
> Hi Richard,
>
> The following changes since commit 79530aeb97976b9a63bf04ed247f98061fc9d737:
>
>    release-notes-4.3: fix spacing (2024-02-05 15:22:33 +0100)
>
> are available in the Git repository at:
>
>    git://git.yoctoproject.org/yocto-docs master-next
>
> for you to fetch changes up to b63e6a5ac71b347961037b7ee496c2e958ad22c5:
>
>    dev-manual: packages: need enough free space (2024-02-23 09:50:37 +0100)
>
> ----------------------------------------------------------------
> Adrian Freihofer (1):
>        sdk-manual: extensible.rst: cover devtool ide-sdk
>
> Khem Raj (1):
>        ref-manual: variables: remove PYTHON_PN
>
> Lee Chee Yang (1):
>        migration-guide: add release notes for 4.3.3
>
> Michael Opdenacker (5):
>        ref-manual: system-requirements: update packages to build docs
>        ref-manual: release-process: grammar fix
>        manuals: suppress excess use of "following" word
>        dev-manual: packages: clarify shared PR service constraint
>        dev-manual: packages: need enough free space
>
> Simone Weiß (1):
>        dev-manual: Rephrase spdx creation
>
> Vyacheslav Yurkov (1):
>        manuals: kernel-dev: Fix BSP in recipe space

As I commented on the patch itself, the above documentation tweak
isn't correct and should be dropped.

Bruce

>
>   documentation/bsp-guide/bsp.rst                        |   9 ++--
>   documentation/dev-manual/building.rst                  |   2 +-
>   documentation/dev-manual/debugging.rst                 |   8 ++--
>   documentation/dev-manual/development-shell.rst         |   2 +-
>   documentation/dev-manual/layers.rst                    |   8 ++--
>   documentation/dev-manual/libraries.rst                 |   4 +-
>   documentation/dev-manual/licenses.rst                  |   2 +-
>   documentation/dev-manual/new-machine.rst               |   2 +-
>   documentation/dev-manual/new-recipe.rst                |   8 ++--
>   documentation/dev-manual/packages.rst                  |  22 +++++++---
>   documentation/dev-manual/prebuilt-libraries.rst        |   4 +-
>   documentation/dev-manual/python-development-shell.rst  |   2 +-
>   documentation/dev-manual/qemu.rst                      |   4 +-
>   documentation/dev-manual/runtime-testing.rst           |   4 +-
>   documentation/dev-manual/sbom.rst                      |  40
> ++++++++++-------
>   documentation/dev-manual/speeding-up-build.rst         |   4 +-
>   documentation/dev-manual/start.rst                     |   6 +--
>   documentation/kernel-dev/advanced.rst                  |   2 +-
>   documentation/kernel-dev/common.rst                    |   4 +-
>   documentation/migration-guides/migration-1.5.rst       |   6 +--
>   documentation/migration-guides/migration-2.2.rst       |   6 +--
>   documentation/migration-guides/migration-2.4.rst       |   8 ----
>   documentation/migration-guides/migration-2.5.rst       |   8 +---
>   documentation/migration-guides/migration-4.0.rst       |   2 +-
>   documentation/migration-guides/release-4.3.rst         |   1 +
>   documentation/migration-guides/release-notes-4.3.3.rst | 200
> +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
>   documentation/overview-manual/concepts.rst             |  18 ++++----
>   documentation/overview-manual/yp-intro.rst             |   2 +-
>   documentation/ref-manual/classes.rst                   |   8 ++--
>   documentation/ref-manual/devtool-reference.rst         |   4 +-
>   documentation/ref-manual/faq.rst                       |   6 +--
>   documentation/ref-manual/features.rst                  |   2 +-
>   documentation/ref-manual/images.rst                    |   2 +-
>   documentation/ref-manual/release-process.rst           |   8 ++--
>   documentation/ref-manual/structure.rst                 |   2 +-
>   documentation/ref-manual/system-requirements.rst       |  10 ++---
>   documentation/ref-manual/terms.rst                     |   4 +-
>   documentation/ref-manual/variables.rst                 |  22 ++--------
>   documentation/sdk-manual/appendix-obtain.rst           |  10 ++---
>   documentation/sdk-manual/extensible.rst                | 283
> +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++-
>   documentation/sdk-manual/intro.rst                     |   2 +-
>   documentation/toaster-manual/setup-and-use.rst         |   4 +-
>   42 files changed, 614 insertions(+), 141 deletions(-)
>   create mode 100644 documentation/migration-guides/release-notes-4.3.3.rst
>
> Thank you in advance
> Cheers
> Michael.
>
> --
> Michael Opdenacker, Bootlin
> Embedded Linux and Kernel engineering
> https://bootlin.com
>
>
> -=-=-=-=-=-=-=-=-=-=-=-
> Links: You receive all messages sent to this group.
> View/Reply Online (#4867): https://lists.yoctoproject.org/g/docs/message/4867
> Mute This Topic: https://lists.yoctoproject.org/mt/104534340/1050810
> Group Owner: docs+owner@lists.yoctoproject.org
> Unsubscribe: https://lists.yoctoproject.org/g/docs/unsub [bruce.ashfield@gmail.com]
> -=-=-=-=-=-=-=-=-=-=-=-
>


-- 
- Thou shalt not follow the NULL pointer, for chaos and madness await
thee at its end
- "Use the force Harry" - Gandalf, Star Trek II

Re: [docs] [master] Pull request

[Michael Opdenacker]

Hi Richard,

On 20.10.23 at 15:42, Richard Purdie wrote:
> On Fri, 2023-10-20 at 15:26 +0200, Michael Opdenacker wrote:
>> Hi Richard,
>>
>> The following changes since commit ceb1812e63b9fac062f886c2a1dde23137c0e1ed:
>>
>>     migration-guides: add release notes for 4.0.13 (2023-10-06 09:59:00
>> +0200)
>>
>> are available in the Git repository at:
>>
>>     git://git.yoctoproject.org/yocto-docs master-next
>>
>> for you to fetch changes up to 65b62118da6f355e56c489c6be08ba9ea94b9f04:
>>
> Thanks!
>
> As part of sorting the 4.3 relase, I did create a nanbield docs repo
> branch btw so patches are currently only merged to master. I can also
> merge to nanbield if all these are appropriate for the release.

Perfect, thanks!
To the best of my knowledge (and my checks), these changes can also be 
merged into nanbield. In particular, I checked that patchtest and 
unimplemented-ptest checks made it to nanbield (you know that).

Cheers
Michael.

-- 
Michael Opdenacker, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com

Re: [docs] [master] Pull request

[Michael Opdenacker]

Hi Richard,

Oops, Charlie Johnston's patches are not ready to merge yet (waiting for 
merged in OE-core), so here's an update without these patches:

The following changes since commit efa1c57ecec934998792b7851b4a162be92c8b23:

   ref-manual: document image-specific variant of INCOMPATIBLE_LICENSE 
(2023-07-31 11:30:46 +0200)

are available in the Git repository at:

   git://git.yoctoproject.org/yocto-docs master-next

for you to fetch changes up to 9a9ecbe46c74280b3741389829764b70671975e6:

   dev-manual: disk-space: mention faster "find" command to trim sstate 
cache (2023-08-17 16:54:46 +0200)

----------------------------------------------------------------
Daniel Semkowicz (1):
       dev-manual: wic.rst: Update native tools build command

Frederic Martinsons (1):
       ref-manual: classes.rst: suppress rust-hello-world reference, add 
ptest-cargo class

Michael Opdenacker (13):
       manuals: create a dedicated "Contributor Guide" document
       ref-manual: classes.rst: fix location of _ref-classes-ccache
       ref-manual: update supported distro versions
       contributor-guide: add missing links to mailing lists
       contributor-guide: add section about why we use mailing lists
       contributor-guide: add recipe style guide
       ref-manual: remove AUTHOR variable
       contributor guide: call section "Reporting a defect"
       contributor-guide: remove obsolete pkg-config guidelines
       contributor guide: remove unnecessary information about mailing lists
       contributor-guide: clarification about patchtest
       contributor guide: update instructions for making and sharing changes
       dev-manual: disk-space: mention faster "find" command to trim 
sstate cache

  documentation/bsp-guide/bsp.rst |   4 +-
  documentation/contributor-guide/identify-component.rst |  29 +++++++++++++
  documentation/contributor-guide/index.rst |  26 ++++++++++++
  documentation/contributor-guide/recipe-style-guide.rst | 257 
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
  documentation/contributor-guide/report-defect.rst |  67 
+++++++++++++++++++++++++++++
  documentation/{dev-manual/changes.rst => 
contributor-guide/submit-changes.rst} | 290 
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++------------------------------------------------------------------
  documentation/dev-manual/debugging.rst |   7 +--
  documentation/dev-manual/disk-space.rst |  34 +++++++++++----
  documentation/dev-manual/index.rst |   3 --
  documentation/dev-manual/new-recipe.rst |  54 ++---------------------
  documentation/dev-manual/start.rst |   9 ++--
  documentation/dev-manual/vulnerabilities.rst |   2 +-
  documentation/dev-manual/wic.rst |   2 +-
  documentation/index.rst |   1 +
  documentation/overview-manual/development-environment.rst |  19 ++++-----
  documentation/ref-manual/classes.rst |  26 +++++++++---
  documentation/ref-manual/resources.rst |   7 ++-
  documentation/ref-manual/system-requirements.rst |  43 +++++++++++++------
  documentation/ref-manual/variables.rst |   4 --
  19 files changed, 617 insertions(+), 267 deletions(-)
  create mode 100644 documentation/contributor-guide/identify-component.rst
  create mode 100644 documentation/contributor-guide/index.rst
  create mode 100644 documentation/contributor-guide/recipe-style-guide.rst
  create mode 100644 documentation/contributor-guide/report-defect.rst
  rename documentation/{dev-manual/changes.rst => 
contributor-guide/submit-changes.rst} (69%)

Thank you in advance
Michael.

-- 
Michael Opdenacker, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com

Re: [docs] [master] Pull request

[Richard Purdie]

On Fri, 2022-08-12 at 18:55 +0200, Michael Opdenacker wrote:
> Gentle reminder for this pull request. It's still applicable as "master" 
> and "master-next" haven't changed.

Merged, sorry about the delay.

Cheers,

Richard

Re: [docs] [master] Pull request

[Richard Purdie]

On Wed, 2022-07-20 at 15:08 +0200, Quentin Schulz wrote:
> Hi Richard,
> 
> On 7/20/22 15:01, Michael Opdenacker via lists.yoctoproject.org wrote:
> > Hi Richard,
> > 
> > Here are changes for master, in particular the update of the hash server 
> > host (happening soon) and the set_versions.py update from Quentin which 
> > will allow to take his changes to run-docs-build.
> > 
> > Thank you in advance
> > Cheers
> > Michael.
> > 
> > -- 
> > 
> > The following changes since commit 
> > afa895871e8ec18f4861f48f70b8a54cc2e4cb98:
> > 
> >    documentation: remove obsolete PEP517_BUILD_API (2022-07-15 12:30:30 
> > +0100)
> > 
> > are available in the Git repository at:
> > 
> >    git://git.yoctoproject.org/yocto-docs master-next
> > 
> > for you to fetch changes up to 5004957d1c65d03d3e296bc9f0a00982457a27f8:
> > 
> >    docs: BB_HASHSERVE_UPSTREAM: update to new host (2022-07-20 14:50:03 
> > +0200)
> > 
> > ----------------------------------------------------------------
> > Aatir Manzur (1):
> >        ref-manual: Sphinx note directive for DISTRO_FEATURES definition
> > 
> > Lee Chee Yang (1):
> >        migration guides: release notes for 4.0.2
> > 
> > Michael Opdenacker (1):
> >        docs: BB_HASHSERVE_UPSTREAM: update to new host
> > 
> > Quentin Schulz (2):
> >        docs: ref-manual: variables: remove sphinx directive from literal 
> > block
> >        docs: auto-generate releases.rst
> > 
> 
> This will likely break the autobuilder unless 
> https://lore.kernel.org/yocto-docs/20220719081214.1924835-3-foss+yocto@0leil.net/T/#u 
> is applied in yocto-autobuilder at the same time.

Thanks, I merged both.

Cheers,

Richard

Re: [docs] [master] Pull request

[Quentin Schulz]

Hi Richard,

On 7/20/22 15:01, Michael Opdenacker via lists.yoctoproject.org wrote:
> Hi Richard,
> 
> Here are changes for master, in particular the update of the hash server 
> host (happening soon) and the set_versions.py update from Quentin which 
> will allow to take his changes to run-docs-build.
> 
> Thank you in advance
> Cheers
> Michael.
> 
> -- 
> 
> The following changes since commit 
> afa895871e8ec18f4861f48f70b8a54cc2e4cb98:
> 
>    documentation: remove obsolete PEP517_BUILD_API (2022-07-15 12:30:30 
> +0100)
> 
> are available in the Git repository at:
> 
>    git://git.yoctoproject.org/yocto-docs master-next
> 
> for you to fetch changes up to 5004957d1c65d03d3e296bc9f0a00982457a27f8:
> 
>    docs: BB_HASHSERVE_UPSTREAM: update to new host (2022-07-20 14:50:03 
> +0200)
> 
> ----------------------------------------------------------------
> Aatir Manzur (1):
>        ref-manual: Sphinx note directive for DISTRO_FEATURES definition
> 
> Lee Chee Yang (1):
>        migration guides: release notes for 4.0.2
> 
> Michael Opdenacker (1):
>        docs: BB_HASHSERVE_UPSTREAM: update to new host
> 
> Quentin Schulz (2):
>        docs: ref-manual: variables: remove sphinx directive from literal 
> block
>        docs: auto-generate releases.rst
> 

This will likely break the autobuilder unless 
https://lore.kernel.org/yocto-docs/20220719081214.1924835-3-foss+yocto@0leil.net/T/#u 
is applied in yocto-autobuilder at the same time.

Cheers,
Quentin

Re: [docs] [master] Pull request

[Richard Purdie]

On Fri, 2022-02-18 at 19:03 +0100, Michael Opdenacker wrote:
> On 2/18/22 18:58, Richard Purdie wrote:
> > 
> > Merged, thanks. Not sure if there was an issue with Peter's patch?
> 
> 
> Great, thanks!
> What patch from Peter are you referring to? I hope I didn't miss any...

https://lists.yoctoproject.org/g/docs/topic/patch_1_2_manuals_remove/88760254

Cheers,

Richard

Re: [docs] [master] Pull request

[Michael Opdenacker]

On 2/18/22 18:58, Richard Purdie wrote:
>
> Merged, thanks. Not sure if there was an issue with Peter's patch?


Great, thanks!
What patch from Peter are you referring to? I hope I didn't miss any...
Cheers
Michael.

-- 
Michael Opdenacker, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com

Re: [docs] [master] Pull request

[Michael Opdenacker]

Hi Richard,

On 8/6/21 7:09 PM, Michael Opdenacker wrote:
> Hello Richard,
>
> The following changes since commit 3c98afb0fefd889e8036639d9a2c775b73b237c2:
>
>   releases: update to include 3.3.1 (2021-08-03 12:48:32 -0700)
>
> are available in the Git repository at:
>
>   git://git.yoctoproject.org/yocto-docs master-next
>   https://git.yoctoproject.org/cgit/cgit.cgi/yocto-docs/log/?h=master-next
>
> for you to fetch changes up to a21137ed4bbf53ca2dbaaf1beb0155eac3dbfba5:

I made a last minute change to the "master-next" branch. Glad that you
haven't merged it yet.
The last commit is now
http://git.yoctoproject.org/cgit/cgit.cgi/yocto-docs/commit/?h=master-next&id=55886d211218b3a604c2f8a29c854685ebf284dd

Now everything is ready ;-)

Thanks,
Michael.

-- 
Michael Opdenacker, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com

Re: [docs] [master] Pull request

[Michael Opdenacker]

On 5/3/21 2:41 PM, Richard Purdie wrote:
> I've merged it with it removed. It should/can be dropped from there and I'll
> alter my scripts so I don't push there. Its just a bit of confusion from when
> I was handling the docs patches...


Understood. Thanks for having taken care of this.
Michael.

-- 
Michael Opdenacker, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com

Re: [docs] [master] Pull request

[Richard Purdie]

On Mon, 2021-05-03 at 14:40 +0200, Michael Opdenacker wrote:
> Hi Richard,
> 
> On 4/30/21 11:42 PM, Richard Purdie wrote:
> > Definitely not. I was trying to get some basic text pulled together on a couple of 
> > topics but keep getting distracted. I should probably put that somewhere else locally
> > and stop it leaking out. It was meant to be done and sent long before now...
> 
> 
> Oops, I should have paid attention to this too.
> 
> May I remove it from master-next so that I can submit the pull request
> again? I could keep a backup somewhere too.

I've merged it with it removed. It should/can be dropped from there and I'll
alter my scripts so I don't push there. Its just a bit of confusion from when
I was handling the docs patches...

Cheers,

Richard

Re: [docs] [master] Pull request

[Michael Opdenacker]

Hi Richard,

On 4/30/21 11:42 PM, Richard Purdie wrote:
> Definitely not. I was trying to get some basic text pulled together on a couple of 
> topics but keep getting distracted. I should probably put that somewhere else locally
> and stop it leaking out. It was meant to be done and sent long before now...


Oops, I should have paid attention to this too.

May I remove it from master-next so that I can submit the pull request
again? I could keep a backup somewhere too.

Cheers,

Michael.

-- 
Michael Opdenacker, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com

Re: [docs] [master] Pull request

[Richard Purdie]

On Fri, 2021-04-30 at 20:56 +0000, Quentin Schulz wrote:
> Hi Michael,
> 
> On April 30, 2021 5:58:59 PM UTC, Michael Opdenacker <michael.opdenacker@bootlin.com> wrote:
> > Hi Richard,
> > 
> > The following changes since commit cefd66301a40f9048499879674e467543f704c44:
> > 
> >   ref-manual/variables.rst: Add incompatibility warning for
> > SERIAL_CONSOLES_CHECK (2021-04-23 17:26:15 +0200)
> > 
> > are available in the Git repository at:
> > 
> >   git://git.yoctoproject.org/yocto-docs master-next
> >   http://git.yoctoproject.org/cgit/cgit.cgi/yocto-docs/log/?h=master-next
> > 
> > for you to fetch changes up to a0fc2e1b4bdc8411b97d02d34bfecfc888b6eb0c:
> > 
> >   sdk-manual: fix broken formatting of sample command (2021-04-30
> > 19:46:12 +0200)
> > 
> > ----------------------------------------------------------------
> > Alexander Kanavin (1):
> >       dev-manual/common-tasks.rst: correct the documentation for debuginfod
> > 
> > Michael Opdenacker (1):
> >       dev-manual: update references to Docker installation instructions
> > 
> > Richard Purdie (1):
> >       test-manual: WIP
> > 
> 
> Not sure this one's ready for master yet :)

Definitely not. I was trying to get some basic text pulled together on a couple of 
topics but keep getting distracted. I should probably put that somewhere else locally
and stop it leaking out. It was meant to be done and sent long before now...

Cheers,

Richard

Re: [docs] [master] Pull request

[Quentin Schulz]

Hi Michael,

On April 30, 2021 5:58:59 PM UTC, Michael Opdenacker <michael.opdenacker@bootlin.com> wrote:
>Hi Richard,
>
>The following changes since commit cefd66301a40f9048499879674e467543f704c44:
>
>  ref-manual/variables.rst: Add incompatibility warning for
>SERIAL_CONSOLES_CHECK (2021-04-23 17:26:15 +0200)
>
>are available in the Git repository at:
>
>  git://git.yoctoproject.org/yocto-docs master-next
>  http://git.yoctoproject.org/cgit/cgit.cgi/yocto-docs/log/?h=master-next
>
>for you to fetch changes up to a0fc2e1b4bdc8411b97d02d34bfecfc888b6eb0c:
>
>  sdk-manual: fix broken formatting of sample command (2021-04-30
>19:46:12 +0200)
>
>----------------------------------------------------------------
>Alexander Kanavin (1):
>      dev-manual/common-tasks.rst: correct the documentation for debuginfod
>
>Michael Opdenacker (1):
>      dev-manual: update references to Docker installation instructions
>
>Richard Purdie (1):
>      test-manual: WIP
>

Not sure this one's ready for master yet :)

Cheers,
Quentin

Re: [docs] [master] Pull request

[Michael Opdenacker]

On 4/23/21 5:49 PM, Richard Purdie wrote
> Merged, thanks.


Great, many thanks !

Michael.

-- 
Michael Opdenacker, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com