bmcweb/docs/COMMON_ERRORS.md

1 # Commonly recurring errors in bmcweb
3 What follows is a list of common errors that new users to bmcweb tend to make
5 developing in bmcweb, the maintainers highly recommend reading and understanding
122 bmcweb uses a single reactor for all operations. Blocking that reactor for any
146 nature of bmcweb, they are not required to be explicitly threadsafe, but they
173 async bmcweb code. While capturing by reference can be useful, given how
174 difficult these types of bugs are to triage, bmcweb explicitly requires that all
183 BMCWEB("/foo/bar");
187 where the behavior must differ) all URL handlers should end in "/". The bmcweb
203 Very commonly, bmcweb maintainers and contributors alike have to do audits of
207 the route handlers no longer greppable, and complicates bmcweb patchsets as a
231 All bmcweb routes should handle 404 (not found) properly, and return it where
270 [a bug in either the system, or bmcweb.](https://github.com/openbmc/bmcweb/blob/master/DEVELOPING.m…
315 In many cases, bmcweb is doing multiple async actions in parallel, and
359 void afterGetSubTree(std::shared_ptr<bmcweb::AsyncResp>& asyncResp,