doc: spell check and formatting

Fix misspellings missed during regular reviews, and remove trailing white space and Windows \r at end of lines. Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2025-06-20 20:53:46 +00:00 · 2019-01-07 13:13:03 -08:00 · 2019-01-07 13:13:03 -08:00 · e50cd15304
commit e50cd15304
parent cc95fdba76
7 changed files with 153 additions and 150 deletions
--- a/doc/getting-started/up2.rst
+++ b/doc/getting-started/up2.rst
@ -82,7 +82,7 @@ UP2 serial port setting
 The serial port (ttyS1) in the 40-pin HAT connector is located at ``serial PCI BDF 0:18.1``.
 You can check this from the ``lspci`` output from the initial Clearlinux installation.
-Also you can use ``dmesg | grep tty`` to get its IRQ infomation for vuart setting; and update
+Also you can use ``dmesg | grep tty`` to get its IRQ information for vuart setting; and update
 SOS bootargs ``console=ttyS1`` in acrn.conf to match with vuart setting.
 .. code-block:: none
--- a/doc/release_notes_0.1.rst
+++ b/doc/release_notes_0.1.rst
@ -390,7 +390,7 @@ initial release in March 2018 (click on the CommitID link to see details):
 - :acrn-commit:`a167f44` doc: add graphviz installation instructions
 - :acrn-commit:`2e3af9e` tools: acrn-crashlog: fix typo in Makefile
 - :acrn-commit:`d8c8403` hv: replace vlapic_init by vlapic_reset in vcpu_reset
- :acrn-commit:`359b93f` HV: Remove misuesed __unused
+- :acrn-commit:`359b93f` HV: Remove misused __unused
 - :acrn-commit:`719e07f` HV: fix a print typo in create_vcpu
 - :acrn-commit:`74dfa42` hv: Add initialize pm.c
 - :acrn-commit:`feed38f` hv: add suspend/resume callback for console
@ -415,7 +415,7 @@ initial release in March 2018 (click on the CommitID link to see details):
 - :acrn-commit:`5e2c83f` hv:replace unsigned long long with uint64_t
 - :acrn-commit:`f757d49` Merge pull request #322 from dbkinder/api-spell
 - :acrn-commit:`44293a4` doc: use graphviz for intro boot-flow diagram
- :acrn-commit:`64515cf` Tools:acrn-manager Fix wrong descrition of mngr_send_msg()
+- :acrn-commit:`64515cf` Tools:acrn-manager Fix wrong description of mngr_send_msg()
 - :acrn-commit:`b7ad705` convert bridge creation to service
 - :acrn-commit:`48b0894` hv: relocate trampoline code to the dynamically allocated memory
 - :acrn-commit:`2a1a6ad` hv: Other preparation for trampoline code relocation
@ -442,7 +442,7 @@ initial release in March 2018 (click on the CommitID link to see details):
 - :acrn-commit:`ce061d3` doc: add python and Kconfiglib as prerequisite development tools
 - :acrn-commit:`647aee6` scripts: introduce .config/config.h generators
 - :acrn-commit:`5e521e2` IOC mediator: Disable hardware flow control by default
- :acrn-commit:`8379119` tools: acrnctl: Fix wrong descrition of mngr
+- :acrn-commit:`8379119` tools: acrnctl: Fix wrong description of mngr
 - :acrn-commit:`c34360b` DM USB: Fix potential crash issues.
 - :acrn-commit:`e334675` hv: add fixup to trampline code
 - :acrn-commit:`f3831cd` hv: don't combine the trampline code with AP start
@ -585,12 +585,12 @@ initial release in March 2018 (click on the CommitID link to see details):
 - :acrn-commit:`11abe6e` tools: acrnctl: fix possibility of buffer overflow
 - :acrn-commit:`004d2e2` HV: treewide: give names to unnamed structs/unions
 - :acrn-commit:`ef3cb5b` treewide: remove unnecessary unnamed structs/unions
- :acrn-commit:`b9660eb` refomatted GET_DATA_SIZE macro
+- :acrn-commit:`b9660eb` reformatted GET_DATA_SIZE macro
 - :acrn-commit:`4b4e1e1` DM: Add option of no check against ptdev reset
 - :acrn-commit:`b19d936` DM: refuse passthrough PCIe without reset support
 - :acrn-commit:`c3793e1` DM sample: update uos launch script for virtio rpmb
 - :acrn-commit:`9f56364` DM USB: xHCI: add log level switch
- :acrn-commit:`be4406c` DM USB: xHCI: modify option parsing function to enable USB virtualiztion
+- :acrn-commit:`be4406c` DM USB: xHCI: modify option parsing function to enable USB virtualization
 - :acrn-commit:`6449950` DM USB: xHCI: add xHCI de-initialization support
 - :acrn-commit:`048b2c7` DM USB: xHCI: add port sharing feature
 - :acrn-commit:`8aef2cb` DM USB: Add some APIs for check native related configurations.
@ -631,7 +631,7 @@ initial release in March 2018 (click on the CommitID link to see details):
 - :acrn-commit:`7811bdd` Makefile: add a target to build sbl hypervisor
 - :acrn-commit:`364b242` hypervisor: install acrn.32.out to /usr/lib/acrn/acrn.sbl
 - :acrn-commit:`977d48d` hypervisor: install acrn.efi to /usr/lib
- :acrn-commit:`9563e24` samples: move samples to specifi platform diretory
+- :acrn-commit:`9563e24` samples: move samples to specify platform directory
 - :acrn-commit:`d3ef8ae` fix "warning ISO C forbids omitting the middle term of a?:expression"
 - :acrn-commit:`64d2efc` fix "obsolete use of designated initializer without '='"
 - :acrn-commit:`67dfec8` vmexit: refine vmexit loop
