Skip to content

Magic values and generic names for /etc/*.cfg #3

@lool

Description

@lool

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!

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions