This is the mail archive of the
binutils@sourceware.cygnus.com
mailing list for the binutils project.
Patch for gas/doc/internals.texi
- To: binutils at sourceware dot cygnus dot com
- Subject: Patch for gas/doc/internals.texi
- From: Hans-Peter Nilsson <hans-peter dot nilsson at axis dot com>
- Date: Tue, 1 Feb 2000 19:30:21 +0100
Hi.
I spotted these minor faults while cleaning up the CRIS port for
submission, but I did not go over internals.texi with a comb.
I hope the way line_separator_chars work is deliberate,
I thought they *did* break up comment lines.
I'm a bit curious over the apparent md_create_short_jump flaw;
it's only benefit over md_create_long_jump seems to be that it
will jump over a *multiple* of md_create_long_jump:s rather than
to an arbitrary location (case-label equivalent) in the function.
brgds, H-P
(PS, I don't have checkin rights to binutils, just gcc.)
Tue Feb 1 18:43:09 2000 Hans-Peter Nilsson <hp@axis.com>
* doc/internals.texi (CPU backend): Mention that
line_separator_chars do not break up comments.
Fix typos for LEX_AT and LEX_NAME descriptions.
Document operands for TC_EQUAL_IN_INSN, md_operand and
md_section_align.
Correct description of md_create_short_jump usage.
Index: internals.texi
===================================================================
RCS file: /cvs/binutils/binutils/gas/doc/internals.texi,v
retrieving revision 1.4
diff -p -c -r1.4 internals.texi
*** internals.texi 1999/09/12 03:44:42 1.4
--- internals.texi 2000/02/01 17:58:15
*************** comment when they appear at the start of
*** 914,920 ****
@cindex line_separator_chars
This is a null terminated @code{const char} array of characters which separate
lines (semicolon and newline are such characters by default, and need not be
! listed in this array).
@item EXP_CHARS
@cindex EXP_CHARS
--- 914,922 ----
@cindex line_separator_chars
This is a null terminated @code{const char} array of characters which separate
lines (semicolon and newline are such characters by default, and need not be
! listed in this array). Note that line_separator_chars do not separate lines
! if found in a comment, such as after a character in line_separator_chars or
! comment_chars.
@item EXP_CHARS
@cindex EXP_CHARS
*************** Usually this includes @samp{r} and @samp
*** 932,944 ****
@item LEX_AT
@cindex LEX_AT
! You may define this macro to the lexical type of the @kbd{@}} character. The
default is zero.
Lexical types are a combination of @code{LEX_NAME} and @code{LEX_BEGIN_NAME},
both defined in @file{read.h}. @code{LEX_NAME} indicates that the character
may appear in a name. @code{LEX_BEGIN_NAME} indicates that the character may
! appear at the beginning of a nem.
@item LEX_BR
@cindex LEX_BR
--- 934,946 ----
@item LEX_AT
@cindex LEX_AT
! You may define this macro to the lexical type of the @kbd{@@} character. The
default is zero.
Lexical types are a combination of @code{LEX_NAME} and @code{LEX_BEGIN_NAME},
both defined in @file{read.h}. @code{LEX_NAME} indicates that the character
may appear in a name. @code{LEX_BEGIN_NAME} indicates that the character may
! appear at the beginning of a name.
@item LEX_BR
@cindex LEX_BR
*************** If you define this macro, GAS will not r
*** 996,1002 ****
@item TC_EQUAL_IN_INSN
@cindex TC_EQUAL_IN_INSN
If you define this macro, it should return nonzero if the instruction is
! permitted to contain an @kbd{=} character. GAS will use this to decide if a
@kbd{=} is an assignment or an instruction.
@item TC_EOL_IN_INSN
--- 998,1006 ----
@item TC_EQUAL_IN_INSN
@cindex TC_EQUAL_IN_INSN
If you define this macro, it should return nonzero if the instruction is
! permitted to contain an @kbd{=} character. GAS will call it with two
! arguments, the character before the @kbd{=} character, and the value of
! @code{input_line_pointer} at that point. GAS uses this macro to decide if a
@kbd{=} is an assignment or an instruction.
@item TC_EOL_IN_INSN
*************** is called.
*** 1022,1030 ****
@item md_operand
@cindex md_operand
! GAS will call this function for any expression that can not be recognized.
! When the function is called, @code{input_line_pointer} will point to the start
! of the expression.
@item tc_unrecognized_line
@cindex tc_unrecognized_line
--- 1026,1035 ----
@item md_operand
@cindex md_operand
! GAS will call this function with one argument, an @code{expressionS}
! pointer, for any expression that can not be recognized. When the function
! is called, @code{input_line_pointer} will point to the start of the
! expression.
@item tc_unrecognized_line
@cindex tc_unrecognized_line
*************** relocation entry.
*** 1114,1124 ****
@cindex md_create_long_jump
If @code{WORKING_DOT_WORD} is defined, GAS will not do broken word processing
(@pxref{Broken words}). Otherwise, you should set @code{md_short_jump_size} to
! the size of a short jump (a jump that is just long enough to jump around a long
! jmp) and @code{md_long_jump_size} to the size of a long jump (a jump that can
! go anywhere in the function), You should define @code{md_create_short_jump} to
! create a short jump around a long jump, and define @code{md_create_long_jump}
! to create a long jump.
@item md_estimate_size_before_relax
@cindex md_estimate_size_before_relax
--- 1119,1129 ----
@cindex md_create_long_jump
If @code{WORKING_DOT_WORD} is defined, GAS will not do broken word processing
(@pxref{Broken words}). Otherwise, you should set @code{md_short_jump_size} to
! the size of a short jump (a jump that is just long enough to jump around a
! number of long jumps) and @code{md_long_jump_size} to the size of a long jump
! (a jump that can go anywhere in the function), You should define
! @code{md_create_short_jump} to create a short jump around a number of long
! jumps, and define @code{md_create_long_jump} to create a long jump.
@item md_estimate_size_before_relax
@cindex md_estimate_size_before_relax
*************** If you define this macro, GAS will call
*** 1216,1222 ****
@item md_section_align
@cindex md_section_align
GAS will call this function for each section at the end of the assembly, to
! permit the CPU backend to adjust the alignment of a section.
@item tc_frob_section
@cindex tc_frob_section
--- 1221,1230 ----
@item md_section_align
@cindex md_section_align
GAS will call this function for each section at the end of the assembly, to
! permit the CPU backend to adjust the alignment of a section. The function
! must take two arguments, a @code{segT} for the section and a @code{valueT}
! for the size of the section, and return a @code{valueT} for the rounded
! size.
@item tc_frob_section
@cindex tc_frob_section