[PATCH] MicroBlaze support - 1 of 6 - documentation

[Michael Eager]

Joseph S. Myers wrote:
> On Thu, 4 Feb 2010, Michael Eager wrote:
> 
>>   * doc/install.texi( microblaze-*-elf): Add.
> 
> Swap "(" and " " here.
> 
>>   * doc/invoke.texi (microblaze options): Add descriptions for
>>   MicroBlaze-specific options.
> 
> The section appears to be called "MicroBlaze Options", so the log entry 
> should use that capitalization.
> 
>> +@item -mmemcpy
>> +@opindex mmemcpy
>> +Don't optimize block moves, use memcpy.
> 
> @code{memcpy}.
> 
>> +@item -mno-clearbss
>> +@opindex mno-clearbss
>> +Clear the BSS to zero and place zero initialized in BSS.
> 
> Why do you need a target-specific option?  I'd expect the 
> target-independent -fno-zero-initialized-in-bss to suffice.  If this 
> option means something different from what the target-independent option 
> controls, you need more documentation to explain the difference, with a 
> cross-reference in that documentation to the target-independent option.

This is needed for backward compatibility with existing usage.  I've
documented this option as deprecated with an xref to
-fno-zero-initialized-in-bss.  I also added a warning if it is used.

>> +@item -mxl-stack-check
>> +@opindex mxl-stack-check
>> +Check for stack overflow at runtime.
> 
> Is there a reason you can't hook up whatever target-specific logic there 
> is to the target-independent -fstack-check option?  Again, more 
> documentation of the difference needed if so.

Similarly.
http://gcc.gnu.org/viewcvs?view=revision&revision=156791
or
svn diff svn://gcc.gnu.org/svn/gcc/branches/microblaze -r r156790:r156791

> 
>> +Select application model @var{app-model}.  Valid models are 
>> +@table @samp
>> +@var{executable} -- normal executable (default), uses startup code crt0.o.
> 
> I think you mean
> 
>   @table @samp
>   @item executable
>   normal executable (default), uses startup code crt0.o.
> 
> and similar for subsequent items.
> 
>> +@var{xmdstub} -- for use with Xilinx Microprocessor Debugger (XMD) based 
>> +software intrusive debug agent called xmdstub. This uses startup file 
>> +crt1.o and sets the start address of the program to be 0x800.
> 
> @file{crt1.o}.
> 
>> +@var{bootstrap} -- for applications that are loaded using a bootloader.
>> +This model uses startup file crt2.o which does not contain a processor 
> 
> @file{crt2.o}
> 
>> +within a monitoring application. This model uses crt3.o as a startup file.
> 
> @file{crt3.o}
> 
>> +Option -xl-mode-@var{app-model} is a deprecated alias for 
>> +-mxl-mode-@var{app-model}.
> 
> New ports shouldn't be adding deprecated options, but if it's really 
> necessary then use @option{-xl-mode-@var{app-model}}, 
> @option{-mxl-mode-@var{app-model}}.
> 
>> +@item MicroBlaze ---@file{config/microblaze/constraints.md}
> 
> Remove the space before "---".
> 

Revised doc patch attached.

-- 
Michael Eager	 eager@eagercon.com
1960 Park Blvd., Palo Alto, CA 94306  650-325-8077


-------------- next part --------------
An embedded and charset-unspecified text was scrubbed...
Name: doc.patch
URL: <http://gcc.gnu.org/pipermail/gcc-patches/attachments/20100219/bb8dd643/attachment.ksh>