anti-patterns: Ill-defined data structuring in `lg2` message strings

Change-Id: Ib4cddad2425b5ab83f3bb248995c5a52806714dd
Signed-off-by: Andrew Jeffery <andrew@codeconstruct.com.au>

anti-patterns: Placing internal headers in a parallel subtree

Don't segregate internal headers into an `include/` directory.

Discord discussion:

https://discord.com/channels/775381525260664832/867

anti-patterns: Placing internal headers in a parallel subtree

Don't segregate internal headers into an `include/` directory.

Discord discussion:

https://discord.com/channels/775381525260664832/867820390406422538/1009977383077564467

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

show more ...

anti-patterns: Add very long lambda callbacks anti-pattern

The content is largely stolen from the following bmcweb change:

https://gerrit.openbmc.org/c/openbmc/bmcweb/+/60384

I felt the advice was

anti-patterns: Add very long lambda callbacks anti-pattern

The content is largely stolen from the following bmcweb change:

https://gerrit.openbmc.org/c/openbmc/bmcweb/+/60384

I felt the advice was too broadly applicable to stay buried in the
bmcweb repo, so here we are.

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

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 ...

anti-patterns: Add DBus GPIO interface anti-pattern

Every so-often we get emails to the list asking about exposing GPIOs on
DBus. It's often best not to do that, so document why.

Change-Id: I416e80

anti-patterns: Add DBus GPIO interface anti-pattern

Every so-often we get emails to the list asking about exposing GPIOs on
DBus. It's often best not to do that, so document why.

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

show more ...

anti-patterns: minor editorial changes to exe placement

Previously we changed the anti-patterns to specify `/usr/libexec` for
many daemons but the "Resolution" on that anti-pattern was not updated
t

anti-patterns: minor editorial changes to exe placement

Previously we changed the anti-patterns to specify `/usr/libexec` for
many daemons but the "Resolution" on that anti-pattern was not updated
to match. Fix this.

Also backtick-escape a few paths that were left unescaped.

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

show more ...

anti-pattern: rephrase sbin/bin pattern

Rephrase the sbin/bin anti-pattern to clarify the difference from
user-facing CLI tools and daemon executables. Add language to
favor using `libexec` for dae

anti-pattern: rephrase sbin/bin pattern

Rephrase the sbin/bin anti-pattern to clarify the difference from
user-facing CLI tools and daemon executables. Add language to
favor using `libexec` for daemons.

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

show more ...

Replace IRC with Discord

Discord has more users. IRC traffic has ground to a halt.

No real objection to
https://lists.ozlabs.org/pipermail/openbmc/2020-November/023984.html

Removed IRC from the RE

Replace IRC with Discord

Discord has more users. IRC traffic has ground to a halt.

No real objection to
https://lists.ozlabs.org/pipermail/openbmc/2020-November/023984.html

Removed IRC from the README and replaced IRC in other places.

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

show more ...

standardize debug in openbmc applications

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

docs: anti-pattern: unexpected errors

This adds an anti-pattern for ineffective error handlers.

Signed-off-by: Joseph Reynolds <joseph-reynolds@charter.net>
Change-Id: Iaf5d8b8100a8720b7cae1b805188

docs: anti-pattern: unexpected errors

This adds an anti-pattern for ineffective error handlers.

Signed-off-by: Joseph Reynolds <joseph-reynolds@charter.net>
Change-Id: Iaf5d8b8100a8720b7cae1b8051888da3035c27aa

show more ...

anti-patterns: use cli11 instead of custom parser

Many OpenBMC applications have a custom ArgumentParser object to provide
a modern argument parsing interface. These are nearly identical between
da

anti-patterns: use cli11 instead of custom parser

Many OpenBMC applications have a custom ArgumentParser object to provide
a modern argument parsing interface. These are nearly identical between
daemons. The CLI11 library provides a modern argument parsing interface
with advanced validation.

Change-Id: I11ca97b2990e342c203ec54b9f3d40bbcebb55eb
Signed-off-by: Patrick Venture <venture@google.com>

show more ...

anti-patterns: application install in /usr/sbin

Many OpenBMC applications install targets incorrectly place applications
in /usr/sbin/

Tested: Copied into https://jbt.github.io/markdown-editor/ and

anti-patterns: application install in /usr/sbin

Many OpenBMC applications install targets incorrectly place applications
in /usr/sbin/

Tested: Copied into https://jbt.github.io/markdown-editor/ and
app.grammarly.com.
Change-Id: Ia18021b68ad2392b3fa5c860af36dba25210ee4b
Signed-off-by: Brad Bishop <bradleyb@fuzziesquirrel.com>
Signed-off-by: Gunnar Mills <gmills@us.ibm.com>

show more ...

anti-patterns: explicit missing pkg messages

Nearly all OpenBMC packages rely primarily on other OpenBMC packages to
build and link. Therefore, it's generally sufficient to list the
missing package

anti-patterns: explicit missing pkg messages

Nearly all OpenBMC packages rely primarily on other OpenBMC packages to
build and link. Therefore, it's generally sufficient to list the
missing package via the default missing package behavior. In the event
the package name isn't the same as the library expected, then
overwriting the error message is still helpful.

Change-Id: I9fc6eba07e09480f9e1da8662d202be681c7506e
Signed-off-by: Patrick Venture <venture@google.com>

show more ...

anti-patterns: add /usr/bin/env launching

Outside of OpenBMC, most applications that provide systemd unit files
don't launch applications in this way.

Change-Id: Ie918be8727c51a1f8f05b8f845b9967c2a

anti-patterns: add /usr/bin/env launching

Outside of OpenBMC, most applications that provide systemd unit files
don't launch applications in this way.

Change-Id: Ie918be8727c51a1f8f05b8f845b9967c2a18c5af
Signed-off-by: Brad Bishop <bradleyb@fuzziesquirrel.com>

show more ...

anti-patterns: explicit shared lib dependencies

Out of the box bitbake examines built applications, automatically adds
runtime dependencies and thus ensures any library packages dependencies
are aut

anti-patterns: explicit shared lib dependencies

Out of the box bitbake examines built applications, automatically adds
runtime dependencies and thus ensures any library packages dependencies
are automatically added to images, sdks, etc. There is no need to list
them explicitly in a recipe.

Change-Id: Ia19805546eb5808afebbc757e4ca36c562109075
Signed-off-by: Brad Bishop <bradleyb@fuzziesquirrel.com>

show more ...

add anti-paterrns for code review

The developers of OpenBMC do not get 100% of decisions right 100% of the
time. That, combined with the fact that software development is often
an exercise in copyi

add anti-paterrns for code review

The developers of OpenBMC do not get 100% of decisions right 100% of the
time. That, combined with the fact that software development is often
an exercise in copying and pasting, results in mistakes happening over
and over again.

Add a page that aims to document some of the anti-patterns that exist in
OpenBMC to ease the job of those reviewing code. If an anti-pattern is
spotted, rather that repeating the same explanations over and over, a
link to this document can be provided.

Change-Id: Ie5efc1ef61a0b948330fa576eca09d5b6fa64751
Signed-off-by: Brad Bishop <bradleyb@fuzziesquirrel.com>

show more ...