Commit Graph

94 Commits

Author SHA1 Message Date
David B. Kinder
84601935a1 doc: use consistent month names in release notes
Some months were spelled out, others were abbreviated, making the list
of all release notes look a bit off.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-08-10 16:15:46 -07:00
David B. Kinder
7404fb08ff doc: update release notes about LAPIC timer in OVMF
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-08-07 14:43:36 -07:00
fuzhongl
3f7b6853ff Doc:release_notes_2.1 update
Add fixed issues and known issues.

Signed-off-by: fuzhongl <fuzhong.liu@intel.com>
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-08-07 08:11:09 -07:00
David B. Kinder
f788d2746f doc: draft v2.1 release notes
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-08-06 08:56:26 -07:00
fuzhongl
eabb512ded DOC: v2.0 release notes
Add fixed issues and known issues in release note.

Signed-off-by: fuzhongl <fuzhong.liu@intel.com>
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-06-24 08:43:21 -07:00
David B. Kinder
b82e6146c4 doc: more release notes 2.0 edits
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-06-22 10:14:09 -07:00
David B. Kinder
380cd7f33e doc: update 2.0 release notes
Updates from reviewer comments included

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-06-18 11:02:37 -07:00
David B. Kinder
137f7d67e7 doc: v2.0 release notes
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-06-17 20:34:22 -07:00
David B. Kinder
db454dcdf1 doc: rst syntax tweaks
There are some subtle syntax errors in some documents that, while they
render OK (most of the time), are being caught by rstcheck (a
restructuredText linter). This PR fixes most of the issues encountered.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-06-03 14:37:37 -07:00
David B. Kinder
4db42c1c7f doc: fix rst-columns display
Using ``.. rst-class:: rst-columns`` wasn't processed correctly because
of an error in the acrn-custom.css file.  Fix that, update the
documentation guidelines, and make use of the multi-column display in
documents where the toctree created a long list.  Now it will
appear in columns.

Also tweaked the toctree listing to use bold for the first-level items
(making a multi-column display look better, particularly when it has
subsections).

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-05-21 15:08:15 -07:00
Junming Liu
3ccbb20087 doc:add tutorial about enabling GVT-d
Previous tutorial "Enable GPU Passthrough on the Skylake NUC"
is out of date, so delete it here.

v2 -> v1:
add attached file

Signed-off-by: Junming Liu <junming.liu@intel.com>
2020-05-20 11:58:19 -04:00
David B. Kinder
b86e90532b doc: fix malformed acrn-issue references
Syntax of acrn-issue role was incorrect in fixed issues section

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-05-11 17:29:06 -07:00
David B. Kinder
956f1157e2 doc: edit 1.6.1 release notes
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-05-11 08:48:50 -07:00
fuzhongl
5ed7f889f1 Doc: releasenotes_1.6.1
Signed-off-by: fuzhongl <fuzhong.liu@intel.com>
2020-05-11 08:05:07 -07:00
David B. Kinder
b0c7993309 doc: remove stray UTF-8 characters
Convert UTF-8 characters (typically pasted from Word for smart quotes
and such) into equivalent ASCII characters.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-05-04 16:16:32 -07:00
Deb Taylor
b514eba9d6 Doc: Modify Getting Started and Advanced Guides sections (navigation)
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2020-04-24 13:03:54 -04:00
David B. Kinder
4b1dfe9632 doc: remove trailing spaces
Remove trailing spaces on lines to avoid potential issues with git

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-04-15 11:46:06 -07:00
David B. Kinder
f5f16f4e64 doc: clean up utf8 characters
Stray non-ASCII characters can creep in when pasting from Word or Google
Docs, particularly for "smart" single and double quotes and non-breaking
spaces.  Change these to their ASCII equivalents.  Also fixed some very
long lines of text to wrap at 80-ish characters.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-04-15 10:17:54 -07:00
David B. Kinder
1e8269b5f7 doc: fix misspellings
Fix misspellings missed during regular reviews

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-04-10 08:58:54 -07:00
Deb Taylor
de3bc3faec Doc: Release Notes update based on DKinder edits
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2020-04-01 19:28:25 -04:00
Deb Taylor
9a805f6c6b Doc: Grammactical edits to Release Notes 1.6
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2020-04-01 14:28:31 -04:00
fuzhongl
0244bcaf5d Doc: releasenotes_1.6
Signed-off-by: fuzhongl <fuzhong.liu@intel.com>
2020-04-01 05:40:09 -04:00
Vijay Dhanraj
a2763ab7f0 doc: Add MBA documentation and update doc for CAT
This patch updates CAT documentation as well as adds
documentation support for newly added MBA feature.