@ -671,7 +671,7 @@ initial release in March 2018 (click on the CommitID link to see details):
 - :acrn-commit:`88ba420` tools: acrn-crashlog: command utils for acrn-crashlog
 - :acrn-commit:`780fefc` tools: acrn-crashlog: string utils for acrn-crashlog
 - :acrn-commit:`6f9dfa4` tools: acrn-crashlog: framework of acrn-crashlog
- :acrn-commit:`7c9cc6b` hv:Merge dump_interrupt and dump_exception to a commond API
+- :acrn-commit:`7c9cc6b` hv:Merge dump_interrupt and dump_exception to a common API
 - :acrn-commit:`d88b968` hv: Remove nested check when dump exception
 - :acrn-commit:`8384ed2` hv:rename data structure intr_ctx
 - :acrn-commit:`88b8ce8` hv: move structure(intr_ctx) to irq.h
@ -729,7 +729,7 @@ initial release in March 2018 (click on the CommitID link to see details):
 - :acrn-commit:`ace25dd` Makefile: implement make install
 - :acrn-commit:`f7a93d8` Makefile: use -C parameter for recursive invocation
 - :acrn-commit:`a6ff3a9` vm: allocated all pcpus to vm0 at the beginning
- :acrn-commit:`d2a7a9c` uefi: remove warkaround for AP wakeup
+- :acrn-commit:`d2a7a9c` uefi: remove workaround for AP wakeup
 - :acrn-commit:`953f6b5` vlapic: kick AP for INIT-SIPI sequence
 - :acrn-commit:`2ea3b49` HV: refine copy_from_vm/copy_to_vm
 - :acrn-commit:`30549a5` DM: increase vioapic pin count
@ -778,7 +778,7 @@ initial release in March 2018 (click on the CommitID link to see details):
 - :acrn-commit:`eebf5fe` HV: correct the handling of MU_MEM_ATTR_READ MMU flag
 - :acrn-commit:`4817134` DM: rename acrn_register to acpi_generic_address
 - :acrn-commit:`8a73718` doc: add use of GitHub issues
- :acrn-commit:`260b37a` HV: Fix the missing list_head initializaiton
+- :acrn-commit:`260b37a` HV: Fix the missing list_head initialization
 - :acrn-commit:`e386a81` DM: bug fix in handling signal
 - :acrn-commit:`2550d71` Subject: DM: virtio-heci: process all available client each time
 - :acrn-commit:`5ed3dbf` Subject: DM: virtio-heci: Use atomic_xchange in client get/put
@ -792,7 +792,7 @@ initial release in March 2018 (click on the CommitID link to see details):
 - :acrn-commit:`e8d5a49` refine external interrupt VM exit handler
 - :acrn-commit:`121d14a` rename 'req_buf' field in 'struct vm_sw_info'
 - :acrn-commit:`bf0d79b` Make the Service OS bootloader configurable
- :acrn-commit:`7dd6476` doc: GSG formating fix, RTD theme tweak
+- :acrn-commit:`7dd6476` doc: GSG formatting fix, RTD theme tweak
 - :acrn-commit:`c3b1d0c` Getting Started Guide: update to reflect the new boot flow
 - :acrn-commit:`85716e8` security: fix issues reported by Klocwork
 - :acrn-commit:`b61e6af` hv: cpuid: don't reference the crossed array
@ -855,9 +855,9 @@ initial release in March 2018 (click on the CommitID link to see details):
 - :acrn-commit:`a331624` dm: virtio-console: Fix the bug that ports cannot work
 - :acrn-commit:`51a76a9` hv: save early hv logmsg before sos booted
 - :acrn-commit:`c61559a` hv: remove spinlock_irq_obtain/spinlock_irq_release
- :acrn-commit:`db4e3f8` bootparam: bug fix on address convertion
+- :acrn-commit:`db4e3f8` bootparam: bug fix on address conversion
- :acrn-commit:`2a37a4d` ACPI: bug fix on address convertion
+- :acrn-commit:`2a37a4d` ACPI: bug fix on address conversion
- :acrn-commit:`c5f860e` MMU: bug fix on operating va <=> pa convertion
+- :acrn-commit:`c5f860e` MMU: bug fix on operating va <=> pa conversion
 - :acrn-commit:`d02f4d4` refine: change the address arguments type of mmio access api
 - :acrn-commit:`11d0e59` revise type of 'exit_reason' and 'inst_len' in vcpu_arch
 - :acrn-commit:`96085d9` DM: release mem range allocated in init_pci
@ -889,7 +889,7 @@ initial release in March 2018 (click on the CommitID link to see details):
 - :acrn-commit:`db46df9` DM: add init/deinit function for mevent
 - :acrn-commit:`c8116fc` spinlock: bug fix in spinlock code
 - :acrn-commit:`c5fabf5` sprintf: bug fix in sprintf implemented code
- :acrn-commit:`9b37e14` add IO requrest 'req_buf' check before reference
+- :acrn-commit:`9b37e14` add IO request 'req_buf' check before reference
 - :acrn-commit:`3a3aeac` VMX: change PAT register default value
 - :acrn-commit:`52c020c` VMX: bug fix on operating vmx
 - :acrn-commit:`7ed446e` ptdev: bug fix on operating list
@ -897,7 +897,7 @@ initial release in March 2018 (click on the CommitID link to see details):
 - :acrn-commit:`1e2c201` vtd: add page allocation check for root_table & context_table
 - :acrn-commit:`4ea7588` vtd: context_table_addr should be hpa
 - :acrn-commit:`403076e` vtd: dmar_uint->root_table_addr should be hpa
- :acrn-commit:`3847a4d` hypercall: bug fix on the address convertion while hypercall
+- :acrn-commit:`3847a4d` hypercall: bug fix on the address conversion while hypercall
 - :acrn-commit:`ebba622` mmu: add mmu invlpg support
 - :acrn-commit:`2d6c754` mmu: refine the checking of entry present
 - :acrn-commit:`60425f9` mmu: add ept execution only capability check
--- a/doc/release_notes_0.2.rst
+++ b/doc/release_notes_0.2.rst
@ -205,7 +205,7 @@ release in July 2018 (click on the CommitID link to see details):
 - :acrn-commit:`6085781` Replace __emalloc() with a call to uefi allocate_page()
 - :acrn-commit:`fea102e` Remove emalloc_for_low_mem() routine in EFI boot code of HV
 - :acrn-commit:`ccf5624` hv:irq: avoid out-of-range access to irq_alloc_bitmap[]
- :acrn-commit:`4a038d1` dm: workaroud for DM crash when doing fastboot reboot
+- :acrn-commit:`4a038d1` dm: workaround for DM crash when doing fastboot reboot
 - :acrn-commit:`688cdda` DM USB: xHCI: enable USB xHCI emulation in LaaG and AaaG.
 - :acrn-commit:`d4afddc` Revert "hv: init_iommu rework to enable IOMMU for partition mode ACRN"
 - :acrn-commit:`40dfd3f` doc: edit 0.2 release notes
@ -215,7 +215,7 @@ release in July 2018 (click on the CommitID link to see details):
 - :acrn-commit:`2197f43` HV: Add acpi_fixup api to override acpi on needs
 - :acrn-commit:`0d5ad8a` HV: add simple parser for ACPI data table
 - :acrn-commit:`a1e9fdc` HV: add Kconfig of CONSTANT_ACPI
- :acrn-commit:`eb8c4fb` hv:Fix Implict conversion:actual to formal param
+- :acrn-commit:`eb8c4fb` hv:Fix Implicit conversion:actual to formal param
 - :acrn-commit:`8f0cb56` HV: trusty: refine version checking when initializing trusty
 - :acrn-commit:`9d60220` hv: remove unused MACROs
 - :acrn-commit:`bb0a2bc` HV:Hypercall:Remove redundant error checking
@ -288,7 +288,7 @@ release in July 2018 (click on the CommitID link to see details):
 - :acrn-commit:`30b77ab` DM: unmap ptdev BAR when deinit
 - :acrn-commit:`1b334ec` hv: replace 'return' with 'panic' in bsp_boot_post
 - :acrn-commit:`bad8d81` IOC mediator: add new signal for VBUS control
- :acrn-commit:`f2f719c` hv: fix 'Procedure is not called or referenced in code analysed'
+- :acrn-commit:`f2f719c` hv: fix 'Procedure is not called or referenced in code analyzed'
 - :acrn-commit:`3718177` hv:Replace dynamic allocation with static memory for shell
 - :acrn-commit:`c045442` DM: watchdog: correct 2 MACRO define
 - :acrn-commit:`198c6e9` DM: coding style: replace tab with space
@ -435,7 +435,7 @@ release in July 2018 (click on the CommitID link to see details):
 - :acrn-commit:`363b4da` DM USB: xHCI: refine xHCI PORTSC Register related functions
 - :acrn-commit:`b746377` DM USB: xHCI: fix an xHCI issue to enable UOS s3 feature
 - :acrn-commit:`b5a233d` HV: Enclose debug specific code with #ifdef HV_DEBUG
- :acrn-commit:`b086162` dm: monotor: bugfix: update wakeup reason before call recume() callback
+- :acrn-commit:`b086162` dm: monitor: bugfix: update wakeup reason before call resume() callback
 - :acrn-commit:`a86a25f` tools: acrnd: Fixed get_sos_wakeup_reason()
 - :acrn-commit:`2d802d0` tools: vm_resume() requires wakeup reason
 - :acrn-commit:`64a9b2b` Revert "[REVERT-ME]: disable turbo mode"
@ -451,7 +451,7 @@ release in July 2018 (click on the CommitID link to see details):
 - :acrn-commit:`7d83abb` HV: Add the emulation of CPUID with 0x16 leaf
 - :acrn-commit:`e0eeb8a` HV: Limit the CPUID with >= 0x15 leaf
 - :acrn-commit:`d5d3d2d` tools: acrnlog: Add [-t interval] [-h] to usage
- :acrn-commit:`a9a2f91` tools: acrntrace: Remove unused paramters "-r" related things
+- :acrn-commit:`a9a2f91` tools: acrntrace: Remove unused parameters "-r" related things
 - :acrn-commit:`76e43ac` HV: handle trusty on vm reset
 - :acrn-commit:`c55b696` HV: remove 'warm_reboot()'function and other minor cleanup
 - :acrn-commit:`77011ce` HV: Merge hypervisor debug header files
@ -576,7 +576,7 @@ release in July 2018 (click on the CommitID link to see details):
 - :acrn-commit:`ae8836d` hv:fix return value violation for vioapic_get_rte
 - :acrn-commit:`cd3a62f` HV: Refine invalid parameter handling in hypervisor shell
 - :acrn-commit:`61782d7` hv:Rename port/mmio read and write APIs
- :acrn-commit:`7db4c0a` DM: Add funciton to update PM_WAK_STS
+- :acrn-commit:`7db4c0a` DM: Add function to update PM_WAK_STS
 - :acrn-commit:`a8a27d8` dm: add S3 support for UOS
 - :acrn-commit:`8ee4c0b` DM: add vm_stop/reset_watchdog
 - :acrn-commit:`a2241d9` DM: register pm ops to monitor
@ -591,14 +591,14 @@ release in July 2018 (click on the CommitID link to see details):
 - :acrn-commit:`64f6295` acrn-manager: create acrn-hypervisor-dev package
 - :acrn-commit:`51c75e9` hv: treewide: fix 'Function prototype/defn param type mismatch'
 - :acrn-commit:`cf8fd8c` Revert "HV: clear memory region used by UOS before it exit"
