poke-devel
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: [PATCH] DOC: Correct some typos, missing indeces and plain BS


From: Jose E. Marchesi
Subject: Re: [PATCH] DOC: Correct some typos, missing indeces and plain BS
Date: Sun, 29 Mar 2020 13:07:59 +0200
User-agent: Gnus/5.13 (Gnus v5.13) Emacs/26.1 (gnu/linux)

Hi John.
This is OK for master.
Thanks!

    ---
     doc/poke.texi | 38 ++++++++++++++++++++++----------------
     1 file changed, 22 insertions(+), 16 deletions(-)
    
    diff --git a/doc/poke.texi b/doc/poke.texi
    index d0ed9393..941f84b9 100644
    --- a/doc/poke.texi
    +++ b/doc/poke.texi
    @@ -114,7 +114,7 @@ The Standard Library
     * Standard Integral Types::        int, long and the like.
     * Standard Offset Types::  off64 and the like.
     * Standard Units::         b, B, Kb and the like.
    -* Conversion Functions::   catos, atoi, etc.
    +* Conversion Functions::   catos, atoi, @i{etc}.
     * String Functions::               Functions which deal with strings.
     * Sorting Functions::              qsort.
     * CRC Functions::               Cyclic Redundancy Checksums.
    @@ -1661,7 +1661,7 @@ details.
     
     There are several ways to express the unit of an offset, which is
     always interpreted as a multiple of the basic unit, which is the bit
    -(one bit.)
    +(one bit).
     
     @subsection Named Units
     
    @@ -1704,14 +1704,14 @@ offsets in any arbitrary unit, as disparate as it 
may seem:
     8#1
     @end example
     
    -That's it, 17 units of 3 bits each, zero units of 12 bits each,
    -and eight units of 1 bit each.  Note that the unit should be bigger
    +That's it: 17 units of 3 bits each, zero units of 12 bits each,
    +and eight units of 1 bit each.  Note that the unit should be greater
     than 0.
     
     @subsection Types as Units
     
    -But then, why stopping there?  Poking is all about defining data
    -structures and operating on them@dots{} so why not using these structures
    +But then, why stop there?  Poking is all about defining data
    +structures and operating on them@dots{} so why not use these structures
     as units as well?  Consider the following struct:
     
     @example
    @@ -3063,7 +3063,7 @@ Where @var{lvalue} is either:
     @itemize @bullet
     @item A variable.
     @item A field reference like @code{foo.bar}.
    -@item An index reference like @code{foo[30]}
    +@item An index reference like @code{foo[30]}.
     @item A map of a simple type, like @code{int @@ 0#B}.
     @end itemize
     
    @@ -3345,7 +3345,7 @@ it is of type @code{any[]}.
     @section Calling Functions
     @cindex calling, function calls
     To call a function, write its name followed by the arguments in
    -parenthesis.  Examples:
    +parentheses.  Examples:
     
     @example
     foo (1,2,3)
    @@ -3369,7 +3369,7 @@ expression-as-statement context.  This alternate 
syntax is:
     @end example
     
     Where @var{arg1} is the name of an argument and @var{val1} the value
    -to pass for that argument.  This is useful to use functions as
    +to pass for that argument.  This is useful when using functions as
     commands in the REPL:
     
     @cindex dump
    @@ -3571,7 +3571,7 @@ deftype BPF_Insn_Regs =
     
     This version, where the ordering of the fields is implemented using
     field labels, is not only more compact, but also has the virtue of not
    -requiring additional "intermediate" fields like @code{le} and
    +requiring additional ``intermediate'' fields like @code{le} and
     @code{be} above.  It also shows how convenient can be to declare
     variables inside structs.
     
    @@ -3633,7 +3633,7 @@ deftype Elf64_Ehdr =
     @end example
     
     Note how @code{set_endian} returns an integer value@dots{}  it is always
    -@code{1}. This is to facilitate its usage in fields constraint
    +@code{1}. This is to facilitate its usage in field constraint
     expressions.
     
     @node Mapping
    @@ -3957,6 +3957,7 @@ given the variable @code{nelems} has a value of 
@code{2}:
     [100,222,333]
     @end example
     
    +@cindex end of file
     If an end-of-file condition happens while mapping the array, because
     the number of elements specified in the array type, at the given
     offset, exceeds the capacity of the underlying IO device, an exception
    @@ -4227,6 +4228,7 @@ Generic error.
     Out of bounds exception.  This can be raised when accessing
     containers, like arrays and strings.
     @item E_eof
    +@cindex end of file
     End of file exception.  This can be raised when mapping in the IO
     space.
     @item E_elem
    @@ -4280,11 +4282,11 @@ try @var{stmt} catch @var{compound_stmt}
     @end example
     
     Where @var{stmt} is any statement and @var{compound_stmt} is a
    -compound statement.  @var{stmt} is executed.  If during its execution
    -an exception is raised, then @var{compound_stmt} gets executed.
    +compound statement.  First, @var{stmt} is executed.  If during its 
execution
    +an exception is raised, then @var{compound_stmt} is executed.
     
     The second form of the statement allows you to catch just one type of
    -exceptions:
    +exception:
     
     @example
     try @var{stmt} catch if @var{exp} @var{compound_stmt}
    @@ -4319,6 +4321,7 @@ until some exception is raised.  If the raised 
exception has type
     @var{exp} then execution continues normally.  @var{exp} should be an
     expression that evaluates to an @code{Exception}.
     
    +@cindex end of file
     This statement is particularly useful for mapping IO spaces until an
     @code{eof} condition occurs.  For example, this is how we would
     compute with every integer in the current IO space:
    @@ -4506,6 +4509,7 @@ XXX
     
     @node Comments
     @chapter Comments
    +@cindex comments
     
     There are several ways to document your Poke programs: comments of
     several types and support for separator characters.
    @@ -4533,14 +4537,16 @@ line or the end of the file, whatever comes first.
     @node Vertical separator
     @section Vertical separator
     
    -Poke ignores form feed characters (ASCII code 14, often visualized as
    +@cindex @code{^L}
    +@cindex form feed
    +Poke ignores form feed characters (ASCII code 12, often visualized as
     ^L).  In GNU software, this character is traditionally used to
     separate conceptually different entities in source files.
     
     @node Modules
     @chapter Modules
     @cindex @code{load}
    -@cindex @code{modules}
    +@cindex modules
     
     It is common for pickles to depend on stuff defined in other pickles.
     In such cases, the @code{load} language construction can be used to



reply via email to

[Prev in Thread] Current Thread [Next in Thread]