Benjamin Fitch
8c8df1afb9
doc: copy edits in the developer reference
...
Signed-off-by: Benjamin Fitch <benjamin.fitch@intel.com>
2021-05-10 14:59:26 -07:00
David B. Kinder
e2d3653976
doc: continue doc restructuring
...
Changing the folder structure will cause too many broken links for
external references (from other sites). So, let's put the content back
where it was before the reorg, and instead use the new persona-based
navigation to point to documents in the original locations.
Also, introduce redirects for some documents that no longer exits.
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-08-01 14:07:22 -07:00
David B. Kinder
11d4f4159f
doc: Reorganize documentation site content
...
Take the existing ACRN technical documentation and reorganize its
presentation to be persona and use-case based, in preparation for adding
new scenario/use-case based architecture introduction and getting
started documents.
Introduce a more graphical home page and theme color tweaks.
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-07-31 18:29:22 -07:00
Shiqing Gao
81e13de407
doc: initial draft of Assembly coding guidelines
...
This patch creates initial draft of Assembly coding guidelines.
Signed-off-by: Shiqing Gao <shiqing.gao@intel.com>
2019-05-06 18:42:35 -07:00
Shiqing Gao
51068eccd0
doc: re-organize coding guidelines
...
This patch re-organizes ACRN coding guidelines to support
language-specific guidelines.
Signed-off-by: Shiqing Gao <shiqing.gao@intel.com>
2019-04-25 19:45:43 -07:00
Shiqing Gao
3e19d62b9c
doc: update coding guidelines
...
This patch updates some rules in coding guidelines.
Signed-off-by: Shiqing Gao <shiqing.gao@intel.com>
2019-04-18 05:26:10 -07:00
Shiqing Gao
74b5de3f86
doc: add rules in coding guidelines
...
This patch adds rules in coding guidelines.
Tracked-On: #861
Signed-off-by: Shiqing Gao <shiqing.gao@intel.com>
2019-04-09 11:23:24 -07:00
Shiqing Gao
3d0992c7bd
doc: update rules category in coding guidelines
...
This patch updates the rules category in coding guidelines.
Move some rules in 'Statements' part to 'Expressions' part and
'Functions' part, which is more reasonable.
No functional change is involved.
Signed-off-by: Shiqing Gao <shiqing.gao@intel.com>
2019-04-08 16:03:48 -07:00
Shiqing Gao
1da23415a9
doc: add some rules related to function documentation
...
This patch adds some rules related to function documentation.
Tracked-On: #1844
Signed-off-by: Shiqing Gao <shiqing.gao@intel.com>
2019-04-04 11:47:07 -07:00
Shiqing Gao
558a178841
doc: update coding guidelines
...
This patch updates some rules in coding guidelines.
Tracked-On: #861
Signed-off-by: Shiqing Gao <shiqing.gao@intel.com>
2019-03-26 23:35:35 -04:00
Shiqing Gao
80dc2c85a5
doc: add some rules related to language extensions
...
This patch adds some rules related to language extensions.
Tracked-On: #861
Signed-off-by: Shiqing Gao <shiqing.gao@intel.com>
2019-03-22 10:15:07 -04:00
Shiqing Gao
90b49375e4
doc: add rules related to implementation-specific behaviors
...
This patch adds some rules related to implementation-specific
behaviors.
Tracked-On: #861
Signed-off-by: Shiqing Gao <shiqing.gao@intel.com>
2019-03-19 08:46:19 -04:00
Shiqing Gao
4157b843e5
doc: add some rules related to naming convention
...
This patch adds some rules related to naming convention.
Tracked-On: #861
Signed-off-by: Shiqing Gao <shiqing.gao@intel.com>
2019-03-14 18:05:19 -07:00
Shiqing Gao
31f04e1a7b
doc: fix typos in coding guidelines
...
This patch fixes typos in coding guidelines.
Tracked-On: #2711
Signed-off-by: Shiqing Gao <shiqing.gao@intel.com>
2019-03-10 21:39:55 -07:00
Shiqing Gao
72fbc7e79f
doc: add some comments for coding guidelines
...
This patch adds some comments for coding guidelines.
Tracked-On: #861
Signed-off-by: Shiqing Gao <shiqing.gao@intel.com>
2019-03-07 22:05:05 -08:00
Shiqing Gao
85b3ed3e8d
doc: update the format in coding style part
...
This patch updates the format in coding style part.
Tracked-On: #861
Signed-off-by: Shiqing Gao <shiqing.gao@intel.com>
2019-03-07 15:51:19 -08:00
Shiqing Gao
bc107105f8
doc: fix the typo related to tab
...
This patch fixes the typo related to tab.
Tracked-On: #861
Signed-off-by: Shiqing Gao <shiqing.gao@intel.com>
2019-03-01 08:36:00 -08:00
Shiqing Gao
30159d5b28
doc: add some rules related to coding style
...
This patch adds some rules related to coding style.
Tracked-On: #861
Signed-off-by: Shiqing Gao <shiqing.gao@intel.com>
2019-02-28 20:01:01 -08:00
Shiqing Gao
ea66747e33
doc: add more rules in coding guidelines
...
This patch adds more rules in coding guidelines.
Tracked-On: #861
Signed-off-by: Shiqing Gao <shiqing.gao@intel.com>
2019-02-14 21:31:02 -08:00
Shiqing Gao
fc887eade4
doc: update coding guidelines
...
- update and add some rules in coding guidelines
Tracked-On: #861
Signed-off-by: Shiqing Gao <shiqing.gao@intel.com>
2019-01-30 10:48:15 -08:00
Shiqing Gao
d0c9fce72d
doc: add more rules in coding guidelines
...
This patch adds more rules in coding guidelines.
Tracked-On: #861
Signed-off-by: Shiqing Gao <shiqing.gao@intel.com>
2019-01-23 11:57:10 -08:00
Shiqing Gao
fae6cbf194
doc: add more rules in coding guidelines
...
This patch adds more rules in coding guidelines.
Tracked-On: #861
Signed-off-by: Shiqing Gao <shiqing.gao@intel.com>
2019-01-10 21:03:51 -08:00
Shiqing Gao
a177d75ed3
doc: initial draft of ACRN coding guidelines
...
This patch introduces an initial draft of ACRN coding guidelines.
We will update this document gradually to support ACRN achieve
MISRA-C compliance.
Tracked-On: #861
Signed-off-by: Shiqing Gao <shiqing.gao@intel.com>
2018-12-26 22:46:46 -08:00
