| Age | Commit message (Collapse) | Author | Files | Lines |
|---|
|
While this is more of a question of style, we have enough problems with
our lambda usage that it is worth having some documentation we can point
people to in review.
Signed-off-by: Ed Tanous <edtanous@google.com>
Change-Id: I2a3f819693dfd6a9a46f92037574c5d28c3121e5
|
|
By convention, we should be following boost here, and passing error_code
by reference, not by value. This makes our code consistent, and removes
the need for a copy in some cases.
Signed-off-by: Ed Tanous <edtanous@google.com>
Change-Id: Id42ea4a90b6685a84818b87d1506c11256b3b9ae
|
|
string_view should always be passed by value; This commit is a sed
replace of the code to make all string_views pass by value, per general
coding guidelines[1].
[1] https://quuxplusone.github.io/blog/2021/11/09/pass-string-view-by-value/
Tested: Code compiles.
Signed-off-by: Ed Tanous <edtanous@google.com>
Change-Id: I55b342a29a0fbfce0a4ed9ea63db6014d03b134c
|
|
Signed-off-by: Patrick Williams <patrick@stwcx.xyz>
Change-Id: I1402cbd84c916792ca2fc0ad0f34db661cbdfa72
|
|
Reformat the repository using the latest from openbmc-build-scripts.
Add the `static/redfish` directory to be ignored by prettier since
these files come from elsewhere and having the ability to do a direct
diff is handy.
Signed-off-by: Patrick Williams <patrick@stwcx.xyz>
Change-Id: I74464d6f97047b4888a591e0d8a4f5ca970ac69e
|
|
Prior to having query params and aggregation supported, this wasn't much
of an issue, but now that we have these features, we need to code
against doing multiple things in parallel. We have had cases in the
past prior to these new features, but these were generally localized to
a single handler, so the fixes tended to go under the radar.
This commit documents this common pitfall, and propose a solution. The
commit below has already done most of the work to make the codebase
consistent in this regard. Documenting this will hopefully ensure that
regressions don't happen again, or if they do, we have documentation
that we can point to.
1476687d Remove brace initialization of json objects
Tested: Documentation only.
Signed-off-by: Ed Tanous <edtanous@google.com>
Change-Id: Id9e761987fd90955218fbb232b277a08b0227339
|
|
Mentioning operator<< and operator>> as throwing
Noting preferred usage of parse() and dump()
Signed-off-by: Josh Lehan <krellan@google.com>
Change-Id: I1ffdc4b39e518ec348a553eac5080accf75fae8e
|
|
COMMON_ERRORS.md Implementation was misspelled.
Signed-off-by: Abhishek Patel <Abhishek.Patel@ibm.com>
Change-Id: I053e8ccc0aad1a900db5b385d848c12ce524643e
|
|
Lots of commits recently seem to make this error. Having this
documented should hopefully reduce the likelihood people make these
mistakes.
Tested:
Documentation only.
Signed-off-by: Ed Tanous <edtanous@google.com>
Change-Id: I72cfc06aee9d687c26aa095353c414193d5d9ce7
|
|
At least 50% of all patchsets I see adding a collection handler seem to
get this wrong, despite a small comment in the developing doc, lets add
a concrete example so that we can be sure this gets handled in the
future, and we have something to point at in code review.
Signed-off-by: Ed Tanous <edtanous@google.com>
Change-Id: I98c9e235019472d3e39a2c142b5a5aec4bca8f4e
|
|
In code review, despite them being documented, people still tend to make
these mistakes. Having them numbered allows responding with comments
that are much simpler for a maintainer, with quick comments like:
"Common error #2"
While this might not seem like a huge savings, for maintainers having to
review 10s of reviews per day, having an optimized workflow helps a lot
with time savings and little improvements add up over time.
Signed-off-by: Ed Tanous <edtanous@google.com>
Change-Id: I877cbbf50c1e20448f31464f820114073bba513e
|
|
Pretty sure the author wanted these on separate lines so do that.
Makes the list a lot easier to scan.
Could have done this multiple ways but went with bullets.
Fixed an escape.
Tested: https://jbt.github.io/markdown-editor/
Change-Id: Ia0a0e5a2023f7eebda1ebf2d4d1d6528429cce8c
Signed-off-by: Gunnar Mills <gmills@us.ibm.com>
|
|
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
|
