Magic values and generic names for /etc/*.cfg
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 35/100
- Issue type
- Feature
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- ubuntu
- Domain
- release
Research direction
Inspect how the Debian package installs /etc/pcp.cfg, /etc/qbv.cfg, and /etc/streams.cfg, then review the values and sample stream addresses in those files. Determine whether they are safe defaults or sample configurations and whether they belong under /etc/xilinx or /usr/share/xilinx-tsn-utils/doc. Done means the installation location and naming are resolved and the configuration values are documented or corrected.
Written by the indexing model from the issue text.
Description
hi!
I'm working on a deb package of tsn-utils for Ubuntu, and I've noticed that these files are installed by default:
/etc/pcp.cfg
/etc/qbv.cfg
/etc/streams.cfg
Some of these filenames are a bit too generic to be used by default as they might collide with other packages or confuse users; could you rename them to e.g. /etc/xilinx/streams.cfg? It would also make it clear where these configs came from for end-users (even if that can be queried with dpkg -S).
These files also come with many many magic values; e.g. in pcp.cfg:
st_pcp = 4;
res_pcp = 2,3;
Similarly, I'm suspicious that all Ubuntu Xilinx systems would ship with:
streams =
(
{
dest = "00:0a:35:00:01:0e";
vid = 10;
trigger = 100000;
count = 1; // fetch 1 frame at this time
},
{
dest = "00:0a:35:00:01:0f";
vid = 20;
trigger = 200000;
count = 2; // fetch 2 frame at this time
}
);
At the very least, the configs should document why these are safe defaults.
If these are sample configs, perhaps these should be installed under /usr/share/xilinx-tsn-utils/doc instead?
Thanks!
- Dominant language
- C
- Stars
- 7
- Forks
- 4
- PR merge metrics
- No merged PRs in 30d
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from Xilinx/tsn-utils
-
Difficulty 2/5 1-3 hours Newbie friendliness 45/100
-
Difficulty 4/5 3-5 days Newbie friendliness 32/100
All issues in Xilinx/tsn-utils
Similar issues
-
enhancement good first issue
Difficulty 2/5 1-3 hours Newbie friendliness 66/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Maintainers usually reply within 1 day
-
Policy query leaks host primary block (BSL_PrimaryBlock_deinit skipped) on two early-exit pathsOpen
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
NASA-AMMOS/BSL#355 ·
Maintainers usually reply within 1 day
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
arancormonk/dsd-neo#660 ·
Maintainers usually reply within 1 day
-
[Bug]: remote-ls --updates reports up-to-date OCI refs because it ignores deployed Alt-idPossibly taken @Joao-kouznetz claimed this today. Open
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Maintainers usually reply within 1 day