CFE_PSP_MemRangeSet() description error

[skliper]

CFE_PSP_MemRangeSet() in cfe_psp_memrange.c has a comment error on the MemoryType argument that could be misleading.

CFE_PSP_MemRangeSet() validates against CFE_PSP_MEM_RAM and CFE_PSP_MEM_EEPROM types and errors out with any other type. (This is consistent with the CFE_PSP_MemValidateRange() implementation.) But the source file comments for CFE_PSP_MemRangeSet() have (cfe_psp_memrange.c, line 188):
{{{
<...snip...>
**
** Parameters:
** RangeNum -- A 32 bit integer ( starting with 0 ) specifying the MemoryTable entry.
** MemoryType -- The memory type to validate: CFE_PSP_MEM_RAM, CFE_PSP_MRM_EEPROM, or CFE_PSP_MEM_ANY
** Address -- A 32 bit starting address of the memory range
<...snip...>
}}}

That last "or CFE_PSP_MEM_ANY" is incorrect.

[skliper]

Imported from trac issue 34. Created by abrown4 on 2015-08-11T17:49:27, last modified: 2019-04-02T14:49:34

[skliper]

Trac comment by sduran on 2015-08-17 15:32:54:

These are the valid values for MemoryType:
#define CFE_PSP_MEM_RAM 1
#define CFE_PSP_MEM_EEPROM 2
#define CFE_PSP_MEM_ANY 3
#define CFE_PSP_MEM_INVALID 4

The last 2 are not valid for this function, so it does look like an incorrect comment.

• Correct comment.

[skliper]

Trac comment by abrown4 on 2015-08-17 15:51:39:

commit: [changeset:1868407] Trac #38 Updated CFE_PSP_MemRangeSet() comments.

[skliper]

Trac comment by jphickey on 2015-12-07 12:58:29:

CCB Review: extracted from trac #14 branch and rebased to development

Commit [changeset:b3f19ff] contains the final fix, in branch trac-34-fixup-description-error

[skliper]

Trac comment by jphickey on 2015-12-07 13:00:01:

Review comments: This changes a comment so it has no impact on function, but it does not fix the obvious typo within the same line (CFE_PSP_MRM_EEPROM)

[skliper]

Trac comment by sstrege on 2015-12-07 22:00:47:

I'm OK with this change for the next release however, this points to a larger issue of having a PSP support memory ranges that are outside of RAM and EEPROM.

[skliper]

Trac comment by jphickey on 2015-12-15 14:05:09:

Commit [changeset:5f281c4] pushed with CCB updates from 2015-12-15

[skliper]

Trac comment by glimes on 2015-12-22 15:51:13:

2015-12-28 merged to development.

[skliper]

Trac comment by glimes on 2016-01-11 10:42:10:

Mark for PSP 1.3 per email from sstrege

[skliper]

Trac comment by jhageman on 2019-04-02 14:49:34:

Milestone renamed