OrgACRN
/
acrn-hypervisor
mirror of https://github.com/projectacrn/acrn-hypervisor.git
1
0
Fork 0
Code Issues Releases Wiki Activity
acrn-hypervisor/doc/release_notes/index.rst

66 lines
1.8 KiB
ReStructuredText
Raw Normal View History

doc: initial doc commit Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-03-06 14:54:44 +08:00
.. _release_notes:
Release Notes
#############
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-10 15:23:36 +08:00
doc: reference old release notes in archived release docs Instead of trying to maintain the release notes for old releases in the current release, reference them in a previous archive. This eliminates the need to fix doc build errors by editing old release notes that reference material that no longer exists in the newer release. We use the intersphinx extension to support references to Sphinx-generated content from other projects. In our case, we're referencing the archived version of v2.7 documents that was the last release to generate release notes for all previous releases. This import is done in conf.py. (Alternatively we could reference the release notes for a release in that specific release's archive, but that means fetchind the intersphinx inventory file (objects.inv) for every release, and seems like overkill.) This modification still allows putting multiple release notes in the doc/release_notes folder and they'll show up in the release notes index as they have in the past. Update the separate "archived" release notes section manually as needed. Also, adds a draft of the v3.0 release notes to verify the new release notes index page layout. Fixes: #7171 Tracked-On: #7171 Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-04-03 04:53:07 +08:00
ACRN is a flexible, lightweight reference hypervisor, built with real-time and
safety-criticality in mind, optimized to streamline embedded development through
an open source platform. Check out the :ref:`introduction` for more information.
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-10 15:23:36 +08:00
doc: fix misspellings Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-03-10 16:06:35 +08:00
The project ACRN reference code can be found on GitHub in
doc: reference old release notes in archived release docs Instead of trying to maintain the release notes for old releases in the current release, reference them in a previous archive. This eliminates the need to fix doc build errors by editing old release notes that reference material that no longer exists in the newer release. We use the intersphinx extension to support references to Sphinx-generated content from other projects. In our case, we're referencing the archived version of v2.7 documents that was the last release to generate release notes for all previous releases. This import is done in conf.py. (Alternatively we could reference the release notes for a release in that specific release's archive, but that means fetchind the intersphinx inventory file (objects.inv) for every release, and seems like overkill.) This modification still allows putting multiple release notes in the doc/release_notes folder and they'll show up in the release notes index as they have in the past. Update the separate "archived" release notes section manually as needed. Also, adds a draft of the v3.0 release notes to verify the new release notes index page layout. Fixes: #7171 Tracked-On: #7171 Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-04-03 04:53:07 +08:00
https://github.com/projectacrn. It includes the ACRN hypervisor, the ACRN
Device Model, and documentation.
.. comment Maintain current release notes in the master branch/latest docs
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-14 02:59:40 +08:00
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-22 04:22:02 +08:00
.. rst-class:: rst-columns
doc: prepare for versioned release notes Break out each version release notes into a separate .rst file and an organizing top-level release notes page. Create a draft version for the v0.2 release notes. Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-09-06 06:49:21 +08:00
.. toctree::
:maxdepth: 1
:glob:
:reversed:
doc: update release v0.1 release notes Include developer comments, add commit change log, update conf.py to include url shortcuts for references to GitHub issues and commits. Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-07-12 03:27:49 +08:00
doc: prepare for versioned release notes Break out each version release notes into a separate .rst file and an organizing top-level release notes page. Create a draft version for the v0.2 release notes. Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-09-06 06:49:21 +08:00
release_notes_*
doc: reference old release notes in archived release docs Instead of trying to maintain the release notes for old releases in the current release, reference them in a previous archive. This eliminates the need to fix doc build errors by editing old release notes that reference material that no longer exists in the newer release. We use the intersphinx extension to support references to Sphinx-generated content from other projects. In our case, we're referencing the archived version of v2.7 documents that was the last release to generate release notes for all previous releases. This import is done in conf.py. (Alternatively we could reference the release notes for a release in that specific release's archive, but that means fetchind the intersphinx inventory file (objects.inv) for every release, and seems like overkill.) This modification still allows putting multiple release notes in the doc/release_notes folder and they'll show up in the release notes index as they have in the past. Update the separate "archived" release notes section manually as needed. Also, adds a draft of the v3.0 release notes to verify the new release notes index page layout. Fixes: #7171 Tracked-On: #7171 Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-04-03 04:53:07 +08:00
Release Notes Archive
*********************
Release notes for previous releases are available in the project documentation
archives:
.. comment Maintain this list of archived release notes manually as needed. As
configured in conf.py, these documents are found in the v2.7 documentation using
the intersphinx extension. (That was the last release where we generated
all the previous release notes in one place.)
.. rst-class:: rst-columns
- :ref:`release_notes_2.7`
- :ref:`release_notes_2.6`
- :ref:`release_notes_2.5`
- :ref:`release_notes_2.5.1`
- :ref:`release_notes_2.4`
- :ref:`release_notes_2.3`
- :ref:`release_notes_2.2`
- :ref:`release_notes_2.1`
- :ref:`release_notes_2.0`
- :ref:`release_notes_1.6`
- :ref:`release_notes_1.6.1`
- :ref:`release_notes_1.5`
- :ref:`release_notes_1.4`
- :ref:`release_notes_1.3`
- :ref:`release_notes_1.2`
- :ref:`release_notes_1.1`
- :ref:`release_notes_1.0`
- :ref:`release_notes_1.0.1`
- :ref:`release_notes_1.0.2`
- :ref:`release_notes_0.8`
- :ref:`release_notes_0.7`
- :ref:`release_notes_0.6`
- :ref:`release_notes_0.5`
- :ref:`release_notes_0.4`
- :ref:`release_notes_0.3`
- :ref:`release_notes_0.2`
- :ref:`release_notes_0.1`