From: borutr Date: Fri, 19 Dec 2008 07:09:42 +0000 (+0000) Subject: * doc/sdccman.lyx, doc/random-notes.txt, doc/avr/avr_design.txt, X-Git-Url: https://git.gag.com/?p=fw%2Fsdcc;a=commitdiff_plain;h=e38680e6b5234f46ad25488e0da448d42a222688 * doc/sdccman.lyx, doc/random-notes.txt, doc/avr/avr_design.txt, doc/TININative.txt, doc/macro-sys-design.txt, doc/libdoc.txt, doc/README.txt, doc/test_suite_spec.lyx: applaid patch 2446381: Dcoumentation spelling correcitons thanks to Steven Borley git-svn-id: https://sdcc.svn.sourceforge.net/svnroot/sdcc/trunk/sdcc@5290 4a8a32a2-be11-0410-ad9d-d568d2c75423 --- diff --git a/ChangeLog b/ChangeLog index 366ee46c..cd9cee3a 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,11 @@ +2008-12-19 Borut Razem + + * doc/sdccman.lyx, doc/random-notes.txt, doc/avr/avr_design.txt, + doc/TININative.txt, doc/macro-sys-design.txt, doc/libdoc.txt, + doc/README.txt, doc/test_suite_spec.lyx: + applaid patch 2446381: Dcoumentation spelling correcitons + thanks to Steven Borley + 2008-12-16 Raphael Neider * device/include/pic/pic12f629.h, diff --git a/doc/README.txt b/doc/README.txt index 721ae48c..4ff88ec6 100644 --- a/doc/README.txt +++ b/doc/README.txt @@ -43,11 +43,11 @@ progress. Please check http://sdcc.sourceforge.net/snap.php for snapshots. Roadmap: COPYING - GPL v2 -as/ - Assembler, derrived from asxxxx +as/ - Assembler, derived from asxxxx debugger/ device/ - Device libraries and examples doc/ - sdcc and target specific documentation -link/ - Linker, also derrived from asxxxx +link/ - Linker, also derived from asxxxx sim/ - Simulator (mcs51 only) src/ - Source to the C compiler and targets support/ - Libraries and apps that may not be provided by your system. @@ -86,5 +86,5 @@ SDCC includes code from: * Pascal Felber Some of the Z80 related files are borrowed from the Gameboy Development Kit (GBDK). -* The GCC developement team http://gcc.gnu.org/ +* The GCC development team http://gcc.gnu.org/ The basis of sdcpp preprocessor diff --git a/doc/TININative.txt b/doc/TININative.txt index 3bbb838c..706b310f 100644 --- a/doc/TININative.txt +++ b/doc/TININative.txt @@ -115,7 +115,7 @@ As mentioned earlier the Native APIs are implemented using compiler intrinsic fu time only the following functions have been mapped (more will be mapped in the future). Some Native API calls return multiple values, I haven't found a good way to handle this yet, in most cases these return a HANDLE and a pointer to ABSOLUTE memory in DPTR, in such cases SDCC will -return ONLY the HANDLE and igonre the POINTER value. The HANDLE can then be used with MM_Deref to +return ONLY the HANDLE and ignore the POINTER value. The HANDLE can then be used with MM_Deref to obtain the POINTER value again (I hope my assumption is correct here). SDCC Prototype Native API diff --git a/doc/avr/avr_design.txt b/doc/avr/avr_design.txt index 779621b3..f47176de 100644 --- a/doc/avr/avr_design.txt +++ b/doc/avr/avr_design.txt @@ -66,7 +66,7 @@ with 8 bit stack pointers. IV) Register Usage ------------------ -R0-R7 - Paramter passing & return value (differs from IAR I don't +R0-R7 - Parameter passing & return value (differs from IAR I don't like IAR's usage of R16-R23, specially since R0-R1 has to be kept free anyway for divide & multiply operations) R8-R25 - General purpose registers for local variables. @@ -78,8 +78,8 @@ V) Parameter passing & return values ------------------------------------ Registers R0-R7 (eight) registers will be used for parameter passing. Unlike the 8051 port the AVR port will pass the first eight bytes of -parameters in a registers (8051 passes only yhe first parameter in -registers), the exception being.. part of a paramter will not be put +parameters in a registers (8051 passes only the first parameter in +registers), the exception being.. part of a parameter will not be put into registers. Examples diff --git a/doc/libdoc.txt b/doc/libdoc.txt index 5a82e221..0aba0efc 100644 --- a/doc/libdoc.txt +++ b/doc/libdoc.txt @@ -361,12 +361,12 @@ strncmp - string manipulation - #include - all ports strchr - string manipulation - #include - all ports char *strchr (char * string, char ch); - Return a pointer to the first occurance of the character ch is string + Return a pointer to the first occurrence of the character ch is string or a NULL pointer if not found. strrchr - string manipulation - #include - all ports char *strrchr(char * string, char ch); - Return a pointer to the last occurance of the character ch is string + Return a pointer to the last occurrence of the character ch is string or a NULL pointer if not found. strspn - string manipulation - #include - all ports diff --git a/doc/macro-sys-design.txt b/doc/macro-sys-design.txt index ef4e889b..6d09c766 100644 --- a/doc/macro-sys-design.txt +++ b/doc/macro-sys-design.txt @@ -8,7 +8,7 @@ GB IAR or rgbds assemblers. simple level from one backend, such as the gbz80 and z80. 3. Provide a way to dynamically build a command line for any spawned processes. -4. Provide a way for the backend to convientely access volatile global data +4. Provide a way for the backend to conveniently access volatile global data such as the source file name or current function name. This is mainly to get around assembler limitations. diff --git a/doc/random-notes.txt b/doc/random-notes.txt index fc8f443d..301c6de5 100644 --- a/doc/random-notes.txt +++ b/doc/random-notes.txt @@ -8,7 +8,7 @@ Lets trace how the register allocator in the mcs51 port works. Some concepts: eBBlock - A basic block. I cant remeber the conditions, but a basic block + A basic block. I can't remember the conditions, but a basic block is one that is easy to optimise and analyse. I guess this means that it has a nice set of assignments and a reasonably straight flow. iCode @@ -33,14 +33,14 @@ In pseudo code, Remove any unneded iTemps that are just used in assignments. Mark anything that can be rematerialised as rematerialisable. There is no way I spelt that correctly. Something is rematerialisable - if it can be generated easily and is constant, and hence dosnt need + if it can be generated easily and is constant, and hence dosn't need to be cached away in an iTemp. An example is the address of something. - Packs iTemps that are only used once into normally unavailble registers. + Packs iTemps that are only used once into normally unavailable registers. Register packing removes unneeded iTemps. -2. Determine what number and type of regsiters are needed for each +2. Determine what number and type of registers are needed for each live range. It does - If the iTemp lives for zero time, dont bother assigning + If the iTemp lives for zero time, don't bother assigning If its not an iTemp, skip for now. If its a conditional (determined in the register packing), skip as it will be stored in carry. @@ -103,7 +103,7 @@ iCode. iCode when this icode is allocated. ->seq - sequence number of the iCode given in - acesnding order of execution. + ascending order of execution. operand. ------- @@ -180,7 +180,7 @@ It seems that IS_SPEC() is being set, deferencing *s so that it's size is sizeof(char) == 1. It's either a SPECIFIER or a DECLARATOR - seems that were the wrong way around. This is set in SDCCsymt.c, SDCCval.c, and the yacc file. SDCCsymt.c and SDCCval.c havnt really changed in 5 days - must -be SDCC.y. Nope, no changes. diff against 5 days ago shows only intersting +be SDCC.y. Nope, no changes. diff against 5 days ago shows only interesting changes are in SDCCicode. Same with -14 days. Michael diff --git a/doc/sdccman.lyx b/doc/sdccman.lyx index b1fda932..3ad7cf77 100644 --- a/doc/sdccman.lyx +++ b/doc/sdccman.lyx @@ -93,7 +93,7 @@ Architecture specific stuff (like memory models, code examples) should maybe \end_layout \begin_layout Standard -into seperate sections/chapters/appendices (it is hard to document PIC or +into separate sections/chapters/appendices (it is hard to document PIC or Z80 in \end_layout @@ -7073,8 +7073,8 @@ name "-\\/-debug" file as well. The library files created with sdcclib are plain text files, so they can be viewed with a text editor. - It is not recomended to modify a library file created with sdcclib using - a text editor, as there are file indexes numbers located accross the file + It is not recommended to modify a library file created with sdcclib using + a text editor, as there are file indexes numbers located across the file used by the linker to quickly locate the required module to link. Once a .rel file (as well as a .adb file) is added to a library using sdcclib, it can be safely deleted, since all the information required for linking @@ -14700,7 +14700,7 @@ name "Storage class" \end_inset - is specified for a local variable, it will NOT be overlayed. + is specified for a local variable, it will NOT be overlaid. \end_layout \begin_layout Standard @@ -14751,7 +14751,7 @@ name "Division" \end_inset - will NOT be overlayed since these are implemented using external functions, + will NOT be overlaid since these are implemented using external functions, e.g.: \end_layout @@ -14832,7 +14832,7 @@ nooverlay was from an interrupt service routine. The #pragma\InsetSpace ~ nooverlay ensures that the parameters and local variables for - the function are NOT overlayed. + the function are NOT overlaid. \begin_inset VSpace bigskip \end_inset @@ -15977,7 +15977,7 @@ EA = EA_SAVE; \end_layout \begin_layout Standard -On other architectures which have seperate opcodes for enabling and disabling +On other architectures which have separate opcodes for enabling and disabling interrupts you might want to make use of defines with inline assembly \begin_inset LatexCommand index name "Assembler routines" @@ -17439,7 +17439,7 @@ target "http://sdcc.svn.sourceforge.net/viewvc/sdcc/trunk/sdcc/device/lib/mcs51/ crtstart.asm \emph default - and when linking your project explicitely specify + and when linking your project explicitly specify \emph on crtstart.rel \emph default @@ -23117,7 +23117,7 @@ name "interrupt vector table" manually, or when there is a secondary, manually defined interrupt vector table (e.g. for the autovector feature of the Cypress EZ-USB FX2). - More elegantly this can be achieved by obmitting the optional interrupt + More elegantly this can be achieved by omitting the optional interrupt number after the interrupt keyword, see section \begin_inset LatexCommand ref reference "sub:Interrupt-Service-Routines" @@ -23501,8 +23501,8 @@ name "\\#pragma preproc\\_asm" (+ | -) - switch _asm _endasm block preprocessing on / off. Default is on. - You use this prama to define multilines of assembly code. - This will prevent the preprocessor from changing the formating required + You use this pragma to define multilines of assembly code. + This will prevent the preprocessor from changing the formatting required by assembly code. Below is an example on how to use this pragma. \end_layout @@ -24704,7 +24704,7 @@ Normally all functions you write end up in \begin_layout Standard Functions that need to be in a switched bank must be put in a named segment. - The name can be mostly anything upto eight characters (e.g. + The name can be mostly anything up to eight characters (e.g. BANK1). To do this you either use - \begin_inset ERT @@ -25040,7 +25040,7 @@ Make local functions static, as non static functions require code page selection \newline Due to the way sdcc handles functions, place called functions prior to calling functions in the file wherever possible: Otherwise sdcc will - insert unneccessary pagesel directives around the call, believing that + insert unnecessary pagesel directives around the call, believing that the called function is externally defined. \end_layout @@ -25479,7 +25479,7 @@ device/lib/pic/Makefile.in device/lib/pic/Makefile \family default to reflect your device. - This might even improve performance for smaller devices as unneccesary + This might even improve performance for smaller devices as unnecessary BANKSELs might be removed. \end_layout @@ -25719,7 +25719,7 @@ status collapsed \end_inset --pstack-model=[model] Used in conjuction with the command above. +-pstack-model=[model] Used in conjunction with the command above. Defines the stack model to be used, valid stack models are: \end_layout @@ -26172,11 +26172,11 @@ status collapsed \end_layout \begin_layout Subsection -Enviroment Variables +Environment Variables \end_layout \begin_layout Standard -There is a number of enviromental variables that can be used when running +There is a number of environmental variables that can be used when running SDCC to enable certain optimizations or force a specific program behaviour. these variables are primarily for debugging purposes so they can be enabled/dis abled at will. @@ -27002,7 +27002,7 @@ libdebug \begin_layout Standard \noindent -This feature allows for linking with specific libraries withoug having to +This feature allows for linking with specific libraries without having to explicit name them in the command line. Note that the \noun on @@ -28272,7 +28272,7 @@ instruction at the \emph on Interrupt Vector Address \emph default - which points at the genetated ISR. + which points at the generated ISR. This single GOTO instruction is part of an automatically generated \emph on interrupt entry point @@ -28290,7 +28290,7 @@ not Address of the specific interrupt. This is not a problem for the LOW priority interrupts, but it is a problem for the RESET and the HIGH priority interrupts because code may be written - at the next interrupt's vector address and cause undeterminate program + at the next interrupt's vector address and cause indeterminate program behaviour if that interrupt is raised. \begin_inset Foot status open @@ -29209,7 +29209,7 @@ For sprintf and vsprintf buf \emph default should normally be a data pointer where the resulting string will be placed. - No range checking is done so the user should allocate the necessery buffer. + No range checking is done so the user should allocate the necessary buffer. For fprintf and vfprintf \emph on fp @@ -29268,7 +29268,7 @@ signal name \begin_inset Text \begin_layout Standard -descritpion +description \end_layout \end_inset @@ -30778,9 +30778,9 @@ ddd -debugger "sdcdb -cpu 8032 ddd_example" status open \begin_layout Standard -Check that the double quotes or an apostroph within the command line survive +Check that the double quotes or an apostrophe within the command line survive the LyX tool chain. - Previously the apostrophs got slanted in the PDF output so a cut and paste + Previously the apostrophes got slanted in the PDF output so a cut and paste did not work. \end_layout @@ -31935,7 +31935,7 @@ reference "sub:Common-interrupt-pitfall-volatile" \end_layout \begin_layout Itemize -check that the compilers are not told to supress warnings. +check that the compilers are not told to suppress warnings. \end_layout \begin_layout Itemize @@ -35147,12 +35147,12 @@ make your students aware about the pros and cons of open source software \end_layout \begin_layout Enumerate -give back to the public as you are probably at least partially publically +give back to the public as you are probably at least partially publicly funded \end_layout \begin_layout Enumerate -give students a chance to publically prove their skills and to possibly +give students a chance to publicly prove their skills and to possibly see a world wide impact \end_layout @@ -38341,7 +38341,7 @@ name "sub:ANSI-Compliance" \end_layout \begin_layout Standard -The latest publically available version of the standard +The latest publicly available version of the standard \emph on ISO/IEC 9899 - Programming languages - C \emph default diff --git a/doc/test_suite_spec.lyx b/doc/test_suite_spec.lyx index 12ee607d..bf4ea1b4 100644 --- a/doc/test_suite_spec.lyx +++ b/doc/test_suite_spec.lyx @@ -170,7 +170,7 @@ The tests suits should be able to be sub-divided, so that the failing or \end_layout \begin_layout Subsection -Artifcats +Artifacts \end_layout \begin_layout Standard