[Issue 1001431] New: Typo regarding FLASH API structure

[bugzilla-daemon at ecoscentric dot com]

Please do not reply to this email. Use the web interface provided at:
https://bugzilla.ecoscentric.com/show_bug.cgi?id=1001431

           Summary: Typo regarding FLASH API structure
           Product: eCos
           Version: unknown
          Platform: All
        OS/Version: Other
            Status: UNCONFIRMED
          Severity: minor
          Priority: normal
         Component: Reference Guide
        AssignedTo: unassigned@bugs.ecos.sourceware.org
        ReportedBy: keith.smith@perkinelmer.com
         QAContact: ecos-bugs@ecos.sourceware.org
                CC: ecos-bugs@ecos.sourceware.org
             Class: Advice Request


At URL http://www.ecos.sourceware.org/docs-latest/ref/ecos-flash-v2.html

the structure cyg_flash_info_t is displayed.

Below is from the file packages/io/flash/v3_0/include/flash.h

----------------------------------------
// Information about what one device driver drives
typedef struct {
  cyg_flashaddr_t               start;              // First address
  cyg_flashaddr_t               end;                // Last address
  cyg_uint32                    num_block_infos;    // Number of entries
  const cyg_flash_block_info_t* block_info;         // Info about block sizes
} cyg_flash_info_t;
----------------------------------------

The URL states

  const cyg_flash_block_info_t* blocks_info;         // Info about block sizes

where flash.h states

  const cyg_flash_block_info_t* block_info;         // Info about block sizes


The documentation uses the name 'blocks_info'.
The code uses the name 'block_info'.

The documentation should be updated to match the code.

-- 
Configure issuemail: https://bugzilla.ecoscentric.com/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
You are the QA contact for the issue.
You are on the CC list for the issue.