doc: fix docs with broken links

Fix links in documentation that have moved (e.g.,
clearlinux.org/documentation moved to docs.01.org/clearlinux/latest).

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
This commit is contained in:
David B. Kinder
2020-03-18 13:32:45 -07:00
committed by wenlingz
parent 6a386d3fe1
commit 589787282c
14 changed files with 26 additions and 23 deletions

View File

@@ -3218,20 +3218,20 @@ function:
6) A blank line shall separate different paragraphs. Inside each paragraph, a
blank line is not required to separate each element.
7) The brief description of the function shall be documented with the format
'@brief <brief description>'.
'\@brief <brief description>'.
8) No specific format is required for the detailed description of the function.
9) The description of the function parameter shall be documented with the format
'@param <parameter name> <parameter description>'.
10) The pre-condition of the function shall be documented with the format '@pre
'\@param <parameter name> <parameter description>'.
10) The pre-condition of the function shall be documented with the format '\@pre
<pre-condition description>'.
11) The post-condition of the function shall be documented with the format
'@post <post-condition description>'.
'\@post <post-condition description>'.
12) The brief description of the function return value shall be documented with
the format '@return <brief description of return value>'.
13) A void-returning function shall be documented with the format '@return
the format '\@return <brief description of return value>'.
13) A void-returning function shall be documented with the format '\@return
None'.
14) The comments explaining the actual return values shall be documented with
the format '@retval <return value> <return value explanation>'.
the format '\@retval <return value> <return value explanation>'.
15) If the description of one element needs to span multiple lines, each line
shall be aligned to the start of the description in the first line for that
element.

View File

@@ -106,7 +106,7 @@ configure, install, and use it as explained on the
as introduced in the project ACRN `Getting Started Guide`_.
.. _Getting Started Guide:
https://projectacrn.github.io/getting_started/
https://projectacrn.github.io/latest/try.html
You should be familiar with common developer tools such as Git and
platforms such as GitHub.

View File

@@ -282,7 +282,7 @@ following rules:
Detailed configurations and policies are out of scope for this document.
For good references on OS system security hardening and enhancement,
see `AGL security
<http://docs.automotivelinux.org/master/docs/architecture/en/dev/reference/security/part-2/0_Abstract.html>`_
<https://docs.automotivelinux.org/docs/en/master/architecture/reference/security/part-2/0_Abstract.html>`_
and `Android security <https://source.android.com/security/>`_
Hypervisor Security Enhancement

View File

@@ -12,7 +12,7 @@ Refer to `Intel Analysis of L1TF`_ and `Linux L1TF document`_ for details.
https://software.intel.com/security-software-guidance/insights/deep-dive-intel-analysis-l1-terminal-fault
.. _Linux L1TF document:
https://github.com/torvalds/linux/blob/master/Documentation/admin-guide/l1tf.rst
https://www.kernel.org/doc/html/latest/admin-guide/hw-vuln/l1tf.html
L1 Terminal Fault is a speculative side channel which allows unprivileged
speculative access to data which is available in the Level 1 Data Cache