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 cb91be6551a8b6d3218e0910a19011d076b1a29a..b2874df7e05008cb2d1d9893eb4bc53ee1ef2116 100755 (executable)
--- 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 f07cf1cf30e6849bd1b4c63bb285b300c1001b77..f3e59608d4c47bd3919198c775affc1d3e575095 100644 (file)
--- 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 9b1e5b0c753d2c791cdb8be816d9c0d60a4ddd39..50ec6979239f114bcba5842941b516470881cea3 100644 (file)
--- 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 de00461b5c4b69430defe1fac971fc41d2cb0a02..7bfee374991d22b8757734c01bdb818cb3caea7f 100644 (file)
--- 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 3c5ffc9afdcf508418af5ef7339b6cadfc492e7b..860589fe1ece77e45bdc55afcfb4b27adc56d1ee 100644 (file)
--- 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 2685420b20e736ebfcb787c85cd1449f92d25c47..78643ea88fc8dd78244fadad21dc893b8ebf156c 100644 (file)
--- 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 c446071940b55fcf63cb9513d637ac079094a72f..b966635d7b32dbf52bb19214a34f59b07c000474 100644 (file)
--- 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 f46dce1bd65a5d5c9d9c53fe2a8729f082aaa85f..c68eadb5100c31b95e7cee1a63cbe98261cf524a 100644 (file)
--- 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 f570f4d3fe89891c820ffc20ad61485d0647197b..2394e0a729d2b5b98dd7f0dcf42d8c63be875eaf 100644 (file)
--- 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 bdd7685d7f1d6546f92684bdbd0cbe58a85889bd..13ac6d4daba985e1eb426fccf95db9502109bea6 100644 (file)
--- 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 2542b41841082c8dadcd1061f15a3ea05b44d2e7..92c80f2ef4dfe0615a3ee85a916039185774095c 100644 (file)
--- 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 d4bd4e3562f6352211458faf41d2af0e47777f26..55d626807fc2836a76b0c512f5ce01eed1def25f 100644 (file)
--- 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 58b5cd60a79b5e0e4bacbb3dd555542a8bfac725..9c02f03c506180806d17db594eb1bcc777403fd4 100644 (file)
--- 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 5e062c0b3367f9fbe419ebffcf439d1a49584f31..f58cb92d73e08006adab36305412d94b3ec1bac7 100644 (file)
--- 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>