Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Bug]: Use meaningful variable names in this repo #50

Closed
1 task done
makubacki opened this issue Mar 9, 2023 · 2 comments
Closed
1 task done

[Bug]: Use meaningful variable names in this repo #50

makubacki opened this issue Mar 9, 2023 · 2 comments
Labels
state:needs-owner Needs an issue owner to be assigned state:needs-triage Needs to triaged to determine next steps state:stale Has not been updated in a long time type:bug Something isn't working urgency:low Little to no impact

Comments

@makubacki
Copy link
Member

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

@makubacki makubacki added state:needs-triage Needs to triaged to determine next steps type:bug Something isn't working labels Mar 9, 2023
@github-actions github-actions bot added urgency:low Little to no impact state:needs-owner Needs an issue owner to be assigned labels Mar 9, 2023
@github-actions
Copy link

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 github-actions bot added the state:stale Has not been updated in a long time label Apr 23, 2023
@github-actions
Copy link

github-actions bot commented May 1, 2023

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.

@github-actions github-actions bot closed this as not planned Won't fix, can't repro, duplicate, stale May 1, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
state:needs-owner Needs an issue owner to be assigned state:needs-triage Needs to triaged to determine next steps state:stale Has not been updated in a long time type:bug Something isn't working urgency:low Little to no impact
Projects
None yet
Development

No branches or pull requests

1 participant