Commit Graph

4 Commits

Author SHA1 Message Date
Junjie Mao
7b06be9e2c HV: checkpatch: add configurations to customize checkpatch.pl
ACRN hypervisor follows MISRA-C which has some inconsistencies with the Linux
kernel coding style. Namely,

    * Braces are required even for single-statement blocks.
    * Zero-initialisers to global variables are allowed.
    * Line limit is 120 instead of 80.

This patch adds a .checkpatch.conf so that checkpatch.pl stops warning on the
exceptions above when invoked under the root directory of the acrn-hypervisor
repository.

The coding style documentation is updated accordingly.

Tracked-On: #1557
Signed-off-by: Junjie Mao <junjie.mao@intel.com>
2018-10-24 18:20:36 +08:00
David B. Kinder
813e3abccc doc: Update contrib doc with Tracked-On
For traceability, all changes must include a Tracked-On: line indicating
the issue driving this change.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
Tracked-On: #1420
2018-10-18 15:04:34 -07:00
David B. Kinder
e04255822a doc: update GSG for v0.1, add console code-block
Console screen shots are hard to maintain, so use the
.. code-block:: console directive to show terminal console-like display
(black background with white text)

Change existing .. code-block:: console uses to .. code-block: none

Replace screen-shot images in apl-nuc getting started guide with
text-based console display.

Update apl-nuc GSG content with v0.1 changes

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-07-16 13:51:28 -07:00
David B. Kinder
3965593df6 doc: reorganize documentation
We've been expanding documentation, and now need to organize things a bit
cleaner and separate content into new major folders: Introduction, Getting
Started, User Guides, Developer Guides, Tutorials, and Release notes..

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-06-28 22:36:13 -07:00