This is the mail archive of the
gcc-patches@gcc.gnu.org
mailing list for the GCC project.
[committed] Wrap comments in examples with @r{}
- From: ja2morri at csclub dot uwaterloo dot ca (James A. Morrison)
- To: gcc-patches at gcc dot gnu dot org
- Date: 05 Mar 2005 14:56:04 -0500
- Subject: [committed] Wrap comments in examples with @r{}
Hi,
This patch has been sitting in my tree for a while and I also submitted back
in september. Anyway, According to Joesph it is obvious, so I committed it
to mainline and 4.0. I've also built the documentation today again to check
to see that everything is still ok.
--
Thanks,
Jim
http://www.student.cs.uwaterloo.ca/~ja2morri/
http://phython.blogspot.com
http://open.nit.ca/wiki/?page=jim
2005-03-05 James A. Morrison <phython@gcc.gnu.org>
* doc/c-tree.texi: Wrap comments in @r{}.
* doc/cpp.texi: Likewise.
* doc/cppinternals.texi: Likewise.
* doc/extend.texi: Likewise.
* doc/md.texi: Likewise.
* doc/objc.texi: Likewise.
* doc/sourcebuild.texi: Likewise.
* doc/tm.texi: Likewise.
* doc/tree-ssa.texi
Index: doc/c-tree.texi
===================================================================
RCS file: /cvsroot/gcc/gcc/gcc/doc/c-tree.texi,v
retrieving revision 1.71
diff -u -p -r1.71 c-tree.texi
--- doc/c-tree.texi 30 Jan 2005 15:36:06 -0000 1.71
+++ doc/c-tree.texi 5 Mar 2005 19:36:26 -0000
@@ -1363,7 +1363,7 @@ void process_stmt (stmt)
@{
case IF_STMT:
process_stmt (THEN_CLAUSE (stmt));
- /* More processing here. */
+ /* @r{More processing here.} */
break;
@dots{}
Index: doc/cpp.texi
===================================================================
RCS file: /cvsroot/gcc/gcc/gcc/doc/cpp.texi,v
retrieving revision 1.78
diff -u -p -r1.78 cpp.texi
--- doc/cpp.texi 10 Feb 2005 13:14:02 -0000 1.78
+++ doc/cpp.texi 5 Mar 2005 19:36:26 -0000
@@ -1318,7 +1318,7 @@ name, and you wish to use the function s
@smallexample
extern void foo(void);
-#define foo() /* optimized inline version */
+#define foo() /* @r{optimized inline version} */
@dots{}
foo();
funcptr = foo;
@@ -2211,7 +2211,7 @@ These definitions are effectively the sa
@smallexample
#define FOUR (2 + 2)
#define FOUR (2 + 2)
-#define FOUR (2 /* two */ + 2)
+#define FOUR (2 /* @r{two} */ + 2)
@end smallexample
@noindent
but these are not:
@@ -3538,8 +3538,8 @@ require matching quotes. For example:
@smallexample
#define m This macro's fine and has an unmatched quote
"/* This is not a comment. */
-/* This is a comment. The following #include directive
- is ill-formed. */
+/* @r{This is a comment. The following #include directive
+ is ill-formed.} */
#include <stdio.h
@end smallexample
@@ -3626,7 +3626,7 @@ example
@smallexample
#define str(x) "x"
-str(/* A comment */some text )
+str(/* @r{A comment} */some text )
@expansion{} "some text "
@end smallexample
Index: doc/cppinternals.texi
===================================================================
RCS file: /cvsroot/gcc/gcc/gcc/doc/cppinternals.texi,v
retrieving revision 1.21
diff -u -p -r1.21 cppinternals.texi
--- doc/cppinternals.texi 8 Feb 2005 15:08:03 -0000 1.21
+++ doc/cppinternals.texi 5 Mar 2005 19:36:26 -0000
@@ -789,8 +789,8 @@ lexed on if, for example, there are inte
C-style comments. For example:
@smallexample
-foo /* A long
-comment */ bar \
+foo /* @r{A long
+comment} */ bar \
baz
@result{}
foo bar baz
Index: doc/extend.texi
===================================================================
RCS file: /cvsroot/gcc/gcc/gcc/doc/extend.texi,v
retrieving revision 1.241
diff -u -p -r1.241 extend.texi
--- doc/extend.texi 25 Feb 2005 18:29:28 -0000 1.241
+++ doc/extend.texi 5 Mar 2005 19:36:26 -0000
@@ -2575,7 +2575,7 @@ int isroot P((uid_t));
/* @r{Old-style function definition.} */
int
-isroot (x) /* ??? lossage here ??? */
+isroot (x) /* @r{??? lossage here ???} */
uid_t x;
@{
return x == 0;
@@ -2854,13 +2854,13 @@ int init_data __attribute__ ((section ("
main()
@{
- /* Initialize stack pointer */
+ /* @r{Initialize stack pointer} */
init_sp (stack + sizeof (stack));
- /* Initialize initialized data */
+ /* @r{Initialize initialized data} */
memcpy (&init_data, &data, &edata - &data);
- /* Turn on the serial ports */
+ /* @r{Turn on the serial ports} */
init_duart (&a);
init_duart (&b);
@}
@@ -2899,8 +2899,8 @@ int foo __attribute__((section ("shared"
int
main()
@{
- /* Read and write foo. All running
- copies see the same value. */
+ /* @r{Read and write foo. All running
+ copies see the same value.} */
return 0;
@}
@end smallexample
@@ -3464,7 +3464,7 @@ GCC does not inline any functions when n
the @samp{always_inline} attribute for the function, like this:
@smallexample
-/* Prototype. */
+/* @r{Prototype.} */
inline void foo (const char) __attribute__((always_inline));
@end smallexample
@@ -3634,7 +3634,7 @@ example for the VAX:
@smallexample
asm volatile ("movc3 %0,%1,%2"
- : /* no outputs */
+ : /* @r{no outputs} */
: "g" (from), "g" (to), "g" (count)
: "r0", "r1", "r2", "r3", "r4", "r5");
@end smallexample
Index: doc/md.texi
===================================================================
RCS file: /cvsroot/gcc/gcc/gcc/doc/md.texi,v
retrieving revision 1.125
diff -u -p -r1.125 md.texi
--- doc/md.texi 10 Feb 2005 08:38:23 -0000 1.125
+++ doc/md.texi 5 Mar 2005 19:36:26 -0000
@@ -4678,9 +4678,9 @@ an equality comparison of a register and
(set (match_dup 0) (compare:CC (match_dup 3) (match_dup 5)))]
"
@{
- /* Get the constant we are comparing against, C, and see what it
+ /* @r{Get the constant we are comparing against, C, and see what it
looks like sign-extended to 16 bits. Then see what constant
- could be XOR'ed with C to get the sign-extended value. */
+ could be XOR'ed with C to get the sign-extended value.} */
int c = INTVAL (operands[2]);
int sextc = (c << 16) >> 16;
Index: doc/objc.texi
===================================================================
RCS file: /cvsroot/gcc/gcc/gcc/doc/objc.texi,v
retrieving revision 1.10
diff -u -p -r1.10 objc.texi
--- doc/objc.texi 18 Jan 2004 01:20:48 -0000 1.10
+++ doc/objc.texi 5 Mar 2005 19:36:26 -0000
@@ -56,7 +56,7 @@ FileStream *Stderr = nil;
Stderr = [[FileStream new] initWithFd:2];
@}
-/* Other methods here */
+/* @r{Other methods here} */
@@end
@end smallexample
@@ -84,7 +84,7 @@ method instead of @code{+initialize}:
Stderr = [[FileStream new] initWithFd:2];
@}
-/* Other methods here */
+/* @r{Other methods here} */
@@end
@end smallexample
Index: doc/sourcebuild.texi
===================================================================
RCS file: /cvsroot/gcc/gcc/gcc/doc/sourcebuild.texi,v
retrieving revision 1.67
diff -u -p -r1.67 sourcebuild.texi
--- doc/sourcebuild.texi 1 Feb 2005 18:16:43 -0000 1.67
+++ doc/sourcebuild.texi 5 Mar 2005 19:36:26 -0000
@@ -1321,8 +1321,8 @@ kind. A command @code{branch(end)} or @
the end of a range without starting a new one. For example:
@smallexample
-if (i > 10 && j > i && j < 20) /* branch(27 50 75) */
- /* branch(end) */
+if (i > 10 && j > i && j < 20) /* @r{branch(27 50 75)} */
+ /* @r{branch(end)} */
foo (i, j);
@end smallexample
Index: doc/tm.texi
===================================================================
RCS file: /cvsroot/gcc/gcc/gcc/doc/tm.texi,v
retrieving revision 1.415
diff -u -p -r1.415 tm.texi
--- doc/tm.texi 25 Feb 2005 21:34:45 -0000 1.415
+++ doc/tm.texi 5 Mar 2005 19:36:26 -0000
@@ -849,7 +849,7 @@ checking the state of the option (docume
@smallexample
[chip.c]
-char *chip_alu = ""; /* Specify default here. */
+char *chip_alu = ""; /* @r{Specify default here.} */
[chip.h]
extern char *chip_alu;
Index: doc/tree-ssa.texi
===================================================================
RCS file: /cvsroot/gcc/gcc/gcc/doc/tree-ssa.texi,v
retrieving revision 1.16
diff -u -p -r1.16 tree-ssa.texi
--- doc/tree-ssa.texi 30 Jan 2005 15:36:13 -0000 1.16
+++ doc/tree-ssa.texi 5 Mar 2005 19:36:26 -0000
@@ -938,14 +938,14 @@ tree FOR_EACH_SSA_TREE_OPERAN
@file{tree-ssa-operands.h}:
@smallexample
-#define SSA_OP_USE 0x01 /* Real USE operands. */
-#define SSA_OP_DEF 0x02 /* Real DEF operands. */
-#define SSA_OP_VUSE 0x04 /* VUSE operands. */
-#define SSA_OP_VMAYUSE 0x08 /* USE portion of V_MAY_DEFS. */
-#define SSA_OP_VMAYDEF 0x10 /* DEF portion of V_MAY_DEFS. */
-#define SSA_OP_VMUSTDEF 0x20 /* V_MUST_DEF definitions. */
+#define SSA_OP_USE 0x01 /* @r{Real USE operands.} */
+#define SSA_OP_DEF 0x02 /* @r{Real DEF operands.} */
+#define SSA_OP_VUSE 0x04 /* @r{VUSE operands.} */
+#define SSA_OP_VMAYUSE 0x08 /* @r{USE portion of V_MAY_DEFS.} */
+#define SSA_OP_VMAYDEF 0x10 /* @r{DEF portion of V_MAY_DEFS.} */
+#define SSA_OP_VMUSTDEF 0x20 /* @r{V_MUST_DEF definitions.} */
-/* These are commonly grouped operand flags. */
+/* @r{These are commonly grouped operand flags.} */
#define SSA_OP_VIRTUAL_USES (SSA_OP_VUSE | SSA_OP_VMAYUSE)
#define SSA_OP_VIRTUAL_DEFS (SSA_OP_VMAYDEF | SSA_OP_VMUSTDEF)
#define SSA_OP_ALL_USES (SSA_OP_VIRTUAL_USES | SSA_OP_USE)