| commit | 04e8ffda0daaf1e0dd034a91b421bab2b3eb9723 | [log] [tgz] |
|---|---|---|
| author | Suraj Jitindar Singh <sjitindarsingh@gmail.com> | Tue Apr 11 13:36:15 2017 +1000 |
| committer | Suraj Jitindar Singh <sjitindarsingh@gmail.com> | Tue Apr 11 15:17:06 2017 +1000 |
| tree | ba3029c6c3980880f8b0137dc877b643385e86d4 | |
| parent | f6e0cf00706a252985d86aee5f9ae2330db68d62 [diff] |
docs: Create Documentation folder and add mboxd and mboxctl documentation Create a separate folder for documentation called Documentation. Move the protocol definition into a file in this folder called mbox_protocol.md and update the README.md to explain the files in the docs folder. Also add two other files to the folder called mboxd.md and mboxctl.md which document the operation of the reference implementations of the mailbox daemon and the mailbox control program respectively. Signed-off-by: Suraj Jitindar Singh <sjitindarsingh@gmail.com> Change-Id: I9f818700ad1e36a396a828f0f085b42cc106b550
Copyright 2017 IBM
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
This repo contains the protocol definition for the host to BMC mailbox communication specification which can be found in Documentation/mbox_procotol.md.
There is also a reference implementation of a BMC mailbox daemon, the details of which can be found in Documentation/mboxd.md.
Finally there is also an implementation of a mailbox daemon control program, the details of which can be found in Documentation/mboxctl.md.