summaryrefslogtreecommitdiffstats
Commit message (Collapse)AuthorAgeFilesLines
...
* Add Gerrit setup documentationAnthony Wilson2018-12-031-0/+73
| | | | | | | | Guide for new users to setup their workstations to connect to and utilize Gerrit. Change-Id: Id0d263b4c775d0a26378d517047b0feea3c96d9e Signed-off-by: Anthony Wilson <wilsonan@us.ibm.com>
* Create an OpenBMC GlossaryJoseph Reynolds2018-12-011-0/+42
| | | | | | | | | | | | Provide a list of terminology and acronyms used in the OpenBMC project together with definitions and explanations as a training aid to community members who need to know the meaning of terms which are not easily found or disambiguated. Tested: N/A Change-Id: I0cd346fe6164037f46abd12a21b4c7150cc34559 Signed-off-by: Joseph Reynolds <jrey@us.ibm.com>
* dev-environment: Fix example formattingAlexander Amelkin2018-11-261-6/+7
| | | | | | | | Use proper markdown with `obmcutil state` example, also fix 'Note' formatting under that example. Change-Id: I45dcaf282d422f6ab8a91e554ef75f6bcbb6633f Signed-off-by: Alexander Amelkin <a.amelkin@yadro.com>
* designs: firmware_update: simplify verificationPatrick Venture2018-11-251-15/+36
| | | | | | | | | | | | Simply the verification approach by providing an additional blob_id whose purpose is to handle triggering verification as well as reporting verification status. Originally, this was handled by actions against the hash blob, however this lead to unnecessary complexity. Change-Id: Ic63900340abae0dac3453619b6cf1c90b8124504 Signed-off-by: Patrick Venture <venture@google.com>
* Add obmc-host-shutdown target dependenciesAndrew Geissler2018-11-201-0/+75
| | | | | | | | | | | | | | | The following information was needed to debug an issue in the power down path. Since the data was useful, makes sense to keep in the corresponding doc. This new section shows all of the targets and services associated with powering off a system and their dependencies. It's for a witherspoon system but the targets and some services are relevant to other systems as well. Change-Id: I62ae04814765f20013de15ec0430a4a94bc5f2bf Signed-off-by: Andrew Geissler <geissonator@yahoo.com>
* designs: firmware_update: add detailsPatrick Venture2018-11-161-4/+23
| | | | | | | Add details pertaining to the P2A bridge configuration. Change-Id: I69d1c95fbfbba84cadfaea9c8a89f8416c14d469 Signed-off-by: Patrick Venture <venture@google.com>
* Add first version of community Code of ConductEmily Shaffer2018-11-151-0/+209
| | | | | | | Adapted from the Linux Foundation COC, https://lfprojects.org/policies/code-of-conduct/ Change-Id: Ic5251970b65ab46b6c5a979e14fbcfa24772be4f Signed-off-by: Emily Shaffer <emilyshaffer@google.com>
* Development Environment Tutorial - fix QEMU URLJoseph Reynolds2018-11-151-1/+1
| | | | | | | | | Corrected the URL to the latest x86 QEMU ARM image. Tested: Yes Change-Id: I2d71cecf14cb57f00c8ed35fdef1687dfe7bdf10 Signed-off-by: Joseph Reynolds <jrey@us.ibm.com>
* user-management: User docs flows updatedRichard Marian Thomaiyar2018-11-131-23/+154
| | | | | | | Added stacked-pam, phosphor-user-manager & authorization flow Change-Id: I3d05306ff337c79034f10f5e75c94172d65bb7f4 Signed-off-by: Richard Marian Thomaiyar <richard.marian.thomaiyar@linux.intel.com>
* design: firmware update: phrasing tweakPatrick Venture2018-11-121-20/+25
| | | | | | | | Tweak phrasing for firmware update naming, legacy here can refer to static. Change-Id: I4c12dd171999f109fc7309e45d6c3e14326c66e4 Signed-off-by: Patrick Venture <venture@google.com>
* OpenBMC Release Process DocumentKurt Taylor2018-11-081-0/+121
| | | | | | | | | This is the initial set of agreements from the Release Planning work group defining the release process and schedule, milestones, content definition and feature prioritization. Change-Id: Iaaf8c70a7e4a3df8012545c37ad47042c1fa7884 Signed-off-by: Kurt Taylor <kurt.r.taylor@gmail.com>
* userguide: update path to code-updateJoel Stanley2018-11-072-2/+2
| | | | | | | | This was moved in c4c7f4055387 ("Moved host code update to own doc") but no one updated the makefile. Change-Id: I2b0b3aad6d2436c9cb207a4faeff7468e54a5b2a Signed-off-by: Joel Stanley <joel@jms.id.au>
* Makefile: Document how to buildJoel Stanley2018-11-071-0/+3
| | | | | Change-Id: Ief393626f9ca5a838eba574e6b70587405118d4e Signed-off-by: Joel Stanley <joel@jms.id.au>
* design: firmware update: title updatePatrick Venture2018-11-021-1/+1
| | | | | | | Update title of firmware update over blobs design. Change-Id: Ibb2544400ed4258865b6668ac2df303aa8f79e87 Signed-off-by: Patrick Venture <venture@google.com>
* add design: firmware_update_via_blobsPatrick Venture2018-11-011-0/+382
| | | | | | | | | | | | Firmware update process using the Blob protocol over IPMI. This process will allow legacy and UBI image uploads over IPMI/P2A/LPC with signature verification. Each platform can provide modifications to the handler behavior or add custom handlers as needed. The firmware update process will be just another blob handler and therefore implement the appropriate blob protocol primitives. Change-Id: I7e18a7900c878d5d9205a8c1b8475e71a1bceeb3 Signed-off-by: Patrick Venture <venture@google.com>
* Create initial REDFISH-cheatsheetAndrew Geissler2018-10-311-0/+60
| | | | | | | | Some initial commands to get people started on authenticating and executing some common redfish commands Change-Id: Ia61e41af5663b59239fbf05d080112a9419cdb73 Signed-off-by: Andrew Geissler <geissonator@yahoo.com>
* Add how to handle private security vulnerabilitiesJoseph Reynolds2018-10-292-0/+185
| | | | | | | | | | | | | Adds two new documents: - "How to report a security vulnerability" says how to privately report a security vulnerability with the intention of getting a fix before public disclosure. - "Security response team guidelines" is for the security response team and community members who are responding to privately disclosed problems and working to provide a fix. Change-Id: I83475bd4bfa014106ab5c3b50ad81e3488d06ba3 Signed-off-by: Joseph Reynolds <jrey@us.ibm.com>
* Create security vulnerability reporting mechanismJoseph Reynolds2018-10-291-0/+38
| | | | | | | | | | | | | | | | | | This documents the process to privately report OpenBMC security vulnerabilities with the intention of giving time to the project to fix the problem before public disclosure. This first commit establishes the project's scope. The next commit: - provides guidelines to the OpenBMC security response team as it works to address the security issues and disclose publicly - establishes the "How to report security vulnerabilities" web page to tell problem submitters what to include in their report and what to expect from the OpenBMC security response team Change-Id: Ib90070f998a815ba3f4430c7eb6ff84b3934e012 Signed-off-by: Joseph Reynolds <jrey@us.ibm.com>
* Add Creative Commons 4.0 LICENSEGunnar Mills2018-10-261-0/+396
| | | | | | | | Copied from https://creativecommons.org/licenses/by/4.0/legalcode.txt Change-Id: I7e5c48ecd93433c65e486030a643d2dfa9d12e32 Signed-off-by: Gunnar Mills <gmills@us.ibm.com>
* Add in command to display event logsAndrew Geissler2018-10-251-0/+5
| | | | | | | | A common use case is to display the details of the event logs on the system Change-Id: Iedf8ec532709f728525d5030416ced7bae3de662 Signed-off-by: Andrew Geissler <geissonator@yahoo.com>
* dev-doc: Make header size consistent in web-uiAndrew Geissler2018-10-251-3/+3
| | | | | Change-Id: Ie09d0e8391dfb33b6c58249c7044cb7043f0228a Signed-off-by: Andrew Geissler <geissonator@yahoo.com>
* dev-doc: Make header size consistent in hello-worldAndrew Geissler2018-10-251-3/+3
| | | | | Change-Id: I02b26db764f7fcbe33346e5ec15719e10f26b357 Signed-off-by: Andrew Geissler <geissonator@yahoo.com>
* dev-doc: Make header size consistent in dev-envAndrew Geissler2018-10-251-4/+4
| | | | | Change-Id: I2c7d7841f4f4e4ca9f7d4d692e44d6920b54587b Signed-off-by: Andrew Geissler <geissonator@yahoo.com>
* dev-doc: Add README to development directoryAndrew Geissler2018-10-251-0/+24
| | | | | | | | Provide a summary of each lesson and the recommended order to read them Change-Id: Iee33a13c80e10bb6ab9f39d232c41c3fb7e1ebcd Signed-off-by: Andrew Geissler <geissonator@yahoo.com>
* dev-doc: Fix typo on BMC service restartAndrew Geissler2018-10-251-1/+1
| | | | | Change-Id: I6c99b14788b7d81da28a94cdacb1fe99421e36ce Signed-off-by: Andrew Geissler <geissonator@yahoo.com>
* dev-doc: Tutorial on adding a new systemAndrew Geissler2018-10-251-0/+265
| | | | | | | | Walk through the process of adding a new system layer in Yocto and customizing it Change-Id: I740ecdee6a143675859b2b32ed9cf39d711bad66 Signed-off-by: Andrew Geissler <geissonator@yahoo.com>
* cpp-style-and-conventions: fix wrong case in examplePatrick Venture2018-10-221-2/+2
| | | | | | | Class names are UpperCamelCase. Change-Id: Ic7d9432ec8458ef6e54070b0af445a9be10f1c9a Signed-off-by: Patrick Venture <venture@google.com>
* design-template: reduce heading depthPatrick Venture2018-10-191-9/+9
| | | | | | | | | Reduce heading depth from the start to reduce depth of sub-headings in detailed design. As the designs are meant to stand alone, they do not need an explicit initial depth of 3. Change-Id: Ib037c2da81962d7b5bee8dc01916e1269e189e5e Signed-off-by: Patrick Venture <venture@google.com>
* dev-doc: Tutorial on modifying web UIAndrew Geissler2018-10-111-0/+110
| | | | | | | | Walk through the process of customizing the web UI with a new logo on the login and screen and header bar Change-Id: I1acba8765190fe0ef633c5203cd5c77260e56829 Signed-off-by: Andrew Geissler <geissonator@yahoo.com>
* Adding OpenBMC Logo filesKurt Taylor2018-10-032-0/+123
| | | | | | | | | This adds the OpenBMC logo in Scalable Vector Graphics format, as well as a logo that includes the "Built on" wording added for branding in products built using OpenBMC. Change-Id: I6c0588182684c3b9e6322e265acbb154ee7e946e Signed-off-by: Kurt Taylor <kurt.r.taylor@gmail.com>
* Add ObjectMapper documentation with examplesMatt Spinler2018-10-031-0/+272
| | | | | | | | | The ObjectMapper is used by pretty much every OpenBMC application that uses D-Bus, so I think it could benefit from a good guide. Change-Id: I3d3b78468f3aea94a7884ed5e94050eabca8e502 Signed-off-by: Matt Spinler <spinler@us.ibm.com>
* dev-doc: Tutorial on basic hello worldAndrew Geissler2018-10-031-0/+114
| | | | | | | | | Walk through the process to customize and build an OpenBMC repository from within the SDK, load it into a QEMU session, and run it Change-Id: I06edafd0838eca968a46acc218b77026b6913211 Signed-off-by: Andrew Geissler <geissonator@yahoo.com>
* dev-doc: development environment setup documentAndrew Geissler2018-10-031-0/+170
| | | | | | | | | A document new developers to OpenBMC can reference for setting up a basic development environment to test their code against. Change-Id: I31180217a9a5e5bb89bf533b123979ba0db182a5 Signed-off-by: Andrew Geissler <geissonator@yahoo.com>
* yocto-development.md: Fix linksGunnar Mills2018-10-031-6/+6
| | | | | | | This link format does not work. Fixed and updated the links. Change-Id: If657b1bbcba793fcb8962af15e7eaa563557f85b Signed-off-by: Gunnar Mills <gmills@us.ibm.com>
* add .clang-format exemplarsPatrick Venture2018-09-274-108/+106
| | | | | | | Adds .clang-format for cpp and javascript Change-Id: I8a7ed63be54a3f44ef448cf603ee2a8643436afd Signed-off-by: Patrick Venture <venture@google.com>
* CONTRIBUTING.md: Remove AuthorsGunnar Mills2018-09-271-4/+0
| | | | | | | | This was the only document with a "Authors" section. This is not necessary since we have the git history. Change-Id: I043d53c8fe36e298c1cce8d392f45820f732d405 Signed-off-by: Gunnar Mills <gmills@us.ibm.com>
* Added HTML/CSS Coding StyleGunnar Mills2018-09-271-0/+5
| | | | | | | | Following https://google.github.io/styleguide/htmlcssguide.html for HTML/CSS Coding Style. Change-Id: I19bdf27617bfa0c6674f2a1dcae66b8abf1a8dc7 Signed-off-by: Gunnar Mills <gmills@us.ibm.com>
* Add Google JavaScript Style GuideGunnar Mills2018-09-271-0/+3
| | | | | | | | Added a few sentences about following Google's JavaScript Style Guide. Change-Id: Ie96c19daf569ca451a805820b856140bf072f6a4 Signed-off-by: Gunnar Mills <gmills@us.ibm.com>
* CONTRIBUTING.md: Add JavaScript .clang-format fileGunnar Mills2018-09-241-0/+10
| | | | | | | Added a new JavaScript section to the "Coding style" section. Change-Id: Ic992efa98500c421504da602fbc96f18e608a074 Signed-off-by: Gunnar Mills <gmills@us.ibm.com>
* cpp-style-and-conventions.md: Remove astyleGunnar Mills2018-09-211-12/+1
| | | | | | | | | | | The astyle command listed formatted the code in a way that varied quite a bit from our coding style. Leaving this command could confuse users into thinking they could use astyle for C++ code. With clang-format being enforced by CI, best to remove astyle and stick with clang-format. Change-Id: I5f80048e037fc2768f07702ade22031a802a002a Signed-off-by: Gunnar Mills <gmills@us.ibm.com>
* MAINTAINERS: Update my email and IRCGunnar Mills2018-09-181-1/+1
| | | | | | | Updated to correct IRC username and preferred email address. Change-Id: Iaf2fdca60dbe15a08e85bb5865168e8327f12fe3 Signed-off-by: Gunnar Mills <gmills@us.ibm.com>
* Rest Cheatsheet: Remove Content-Type on GET requestGunnar Mills2018-09-131-7/+7
| | | | | | | | | | There is no "Content-Type" on GET request. Content-Type is only used with POST and PUT requests. See: https://en.wikipedia.org/wiki/List_of_HTTP_header_fields Change-Id: Ic927eaaa95aa2eee92791032bc631a1623602e90 Signed-off-by: Gunnar Mills <gmills@us.ibm.com>
* clang-format: Sort using statementsAdriana Kobylak2018-09-121-0/+1
| | | | | | | | Make using order consistent where used. There aren't any in this project, but this should be used more widely by openbmc projects. Change-Id: I5e2395f480cbf76e1d3e006b1ab648da5aa39aec Signed-off-by: Adriana Kobylak <anoo@us.ibm.com>
* clang-format: always break template declarationsAdriana Kobylak2018-09-121-1/+1
| | | | | | | | | | | | | To better match the defined openbmc style defined here: https://github.com/openbmc/docs/blob/master/cpp-style-and-conventions.md#types template <typename T> class foo { using type = std::decay_t<T>; }; Change-Id: I87640f5cea5935bbee2546526ebad9ccfcf34726 Signed-off-by: Adriana Kobylak <anoo@us.ibm.com>
* clang-format: Remove 2nd PointerAlignmentGunnar Mills2018-09-121-3/+2
| | | | | | | | | | | | | | | | | | PointerAlignment was in the .clang-format example twice. PointerAlignment: Left follows the style defined here: https://github.com/openbmc/docs/blob/master/cpp-style-and-conventions.md#additional-whitespace foo(T& bar, const S* baz); /// Correct. foo(T &bar, const S *baz); /// Incorrect. Also, set DerivePointerAlignment to false so clang-format looks at PointerAlignment instead of "If true, analyze the formatted file for the most common alignment of & and *. Pointer and reference alignment styles are going to be updated according to the preferences found in the file." Change-Id: If33c8842c7e4dc8e03c0ced3a8ba814958daa8a1 Signed-off-by: Gunnar Mills <gmills@us.ibm.com>
* Point to phosphor-dbus-interfaces repoGunnar Mills2018-09-051-3/+3
| | | | | | | | | | | dbus-interfaces.md was removed here: https://github.com/openbmc/docs/commit/d9c32b0762dede747a6bc42b9f997027ce5b5955 and before was moved to the deprecated dir, so this link hasn't worked for some time. It should point to phosphor-dbus-interfaces repo instead. Change-Id: I87e21d593a785e94cf07f3b58eaf32212681db70 Signed-off-by: Gunnar Mills <gmills@us.ibm.com>
* code-update/ubi-code-update fix ActivationProgressJoseph Reynolds2018-09-041-1/+1
| | | | | | | tested: copy&pasted the new command: works Change-Id: I8e2130b090820e46084794a61e9bc2c27fb2b1c9 Signed-off-by: Joseph Reynolds <jrey@us.ibm.com>
* add header ordering section to style guidePatrick Venture2018-08-291-2/+35
| | | | | | | | Adds a section to the style guide defining a header inclusion order for header files and source files. Change-Id: Ieb723380bbab257b98b319cda999cf0e9c1ef389 Signed-off-by: Patrick Venture <venture@google.com>
* cheatsheet: Update TEMPLATECONFAdriana Kobylak2018-08-281-2/+2
| | | | | | | | With the introduction of subtrees (see subtree.md), the TEMPLATECONF has changed. Update the cheatsheet examples. Change-Id: Ice41dd1cb2f85fd426cc224852eead7e04dfc839 Signed-off-by: Adriana Kobylak <anoo@us.ibm.com>
* OpenBMC Design TemplateKurt Taylor2018-08-271-0/+81
| | | | | | | | | This is a proposed design template for new OpenBMC features. It is heavily influenced by the OpenStack, PEP and Google design documents. Change-Id: I80cd52873e2692a4ffed6589507c46b5d99f47fb Signed-off-by: Kurt Taylor <kurt.r.taylor@gmail.com>
OpenPOWER on IntegriCloud