summaryrefslogtreecommitdiffstats
Commit message (Collapse)AuthorAgeFilesLines
...
* | cheatsheet.md: Re-write QEMU invocation exampleAndrew Jeffery2016-06-151-6/+4
|/ | | | | | | | | | | | | | | | The commandline provided had several issues: * The -dtb option was redundant as we boot with the cuImage, and caused some kernel configuration to be skipped which in turn ended in a kernel panic * -append argument was redundant with respect to the devicetree * The file paths used typically required the user to change up out of the build directory after bitbaking obmc-phosphor-image The patch addresses all of the above. Signed-off-by: Andrew Jeffery <andrew@aj.id.au> Signed-off-by: Jeremy Kerr <jk@ozlabs.org>
* userguide: run tex twiceJeremy Kerr2016-05-261-0/+1
| | | | | | .. to generate proper cross-references. Signed-off-by: Jeremy Kerr <jk@ozlabs.org>
* userguide: don't run tex in interactive modeJeremy Kerr2016-05-261-1/+2
| | | | | | ... as it doesn't behave well with CI builds. Signed-off-by: Jeremy Kerr <jk@ozlabs.org>
* userguide: Don't use pandoc for final tex outputJeremy Kerr2016-05-262-4/+5
| | | | | | | | | | When using pandoc to create the main .tex document, we lose all styles and formatting information in the main userguide doc. This change reverts commit bba5b1817e89bd63766e2bb91d406130f027fcaf, and adds the \tighlist macro that was required by that change. Signed-off-by: Jeremy Kerr <jk@ozlabs.org>
* cheatsheet: QEMU commandline for palmetto-bmcAndrew Jeffery2016-05-251-0/+26
| | | | | Signed-off-by: Andrew Jeffery <andrew@aj.id.au> Signed-off-by: Jeremy Kerr <jk@ozlabs.org>
* Merge pull request #21 from hramasub/logmannkskjames2016-05-181-0/+145
|\ | | | | RFC on the OBMC Service Interface.
| * RFC on the OBMC Service Interface.Hariharasubramanian R2016-04-011-0/+145
| |
* | Take a stab at a proper DBUS API document.Brad Bishop2016-05-131-237/+681
| | | | | | | | | | | | | | | | | | | | | | | | | | | | Changed the main structure to be interface based rather than topic based. Each interface should have a methods, signals properties and namespace section with a table and option free form examples or additional overview information. If an interface doesn't have any properties, methods or signals those sections can be omitted. The namespace section outlines where objects implementing certain interfaces are expected to be found. There are a number of things that still need to be filled out.
* | Added steps to build barreleye imageAdi Gangidi2016-05-121-0/+11
| |
* | README.md: Fix 'easily to learn' grammarAndrew Jeffery2016-05-121-1/+1
| | | | | | | | Signed-off-by: Andrew Jeffery <andrew@aj.id.au>
* | rest-api: Fix capitalisation of 'Just'Andrew Jeffery2016-05-121-1/+1
| | | | | | | | Signed-off-by: Andrew Jeffery <andrew@aj.id.au>
* | rest-api.md: Fix 'emumerate' typoAndrew Jeffery2016-05-121-1/+1
| | | | | | | | Signed-off-by: Andrew Jeffery <andrew@aj.id.au>
* | Makefile: Remove xelatex build log on cleanAndrew Jeffery2016-05-091-1/+1
| | | | | | | | | | | | | | | | | | Previously the log files from xelatex were being left behind. Also, as xelatex now builds the generated userguide.tex, the arguments to rm can be matched by the userguide.* wildcard along with *.tex to remove the remaining pandoc output. Signed-off-by: Andrew Jeffery <andrew@aj.id.au>
* | userguide: Generate userguide.tex to include \tightlist macroAndrew Jeffery2016-05-091-1/+4
| | | | | | | | | | | | | | | | | | | | Allow xelatex to build userguide.pdf without errors. pandoc injects \tightlist macros into its output files which cause xelatex to choke. By processing the hand-rolled userguide.tex with pandoc the definition is injected and xelatex can build the PDF. Signed-off-by: Andrew Jeffery <andrew@aj.id.au>
* | Add infrastructure for User GuideJeremy Kerr2016-05-052-0/+48
| | | | | | | | | | | | | | This change adds a little infrastructure for creating an OpenBMC User's Guide, from the user-related documents in markdown. Signed-off-by: Jeremy Kerr <jk@ozlabs.org>
* | console: Fix code formattingJeremy Kerr2016-05-051-4/+4
| | | | | | | | | | | | We need four spaces, not two. Signed-off-by: Jeremy Kerr <jk@ozlabs.org>
* | Add host management docJeremy Kerr2016-05-052-0/+145
| | | | | | | | | | | | From content in the user manual. Signed-off-by: Jeremy Kerr <jk@ozlabs.org>
* | Add code update docJeremy Kerr2016-05-052-0/+100
| | | | | | | | | | | | Roughly based on Norm's user manual. Signed-off-by: Jeremy Kerr <jk@ozlabs.org>
* | rest-api: Restructure and expand, and improve example codeJeremy Kerr2016-05-051-94/+163
| | | | | | | | | | | | | | | | | | | | | | | | This change restructures the rest-api document a little, so that it's more in a manual format. Also, we simplify the command-line examples a little, by only providing the cjar-specific options where required; use single-quoting to avoid lots of shell escaping; add command output where suitable, and wrap to prevent long lines. Signed-off-by: Jeremy Kerr <jk@ozlabs.org>
* | README: Add OpenBMC goals sectionJeremy Kerr2016-05-041-0/+27
| | | | | | | | | | | | Based on the user guide Signed-off-by: Jeremy Kerr <jk@ozlabs.org>
* | README: split contents into usage & development sectionsJeremy Kerr2016-04-211-4/+16
| | | | | | | | Signed-off-by: Jeremy Kerr <jk@ozlabs.org>
* | Add console documentJeremy Kerr2016-04-142-0/+45
| | | | | | | | | | | | | | Add a little info about host console for the new obmc-console infrastructure Signed-off-by: Jeremy Kerr <jk@ozlabs.org>
* | contributing: use project-wide query for bitesize issuesJeremy Kerr2016-04-141-1/+1
| | | | | | | | Signed-off-by: Jeremy Kerr <jk@ozlabs.org>
* | contributing: Add 'Starting out' sectionJeremy Kerr2016-04-141-0/+14
|/ | | | | | To provide a little direction for newcomers. Signed-off-by: Jeremy Kerr <jk@ozlabs.org>
* Add documentation for associationsBrad Bishop2016-03-181-0/+61
|
* Merge branch 'patch-1' of https://github.com/causten/docs into causten-patch-1Jeremy Kerr2016-02-291-0/+26
|\
| * Update dbus-interfaces.md for Event Log apiChris Austen2016-02-031-0/+26
| |
* | contributing: Add note about warningsJeremy Kerr2016-02-101-0/+3
| | | | | | | | Signed-off-by: Jeremy Kerr <jk@ozlabs.org>
* | Merge branch 'occstatus' of https://github.com/adamliyi/docs-1Jeremy Kerr2016-02-081-0/+6
|\ \
| * | dbus-interface-doc: Add PowerCap and OccStatus descriptionYi Li2016-01-201-0/+6
| |/ | | | | | | | | | | | | Add description for dbus objects '/org/openbmc/sensors/host/PowerCap' and '/org/openbmc/sensors/host/OccStatus'. Signed-off-by: Yi Li <adamliyi@msn.com>
* / README: Add overview page with indexJeremy Kerr2016-02-082-2/+20
|/ | | | Signed-off-by: Jeremy Kerr <jk@ozlabs.org>
* Merge pull request #13 from shenki/masterJeremy Kerr2016-01-181-1/+1
|\ | | | | cheatsheet: Fix misspelling of TEMPLATECONF
| * cheatsheet: Fix misspelling of TEMPLATECONFJoel Stanley2016-01-181-1/+1
|/ | | | | | | The existing hint would not work, as the tool expects the variable to be called TEMPLATECONF not TEMPLATE_CONF. Signed-off-by: Joel Stanley <joel@jms.id.au>
* Add doc for contribution guidelinesJeremy Kerr2016-01-151-0/+145
| | | | | | | | | Start somewhere to document our development conventions. Signed-off-by: Jeremy Kerr <jk@ozlabs.org> Reviewed-by: Andrew Donnellan <andrew.donnellan@au1.ibm.com> Reviewed-by: Stewart Smith <stewart@linux.vnet.ibm.com> Reviewed-by: Andrew Jeffery <andrew@aj.id.au>
* added chassis, leds, buttons, inventory, and sensorsNorman James2016-01-111-0/+138
|
* Merge pull request #8 from bradbishop/masterPatrick Williams2016-01-081-25/+39
|\ | | | | Add login/logout examples
| * Add login/logout examplesBrad Bishop2015-12-021-25/+39
|/
* Merge pull request #7 from bradbishop/masterPatrick Williams2015-11-231-6/+13
|\ | | | | Rest API documentation fixes
| * Rest API documentation fixesBrad Bishop2015-11-201-6/+13
|/ | | | | | HTTP verbs need to be upper case. -k appeared twice in some examples. Add delete description and example.
* Merge pull request #6 from bradbishop/masterPatrick Williams2015-11-091-28/+45
|\ | | | | REST API updates
| * REST API updatesBrad Bishop2015-11-091-28/+45
|/ | | | | | | I am working on a number of API (json format) changes. Use https:// instead of http:// Show how to set the Content-Type HTTP header. Show how to set the HTTP verb.
* Merge pull request #4 from bradbishop/masterPatrick Williams2015-10-302-1/+82
|\ | | | | REST API examples
| * Add REST API examplesBrad Bishop2015-10-291-0/+81
| |
| * Fix description of busctlBrad Bishop2015-10-291-1/+1
|/ | | | It doesn't have much to do with REST.
* cheatsheet: Add SDK build instructionsChris Austen2015-10-261-0/+11
|
* dbus-interfaces: Move busctl doc to cheatsheetJeremy Kerr2015-10-262-10/+20
| | | | | | I'd like to keep the dbus-interfaces doc as a more formal specification. Signed-off-by: Jeremy Kerr <jk@ozlabs.org>
* Merge pull request #2 from causten/patch-1Patrick Williams2015-10-251-0/+8
|\ | | | | Update dbus-interfaces.md
| * Update dbus-interfaces.mdChris Austen2015-10-241-0/+8
|/
* Add initial kernel-development docJeremy Kerr2015-10-221-0/+47
| | | | Signed-off-by: Jeremy Kerr <jk@ozlabs.org>
* cheatsheet: fix build commandJeremy Kerr2015-10-221-1/+1
| | | | Signed-off-by: Jeremy Kerr <jk@ozlabs.org>
OpenPOWER on IntegriCloud