summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorEd Tanous <ed.tanous@intel.com>2019-10-11 01:39:33 +0300
committerEd Tanous <ed.tanous@intel.com>2019-10-18 19:20:11 +0300
commitc94ad49bc747e7a7170287b9f4c859e3638cf432 (patch)
tree17ca83806e5b546f20c3478862fe1aa699e2ae22 /README.md
parent789771dda22c256afa9e46ffe4c859bb87532af1 (diff)
downloadbmcweb-c94ad49bc747e7a7170287b9f4c859e3638cf432.tar.xz
Make references to crow less obvious
Recently, a number of people in the community have made the (admittedly easy) mistake that we use a significant portion of crow. Today, we use crow for the router, and the "app" structure, and even those have been significantly modified to meet the bmc needs. All other components have been replaced with Boost beast. This commit removes the crow mentions from the Readme, and moves the crow folder to "http" to camouflage it a little. No code content has changed. Tested: Code compiles. No functional change made to any executable code. Signed-off-by: Ed Tanous <ed.tanous@intel.com> Change-Id: Iceb57b26306cc8bdcfc77f3874246338864fd118
Diffstat (limited to 'README.md')
-rw-r--r--README.md21
1 files changed, 0 insertions, 21 deletions
diff --git a/README.md b/README.md
index 9fb5d54304..93660ed655 100644
--- a/README.md
+++ b/README.md
@@ -34,24 +34,3 @@ certificate
- has a random serial number, and
- is signed using the `SHA-256` algorithm.
-## Crow patches ##
-The crow project has had a number of additions to make it more useful for use in the OpenBmc Project. A non-exhaustive list is below. At the time of this writing, the crow project is not accepting patches, so for the time being crow will simply be checked in as is.
-
-+ Applied clang-format to the whole crow tree. This was done without regard for arrays and fixed data structures, but was deemed to be overall better than the inconsistent formatting that existed in upstream previously.
-+ Crow server now calls stop before destruction of the Crow app object.
-+ Fixed a bug where timed out websockets would seg fault the system by accessing a destroyed socket object without null checks when in SSL mode.
-+ Added a TestSocketAdapter class that could be used to unit test server behavior without utilizing a socket.
-+ Added the "getRoutes" call to both the app and the routing Trie class that allows consumers to poll the server for all (or a subset of) registered web routes in the system.
-+ Hardcoded the websocket implementation for binary mode, instead of leaving protocol unspecified.
-+ Move most uses of std::unordered_map to boost::flat_map to lower memory consumption, and (in some cases) to improve memory locality.
-+ Adjust the addHeaders mechanism to use a fixed string instead of a full map implementation to avoid unnecessary mallocs and reduce the number of scatter gather buffers on an http response.
-+ Change server name header from Crow/0.1 to iBMC
-+ Starts the http server io_context inside the main thread, instead of creating a new thread.
-+ Removes all BMCWEB_MSVC_WORKAROUND flags.
-+ Removes the behavior that causes a 301 redirect for paths that end in "/", and simply returns the endpoint requested. This was done for redfish compatibility.
-+ Removes the built in crow/json.hpp package and adds nlohmann json package as the first class json package for crow.
-+ Move uses of boost::array to std::array where possible.
-+ Add the ability to get a reference to the crow::Request object on websocket connection to allow checking header values.
-+ Patch http handler to call middlewares on websocket connections to allow authentication to be applied appropriately.
-+ Adds an is_secure flag to provide information about whether or not the payload was delivered over ssl.
-