- :acrn-commit:`9c24c5c` HV:Remame 'shell_internal.c' to 'shell.c'
+- :acrn-commit:`9c24c5c` HV:Rename 'shell_internal.c' to 'shell.c'
 - :acrn-commit:`3b06282` HV:Remove i/o session sw interface from hypervisor shell
 - :acrn-commit:`a8e9d83` samples: change WIFI BDF to 3:0:0
 - :acrn-commit:`00bfde3` HV: rename resume_vm to start_vm in hypercall api
 - :acrn-commit:`5e31e7c` IOC mediator: Add parking brake and Hvac signals
 - :acrn-commit:`457ecd6` hv: softirq: refine softirq
 - :acrn-commit:`073583c` hv: softirq: move softirq.c to common directory
- :acrn-commit:`dec24a9` hv: add check to invalid CR8 writting from guest
+- :acrn-commit:`dec24a9` hv: add check to invalid CR8 writing from guest
 - :acrn-commit:`13a50c9` hv: Explicitly trap VMXE and PCIDE bit for CR4 write
 - :acrn-commit:`f0ef41c` hv: Extend the always off mask of CR0 and CR4
 - :acrn-commit:`d18642a` hv: Add function to check whether cr0 written operation is valid
@ -619,7 +619,7 @@ release in July 2018 (click on the CommitID link to see details):
 - :acrn-commit:`b21b172` HV: io: refactoring vmexit handler on EPT violation
 - :acrn-commit:`50e4bc1` HV: io: refactoring vmexit handler on I/O instruction
 - :acrn-commit:`d4d8a12` doc: tweak formatting for :kbd: role
- :acrn-commit:`9c3d77e` doc: tweek known-issues pattern for hypercall API
+- :acrn-commit:`9c3d77e` doc: tweak known-issues pattern for hypercall API
 - :acrn-commit:`99ebd92` hv:Delete serial files
 - :acrn-commit:`ae30040` hv:Reshuffle console/uart code
 - :acrn-commit:`b743627` IOC mediator: fix IOC mediator blocks acrn-dm shutdown flow
@ -630,7 +630,7 @@ release in July 2018 (click on the CommitID link to see details):
 - :acrn-commit:`3446e84` HV:treewide:rename struct timer as struct hv_timer
 - :acrn-commit:`cf7a940` HV: clear memory region used by UOS before it exit
 - :acrn-commit:`a2fe964` HV: Rename functions beginning with "_"
- :acrn-commit:`d40a6b9` DM: add service to support auot boot UOS
+- :acrn-commit:`d40a6b9` DM: add service to support auto boot UOS
 - :acrn-commit:`496e400` HV:treewide:fix rest of violations related parameter changed
 - :acrn-commit:`42c77e4` Documentation: add needed library for acrnprobe
 - :acrn-commit:`a4aed45` tools: acrn-crashlog: replace debugfs with api
@ -675,7 +675,7 @@ release in July 2018 (click on the CommitID link to see details):
 - :acrn-commit:`3d6ff0e` tools: acrntrace: save trace data file under current dir by default
 - :acrn-commit:`3abfdba` doc: add script for syncing acrn-kernel for API gen
 - :acrn-commit:`363a84c` DOC:GSG: Fix few mistakes about updating acrn.conf and efibootmgr options
- :acrn-commit:`f18a02a` HV: misra cleanup for platform acpi info
+- :acrn-commit:`f18a02a` HV: MISRA cleanup for platform acpi info
 - :acrn-commit:`ee13110` HV: change wake vector address to accommodate sbl
 - :acrn-commit:`4344832` Revert "DM sample: force enabling HDMI1 and HDMI2 connectors"
 - :acrn-commit:`f7f04ba` hv: mmu: minor fix about hv mmu && ept modify
@ -683,7 +683,7 @@ release in July 2018 (click on the CommitID link to see details):
 - :acrn-commit:`27fbf9b` HV:treewide:Fixing pointer castings
 - :acrn-commit:`a368b57` hv: fix typo in relocation code
 - :acrn-commit:`b35e330` HV: make: check CONFIG_RELEASE=y for release build
- :acrn-commit:`da0f28c` HV: Bracket for the same level of precendence
+- :acrn-commit:`da0f28c` HV: Bracket for the same level of precedence
 - :acrn-commit:`91337da` HV: logical and high level precedence expression needs brackets
 - :acrn-commit:`7aec679` HV: Clean up the unused or legacy code-like comment
 - :acrn-commit:`c776137` doc: fix doc error filter patterns
@ -691,7 +691,7 @@ release in July 2018 (click on the CommitID link to see details):
 - :acrn-commit:`af194bc` HV: fix bug of restore rsp context
 - :acrn-commit:`4fd870f` hv: efi: remove multiple defined struct efi_ctx & dt_addr_t
 - :acrn-commit:`d5be735` hv: correct the way to check if a MSR is a fixed MTRR register
- :acrn-commit:`bd69799` fix assign.c interger violations
+- :acrn-commit:`bd69799` fix assign.c integer violations
 - :acrn-commit:`f0a3585` HV: common: cleanup of remaining integral-type issues
 - :acrn-commit:`112b5b8` HV: guest: cleanup of remaining integral type violations
 - :acrn-commit:`1a1ee93` HV: hypercall: make hypercall functions return int32_t
@ -754,7 +754,7 @@ release in July 2018 (click on the CommitID link to see details):
 - :acrn-commit:`8d12c06` dm: introduce system/full reset and suspend
 - :acrn-commit:`76662a6` loader: Update the memory address of GUEST_CFG_OFFSET
 - :acrn-commit:`a91952d` HV: per_cpu: drop dependency on version.h and add license header
- :acrn-commit:`116038f` HV: make: consider header depenencies when rebuilding
+- :acrn-commit:`116038f` HV: make: consider header dependencies when rebuilding
 - :acrn-commit:`11239ae` update launch_uos.sh to align with ACRN v0.1
 - :acrn-commit:`b2e676a` update kernel-pk version to align with ACNR v0.1
 - :acrn-commit:`ea0bbd5` doc: reorganize doc tree
@ -766,12 +766,12 @@ release in July 2018 (click on the CommitID link to see details):
 - :acrn-commit:`ee9ec9d` tools: acrnd: the acrnd work list
 - :acrn-commit:`f5e9c76` tools: acrnd: handle resume request from SOS-LCS
 - :acrn-commit:`04ed916` tools: acrnd: handle stop request from SOS-LCS
- :acrn-commit:`bcb101f` tools: acrnd: the deamon for acrn-manager
+- :acrn-commit:`bcb101f` tools: acrnd: the daemon for acrn-manager
 - :acrn-commit:`c4f9a2f` tools: rework on vm ops
 - :acrn-commit:`f0fe17d` hv: sprintf: fix 'Declaration does not specify an array'
 - :acrn-commit:`aa5027a` HV:misc:fix "signed/unsigned conversion with cast"
 - :acrn-commit:`619c600` hv: cpu state update should be moved just before halt.
- :acrn-commit:`621425d` hv: further fix to configurable relocatoin
+- :acrn-commit:`621425d` hv: further fix to configurable relocation
 - :acrn-commit:`944776f` HV: Fix new MISRAC violations for brackets
 - :acrn-commit:`90b342b` HV: prototyping non-static function
 - :acrn-commit:`8925eb5` hv: set guest segment base to zero if VCPU does not start in real mode
@ -804,7 +804,7 @@ release in July 2018 (click on the CommitID link to see details):
 - :acrn-commit:`b4fb261` hv: fix bug in some embedded assembly code in vmx
 - :acrn-commit:`8336101` DM: Fix potential buffer overflow and uninitialized variable
 - :acrn-commit:`194fd8b` hv: irq: fix 'Pointer arithmetic is not on array'
- :acrn-commit:`401ffd1` HV: pm: cleanup for misra integral type violations
+- :acrn-commit:`401ffd1` HV: pm: cleanup for MISRA integral type violations
 - :acrn-commit:`202bc54` HV: trusty: revise trusty_boot_param structure
 - :acrn-commit:`b30ba3d` tools:acrn-crashlog: Detect and classify the crash in ACRN and kernel
 - :acrn-commit:`a5853d6` tools:acrn-crashlog: Improve the process of crash reclassify
--- a/doc/release_notes_0.3.rst
+++ b/doc/release_notes_0.3.rst
@ -272,7 +272,7 @@ release in Sep 2018 (click on the CommitID link to see details):
 - :acrn-commit:`c1d2499e` hv: enable MSI remapping on vm0
 - :acrn-commit:`8c398f7d` hv: fix issues when msi-x shares same BAR with other data structures
 - :acrn-commit:`5cbe079e` hv: MSI-X Message Address write fix
- :acrn-commit:`dbe156e9` hv: fix misrac violations in vcpi code
+- :acrn-commit:`dbe156e9` hv: fix MISRA-c violations in vcpi code
 - :acrn-commit:`5555a2f8` hv: fix bug in sizing MSI-X Table Base Address Register
 - :acrn-commit:`51977a6d` hv: Don't check multi-function flag in PCI enumeration
 - :acrn-commit:`e32bc9e3` hv: avoid hardcode cs.limit in set_vcpu_regs()
@ -439,7 +439,7 @@ release in Sep 2018 (click on the CommitID link to see details):
 - :acrn-commit:`4ce80e5c` tools: acrn-manager: fix a potential compiler warning
 - :acrn-commit:`e8c86566` tools: acrn-manager: fix a potential NULL pointer dereference
 - :acrn-commit:`da3b0270` tools: acrnd: Ignore null line reading from timer_list
- :acrn-commit:`a45d961b` tools: acrnd: check weakup reason first in init_vm
+- :acrn-commit:`a45d961b` tools: acrnd: check wakeup reason first in init_vm
 - :acrn-commit:`acc51877` doc: merge static core with cpu virt
 - :acrn-commit:`e01f4777` doc: HV startup and CPU virtualization sections
 - :acrn-commit:`8893a8c2` doc: update HLD overview chapter
@ -457,7 +457,7 @@ release in Sep 2018 (click on the CommitID link to see details):
 - :acrn-commit:`f533a07a` DM USB: xHCI: support multiple hubs in single layer
 - :acrn-commit:`6886d3cd` DM USB: xHCI: change port mapping logic for multiple hub support
 - :acrn-commit:`540ce05f` DM USB: introduce function usb_get_native_devinfo
- :acrn-commit:`e8f7b6fa` DM USB: introduce struct usb_devpath and releted functions
+- :acrn-commit:`e8f7b6fa` DM USB: introduce struct usb_devpath and related functions
 - :acrn-commit:`14bc961f` DM USB: xHCI: remove old hub support code.
 - :acrn-commit:`8b5d357f` HV: move default ACPI info to default_acpi_info.h
 - :acrn-commit:`bd042352` hv: fix potential buffer overflow in vpic_set_pinstate()
@ -565,7 +565,7 @@ release in Sep 2018 (click on the CommitID link to see details):
 - :acrn-commit:`5b28b378` hv: Fix for PARTITION_MODE compilation
 - :acrn-commit:`eebccac2` hv: add suffix(U) in vmx.h to come up MISRA-C
 - :acrn-commit:`8787b65f` dm: fix the issue when guest tries to disable memory range access
- :acrn-commit:`be0cde7d` Revert "dm: workaroud for DM crash when doing fastboot reboot"
+- :acrn-commit:`be0cde7d` Revert "dm: workaround for DM crash when doing fastboot reboot"
 - :acrn-commit:`b115546b` crashlog: deprecate acrnprobe_prepare and update Makefile
 - :acrn-commit:`f3fc857f` crashlog: introducing crashlogctl
 - :acrn-commit:`b1a05d17` crashlog: re-write usercrash-wrapper
@ -649,7 +649,7 @@ release in Sep 2018 (click on the CommitID link to see details):
 - :acrn-commit:`270a8332` tools: acrnd: bugfix: service lack of prerequisition
 - :acrn-commit:`5affe53a` tools: acrn-crashlog: update Makefile flags
 - :acrn-commit:`726711e2` tools: acrn-crashlog: fix some compiler warnings
- :acrn-commit:`4e17d207` hv: fix 'Static procedure is not explicitly called in code analysed'
+- :acrn-commit:`4e17d207` hv: fix 'Static procedure is not explicitly called in code analyzed'
 - :acrn-commit:`ac9ebc5e` update to support v0.2 release
 - :acrn-commit:`71b047cb` hv: fix 'Switch case not terminated with break'
 - :acrn-commit:`f3758850` dm: virtio_net: remove netmap/vale backend support
--- a/doc/release_notes_0.4.rst
+++ b/doc/release_notes_0.4.rst
@ -207,7 +207,7 @@ release in Nov 2018 (click on the CommitID link to see details):
 - :acrn-commit:`b6aaf1b8` hv: MSRs may need isolation between normal and secure world
 - :acrn-commit:`92bbb545` hv: rearrange data structure for emulated MSRs
 - :acrn-commit:`7fce2462` dm: apply new mevent API to avoid race issue in mei
- :acrn-commit:`64d9c59a` dm: enhence the mevent API
+- :acrn-commit:`64d9c59a` dm: enhance the mevent API
 - :acrn-commit:`eec3a342` dm: fix the race issue in mevent_del
 - :acrn-commit:`87e7bdb9` DM: updating launch_uos.sh
 - :acrn-commit:`9e0562f4` hv: add obvious comment for empty else clause following else if
@ -403,7 +403,7 @@ release in Nov 2018 (click on the CommitID link to see details):
 - :acrn-commit:`efb24923` hv: vtd: merge lines for a statement if needed.
 - :acrn-commit:`e35a8e8c` hv: vtd: typo fix
 - :acrn-commit:`611944c0` dm: Fix race between ioreq client destroy and access
- :acrn-commit:`3b24c34c` hv: msix: corrently determine when the guest is changing Message Data/Addr
+- :acrn-commit:`3b24c34c` hv: msix: correctly determine when the guest is changing Message Data/Addr
 - :acrn-commit:`c41c0dab` hv: properly initialize MSI-X table
 - :acrn-commit:`53971e19` hv: fix 2 bugs in msix.c
 - :acrn-commit:`119eccfe` hv: hypercall: clean up HV_DEBUG usage
--- a/doc/tutorials/using_sbl_on_up2.rst
+++ b/doc/tutorials/using_sbl_on_up2.rst
@ -1,6 +1,6 @@
 .. _using-sbl-up2:
-Using SBL on UP2 Borad
+Using SBL on UP2 Board
 ######################
 This document builds on the :ref:`getting-started-up2`, and explains how to use
@ -14,8 +14,8 @@ please visit `<https://slimbootloader.github.io/how-tos/boot-acrn.html>`_.
 .. image:: images/sbl_boot_flow_UP2.png
   :align: center
-   
+
-We show a verified Boot Sequence with SBL on an Intel® Architecture platform UP2, 
+We show a verified Boot Sequence with SBL on an Intel® Architecture platform UP2,
 and the boot process proceeds as follows:
 #. SBL verifies and boots the ACRN hypervisor and Service OS kernel
@ -39,8 +39,8 @@ The following hardware and software are required to use SBL on an UP2 board:
 .. image:: images/up2_sbl_connections.png
   :align: center
-The connections between USB to TTL Serial Cable and USB 2.0 Pin Header 
+The connections between USB to TTL Serial Cable and USB 2.0 Pin Header
-Cable shoule be:
+Cable should be:
 .. image:: images/up2_sbl_cables_connections.png
   :align: center
@ -49,8 +49,8 @@ Build SBL
 *********
 Follow the steps of `Building <https://slimbootloader.github.io/supported-hardware/up2.html#building>`_
-and `Stitching <https://slimbootloader.github.io/supported-hardware/up2.html#stitching>`_ 
+and `Stitching <https://slimbootloader.github.io/supported-hardware/up2.html#stitching>`_
-from `<https://slimbootloader.github.io/supported-hardware/up2.html>`_ to generate the 
+from `<https://slimbootloader.github.io/supported-hardware/up2.html>`_ to generate the
 BIOS binary file ``<SBL_IFWI_IMAGE>``, which is the new IFWI image with SBL in BIOS region.
@ -60,14 +60,14 @@ Flash SBL on the UP2
 #. Download the appropriate BIOS update for `UP2 Board <https://downloads.up-community.org/download/up-board-uefi-bios-upc1dm15/>`_.
 #. Put the empty USB flash drive in your PC and format it as FAT32.
-#. Decompress the BIOS zip file into the formatted drive. 
+#. Decompress the BIOS zip file into the formatted drive.
 #. Attach the USB disk and keyboard to the board and power it on.
 #. During boot, press :kbd:`F7` on the keyboard to enter the UEFI BIOS boot menu.
 #. Navigate through the following menus and select ``Built-in EFI shell``.
 #. Please take note of which filesystem number ``fs*`` your USB drive is mapped to.
 #. Switch to that filesystem, e.g. ``fs1:``.  (Don't forget the colon.)
 #. Navigate to the path where you decompressed the update (the ``cd`` and ``ls`` commands are available here, as if in an Unix shell).
