Add new system: Fix doc

GitHub is rendering this as terrible looking red highlighted text. Fix
by making this correct JSON. It appears to be caused by some JSON
validation.

[1]: https://github.com/

Add new system: Fix doc

GitHub is rendering this as terrible looking red highlighted text. Fix
by making this correct JSON. It appears to be caused by some JSON
validation.

[1]: https://github.com/openbmc/docs/blob/44f3de929bbee0dbacd024b9724fe72817fd1f48/development/add-new-system.md?plain=1#L371

This was introduced years ago by
[2]: https://github.com/openbmc/docs/commit/ace9cd140d93e92c82b9bd705efea599cc5118e6

The GitHub rendering engine could have changed in that time.

Now that this was correct syntax, prettier had an opinion.

Tested: Pushed to my fork and looks good.

Change-Id: Idddfb94269665640cd94c9d920a02c91953898e0
Signed-off-by: Gunnar Mills <gmills@us.ibm.com>

show more ...

dev-environ: utilize devtool for code modifications

This moves from utilizing the SDK to using devtool in order to make a
"hello world" test. As noted in the prior commit, this is done due to
the co

dev-environ: utilize devtool for code modifications

This moves from utilizing the SDK to using devtool in order to make a
"hello world" test. As noted in the prior commit, this is done due to
the complexity of the SDK environment vs. the more consistent (but
slower) devtool development process.

Change-Id: Iab7b6bbf82a5e36b121c1fedf916f956a35ca8e9
Signed-off-by: Andrew Geissler <geissonator@yahoo.com>

show more ...

dev-environ: remove SDK and move to devtool

This is a series of patches to clean up our development tutorials.
There's some miscellaneous cleanup combined with moving these from the
use of the SDK t

dev-environ: remove SDK and move to devtool

This is a series of patches to clean up our development tutorials.
There's some miscellaneous cleanup combined with moving these from the
use of the SDK to devtool.

SDK usage, especially by new users of OpenBMC, can be confusing. You
need to ensure you have the exact same level matching your version of
openbmc/openbmc. There are consistently questions and confusion around
the use of the SDK in discord and the mailing list. Although it can
offer some extra speed with development, it's not a good area to have
new users start with. Also, it does not seem many of our active OpenBMC
developers use it, as it seems to consistently be missing packages
required to build all of the OpenBMC repos.

Given the above, lets refocus these intro-to-openbmc tutorials on just
using bitbake and devtool. It takes a bit longer but you're guaranteed
to have the correct levels and all needed packages when doing this.

Change-Id: I7d50ea85a3489f702e98d7e8dca02e44886c2a5c
Signed-off-by: Andrew Geissler <geissonator@yahoo.com>

show more ...

prettier: re-format

Prettier is enabled in openbmc-build-scripts on Markdown, JSON, and YAML
files to have consistent formatting for these file types. Re-run the
formatter on the whole repository.

prettier: re-format

Prettier is enabled in openbmc-build-scripts on Markdown, JSON, and YAML
files to have consistent formatting for these file types. Re-run the
formatter on the whole repository.

Change-Id: I35ec9c19ae581e4dd00b515c1bba3a9c1862eeb1
Signed-off-by: Patrick Williams <patrick@stwcx.xyz>

show more ...

workflow: switch openbmc-env for setup

There are upstream changes in poky that are forcing TEMPLATECONF
to be used differently. Rather than try to track those changes,
I am switching the documentat

workflow: switch openbmc-env for setup

There are upstream changes in poky that are forcing TEMPLATECONF
to be used differently. Rather than try to track those changes,
I am switching the documentation to use `setup`, which has existed
for a number of years and is a simpler way to get started.

Signed-off-by: Patrick Williams <patrick@stwcx.xyz>
Change-Id: I258a38b455a14ebad7952e7480ece965e2b1edfd

show more ...

OWNERS: switch references from MAINTAINERS

MAINTAINERS files are now deprecated and/or removed and
replaced by OWNERS. Update the documentation accordingly.

Signed-off-by: Patrick Williams <patric

OWNERS: switch references from MAINTAINERS

MAINTAINERS files are now deprecated and/or removed and
replaced by OWNERS. Update the documentation accordingly.

Signed-off-by: Patrick Williams <patrick@stwcx.xyz>
Change-Id: I9c7e6ca3aeb41ea8f92ddc42072252d4f65de0aa

show more ...

gerrit-setup: Update rsa to ed25519

Since openssh 8.8 rsa signatures are disabled https://www.openssh.com/txt/release-8.8
Test: Ubuntu 22.04 rsa key does not give access to gerrit, Ed25519 - no acce

gerrit-setup: Update rsa to ed25519

Since openssh 8.8 rsa signatures are disabled https://www.openssh.com/txt/release-8.8
Test: Ubuntu 22.04 rsa key does not give access to gerrit, Ed25519 - no access problems

