From bafb82b220a201704b65da555cb78e7925b48c26 Mon Sep 17 00:00:00 2001 From: Ed Tanous Date: Mon, 17 Aug 2020 09:44:29 -0700 Subject: 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 Change-Id: Icc0081c94403c937d9a1ce44b7d6e81a5716a32e --- DEVELOPING.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) (limited to 'DEVELOPING.md') 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. -- cgit v1.2.3