-  
+
   .. code-block:: none
      Fpt_3.1.50.2222.efi -f <SBL_IFWI_IMAGE> -y
@ -98,14 +98,14 @@ An example of the configuration file ``uos.json``:
   }
 .. note::
-   To generate the image with a specified version, please modify 
+   To generate the image with a specified version, please modify
-   the "Version" argument, ``"Version": 26000`` instead 
+   the "Version" argument, ``"Version": 26000`` instead
   of ``"Version": 26880`` for example.
 Clone the source code of ``acrn-hypervisor`` and build SOS and LaaG image:
 .. code-block:: none
-   
+
   cd ~
   git clone https://github.com/projectacrn/acrn-hypervisor
   sudo ./acrn-hypervisor/devicemodel/samples/up2/create-up2-images.sh --images-type all \
@ -119,19 +119,19 @@ This step will generate the images of SOS and LaaG:
 * up2_laag.img
 .. note::
-   When building images, you can modify the ``--clearlinux-version`` argument 
+   When building images, you can modify the ``--clearlinux-version`` argument
-   to a specific version (such as 26800). To generate the images of SOS only, 
+   to a specific version (such as 26800). To generate the images of SOS only,
   modify the ``--images-type`` argument to ``sos``.
-We still need the binary image for GPT partitions and 
+
 We still need the binary image for GPT partitions and
 configuration file for flashing:
 * partition_desc.bin
 * flash_LaaG.json
 .. note::
-   ``partition_desc.bin`` and ``flash_LaaG.json`` are in the diretory 
+   ``partition_desc.bin`` and ``flash_LaaG.json`` are in the directory
   ``~/acrn-hypervisor/doc/tutorials/``.
@ -159,22 +159,25 @@ configuration file for flashing:
      +------------------------------+---------------------------------------------------+
 .. note::
-   In this step, please build SOS and LaaG images in Clear Linux rather than Ubuntu. 
+   In this step, please build SOS and LaaG images in Clear Linux rather than Ubuntu.
 Download and install flash tool
 *******************************
-#. Download Intel® Platform Flash Tool Lite from `<https://github.com/projectceladon/tools/tree/master/platform_flash_tool_lite/latest/>`_.
+#. Download Intel® Platform Flash Tool Lite from
   `<https://github.com/projectceladon/tools/tree/master/platform_flash_tool_lite/latest/>`_.
-#. For Ubuntu host, install `platformflashtoollite_5.8.9.0_linux_x86_64.deb <https://github.com/projectceladon/tools/blob/master/platform_flash_tool_lite/latest/platformflashtoollite_5.8.9.0_linux_x86_64.deb>`_ for example.
+#. For Ubuntu host, install `platformflashtoollite_5.8.9.0_linux_x86_64.deb
   <https://github.com/projectceladon/tools/blob/master/platform_flash_tool_lite/latest/platformflashtoollite_5.8.9.0_linux_x86_64.deb>`_
   for example.
 SOS and LaaG Installation
 *************************
-#. Connect a USB cable from the debug board to your Ubuntu host machine, 
+#. Connect a USB cable from the debug board to your Ubuntu host machine,
-   and run the following command to verify that its USB serial port is 
+   and run the following command to verify that its USB serial port is
   discovered and showing under ``/dev``.
   .. code-block:: none
@ -187,57 +190,57 @@ SOS and LaaG Installation
   .. code-block:: none
       sudo minicom -s /dev/ttyUSB0
-       
+
   .. note::
      Please verify the minicom serial port settings are 115200 8N1 and
-      both HW and SW flow control are turned off.    
+      both HW and SW flow control are turned off.
-#. When you see following console log, please press any key to enter 
+#. When you see following console log, please press any key to enter
   shell command：
   .. code-block:: none
-  
+
       ====================Os Loader====================
- 
+
- 
+
       Press any key within 2 second(s) to enter the command shell
-      
+
       Shell>
 #. Swap the boot sequence of ``DevType: MEM`` to ``Idx:0``:
   .. code-block:: none
-  
+
-      Shell> boot                                                                     
+      Shell> boot
-      Boot options (in HEX):                                                          
+      Boot options (in HEX):
-                                                                                
+
-      Idx|ImgType|DevType|DevNum|Flags|HwPart|FsType|SwPart|File/Lbaoffset            
+      Idx|ImgType|DevType|DevNum|Flags|HwPart|FsType|SwPart|File/Lbaoffset
-        0|      0|   MMC |    0 |   0 |    0 |  RAW |    1 | 0x0                      
+        0|      0|   MMC |    0 |   0 |    0 |  RAW |    1 | 0x0
-        1|      4|   MEM |    0 |   0 |    0 |  RAW |    0 | 0x0                      
+        1|      4|   MEM |    0 |   0 |    0 |  RAW |    0 | 0x0
-                                                                                
+
-      SubCommand:                                                                     
+      SubCommand:
-        s   -- swap boot order by index                                               
+        s   -- swap boot order by index
-        a   -- modify all boot options one by one                                     
+        a   -- modify all boot options one by one
-        q   -- quit boot option change                                                
+        q   -- quit boot option change
-        idx -- modify the boot option specified by idx (0 to 0x1)                     
+        idx -- modify the boot option specified by idx (0 to 0x1)
-      s                                                                               
+      s
-      Updated the Boot Option List                                                    
+      Updated the Boot Option List
-      Boot options (in HEX):                                                          
+      Boot options (in HEX):
-                                                                                
+
-      Idx|ImgType|DevType|DevNum|Flags|HwPart|FsType|SwPart|File/Lbaoffset            
+      Idx|ImgType|DevType|DevNum|Flags|HwPart|FsType|SwPart|File/Lbaoffset
-        0|      4|   MEM |    0 |   0 |    0 |  RAW |    0 | 0x0                      
+        0|      4|   MEM |    0 |   0 |    0 |  RAW |    0 | 0x0
-        1|      0|   MMC |    0 |   0 |    0 |  RAW |    1 | 0x0   
+        1|      0|   MMC |    0 |   0 |    0 |  RAW |    1 | 0x0
-         
+
-         
+
 #. Exit and reboot to fastboot mode:
   .. code-block:: none