Signed-off-by: Glukhov Mikhail <mikl@greenfil.ru>
Change-Id: I7fdb9cf003f90ebbc3adabf01324db9c6d891654

show more ...

Changed occurrences of gerrit.openbmc-project.xyz

After updates Gerrit is now hosted at https://gerrit.openbmc.org.
Urls in the documentation are now updated to reflect this change.

Signed-off-by:

Changed occurrences of gerrit.openbmc-project.xyz

After updates Gerrit is now hosted at https://gerrit.openbmc.org.
Urls in the documentation are now updated to reflect this change.

Signed-off-by: Corey Hardesty <corey.hardesty@icloud.com>
Change-Id: I5adaef01abb727662575de7698483d0ec2205d28

show more ...

development: deprecate tutorial on adding new system

As noted in openbmc/docs#68, the tutorial to add a new system is
becoming a bit outdated. It was never a full end to end doc to begin
with and it

development: deprecate tutorial on adding new system

As noted in openbmc/docs#68, the tutorial to add a new system is
becoming a bit outdated. It was never a full end to end doc to begin
with and it doesn't really fit well within a tutorial anyway.

Ideally we as a community get a full blown document describing all the
different areas a user needs to update to add a new system.

This document still has some useful information within it so
for now remove it from the official tutorial README and add a
note to it that it is no longer officially supported.

Resolves openbmc/docs#68

Change-Id: I16924b7991bc5e5a9111fdfd9a0bc18828ab4363
Signed-off-by: Andrew Geissler <geissonator@yahoo.com>

show more ...

dev-environment: improve readability of qemu commands

The QEMU commands are so long that they are nearly impossible to read
or review when changes are made. Attempt to make review easier by
splitti

dev-environment: improve readability of qemu commands

The QEMU commands are so long that they are nearly impossible to read
or review when changes are made. Attempt to make review easier by
splitting the lines up a bit.

Signed-off-by: Patrick Williams <patrick@stwcx.xyz>
Change-Id: I4f348bc61f5d81d643839ef33be7135b0741c102

show more ...

dev-environment: Add info about IPMI port forwarding

IPMI uses UDP port 623 for the communication. Add information how to
forward this port to QEMU.

Signed-off-by: Konstantin Aladyshev <aladyshev22

dev-environment: Add info about IPMI port forwarding

IPMI uses UDP port 623 for the communication. Add information how to
forward this port to QEMU.

Signed-off-by: Konstantin Aladyshev <aladyshev22@gmail.com>
Change-Id: I83d9e9e6996e58b124b6f4a5c6d827589b7f9c44

show more ...

Fix spelling mistakes and typos in documentation

Change-Id: Idcc8a07ca7789176bf06d7f1fabbd7e2ce4bc494
Signed-off-by: George Keishing <gkeishin@in.ibm.com>

Correct spelling issues

A previous commit introucded several spelling issues. This change
corrects them.

See:
https://gerrit.openbmc-project.xyz/c/openbmc/docs/+/43454

Change-Id: Id913da68778e673d

Correct spelling issues

A previous commit introucded several spelling issues. This change
corrects them.

See:
https://gerrit.openbmc-project.xyz/c/openbmc/docs/+/43454

Change-Id: Id913da68778e673dd8eeb1fb2d56735e0d690934
Signed-off-by: John Edward Broadbent <jebr@google.com>

show more ...

dev-environment: adds instructions for yocto QEMU

This is a different way some are using qemu. This method provides
useful results, especially when there are complex networking issue.
I thought docu

dev-environment: adds instructions for yocto QEMU

This is a different way some are using qemu. This method provides
useful results, especially when there are complex networking issue.
I thought documenting it would be useful.

Signed-off-by: John Edward Broadbent <jebr@google.com>
Change-Id: Ie76792ff98d940d5e2e7b9770ea882c8ac287f04

show more ...

Update Web UI Development docs

- Phosphor-webui was built on AngularJS
and AngularJS goes end of life June 2021
- The phosphor-webui was replaced with webui-vue
- This doc update links to webui-vu

Update Web UI Development docs

- Phosphor-webui was built on AngularJS
and AngularJS goes end of life June 2021
- The phosphor-webui was replaced with webui-vue
- This doc update links to webui-vue contributing docs,
the webui-vue UI style guide, and custom theming documentation

Signed-off-by: Dixsie Wolmers <dixsie@ibm.com>
Change-Id: I7333b9c4e447324e9a633f8421ad1c8b896ad062

show more ...

dev-environment: Update Ubuntu version recommendation

The developent environment setup guide still suggests installing
Ubuntu 16.04, but the qemu image from CI is currently built on 18.04
and requir

dev-environment: Update Ubuntu version recommendation