Signed-off-by: Vijay Dhanraj <vijay.dhanraj@intel.com>
2020-03-27 16:58:20 -04:00
Deb Taylor
fd2330c924 Doc: Changed lines in RN 1.0 and 0.1 to correct ref issue.
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2020-03-12 22:55:03 -04:00
fuzhongl
fe03d8700d Doc: releasenotes_1.5 update
adding this information to releasenotes:
Update to use ACRNGT GOP to install Windows

Signed-off-by: fuzhongl <fuzhong.liu@intel.com>
2020-01-08 20:33:53 -05:00
Deb Taylor
96aba9bd45 Doc: Grammatical edits to RN 1.5.
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2020-01-07 22:12:38 -05:00
fuzhongl
9b454dc406 Doc: releasenotes_1.5
Signed-off-by: fuzhongl <fuzhong.liu@intel.com>
2020-01-07 20:36:21 -05:00
lirui34
ec6777ab09 doc: Update 1.4 versions and some words
Signed-off-by: lirui34 <ruix.li@intel.com>
2019-11-21 10:15:46 -05:00
Deb Taylor
faa348ebdd Doc: Corrected title formatting in RN 1.0.2 doc.
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2019-11-21 09:43:55 -05:00
wenlingz
2400f073d1 releasenote for release_1.0.2
Signed-off-by: wenlingz <wenling.zhang@intel.com>
2019-11-21 08:51:25 -05:00
Deb Taylor
bb3befa306 Doc: Grammatical edits to the 1.4 Release Notes.
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2019-11-11 11:47:12 -05:00
lirui34
c1470c8a02 doc: Release notes v1.4
Signed-off-by: lirui34 <ruix.li@intel.com>
2019-11-11 11:06:25 -05:00
lirui34
f835fdef05 doc: Remove apl gsg and merge contents into rt gsg
Change APL getting started guide to KBL getting started guide;
Merge some of the contents into preempt-rt getting started guide;
Move the modified kbl getting started guide to the behind of the configuration tutorials;
Fix issues for acrn_quick_setup.sh script.

Signed-off-by: lirui34 <ruix.li@intel.com>
2019-11-05 15:09:49 -05:00
David B. Kinder
c1cc3040a4 doc: fix remaining masked doc build errors
This should get us back to a clean doc build now...

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-10-29 17:26:21 -07:00
Deb Taylor
04d88e4b7d Doc: remove broken links in RNs.
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2019-10-29 20:06:25 -04:00
Lei, Lu
64742be820 doc: fix broken link in release notes 1.3
Signed-off-by: Lei, Lu <leix.lu@intel.com>
2019-09-29 14:59:33 +08:00
lirui34
9dbbaa1e7d doc: Release notes v1.3
Release notes v1.3

Signed-off-by: lirui34 <ruix.li@intel.com>
2019-09-27 17:34:41 -04:00
lirui34
a95a88c5b2 doc: Remove "or newer/higher" descriptions for other release notes and some tutorials.
ACRN tag is ONLY specific to one Clear Linux version.
For the tutorials, we just need to make sure the validated version is functional.

Signed-off-by: lirui34 <ruix.li@intel.com>
2019-09-11 12:56:42 -04:00
Deb Taylor
add89b51ec Remove "or newer" reference to ensure that users know ACRN 1.2 requires ONLY Clear Linux OS version 30690.
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2019-09-06 18:44:17 -04:00
lirui34
48d06da743 doc: Add three known issues to the v1.2 release notes
Add three known issues to the v1.2 release notes.

Signed-off-by: lirui34 <ruix.li@intel.com>
2019-08-23 19:50:42 +08:00
lirui34
27b7cc23ea doc: Release Notes v1.2
Add release notes v1.2

Signed-off-by: lirui34 <ruix.li@intel.com>
2019-08-15 09:23:40 -07:00
David B. Kinder
0085348f36 doc: update v1.0.1 release notes
Fix some wording, table formatting, and links to issues and commits from
the original PR #3515

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-08-02 10:23:13 -07:00
lirui34
3b00ab160e doc: release notes v1.0.1
Add release notes v1.0.1

Signed-off-by: lirui34 <ruix.li@intel.com>
2019-08-02 09:55:19 -07:00
David B. Kinder
9fef51abf9 doc: organize release notes into a folder
Unclutter the main doc folder by putting all the release notes
into a separate folder.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-07-24 09:47:24 -07:00