microsoft/mu_feature_dfci

[Bug]: Use meaningful variable names in this repo

makubacki opened this issue · 2 comments

makubacki commented

Is there an existing issue for this?

  • I have searched existing issues

Current Behavior

Code has variable names that do meet the EDK II C Coding Standards Specification.

Specifically, refer to v2.20 3.1 Naming.

For example, in DfciPkg/SettingsManager/SettingsManagerProvider.c:

EFI_STATUS
EFIAPI
SetProviderValueFromAscii (
  IN CONST DFCI_SETTING_PROVIDER  *Provider,
  IN CONST CHAR8                  *Value,
  IN CONST DFCI_AUTH_TOKEN        *AuthToken,
  IN OUT DFCI_SETTING_FLAGS       *Flags
  )
{
  CONST VOID  *SetValue  = NULL;
  BOOLEAN     v          = FALSE;
  UINT8       b          = 0;
  UINT8       *ByteArray = NULL;
  .  .  .

Variable names v and b poorly describe the variable. This is a single example, but the issue tracks fixing this in the whole package. This impacts maintainability of the code.

Expected Behavior

Relevant, precise, and useful variable names.

Steps To Reproduce

Review code in the repo.

Build Environment

N/A

Version Information

Tag: v2.0.1 (current tip of main branch)

Urgency

Low

Are you going to fix this?

Someone else needs to fix it

Do you need maintainer feedback?

No maintainer feedback needed

Anything else?

No response

github-actions commented

This issue has been automatically marked as stale because it has not had activity in 45 days. It will be closed if no further activity occurs within 7 days. Thank you for your contributions.

github-actions commented

This issue has been automatically been closed because it did not have any activity in 45 days and no follow up within 7 days after being marked stale. Thank you for your contributions.