[SERVER-60214] Make improvements in generic FCV commenting/terminology Created: 24/Sep/21  Updated: 01/May/23

Status: Open
Project: Core Server
Component/s: None
Affects Version/s: None
Fix Version/s: None

Type: Task Priority: Major - P3
Reporter: Xuerui Fa Assignee: Backlog - Replication Team
Resolution: Unresolved Votes: 0
Labels: former-quick-wins, milestone-2, pm-2821-quick-wins
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Depends
Related
related to SERVER-60215 Investigate improvements in generic F... Closed
Assigned Teams:
Replication
Sprint: Repl 2022-06-27, Repl 2022-07-11, Repl 2022-08-08, Repl 2022-08-22, Repl 2022-09-05, Repl 2022-09-19, Repl 2022-07-25, Repl 2023-05-01
Participants:

 Description   

In the 5.0 release, we ran into occasional issues where generic FCV constants were used instead of real FCVs. For these cases, we should investigate any improvements to help engineers from accidentally stumbling into this error. We currently require any generic FCV usage to have a corresponding comment that begins with “(Generic FCV reference):”. One suggestion is to expand that comment to start with:

(Generic FCV reference): This FCV reference must remain across binary version releases because…

 

So that it is clear that this reference must persist across releases and that engineers must explain why the reference should persist across releases

We could also consider renaming “generic” terminology to be more representative of their use cases, something to represent that these FCVs (kLatest, kLastLTS, etc) will change with each new release (i.e. in the 6.1 release kLatest points to kVersion_6_1 and kLastLTS points to kVersion_6_0, but in the 7.1 release kLatest points to kVersion_7_1 and kLastLTS points to kVersion_7_0)


Generated at Thu Feb 08 05:49:15 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.