From: Andrew Cooper <andrew.cooper3@citrix.com>
Date: Fri, 15 Jul 2016 13:02:37 +0000 (+0100)
Subject: Replace @sa with @see in all documentation
X-Git-Url: http://xenbits.xensource.com/gitweb?a=commitdiff_plain;h=38249f0026c64234a2d1805f036bd87bbc334a35;p=xtf.git

Replace @sa with @see in all documentation

They are identical as far as Doxygen is concerned, but more intuitive when
reading the raw text.

Signed-off-by: Andrew Cooper <andrew.cooper3@citrix.com>
---

diff --git a/make-new-test.sh b/make-new-test.sh
index cb91be6..b2874df 100755
--- a/make-new-test.sh
+++ b/make-new-test.sh
@@ -88,7 +88,7 @@ cat <<EOF
  *
  * @page test-$NAME TODO
  *
- * @sa tests/$NAME/main.c
+ * @see tests/$NAME/main.c
  */
 #include <xtf.h>
 
diff --git a/tests/cpuid/main.c b/tests/cpuid/main.c
index f07cf1c..f3e5960 100644
--- a/tests/cpuid/main.c
+++ b/tests/cpuid/main.c
@@ -7,7 +7,7 @@
  * Prints all CPUID information visible to the guest.  PV guests dump both
  * native and emulated CPUID.
  *
- * @sa tests/cpuid/main.c
+ * @see tests/cpuid/main.c
  */
 #include <xtf.h>
 
diff --git a/tests/example/main.c b/tests/example/main.c
index 9b1e5b0..50ec697 100644
--- a/tests/example/main.c
+++ b/tests/example/main.c
@@ -6,7 +6,7 @@
  *
  * A Hello World XTF testcase.
  *
- * @sa tests/example/main.c
+ * @see tests/example/main.c
  */
 #include <xtf.h>
 
diff --git a/tests/fep/main.c b/tests/fep/main.c
index de00461..7bfee37 100644
--- a/tests/fep/main.c
+++ b/tests/fep/main.c
@@ -9,7 +9,7 @@
  *
  * Returns SUCCESS if FEP is available, FAILURE if not.
  *
- * @sa tests/fep/main.c
+ * @see tests/fep/main.c
  */
 #include <xtf.h>
 
diff --git a/tests/invlpg/main.c b/tests/invlpg/main.c
index 3c5ffc9..860589f 100644
--- a/tests/invlpg/main.c
+++ b/tests/invlpg/main.c
@@ -81,7 +81,7 @@
  * @todo Come up with some sensible way of running this test in both shadow
  * and hap mode.
  *
- * @sa tests/invlpg/main.c
+ * @see tests/invlpg/main.c
  */
 #include <xtf.h>
 
diff --git a/tests/msr/main.c b/tests/msr/main.c
index 2685420..78643ea 100644
--- a/tests/msr/main.c
+++ b/tests/msr/main.c
@@ -9,7 +9,7 @@
  * @warning As this probes all MSR indicies, it can cause substantial logspam
  * in Xen from extable fixup, depending on log level.
  *
- * @sa tests/msr/main.c
+ * @see tests/msr/main.c
  */
 #include <xtf.h>
 
diff --git a/tests/pv-iopl/main.c b/tests/pv-iopl/main.c
index c446071..b966635 100644
--- a/tests/pv-iopl/main.c
+++ b/tests/pv-iopl/main.c
@@ -36,7 +36,7 @@
  *    kernel to have an cpl of 0, and the shadowed IOPL will be updated from
  *    the contents of iret frame during an iret hypercall.
  *
- * @sa tests/pv-iopl/main.c
+ * @see tests/pv-iopl/main.c
  */
 #include <xtf.h>
 
diff --git a/tests/selftest/main.c b/tests/selftest/main.c
index f46dce1..c68eadb 100644
--- a/tests/selftest/main.c
+++ b/tests/selftest/main.c
@@ -7,7 +7,7 @@
  * Sanity tests for the framework environment and functionality.  Failure of
  * these tests tend to suggest bugs with the framework itself.
  *
- * @sa tests/selftest/main.c
+ * @see tests/selftest/main.c
  */
 #include <xtf.h>
 
diff --git a/tests/swint-emulation/main.c b/tests/swint-emulation/main.c
index f570f4d..2394e0a 100644
--- a/tests/swint-emulation/main.c
+++ b/tests/swint-emulation/main.c
@@ -42,7 +42,7 @@
  *
  * In all cases, the exception frame is verified to be correct.
  *
- * @sa tests/swint-emulation/main.c
+ * @see tests/swint-emulation/main.c
  */
 #include <xtf.h>
 
diff --git a/tests/xsa-122/main.c b/tests/xsa-122/main.c
index bdd7685..13ac6d4 100644
--- a/tests/xsa-122/main.c
+++ b/tests/xsa-122/main.c
@@ -18,7 +18,7 @@
  * success if it is the first vcpu to run on a "fresh" pcpu after host reboot.
  * For added reliability, pin the PoC to a specific pcpu and run it twice.
  *
- * @sa tests/xsa-122/main.c
+ * @see tests/xsa-122/main.c
  */
 #include <xtf.h>
 
diff --git a/tests/xsa-123/main.c b/tests/xsa-123/main.c
index 2542b41..92c80f2 100644
--- a/tests/xsa-123/main.c
+++ b/tests/xsa-123/main.c
@@ -25,7 +25,7 @@
  * the x86 instruction emulator.  If the destination register doesn't match
  * the source register, hypervisor memory corruption has occurred.
  *
- * @sa tests/xsa-123/main.c
+ * @see tests/xsa-123/main.c
  */
 #include <xtf.h>
 
diff --git a/tests/xsa-167/main.c b/tests/xsa-167/main.c
index d4bd4e3..55d6268 100644
--- a/tests/xsa-167/main.c
+++ b/tests/xsa-167/main.c
@@ -23,7 +23,7 @@
  * host crash.  If Xen is not vulnerable, the hypercall should fail with
  * -EINVAL.
  *
- * @sa tests/xsa-167/main.c
+ * @see tests/xsa-167/main.c
  */
 #include <xtf.h>
 
diff --git a/tests/xsa-168/main.c b/tests/xsa-168/main.c
index 58b5cd6..9c02f03 100644
--- a/tests/xsa-168/main.c
+++ b/tests/xsa-168/main.c
@@ -27,7 +27,7 @@
  * with a @#GP fault.  If not, the test will exit cleanly.  The test is unable
  * to distinguish between a fixed Xen and a test misconfiguration.
  *
- * @sa tests/xsa-168/main.c
+ * @see tests/xsa-168/main.c
  */
 #include <xtf.h>
 
diff --git a/tests/xsa-173/main.c b/tests/xsa-173/main.c
index 5e062c0..f58cb92 100644
--- a/tests/xsa-173/main.c
+++ b/tests/xsa-173/main.c
@@ -18,7 +18,7 @@
  * shadow paging implementation, but can identify a buggy shadow paging
  * implementation.
  *
- * @sa tests/xsa-173/main.c
+ * @see tests/xsa-173/main.c
  */
 #include <xtf.h>