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.

Sign up for GitHub

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

Test-case: Updated check-sof-logger.sh with SOF-specific codec #1248

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Test-case: Updated check-sof-logger.sh with SOF-specific codec #1248

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion test-case/check-sof-logger.sh
View file
Open in desktop
harajend marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,14 @@ sof_alsa_card_found()
# note: assumes SOF card names to start with "sof", e.g.
# - /proc/asound/sofsoundwire/id
# - /proc/asound/sofhdadsp/id
test -e /proc/asound/sof*/id
# test -e /proc/asound/sof*/id
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@harajend The git commit style is still a bit different than what is the established practise. Please check "git log" history for sof-test to see examples. E.g. there should be some prefix like "check-sof-logger: fix support for multiple SOF cards" on first line. Commit should also explain what is fixed and why, "check-sof-logger.sh fails to detect SOF in case mulitple SOF cards are present in the system. Fix the logic to check the SOF card."

# - https://github.com/thesofproject/sof-test/issues/1243
# Internal issue #615
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd avoid these internal references. At least should mention "Intel internal issue tracker".

Copy link
Collaborator

@marc-hb marc-hb Jan 13, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think any reference or comment is required in the source in this particular case. It's pretty obvious a for loop is designed to support multiple devices.

If you really want to add a comment, say something like # we have multiple sof* devices every time we enable sofprobes. EDIT: you already have something close to this but it does not mention "sofprobes" and does not add much information. Comments must not repeat the code, they must add information.

When possible, it's better not to have to open a link to understand something. References in the source are for complicated problems that are too long to explain in place.

The commit message is a good place for references: you can be quite verbose there and have as many references as you want in the git log.

# Designed to support multiple sof*
for i in /proc/asound/sof*/id; do
if test -e "$i"; then return 0; fi
done
return 1
}

wait_for_sof_alsa_card()
Expand Down