Uploaded image for project: 'Core Server'
  1. Core Server
  2. SERVER-86410

Document why and how we use AtomicWord

    • Type: Icon: Improvement Improvement
    • Resolution: Unresolved
    • Priority: Icon: Major - P3 Major - P3
    • None
    • Affects Version/s: None
    • Component/s: None
    • None
    • Service Arch
    • SP Prioritized List

      We prohibit std::atomic in favor of AtomicWord, but it's not clear from the error message in https://github.com/mongodb/mongo/blob/master/src/mongo/tools/mongo_tidy_checks/MongoStdAtomicCheck.cpp#L57-L59 why we do so. Furthermore, we should document how to use AtomicWord safely.

      AC:

      • The error message points to documentation clearly explaining why std::atomic is prohibited.
      • There is a "new engineer"-style doc on Confluence clearly explaining how to use AtomicWord safely.

            Assignee:
            backlog-server-servicearch [DO NOT USE] Backlog - Service Architecture
            Reporter:
            brad.cater@mongodb.com Brad Cater
            Votes:
            0 Vote for this issue
            Watchers:
            6 Start watching this issue

              Created:
              Updated: