diff options
author | Antonio Borneo <borneo.antonio@gmail.com> | 2018-02-10 23:56:30 +0100 |
---|---|---|
committer | Matthias Welwarsky <matthias@welwarsky.de> | 2018-05-09 11:43:23 +0100 |
commit | f0767a316a11c03924322b96b8d3feae1fe99a34 (patch) | |
tree | 350d79e8b7fad98e1bd1894edaddbf8da731f779 /doc/manual/primer | |
parent | 7b94ae9e520877e7f2341b48b3bd0c0d1ca8a14b (diff) |
doc: fix several typos within manual documents
Mostly trivial fixes spotted by spell checker
Change-Id: I3af693faf5506c866e2abe253a0e37aea3c4d284
Signed-off-by: Antonio Borneo <borneo.antonio@gmail.com>
Reviewed-on: http://openocd.zylin.com/4510
Tested-by: jenkins
Reviewed-by: Christopher Head <chead@zaber.com>
Reviewed-by: Matthias Welwarsky <matthias@welwarsky.de>
Diffstat (limited to 'doc/manual/primer')
-rw-r--r-- | doc/manual/primer/autotools.txt | 2 | ||||
-rw-r--r-- | doc/manual/primer/commands.txt | 2 | ||||
-rw-r--r-- | doc/manual/primer/docs.txt | 2 | ||||
-rw-r--r-- | doc/manual/primer/tcl.txt | 26 |
4 files changed, 16 insertions, 16 deletions
diff --git a/doc/manual/primer/autotools.txt b/doc/manual/primer/autotools.txt index 9d9aada1..3471eacd 100644 --- a/doc/manual/primer/autotools.txt +++ b/doc/manual/primer/autotools.txt @@ -123,7 +123,7 @@ implement new checks. The <code>make distcheck</code> command produces an archive of the project deliverables (using <code>make dist</code>) and verifies its -integrity for distribution by attemptng to use the package in the same +integrity for distribution by attempting to use the package in the same manner as a user. These checks includes the following steps: diff --git a/doc/manual/primer/commands.txt b/doc/manual/primer/commands.txt index 5f89d506..a626f56b 100644 --- a/doc/manual/primer/commands.txt +++ b/doc/manual/primer/commands.txt @@ -30,7 +30,7 @@ called (with the appropriate parameters), the @c CALL_COMMAND_HANDLER macro to pass any e as parameters to the following helper function: The subsequent blocks of code are a normal C function that can do -anything, so only complex commands deserve should use comamnd helper +anything, so only complex commands deserve should use command helper functions. In this respect, this example uses one to demonstrate how -- not when -- they should be used. diff --git a/doc/manual/primer/docs.txt b/doc/manual/primer/docs.txt index 504da790..b1c05313 100644 --- a/doc/manual/primer/docs.txt +++ b/doc/manual/primer/docs.txt @@ -19,7 +19,7 @@ OpenOCD presently produces several kinds of documentation: - See @subpage primerlatex and @ref stylelatex. - The Manual: - Focuses on developing the OpenOCD software. - - Details the architecutre, driver interfaces, and processes. + - Details the architecture, driver interfaces, and processes. - Provides "full" coverage of C source code (work-in-progress). - Written using Doxygen C language conventions (i.e. in comments). - Created with 'make doxygen'. diff --git a/doc/manual/primer/tcl.txt b/doc/manual/primer/tcl.txt index 9be4a05e..868a75ba 100644 --- a/doc/manual/primer/tcl.txt +++ b/doc/manual/primer/tcl.txt @@ -125,7 +125,7 @@ There is some tricky things going on. =============== First, there is a "for" loop - at level 0 -{level 0 means: out side of a proc/function} +{level 0 means: outside of a procedure/function} This means it is evaluated when the file is parsed. @@ -151,9 +151,9 @@ The FOR command: 5) Goto Step 2. As show, each of these items are in {curly-braces}. This means they -are passed as they are - KEY-POINT: un evaluated to the FOR +are passed as they are - KEY-POINT: unevaluated to the FOR command. Think of it like escaping the backticks in Bash so that the -"under-lying" command can evaluate the contents. In this case, the FOR +"underlying" command can evaluate the contents. In this case, the FOR COMMAND. == END: SIDEBAR: About The FOR command == @@ -167,9 +167,9 @@ Format is like "sprintf". Because of the [brackets], it becomes what you think. But here's how: First - the line is parsed - for {braces}. In this case, there are -none. The, the parser looks for [brackets] and finds them. The, +none. Then, the parser looks for [brackets] and finds them. The parser then evaluates the contents of the [brackets], and replaces -them. It is alot this bash statement. +them. It is similar to this bash statement. EXPORT vn=`date` @@ -179,7 +179,7 @@ LINE 2 & 3 In line 1, we dynamically created a variable name. Here, we are assigning it a value. Lastly Line 3 we force the variable to be -global, not "local" the the "for command body" +global, not "local" within the "for command body" =============== The PROCS @@ -194,7 +194,7 @@ The (1) NAME of the function, a (2) LIST of parameters, and a (3) BODY Again, this is at "level 0" so it is a global function. (Yes, TCL supports local functions, you put them inside of a function} -You'll see in some cases, I nest [brackets] alot and in others I'm +You'll see in some cases, I nest [brackets] a lot and in others I'm lazy or wanted it to be more clear... it is a matter of choice. =============== @@ -224,7 +224,7 @@ All memory regions must have 2 things: RWX - the access ability. WIDTH - the accessible width. - ie: Some regions of memory are not 'word' + i.e.: Some regions of memory are not 'word' accessible. The function "address_info" - given an address should @@ -287,7 +287,7 @@ Notice this IF COMMAND - (not statement) is like this: error [format string...] } -The "IF" command expects either 2 params, or 4 params. +The "IF" command expects either 2 or 4 parameters. === Sidebar: About "commands" === @@ -317,7 +317,7 @@ You give CATCH 1 or 2 parameters. The 2nd (optional) is where to put the error message. CATCH returns 0 on success, 1 for failure. - The "![catch command]" is self explaintory. + The "![catch command]" is self explanatory. The 3rd parameter to IF must be exactly "else" or "elseif" [I lied @@ -341,7 +341,7 @@ exists. {the function: "proc_exists" does this} And - if it does - I call the function. -In "C" it is alot like using: 'sprintf()' to construct a function name +In "C" it is a lot like using: 'sprintf()' to construct a function name string, then using "dlopen()" and "dlsym()" to look it up - and get a function pointer - and calling the function pointer. @@ -380,7 +380,7 @@ Some assumptions: The "CHIP" file has defined some variables in a proper form. -ie: AT91C_BASE_US0 - for usart0, +i.e.: AT91C_BASE_US0 - for usart0, AT91C_BASE_US1 - for usart1 ... And so on ... @@ -394,7 +394,7 @@ looks like this: In this case, I'm trying to figure out what USARTs exist. Step 1 - is to determine if the NAME has been defined. -ie: Does AT91C_BASE_USx - where X is some number exist? +i.e.: Does AT91C_BASE_USx - where X is some number exist? The "info exists VARNAME" tells you if the variable exists. Then - inside the IF statement... There is another loop. This loop is the |