Commit Graph

70 Commits

Author SHA1 Message Date
Geoffroy Van Cutsem
50249ac151 getting_started: make instructions more specific
Make the Getting Started Guide instructions more specific and
comprehensive for Clear Linux version 21260 (version of reference)

Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2018-03-20 01:03:58 +01:00
David Kinder
a5e4193ed4
Merge pull request #34 from dbkinder/master
doc: improvements for sphinx generation
2018-03-16 10:25:10 -07:00
David B. Kinder
5c6bfd7392 doc: improvements for sphinx generation
Handle version retrieval better when comments are present.
Add warning if Sphinx theme (read_the_docs) is missing.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-03-16 10:18:42 -07:00
David Kinder
b1b9f132ec
Merge pull request #33 from gvancuts/ubuntu-debian-instructions
Getting Started Guide: add instructions for other OSs
2018-03-15 14:21:53 -07:00
Geoffroy Van Cutsem
6ebdfedbbf Getting Started Guide: add instructions for other OSs
Add instructions on how to build the hypervisor and device model
on other operating systems such as Ubuntu/Debian, Fedora/Redhat
and CentOS.

Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2018-03-15 13:19:56 -07:00
David Kinder
f483ddebdb
Merge pull request #32 from dbkinder/license
doc: update project documentation LICENSE
2018-03-14 12:38:43 -07:00
David B. Kinder
46d8c04843 doc: update project documentation LICENSE
Per Project ACRN governance, documentation is under a Creative Commons
Attribution 4.0 International License (CC BY 4.0).  This patch updates
this information, and adds a tagline to documentation mentioning this
license.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-03-14 12:33:47 -07:00
David Kinder
17f0c780fe
Delete LICENSE 2018-03-14 11:14:56 -07:00
David Kinder
cbfbc3949f
Merge pull request #31 from dbkinder/filter-warnings
doc: filter known issues
2018-03-13 16:43:37 -07:00
David B. Kinder
561562dd76 doc: filter known issues
make the doc build process quiet and add filtering of known (Sphinx)
issues.  Scripting comes from the open source Zephyr project.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-03-13 16:38:08 -07:00
David Kinder
5dd9ac176c
Merge pull request #30 from dbkinder/edits1
doc: general edit for typos
2018-03-13 12:05:23 -07:00
David B. Kinder
adc74cbc37 doc: general edit for typos
Fix typos and misspellings, and tweak CSS for spacing before lists.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-03-13 11:59:40 -07:00
David Kinder
3269706e07
Merge pull request #29 from dbkinder/doxy-exclude
doc: fix doxy for hiding internal symbols
2018-03-12 11:27:34 -07:00
David B. Kinder
0250fc3298 doc: fix doxy for hiding internal symbols
Docyten syntax for EXCLUDE_SYMBOLS is with spaces for separator,
not commas.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-03-12 11:21:23 -07:00
David Kinder
da2df5a5af
Merge pull request #28 from dbkinder/gsg-1
doc: update GSG instructions
2018-03-12 07:58:19 -07:00
David B. Kinder
19ac78d834 doc: update GSG instructions
Add some clarity edits and fix misspellings

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-03-12 07:52:39 -07:00
David Kinder
2d1d1e5834
Merge pull request #27 from ailun258/patch-1
update to support latest image
2018-03-12 07:24:26 -07:00
ailun258
3b2bfade81
update to support latest image
changed 3 to support latest image release
1, deleted one bundle installation -os-clr-on-clr-dev
2, changed the default configuration file path to /usr/share/acrn/demo 
3, after installed service os bundle, all the configuration files and scripts were installed, no need to download manually any more
2018-03-12 20:41:32 +08:00
David Kinder
9037ce8caf
Merge pull request #26 from dbkinder/master
doc: Update publish process in Makefile
2018-03-11 08:49:33 -07:00
David B. Kinder
3b86ac613e doc: Update publish process in Makefile
Simplify the publishing process to projectacrn.github.io by making
commits directly to the projectacrn/projectacrn.github.io repo (rather
than to a personal repo, doing a PR, and processing the PR).  This
eliminates manual processing in an otherwise automated publishing
process:  PR reviews aren't needed for this step.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-03-11 08:40:26 -07:00
David Kinder
979411cb07
Merge pull request #25 from gvancuts/update-cl-version
getting-started-guide: update Clear Linux version to min required
2018-03-11 08:05:19 -07:00
Geoffroy Van Cutsem
7b2b622267 getting-started-guide: update Clear Linux version to min required
Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2018-03-10 23:49:55 -08:00
David Kinder
6100dd1fff
Merge pull request #24 from dbkinder/master
doc: remove "under construction" tagline
2018-03-10 15:01:27 -08:00
David B. Kinder
2d481c0e00 doc: remove "under construction" tagline
we're getting close...

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-03-10 14:55:35 -08:00
David Kinder
3041f00089
Merge pull request #23 from dbkinder/gsg
doc: add Getting Started Guide
2018-03-10 14:42:55 -08:00
David B. Kinder
14d72d2d8e doc: add Getting Started Guide
Initial version of Getting Started Guide doc (and images).
Need to replace images with better ones.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-03-10 14:35:19 -08:00
David Kinder
c6a32451a7
Merge pull request #22 from dbkinder/master
doc: fix misspellings
2018-03-10 00:12:09 -08:00
David B. Kinder
9242b2d0a9 doc: fix misspellings
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-03-10 00:06:35 -08:00
David Kinder
4941243470
Merge pull request #21 from dbkinder/master
doc: update release notes
2018-03-10 00:00:40 -08:00
David B. Kinder
b8014ead1e doc: update release notes
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-03-09 23:55:24 -08:00
David Kinder
c0f0a4bc4d
Merge pull request #20 from dbkinder/fix-contribute
doc: fix error in contributing guidelines
2018-03-09 23:50:56 -08:00
David B. Kinder
2dbcb18103 doc: fix error in contributing guidelines
fix typo

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-03-09 23:45:15 -08:00
David Kinder
5decfbc6df
Merge pull request #19 from dbkinder/releasenotes
doc: add 0.1 release notes
2018-03-09 23:29:24 -08:00
David B. Kinder
855f0d6595 doc: add 0.1 release notes
Initial version of 0.1 release notes, plus a CSS tweak for tables

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-03-09 23:23:36 -08:00
Rraghuveer
5a5fba5c3c
Update contribute.rst 2018-03-09 16:57:00 -08:00
David Kinder
d9804d81d2
Merge pull request #18 from dbkinder/primer
doc: add developer primer
2018-03-09 14:54:45 -08:00
David B. Kinder
d09dc94b52 doc: add developer primer
Developer Primer and images, and a tweak to figure formatting
also renamed from Hypervisor Primer to just Developer Primer since the
doc talks about Device Model too.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-03-09 14:48:04 -08:00
David Kinder
692cce5820
Merge pull request #17 from dbkinder/rc-version
doc: update display of RC version
2018-03-09 07:45:08 -08:00
David B. Kinder
af1aef223d doc: update display of RC version
Change display of RC_VERSION on documents to be
  vMAJOR_VERSION.MINOR_VERSION-rcRC_VERSION
