diff options
| author | Ed Tanous <ed@tanous.net> | 2020-08-17 19:44:29 +0300 |
|---|---|---|
| committer | Ed Tanous <ed@tanous.net> | 2020-08-21 18:23:20 +0300 |
| commit | bafb82b220a201704b65da555cb78e7925b48c26 (patch) | |
| tree | 91171c6563e273387b27f9f7ff2f2b13a1364646 /DEVELOPING.md | |
| parent | 2618d5e3906338774da310c9ccf519d64cffd3c9 (diff) | |
| download | bmcweb-bafb82b220a201704b65da555cb78e7925b48c26.tar.xz | |
Add reoccuring errors doc
There are a number of common coding, design, and implementation mistakes
that bmcweb users tend to make. This attempts to document them so we
have a single source to point users to when making gerrit comments. The
hope is that this alleviates some of the early mistakes that new users
tend to make.
Tested:
Documentation only. No functional changes.
Signed-off-by: Ed Tanous <ed@tanous.net>
Change-Id: Icc0081c94403c937d9a1ce44b7d6e81a5716a32e
Diffstat (limited to 'DEVELOPING.md')
| -rw-r--r-- | DEVELOPING.md | 8 |
1 files changed, 7 insertions, 1 deletions
diff --git a/DEVELOPING.md b/DEVELOPING.md index 8c7ceabb5c..6e5e1ed00f 100644 --- a/DEVELOPING.md +++ b/DEVELOPING.md @@ -126,7 +126,13 @@ meetings. For more information on Redfish and supported schemas visit [Redfish.md](https://github.com/openbmc/bmcweb/blob/master/Redfish.md). -13. ### Developing and Testing +13. ### Common errors + A number of examples of common errors are captured in the common errors doc. + It is recommended that developers read and understand all of them before + starting any openbmc development. + [Common Errors](https://github.com/openbmc/bmcweb/blob/master/COMMON_ERRORS.md). + +14. ### Developing and Testing There are a variety of ways to develop and test bmcweb software changes. Here are the steps for using the SDK and QEMU. |