oasis-tcs / csaf

OASIS CSAF TC: Supporting version control for Work Product artifacts developed by members of TC, including prose specifications and secondary artifacts like meeting minutes and productivity code
https://github.com/oasis-tcs/csaf
Other
148 stars 39 forks source link

Change category name "aggregator" to "mirror" for consistency #529

Open bernhardreiter opened 2 years ago

bernhardreiter commented 2 years ago

2.0 Committee Specification Draft 02 has

7.1.23 Requirement 23: Mirror

  "aggregator": {
      "category": "aggregator",

to be more consistent renaming the category to mirror would be helpful, because this fits the wording in other parts of the document, e.g in the variables

list_on_CSAF_aggregators and true in mirror_on_CSAF_aggregators

sthagen commented 2 years ago

Consistency might then enforce renaming of aggregator to mirror which would

  1. hide the (main) aggregating function of the now aggregator :-1:
  2. both changes would be of material impact

So, personally I suggest to reconsider (later) but not before CS02 is out.

bernhardreiter commented 2 years ago

Consistency might then enforce renaming of aggregator to mirror

No it is consistent in terminology to have an "aggregator" acting in two modes "mirror" and "lister".

tschmidtb51 commented 2 years ago

Consistency might then enforce renaming of aggregator to mirror

No it is consistent in terminology to have an "aggregator" acting in two modes "mirror" and "lister".

I think this is a misunderstanding: I guess @sthagen is right: 7.2.5 Role: CSAF aggregator would have to be renamed into CSAF Mirror (?)

As this is a sever material change, we need to discuss that in the TC. Personally, I would probably delay the change.

To provide a little bit context: Historically, there was only an aggregator in the concept. Then, the role what is CSAF lister was add (but initially named "CSAF aggregator light"). When it was added in the standard, it became the CSAF lister and the CSAF aggregator stayed the same.

sthagen commented 2 years ago

@bernhardreiter and @tschmidtb51 I added the TC discussion needed label accordingly.

bernhardreiter commented 2 years ago

@tschmidtb51 thanks for the clarification!