if RC_VERSION is non-zero, otherwise only
  vMAJOR_VERSION.MINOR_VERSION

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-03-09 07:35:54 -08:00
David Kinder
7c0a4049eb
Merge pull request #16 from dbkinder/master
doc: add CODEOWNERS for assigning reviewers
2018-03-08 23:20:10 -08:00
David Kinder
571b81e13a
Create LICENSE 2018-03-08 23:16:10 -08:00
David B. Kinder
f2c0cae738 doc: add CODEOWNERS for assigning reviewers
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-03-08 23:14:53 -08:00
David Kinder
d621217225
Merge pull request #15 from dbkinder/master
doc: update build process to get RC_VERSION
2018-03-08 22:52:07 -08:00
David B. Kinder
2e6d469c16 doc: update build process to get RC_VERSION
Doc version tracking with acrn-hypervisor version now to be
MAJOR_VERSION . MINOR_VERSION . RC_VERSION

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-03-08 22:44:04 -08:00
David Kinder
b4b3ebcb9c
Merge pull request #14 from dbkinder/contrib1
doc: fix formatting errors in contribution guide
2018-03-08 22:37:50 -08:00
David B. Kinder
7b291e4afd doc: fix formatting errors in contribution guide
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-03-08 22:31:27 -08:00
Rraghuveer
73bdb47775
Update contribute.rst 2018-03-08 22:05:42 -08:00
Rraghuveer
575b48a9c1
Update contribute.rst 2018-03-08 21:50:44 -08:00
David Kinder
9737b14dfe
Merge pull request #13 from dbkinder/master
doc: add Technical intro doc
2018-03-08 16:13:14 -08:00
David B. Kinder
74274634de doc: add Technical intro doc
Add the "Introduction of Project Acorn" doc.

Also adds improvements to the doc generation processes, content styles,
removed doxygen-generated API material.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-03-08 16:07:31 -08:00