Commit Graph

65 Commits

Author SHA1 Message Date
David Brown 31d29c8edb imgtool: Update docs for new key format
Update the dependencies needed, as well as adding a blurb about how to
password protect the private key.

Signed-off-by: David Brown <david.brown@linaro.org>
2018-01-09 09:41:30 -07:00
Fabio Utzig a722f5aaa1 Describe the tradeoffs of scratch size
JIRA: MCUB-74
Signed-off-by: Fabio Utzig <utzig@apache.org>
2018-01-04 10:34:43 -07:00
Marti Bolivar 38d67f76f0 zephyr: add script for running mcuboot tests
It's onerous to work through the tests in docs/testplan-zephyr.md by
hand. Add a script which takes the thinking out of it.

Signed-off-by: Marti Bolivar <marti@opensourcefoundries.com>
2017-11-20 18:10:29 -07:00
Ryan C Johnson ce4fa4400a Correction to swap procedure design documentation
The swap procedure as documented doesn't match the code, and it would
loose the contents of slot1[index] as it's erased before it is copied
anywhere. Also, add the missing word 'to'.

Signed-off-by: Ryan C Johnson <ryan.johnson@flex.com>
2017-10-19 17:41:59 -02:00
David Brown 2467de10c5 Fix `imgtool.py` link in main webpage
URL was referencing old location for this script.

Signed-off-by: David Brown <david.brown@linaro.org>
2017-09-29 09:03:36 -07:00
David Brown 1d3f67d36e zephyr: Move testplan into sample Makefile
Instead of a bunch of patches that tend to become conflicting, use the
newly parameterized Makefile to make all of the test plans into make
targets.  Update the instructions to match this.

Signed-off-by: David Brown <david.brown@linaro.org>
2017-09-14 16:10:50 -06:00
David Brown a3032918a3 Update the release documentation
Add instructions about release notes, and pushing tags.

Signed-off-by: David Brown <david.brown@linaro.org>
2017-09-12 12:08:22 -06:00
David Brown 17e20d1b21 Convert design document to Markdown
The complex blocks are just verbatim, and some of the outline-style
blocks are keps as pre formatted until we decide the right way to format
them.

Signed-off-by: David Brown <david.brown@linaro.org>
2017-09-12 12:01:09 -06:00
David Brown e5f2d1cdf6 Minor doc cleanups
Fix spelling of MCUboot, and remove a duplicated link.

Signed-off-by: David Brown <david.brown@linaro.org>
2017-09-12 12:01:09 -06:00
David Brown 37f8afd217 Release notes for 1.0.0.
Move the release notes document into the docs directory, and convert to
Markdown so that it can be rendered on the project's website.

Signed-off-by: David Brown <david.brown@linaro.org>
2017-09-12 12:01:09 -06:00
David Brown c337025e3a Document the release process
An initial document describing the mechanics of how a release is made.
This is a start of documenting our full development process.

Signed-off-by: David Brown <david.brown@linaro.org>
2017-09-12 10:37:04 -06:00
David Brown d2fcc21b4f Make docs more visible from home page
Add links to the other documents to the homepage at `index.md`.  Clean
up some of these other documents (including converting the Zephyr test
plan to markdown).

Signed-off-by: David Brown <david.brown@linaro.org>
2017-09-11 16:08:47 -06:00
David Brown af30189f63 Create files needed to run Jekyll locally
By adding a Gemfile, it is possible to test the website/documentation
rendering locally.  This expects a reasonably recent version of "bundle"
to be installed, and from within the docs directory:

    bundle update
    bundle exec jekyll serve

will run a small web server on port 4000 to preview the docs.

Signed-off-by: David Brown <david.brown@linaro.org>
2017-09-11 16:08:47 -06:00
David Brown c20b997137 Remove eol whitespace from doc file
Remove these extraneous end of line spaces.

Signed-off-by: David Brown <david.brown@linaro.org>
2017-09-11 14:03:28 -06:00
David Brown 12b9dedaf6 Rearrange docs for gh-pages
Github pages allows the documentation to be in the master branch in a
'docs' directory to be rendered as the main site (mcuboot.com).  Rename
this directory, and pull in the documentation files from the old
gh-pages branch.

The main index.md page does not link to the rest of the docs yet, and
that change can be made in a future patch.

Signed-off-by: David Brown <david.brown@linaro.org>
2017-09-11 14:03:28 -06:00