-   
+
       Shell> exit
-      
+
       …
-       
+
        40E0 |  175118 ms |     158 ms | Kernel setup
        40F0 |  175144 ms |      26 ms | FSP ReadyToBoot/EndOfFirmware notify
        4100 |  175144 ms |       0 ms | TPM IndicateReadyToBoot
@ -265,17 +268,17 @@ SOS and LaaG Installation
       USB for fastboot transport layer selected
-#. When UP2 board is in fastboot mode, you should be able 
+#. When UP2 board is in fastboot mode, you should be able
-   see the device in Platform Flash Tool. Select the 
+   see the device in Platform Flash Tool. Select the
   file ``flash_LaaG.json`` and modify ``Configuration``
   to ``SOS_and_LaaG``. Click ``Start to flash`` to flash images.
-   
+
   .. image:: images/platformflashtool_start_to_flash.png
      :align: center
-Boot to SOS 
+Boot to SOS
 ***********
-After flashing, UP2 board will automaticlly reboot and 
+After flashing, UP2 board will automatically reboot and
 boot to ACRN hypervisor. And login SOS by following command:
 .. image:: images/sos_console_login.png
@ -284,11 +287,11 @@ boot to ACRN hypervisor. And login SOS by following command:
 Launch UOS
 **********
 Run the ``launch_uos.sh`` script to launch the UOS:
-    
+
-   .. code-block:: none   
+.. code-block:: none
-      
+
-      cd ~
+   cd ~
-      wget https://raw.githubusercontent.com/projectacrn/acrn-hypervisor/master/doc/tutorials/launch_uos.sh
+   wget https://raw.githubusercontent.com/projectacrn/acrn-hypervisor/master/doc/tutorials/launch_uos.sh
-      sudo ./launch_uos.sh -V 1
+   sudo ./launch_uos.sh -V 1
-       
+
-   **Congratulations**, you are now watching the User OS booting up!
+**Congratulations**, you are now watching the User OS booting up!
--- a/doc/user-guides/acrn-shell.rst
+++ b/doc/user-guides/acrn-shell.rst
@ -1,43 +1,43 @@
-.. _acrnshell:
+.. _acrnshell:
-
+
-ACRN Shell Commands
+ACRN Shell Commands
-###################
+###################
-
+
-The ACRN hypervisor shell supports the following commands:
+The ACRN hypervisor shell supports the following commands:
-
+
-.. list-table::
+.. list-table::
-   :header-rows: 1
+   :header-rows: 1
-   :widths: 40 60
+   :widths: 40 60
-
+
-   * - Command (and parameters)
+   * - Command (and parameters)
-     - Description
+     - Description
-   * - help
+   * - help
-     - Displays information about supported hypervisor shell commands
+     - Displays information about supported hypervisor shell commands
-   * - vm_list
+   * - vm_list
-     - Lists all VMs, displaying VM Name, VM ID, and VM State (ON=running)
+     - Lists all VMs, displaying VM Name, VM ID, and VM State (ON=running)
-   * - vcpu_list
+   * - vcpu_list
-     - Lists all VCPUs in all VMs
+     - Lists all VCPUs in all VMs
-   * - vcpu_dumpreg <vm_id, vcpu_id>
+   * - vcpu_dumpreg <vm_id, vcpu_id>
-     - Dumps registers for a specific VCPU
+     - Dumps registers for a specific VCPU
-   * - dumpmem <hva, length>
+   * - dumpmem <hva, length>
-     - Dumps host memory, starting a given address, and for
+     - Dumps host memory, starting a given address, and for
-       a given length (in bytes)
+       a given length (in bytes)
-   * - sos_console
+   * - sos_console
-     - Switches to the SOS's console
+     - Switches to the SOS's console
-   * - int
+   * - int
-     - Lists interrupt information per CPU
+     - Lists interrupt information per CPU
-   * - pt
+   * - pt
-     - Shows pass-through device information
+     - Shows pass-through device information
-   * - reboot
+   * - reboot
-     - Triggers a system reboot (immediately)
+     - Triggers a system reboot (immediately)
-   * - dump_ioapic
+   * - dump_ioapic
-     - Shows native ioapic information
+     - Shows native ioapic information
-   * - vmexit
+   * - vmexit
-     - Shows vmexit profiling
+     - Shows vmexit profiling
-   * - logdump <pcpu_id>
+   * - logdump <pcpu_id>
-     - Dumps the log buffer for the physical CPU
+     - Dumps the log buffer for the physical CPU
-   * - loglevel [console_loglevel] [mem_loglevel]
+   * - loglevel [console_loglevel] [mem_loglevel]
-     - Get (when no parameters are given)  or Set loglevel [0 (none) - 6 (verbose)] for the console and optionally
+     - Get (when no parameters are given)  or Set loglevel [0 (none) - 6 (verbose)] for the console and optionally
-       for memory
+       for memory
-   * - cpuid <leaf> [subleaf]
+   * - cpuid <leaf> [subleaf]
-     - Displays the CPUID leaf [subleaf], in hexadecimal
+     - Displays the CPUID leaf [subleaf], in hexadecimal