The developent environment setup guide still suggests installing
Ubuntu 16.04, but the qemu image from CI is currently built on 18.04
and requires a newer libc (2.27 vs 2.25).

Change-Id: Ie064c542c05fbeb88b903291325add2cb6dd0e3b
Signed-off-by: Milton Miller <miltonm@us.ibm.com>

show more ...

Gerrit Setup: Add notice to add full name

Note to newcomers that they should add their full name in Gerrit.

Signed-off-by: Noah Brewer <noah.t.brewer@gmail.com>
Change-Id: I30bf805822e34191c0f7064a

Gerrit Setup: Add notice to add full name

Note to newcomers that they should add their full name in Gerrit.

Signed-off-by: Noah Brewer <noah.t.brewer@gmail.com>
Change-Id: I30bf805822e34191c0f7064a82ef1999f7294595

show more ...

development: The SDK is not to be installed in the BMC image

Be explicit about installing the SDK on the developer's machine and not
in the BMC qemu session.

Change-Id: Ice2005933e47bc6c6e27f49610b

development: The SDK is not to be installed in the BMC image

Be explicit about installing the SDK on the developer's machine and not
in the BMC qemu session.

Change-Id: Ice2005933e47bc6c6e27f49610b05019763e0f44
Signed-off-by: Andrew Jeffery <andrew@aj.id.au>

show more ...

development: Re-order steps in dev-environment

Reduce the opportunity for confusion around whether the SDK should be
installed on the host or in the QEMU session.

Change-Id: I504ab9a3072f18f42b6474

development: Re-order steps in dev-environment

Reduce the opportunity for confusion around whether the SDK should be
installed on the host or in the QEMU session.

Change-Id: I504ab9a3072f18f42b64745839015e425887b07f
Signed-off-by: Andrew Jeffery <andrew@aj.id.au>

show more ...

update link to qemu binary

The building of the qemu binary changed and that resulted in it going
into a different directory

Change-Id: I537a4bb18dc50576e2c4a985f6ff0c4f1b7ad953
Signed-off-by: Andre

update link to qemu binary

The building of the qemu binary changed and that resulted in it going
into a different directory

Change-Id: I537a4bb18dc50576e2c4a985f6ff0c4f1b7ad953
Signed-off-by: Andrew Geissler <geissonator@yahoo.com>

show more ...

change jenkins over to jenkins.openbmc.org

The project has moved its jenkins server over to jenkins.openbmc.org so
ensure that is reflected in the documentation

Change-Id: Ife5aeca8f552a9e851013477

change jenkins over to jenkins.openbmc.org

The project has moved its jenkins server over to jenkins.openbmc.org so
ensure that is reflected in the documentation

Change-Id: Ife5aeca8f552a9e8510134772d4104f9277ced54
Signed-off-by: Andrew Geissler <geissonator@yahoo.com>

show more ...

Fixed hello world example to launch via service

Times have changed since this hello world document
was first added. Service files have hardcoded
paths to where applications live so I changed the
te

Fixed hello world example to launch via service

Times have changed since this hello world document
was first added. Service files have hardcoded
paths to where applications live so I changed the
text to encourage the use of overlay instead of
the old /usr/local/bin approach which failed to
launch the users application via systemctl restart

Tested: I verified the markdown text change and ran
example verbatim using the Romulus QEMU environment

Signed-off-by: Chris Austen <chrishausten@gmail.com>
Change-Id: Iba1d7cb3521e8fc2ee5793121cff40bc249e1f05

show more ...

phosphor-state-manager change updates

phosphor-state-manager moved to meson recently, update the documentation
to reflect this. Some feedback noted the need to stop the state manager
service prior t

phosphor-state-manager change updates

phosphor-state-manager moved to meson recently, update the documentation
to reflect this. Some feedback noted the need to stop the state manager
service prior to launching the hello world application due to D-Bus name
contention. Added that change in here as well.

Change-Id: Ifec850385e923b09759492017ad5b0efad1ad958
Signed-off-by: Andrew Geissler <geissonator@yahoo.com>

show more ...

Move sensor-architecture.md under architecture/

Change-Id: I118f6a95eea8d28b2aefce6c73bc2a4b726081fc
Signed-off-by: Gunnar Mills <gmills@us.ibm.com>

Update development guide to use new SDK file name

A yocto update changed the name of the SDK file. The change was from
armv6 to arm1176jzs. Update the documentation to reflect this.

Change-Id: Ic22

Update development guide to use new SDK file name

A yocto update changed the name of the SDK file. The change was from
armv6 to arm1176jzs. Update the documentation to reflect this.

Change-Id: Ic22786881a2d5884ac6fd7965007ea8c714b8661
Signed-off-by: Andrew Geissler <geissonator@yahoo.com>

show more ...