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

RTE Configuration file PLM - reconsider filenaming convention #324

Closed
jkrech opened this issue May 8, 2022 · 4 comments
Closed

RTE Configuration file PLM - reconsider filenaming convention #324

jkrech opened this issue May 8, 2022 · 4 comments
Assignees
Labels
documentation Improvements or additions to documentation proposal Proposal for change or extension

Comments

@jkrech
Copy link
Member

jkrech commented May 8, 2022

While answering and discussing this issue #313 the concerns got raised, that on UNIX operating systems files and directories starting with a "." are hidden by default but not on windows.

In order not to confuse users with multiple "similar" filenames, one suggestion was to store the "versioned" files in a different directory location. Which may make it harder for users to identify and localize the files required for a three-way merge.

a) project specific configuration file used by the build process

b) copy of the configuration file version used as the basis of the project specific file as provided by the component version at the time when the component was added or an updated version merged

  • unmodified
  • read-only
  • provides version information

c) copy of the configuration file as provided by the current component version / pack version when processed

  • unmodified
  • read-only
  • provides version information

Alternative using current and update

<configfile>.<ext>
<configfile>.<ext>.current@version
<configfile>.<ext>.update@version

Note:
a) we need to be able to identify which versioned file is the basis of the actual configuration file.
b) the tools shall remove any "update" configuration file that was not merged.
c) there is a maximum of one "update" file present or none in case the version of "update" would match "original".

@jkrech jkrech added the discussion Indicates an issue being in discussion label May 8, 2022
@ReinhardKeil ReinhardKeil added the proposal Proposal for change or extension label Jun 13, 2022
@ReinhardKeil
Copy link
Collaborator

Reflected in the next version of the documentation https://github.com/Open-CMSIS-Pack/devtools/blob/main/tools/projmgr/docs/Manual/Overview.md#plm-of-configuration-files (will be live tomorrow)

@ReinhardKeil ReinhardKeil added the question Further information is requested label Sep 20, 2022
@ReinhardKeil
Copy link
Collaborator

Is this completed?

@jkrech
Copy link
Member Author

jkrech commented Sep 20, 2022

This has not been implemented in csolution (RTE-Model) yet.
During discussion @edriouk and @brondani suggested to use base instead of current as this term is also used by git merge.

<configfile>.<ext>
<configfile>.<ext>.base@version
<configfile>.<ext>.update@version

@jkrech jkrech added documentation Improvements or additions to documentation and removed question Further information is requested discussion Indicates an issue being in discussion labels Oct 4, 2022
@ReinhardKeil
Copy link
Collaborator

implemented

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation proposal Proposal for change or extension
Projects
None yet
Development

No branches or pull requests

4 participants